Commit 9f2b44fc by Alexander Makarov

phpdoc

parent ac5b25e3
...@@ -51,6 +51,7 @@ class ErrorHandler extends Component ...@@ -51,6 +51,7 @@ class ErrorHandler extends Component
/** /**
* Handles exception
* @param \Exception $exception * @param \Exception $exception
*/ */
public function handle($exception) public function handle($exception)
...@@ -64,6 +65,10 @@ class ErrorHandler extends Component ...@@ -64,6 +65,10 @@ class ErrorHandler extends Component
$this->renderException($exception); $this->renderException($exception);
} }
/**
* Renders exception
* @param \Exception $exception
*/
protected function renderException($exception) protected function renderException($exception)
{ {
if ($this->errorAction !== null) { if ($this->errorAction !== null) {
...@@ -196,6 +201,10 @@ class ErrorHandler extends Component ...@@ -196,6 +201,10 @@ class ErrorHandler extends Component
echo '<div class="code"><pre>' . $output . '</pre></div>'; echo '<div class="code"><pre>' . $output . '</pre></div>';
} }
/**
* Renders calls stack trace
* @param array $trace
*/
public function renderTrace($trace) public function renderTrace($trace)
{ {
$count = 0; $count = 0;
...@@ -233,6 +242,11 @@ class ErrorHandler extends Component ...@@ -233,6 +242,11 @@ class ErrorHandler extends Component
echo '</table>'; echo '</table>';
} }
/**
* Converts special characters to HTML entities
* @param string $text text to encode
* @return string
*/
public function htmlEncode($text) public function htmlEncode($text)
{ {
return htmlspecialchars($text, ENT_QUOTES, \Yii::$app->charset); return htmlspecialchars($text, ENT_QUOTES, \Yii::$app->charset);
......
...@@ -13,27 +13,45 @@ namespace yii\base; ...@@ -13,27 +13,45 @@ namespace yii\base;
*/ */
class Response extends Component class Response extends Component
{ {
/**
* Starts output buffering
*/
public function beginOutput() public function beginOutput()
{ {
ob_start(); ob_start();
ob_implicit_flush(false); ob_implicit_flush(false);
} }
/**
* Returns contents of the output buffer and discards it
* @return string output buffer contents
*/
public function endOutput() public function endOutput()
{ {
return ob_get_clean(); return ob_get_clean();
} }
/**
* Returns contents of the output buffer
* @return string output buffer contents
*/
public function getOutput() public function getOutput()
{ {
return ob_get_contents(); return ob_get_contents();
} }
/**
* Discards the output buffer
*/
public function cleanOutput() public function cleanOutput()
{ {
ob_clean(); ob_clean();
} }
/**
* Discards the output buffer
* @param boolean $all if true recursively discards all output buffers used
*/
public function removeOutput($all = true) public function removeOutput($all = true)
{ {
if ($all) { if ($all) {
......
...@@ -52,6 +52,7 @@ class DbDependency extends Dependency ...@@ -52,6 +52,7 @@ class DbDependency extends Dependency
/** /**
* Generates the data needed to determine if dependency has been changed. * Generates the data needed to determine if dependency has been changed.
* This method returns the value of the global state. * This method returns the value of the global state.
* @throws InvalidConfigException
* @return mixed the data needed to determine if dependency has been changed. * @return mixed the data needed to determine if dependency has been changed.
*/ */
protected function generateDependencyData() protected function generateDependencyData()
......
...@@ -106,7 +106,7 @@ class MemCache extends Cache ...@@ -106,7 +106,7 @@ class MemCache extends Cache
/** /**
* Returns the underlying memcache (or memcached) object. * Returns the underlying memcache (or memcached) object.
* @return \Memcache|\Memcached the memcache (or memcached) object used by this cache component. * @return \Memcache|\Memcached the memcache (or memcached) object used by this cache component.
* @throws Exception if memcache or memcached extension is not loaded * @throws InvalidConfigException if memcache or memcached extension is not loaded
*/ */
public function getMemcache() public function getMemcache()
{ {
......
...@@ -64,7 +64,7 @@ class VarDumper ...@@ -64,7 +64,7 @@ class VarDumper
return self::$_output; return self::$_output;
} }
/* /**
* @param mixed $var variable to be dumped * @param mixed $var variable to be dumped
* @param integer $level depth level * @param integer $level depth level
*/ */
......
...@@ -68,6 +68,7 @@ class CaptchaValidator extends Validator ...@@ -68,6 +68,7 @@ class CaptchaValidator extends Validator
/** /**
* Returns the CAPTCHA action object. * Returns the CAPTCHA action object.
* @throws InvalidConfigException
* @return CaptchaAction the action object * @return CaptchaAction the action object
*/ */
public function getCaptchaAction() public function getCaptchaAction()
......
...@@ -39,10 +39,16 @@ class ActiveForm extends Widget ...@@ -39,10 +39,16 @@ class ActiveForm extends Widget
public $errorMessageClass = 'yii-error-message'; public $errorMessageClass = 'yii-error-message';
/** /**
* @var string the default CSS class that indicates an input has error. * @var string the default CSS class that indicates an input has error.
* This is
*/ */
public $errorClass = 'yii-error'; public $errorClass = 'yii-error';
/**
* @var string the default CSS class that indicates an input validated successfully.
*/
public $successClass = 'yii-success'; public $successClass = 'yii-success';
/**
* @var string the default CSS class that indicates an input is currently being validated.
*/
public $validatingClass = 'yii-validating'; public $validatingClass = 'yii-validating';
/** /**
* @var boolean whether to enable client-side data validation. Defaults to false. * @var boolean whether to enable client-side data validation. Defaults to false.
...@@ -127,6 +133,14 @@ class ActiveForm extends Widget ...@@ -127,6 +133,14 @@ class ActiveForm extends Widget
return Html::label($label, $for, $options); return Html::label($label, $for, $options);
} }
/**
* @param string $type
* @param Model $model
* @param string $attribute
* @param array $options
*
* @return string
*/
public function input($type, $model, $attribute, $options = array()) public function input($type, $model, $attribute, $options = array())
{ {
$value = $this->getAttributeValue($model, $attribute); $value = $this->getAttributeValue($model, $attribute);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment