Skip to content

Y
yii2
Commit 77368538 by Carsten Brandt
Options

property code style extensions

parent 63b98dbc
Showing with 183 additions and 104 deletions
build/controllers/PhpDocController.php
......@@ -278,7 +278,7 @@ class PhpDocController extends Controller
}
if (trim($line) === '') {
unset($lines[$i]);
} elseif (ltrim($line)[0] !== '*' && strpos($line, 'function') !== false) {
} elseif (ltrim($line)[0] !== '*' && strpos($line, 'function ') !== false) {
break;
} elseif (trim($line) === '}') {
$propertiesOnly = true;
......@@ -309,32 +309,33 @@ class PhpDocController extends Controller
${'endof'.$property} = $i;
}
if (strncmp(trim($line), 'public $', 8) === 0 || strncmp(trim($line), 'public static $', 15) === 0) {
$line = trim($line);
if (strncmp($line, 'public $', 8) === 0 || strncmp($line, 'public static $', 15) === 0) {
$endofPublic = $i;
$property = 'Public';
$level = 0;
} elseif (strncmp(trim($line), 'protected $', 11) === 0 || strncmp(trim($line), 'protected static $', 18) === 0) {
} elseif (strncmp($line, 'protected $', 11) === 0 || strncmp($line, 'protected static $', 18) === 0) {
$endofProtected = $i;
$property = 'Protected';
$level = 0;
} elseif (strncmp(trim($line), 'private $', 9) === 0 || strncmp(trim($line), 'private static $', 16) === 0) {
} elseif (strncmp($line, 'private $', 9) === 0 || strncmp($line, 'private static $', 16) === 0) {
$endofPrivate = $i;
$property = 'Private';
$level = 0;
} elseif (substr(trim($line),0 , 6) === 'const ') {
} elseif (substr($line,0 , 6) === 'const ') {
$endofConst = $i;
$property = false;
} elseif (substr(trim($line),0 , 4) === 'use ') {
} elseif (substr($line,0 , 4) === 'use ') {
$endofUse = $i;
$property = false;
} elseif (ltrim($line)[0] === '*') {
} elseif (!empty($line) && $line[0] === '*') {
$property = false;
} elseif (ltrim($line)[0] !== '*' && strpos($line, 'function') !== false || trim($line) === '}') {
} elseif (!empty($line) && $line[0] !== '*' && strpos($line, 'function ') !== false || $line === '}') {
break;
}
// check for multi line array
if ($property !== false && strncmp(trim($line), "'SQLSTATE[", 10) !== 0) {
if ($property !== false && strncmp($line, "'SQLSTATE[", 10) !== 0) {
$level += substr_count($line, '[') - substr_count($line, ']');
}
}
......
extensions/apidoc/commands/ApiController.php
......@@ -28,8 +28,8 @@ class ApiController extends BaseController
*/
public $guide;
// TODO add force update option
// TODO add force update option
/**
* Renders API documentation files
* @param array $sourceDirs
......
extensions/apidoc/commands/GuideController.php
......@@ -28,6 +28,7 @@ class GuideController extends BaseController
*/
public $apiDocs;
/**
* Renders API documentation files
* @param array $sourceDirs
......
extensions/apidoc/components/BaseController.php
......@@ -30,6 +30,7 @@ abstract class BaseController extends Controller
*/
public $exclude;
protected function normalizeTargetDir($target)
{
$target = rtrim(Yii::getAlias($target), '\\/');
......
extensions/apidoc/helpers/ApiIndexer.php
<?php
/**
*
*
* @author Carsten Brandt <mail@cebe.cc>
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\apidoc\helpers;
use cebe\jssearch\Indexer;
use cebe\jssearch\tokenizer\StandardTokenizer;
use cebe\jssearch\TokenizerInterface;
......
extensions/apidoc/helpers/ApiMarkdown.php
......@@ -31,6 +31,7 @@ class ApiMarkdown extends GithubMarkdown
protected $renderingContext;
/**
* Renders a code block
*/
......
extensions/apidoc/helpers/ApiMarkdownLaTeX.php
......@@ -29,6 +29,7 @@ class ApiMarkdownLaTeX extends GithubMarkdown
protected $renderingContext;
protected function inlineMarkers()
{
return array_merge(parent::inlineMarkers(), [
......
extensions/apidoc/helpers/IndexFileAnalyzer.php
......@@ -17,6 +17,7 @@ class IndexFileAnalyzer extends Markdown
private $_chapter = 0;
private $_chapters = [];
public function analyze($text)
{
$this->parse($text);
......
extensions/apidoc/models/BaseDoc.php
......@@ -24,24 +24,21 @@ class BaseDoc extends Object
* @var \phpDocumentor\Reflection\DocBlock\Context
*/
public $phpDocContext;
public $name;
public $sourceFile;
public $startLine;
public $endLine;
public $shortDescription;
public $description;
public $since;
public $deprecatedSince;
public $deprecatedReason;
/**
* @var \phpDocumentor\Reflection\DocBlock\Tag[]
*/
public $tags = [];
public function hasTag($name)
{
foreach ($this->tags as $tag) {
......
extensions/apidoc/models/ClassDoc.php
......@@ -18,10 +18,8 @@ namespace yii\apidoc\models;
class ClassDoc extends TypeDoc
{
public $parentClass;
public $isAbstract;
public $isFinal;
/**
* @var string[]
*/
......@@ -29,7 +27,6 @@ class ClassDoc extends TypeDoc
public $traits = [];
// will be set by Context::updateReferences()
public $subclasses = [];
/**
* @var EventDoc[]
*/
......@@ -39,6 +36,7 @@ class ClassDoc extends TypeDoc
*/
public $constants = [];
public function findSubject($subjectName)
{
if (($subject = parent::findSubject($subjectName)) !== null) {
......
extensions/apidoc/models/ConstDoc.php
......@@ -18,6 +18,7 @@ class ConstDoc extends BaseDoc
public $definedBy;
public $value;
/**
* @param \phpDocumentor\Reflection\ClassReflector\ConstantReflector $reflector
* @param Context $context
......
extensions/apidoc/models/Context.php
......@@ -33,9 +33,9 @@ class Context extends Component
* @var TraitDoc[]
*/
public $traits = [];
public $errors = [];
public function getType($type)
{
$type = ltrim($type, '\\');
......
extensions/apidoc/models/EventDoc.php
......@@ -20,6 +20,7 @@ class EventDoc extends ConstDoc
public $type;
public $types;
/**
* @param \phpDocumentor\Reflection\ClassReflector\ConstantReflector $reflector
* @param Context $context
......
extensions/apidoc/models/FunctionDoc.php
......@@ -30,6 +30,7 @@ class FunctionDoc extends BaseDoc
public $returnTypes;
public $isReturnByReference;
/**
* @param \phpDocumentor\Reflection\FunctionReflector $reflector
* @param Context $context
......
extensions/apidoc/models/InterfaceDoc.php
......@@ -16,10 +16,10 @@ namespace yii\apidoc\models;
class InterfaceDoc extends TypeDoc
{
public $parentInterfaces = [];
// will be set by Context::updateReferences()
public $implementedBy = [];
/**
* @param \phpDocumentor\Reflection\InterfaceReflector $reflector
* @param Context $context
......
extensions/apidoc/models/MethodDoc.php
......@@ -17,14 +17,12 @@ class MethodDoc extends FunctionDoc
{
public $isAbstract;
public $isFinal;
public $isStatic;
public $visibility;
// will be set by creating class
public $definedBy;
/**
* @param \phpDocumentor\Reflection\ClassReflector\MethodReflector $reflector
* @param Context $context
......
extensions/apidoc/models/ParamDoc.php
......@@ -23,13 +23,13 @@ class ParamDoc extends Object
public $isOptional;
public $defaultValue;
public $isPassedByReference;
// will be set by creating class
public $description;
public $type;
public $types;
public $sourceFile;
/**
* @param \phpDocumentor\Reflection\FunctionReflector\ArgumentReflector $reflector
* @param Context $context
......
extensions/apidoc/models/PropertyDoc.php
......@@ -20,18 +20,16 @@ class PropertyDoc extends BaseDoc
{
public $visibility;
public $isStatic;
public $type;
public $types;
public $defaultValue;
// will be set by creating class
public $getter;
public $setter;
// will be set by creating class
public $definedBy;
public function getIsReadOnly()
{
return $this->getter !== null && $this->setter === null;
......
extensions/apidoc/models/TraitDoc.php
......@@ -18,9 +18,9 @@ class TraitDoc extends TypeDoc
// classes using the trait
// will be set by Context::updateReferences()
public $usedBy = [];
public $traits = [];
/**
* @param \phpDocumentor\Reflection\TraitReflector $reflector
* @param Context $context
......
extensions/apidoc/models/TypeDoc.php
......@@ -34,9 +34,9 @@ class TypeDoc extends BaseDoc
* @var PropertyDoc[]
*/
public $properties = [];
public $namespace;
public function findSubject($subjectName)
{
if ($subjectName[0] != '$') {
......
extensions/apidoc/renderers/BaseRenderer.php
......@@ -42,10 +42,10 @@ abstract class BaseRenderer extends Component
* @var Controller the apidoc controller instance. Can be used to control output.
*/
public $controller;
public $guideUrl;
public $guideReferences = [];
public function init()
{
ApiMarkdown::$renderer = $this;
......
extensions/apidoc/templates/bootstrap/ApiRenderer.php
......@@ -24,6 +24,7 @@ class ApiRenderer extends \yii\apidoc\templates\html\ApiRenderer
public $layout = '@yii/apidoc/templates/bootstrap/layouts/api.php';
public $indexView = '@yii/apidoc/templates/bootstrap/views/index.php';
/**
* @inheritdoc
*/
......
extensions/apidoc/templates/bootstrap/GuideRenderer.php
......@@ -23,6 +23,7 @@ class GuideRenderer extends \yii\apidoc\templates\html\GuideRenderer
public $layout = '@yii/apidoc/templates/bootstrap/layouts/guide.php';
/**
* @inheritDoc
*/
......
extensions/apidoc/templates/bootstrap/SideNavWidget.php
......@@ -78,6 +78,7 @@ class SideNavWidget extends \yii\bootstrap\Widget
*/
public $activeUrl;
/**
* Initializes the widget.
*/
......
extensions/apidoc/templates/html/ApiRenderer.php
......@@ -46,12 +46,14 @@ class ApiRenderer extends BaseApiRenderer implements ViewContextInterface
* @var string path or alias of the view file to use for rendering the index page.
*/
public $indexView = '@yii/apidoc/templates/html/views/index.php';
/**
* @var View
*/
private $_view;
private $_targetDir;
public function init()
{
parent::init();
......
extensions/apidoc/templates/html/GuideRenderer.php
......@@ -34,6 +34,7 @@ abstract class GuideRenderer extends BaseGuideRenderer
private $_view;
private $_targetDir;
public function init()
{
parent::init();
......
extensions/apidoc/templates/online/ApiRenderer.php
......@@ -20,9 +20,9 @@ class ApiRenderer extends \yii\apidoc\templates\html\ApiRenderer
{
public $layout = false;
public $indexView = '@yii/apidoc/templates/online/views/index.php';
public $pageTitle = 'Yii Framework 2.0 API Documentation';
/**
* @inheritdoc
*/
......
extensions/authclient/AuthAction.php
......@@ -93,6 +93,8 @@ class AuthAction extends Action
* @var string the redirect url after unsuccessful authorization (e.g. user canceled).
*/
private $_cancelUrl = '';
/**
* @var string name or alias of the view file, which should be rendered in order to perform redirection.
* If not set default one will be used.
......
extensions/authclient/BaseClient.php
......@@ -58,6 +58,7 @@ abstract class BaseClient extends Component implements ClientInterface
*/
private $_viewOptions;
/**
* @param string $id service id.
*/
......
extensions/authclient/BaseOAuth.php
......@@ -39,12 +39,6 @@ abstract class BaseOAuth extends BaseClient implements ClientInterface
*/
public $version = '1.0';
/**
* @var string URL, which user will be redirected after authentication at the OAuth provider web site.
* Note: this should be absolute URL (with http:// or https:// leading).
* By default current URL will be used.
*/
private $_returnUrl;
/**
* @var string API base URL.
*/
public $apiBaseUrl;
......@@ -56,6 +50,13 @@ abstract class BaseOAuth extends BaseClient implements ClientInterface
* @var string auth request scope.
*/
public $scope;
/**
* @var string URL, which user will be redirected after authentication at the OAuth provider web site.
* Note: this should be absolute URL (with http:// or https:// leading).
* By default current URL will be used.
*/
private $_returnUrl;
/**
* @var array cURL request options. Option values from this field will overwrite corresponding
* values from [[defaultCurlOptions()]].
......@@ -70,6 +71,7 @@ abstract class BaseOAuth extends BaseClient implements ClientInterface
*/
private $_signatureMethod = [];
/**
* @param string $returnUrl return URL
*/
......
extensions/authclient/Collection.php
......@@ -47,6 +47,7 @@ class Collection extends Component
*/
private $_clients = [];
/**
* @param array $clients list of auth clients
*/
......
extensions/authclient/InvalidResponseException.php
......@@ -26,6 +26,7 @@ class InvalidResponseException extends Exception
*/
public $responseBody = '';
/**
* Constructor.
* @param array $responseHeaders response headers
......
extensions/authclient/OAuth1.php
......@@ -62,6 +62,7 @@ class OAuth1 extends BaseOAuth
*/
public $accessTokenMethod = 'GET';
/**
* Fetches the OAuth request token.
* @param array $params additional request params.
......
extensions/authclient/OAuth2.php
......@@ -50,6 +50,7 @@ class OAuth2 extends BaseOAuth
*/
public $tokenUrl;
/**
* Composes user authorization URL.
* @param array $params additional auth GET params.
......
extensions/authclient/OAuthToken.php
......@@ -43,6 +43,8 @@ class OAuthToken extends Object
* @var array token parameters.
*/
private $_params = [];
/**
* @var integer object creation timestamp.
*/
......
extensions/authclient/OpenId.php
......@@ -68,7 +68,6 @@ class OpenId extends BaseClient implements ClientInterface
* ~~~
*/
public $optionalAttributes = [];
/**
* @var boolean whether to verify the peer's certificate.
*/
......@@ -83,7 +82,6 @@ class OpenId extends BaseClient implements ClientInterface
* This value will take effect only if [[verifyPeer]] is set.
*/
public $cainfo;
/**
* @var string authentication return URL.
*/
......@@ -96,6 +94,8 @@ class OpenId extends BaseClient implements ClientInterface
* @var string client trust root (realm), by default [[\yii\web\Request::hostInfo]] value will be used.
*/
private $_trustRoot;
/**
* @var array data, which should be used to retrieve the OpenID response.
* If not set combination of GET and POST will be used.
......
extensions/authclient/clients/Facebook.php
......@@ -57,6 +57,7 @@ class Facebook extends OAuth2
*/
public $scope = 'email';
/**
* @inheritdoc
*/
......
extensions/authclient/clients/GitHub.php
......@@ -53,6 +53,7 @@ class GitHub extends OAuth2
*/
public $apiBaseUrl = 'https://api.github.com';
/**
* @inheritdoc
*/
......
extensions/authclient/clients/GoogleOAuth.php
......@@ -55,6 +55,7 @@ class GoogleOAuth extends OAuth2
*/
public $apiBaseUrl = 'https://www.googleapis.com/plus/v1';
/**
* @inheritdoc
*/
......
extensions/authclient/clients/GoogleOpenId.php
......@@ -48,6 +48,7 @@ class GoogleOpenId extends OpenId
'pref/language',
];
/**
* @inheritdoc
*/
......
extensions/authclient/clients/LinkedIn.php
......@@ -56,6 +56,7 @@ class LinkedIn extends OAuth2
*/
public $apiBaseUrl = 'https://api.linkedin.com/v1';
/**
* @inheritdoc
*/
......
extensions/authclient/clients/Live.php
......@@ -53,6 +53,7 @@ class Live extends OAuth2
*/
public $apiBaseUrl = 'https://apis.live.net/v5.0';
/**
* @inheritdoc
*/
......
extensions/authclient/clients/Twitter.php
......@@ -65,6 +65,7 @@ class Twitter extends OAuth1
*/
public $apiBaseUrl = 'https://api.twitter.com/1.1';
/**
* @inheritdoc
*/
......
extensions/authclient/clients/VKontakte.php
......@@ -53,6 +53,7 @@ class VKontakte extends OAuth2
*/
public $apiBaseUrl = 'https://api.vk.com/method';
/**
* @inheritdoc
*/
......
extensions/authclient/clients/YandexOAuth.php
......@@ -53,6 +53,7 @@ class YandexOAuth extends OAuth2
*/
public $apiBaseUrl = 'https://login.yandex.ru';
/**
* @inheritdoc
*/
......
extensions/authclient/clients/YandexOpenId.php
......@@ -46,6 +46,7 @@ class YandexOpenId extends OpenId
'contact/email',
];
/**
* @inheritdoc
*/
......
extensions/authclient/signature/RsaSha1.php
......@@ -33,6 +33,8 @@ class RsaSha1 extends BaseMethod
* This value can be fetched from file specified by [[publicCertificateFile]].
*/
protected $_publicCertificate;
/**
* @var string path to the file, which holds private key certificate.
*/
......
extensions/authclient/widgets/AuthChoice.php
......@@ -96,6 +96,7 @@ class AuthChoice extends Widget
*/
private $_clients;
/**
* @param ClientInterface[] $clients auth providers
*/
......
extensions/bootstrap/ActiveField.php
......@@ -95,17 +95,14 @@ class ActiveField extends \yii\widgets\ActiveField
* @var bool whether to render [[checkboxList()]] and [[radioList()]] inline.
*/
public $inline = false;
/**
* @var string|null optional template to render the `{input}` placeholder content
*/
public $inputTemplate;
/**
* @var array options for the wrapper tag, used in the `{beginWrapper}` placeholder
*/
public $wrapperOptions = [];
/**
* @var null|array CSS grid classes for horizontal layout. This must be an array with these keys:
* - 'offset' the offset grid class to append to the wrapper if no label is rendered
......@@ -115,47 +112,40 @@ class ActiveField extends \yii\widgets\ActiveField
* - 'hint' the hint grid class
*/
public $horizontalCssClasses;
/**
* @var string the template for checkboxes in default layout
*/
public $checkboxTemplate = "<div class=\"checkbox\">\n{beginLabel}\n{input}\n{labelTitle}\n{endLabel}\n{error}\n{hint}\n</div>";
/**
* @var string the template for radios in default layout
*/
public $radioTemplate = "<div class=\"radio\">\n{beginLabel}\n{input}\n{labelTitle}\n{endLabel}\n{error}\n{hint}\n</div>";
/**
* @var string the template for checkboxes in horizontal layout
*/
public $horizontalCheckboxTemplate = "{beginWrapper}\n<div class=\"checkbox\">\n{beginLabel}\n{input}\n{labelTitle}\n{endLabel}\n</div>\n{error}\n{endWrapper}\n{hint}";
/**
* @var string the template for radio buttons in horizontal layout
*/
public $horizontalRadioTemplate = "{beginWrapper}\n<div class=\"radio\">\n{beginLabel}\n{input}\n{labelTitle}\n{endLabel}\n</div>\n{error}\n{endWrapper}\n{hint}";
/**
* @var string the template for inline checkboxLists
*/
public $inlineCheckboxListTemplate = "{label}\n{beginWrapper}\n{input}\n{error}\n{endWrapper}\n{hint}";
/**
* @var string the template for inline radioLists
*/
public $inlineRadioListTemplate = "{label}\n{beginWrapper}\n{input}\n{error}\n{endWrapper}\n{hint}";
/**
* @var bool whether to render the error. Default is `true` except for layout `inline`.
*/
public $enableError = true;
/**
* @var bool whether to render the label. Default is `true`.
*/
public $enableLabel = true;
/**
* @inheritdoc
*/
......
extensions/bootstrap/ActiveForm.php
......@@ -69,7 +69,6 @@ class ActiveForm extends \yii\widgets\ActiveForm
* @var array HTML attributes for the form tag. Default is `['role' => 'form']`.
*/
public $options = ['role' => 'form'];
/**
* @var string the form layout. Either 'default', 'horizontal' or 'inline'.
* By choosing a layout, an appropriate default field configuration is applied. This will
......@@ -79,6 +78,7 @@ class ActiveForm extends \yii\widgets\ActiveForm
*/
public $layout = 'default';
/**
* @inheritdoc
*/
......
extensions/bootstrap/Alert.php
......@@ -68,6 +68,7 @@ class Alert extends Widget
*/
public $closeButton = [];
/**
* Initializes the widget.
*/
......
extensions/bootstrap/Button.php
......@@ -39,6 +39,7 @@ class Button extends Widget
*/
public $encodeLabel = true;
/**
* Initializes the widget.
* If you override this method, make sure you call the parent implementation first.
......
extensions/bootstrap/ButtonDropdown.php
......@@ -59,6 +59,7 @@ class ButtonDropdown extends Widget
*/
public $encodeLabel = true;
/**
* Renders the widget.
*/
......
extensions/bootstrap/ButtonGroup.php
......@@ -52,6 +52,7 @@ class ButtonGroup extends Widget
*/
public $encodeLabels = true;
/**
* Initializes the widget.
* If you override this method, make sure you call the parent implementation first.
......
extensions/bootstrap/Carousel.php
......@@ -66,6 +66,7 @@ class Carousel extends Widget
*/
public $items = [];
/**
* Initializes the widget.
*/
......
extensions/bootstrap/Collapse.php
......@@ -59,6 +59,7 @@ class Collapse extends Widget
*/
public $items = [];
/**
* Initializes the widget.
*/
......
extensions/bootstrap/Dropdown.php
......@@ -45,7 +45,8 @@ class Dropdown extends Widget
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
protected $_containerOptions = [];
/**
* Initializes the widget.
* If you override this method, make sure you call the parent implementation first.
......
extensions/bootstrap/Modal.php
......@@ -82,6 +82,7 @@ class Modal extends Widget
*/
public $toggleButton;
/**
* Initializes the widget.
*/
......
extensions/bootstrap/Nav.php
......@@ -93,6 +93,7 @@ class Nav extends Widget
*/
public $params;
/**
* Initializes the widget.
*/
......
extensions/bootstrap/NavBar.php
......@@ -85,6 +85,7 @@ class NavBar extends Widget
*/
public $innerContainerOptions = [];
/**
* Initializes the widget.
*/
......
extensions/bootstrap/Progress.php
......@@ -89,6 +89,7 @@ class Progress extends Widget
*/
public $bars;
/**
* Initializes the widget.
* If you override this method, make sure you call the parent implementation first.
......
extensions/bootstrap/Tabs.php
......@@ -102,6 +102,7 @@ class Tabs extends Widget
*/
public $navType = 'nav-tabs';
/**
* Initializes the widget.
*/
......
extensions/bootstrap/Widget.php
......@@ -39,6 +39,7 @@ class Widget extends \yii\base\Widget
*/
public $clientEvents = [];
/**
* Initializes the widget.
* This method will register the bootstrap asset bundle. If you override this method,
......
extensions/codeception/BasePage.php
......@@ -27,11 +27,13 @@ abstract class BasePage extends Component
* the route and the rest of the name-value pairs are treated as GET parameters, e.g. `array('site/page', 'name' => 'about')`.
*/
public $route;
/**
* @var \Codeception\AbstractGuy the testing guy object
*/
protected $guy;
/**
* Constructor.
*
......
extensions/codeception/TestCase.php
......@@ -33,6 +33,7 @@ class TestCase extends Test
*/
public $appConfig = '@tests/unit/_config.php';
/**
* Returns the value of an object property.
*
......
extensions/composer/Installer.php
......@@ -23,9 +23,9 @@ class Installer extends LibraryInstaller
const EXTRA_WRITABLE = 'writable';
const EXTRA_EXECUTABLE = 'executable';
const EXTRA_CONFIG = 'config';
const EXTENSION_FILE = 'yiisoft/extensions.php';
/**
* @inheritdoc
*/
......
extensions/debug/LogTarget.php
......@@ -25,6 +25,7 @@ class LogTarget extends Target
public $module;
public $tag;
/**
* @param \yii\debug\Module $module
* @param array $config
......
extensions/debug/Panel.php
......@@ -49,6 +49,7 @@ class Panel extends Component
*/
public $actions = [];
/**
* @return string name of the panel
*/
......
extensions/debug/components/search/Filter.php
......@@ -23,6 +23,7 @@ class Filter extends Component
*/
protected $rules = [];
/**
* Adds data filtering rule.
*
......
extensions/debug/components/search/matchers/Base.php
......@@ -22,6 +22,7 @@ abstract class Base extends Component implements MatcherInterface
*/
protected $baseValue;
/**
* @inheritdoc
*/
......
extensions/debug/components/search/matchers/SameAs.php
......@@ -20,6 +20,7 @@ class SameAs extends Base
*/
public $partial = false;
/**
* @inheritdoc
*/
......
extensions/debug/controllers/DefaultController.php
......@@ -33,6 +33,7 @@ class DefaultController extends Controller
*/
public $summary;
/**
* @inheritdoc
*/
......
extensions/debug/models/search/Db.php
......@@ -23,12 +23,12 @@ class Db extends Base
* @var string type of the input search value
*/
public $type;
/**
* @var integer query attribute input search value
*/
public $query;
/**
* @inheritdoc
*/
......
extensions/debug/models/search/Debug.php
......@@ -23,47 +23,40 @@ class Debug extends Base
* @var string tag attribute input search value
*/
public $tag;
/**
* @var string ip attribute input search value
*/
public $ip;
/**
* @var string method attribute input search value
*/
public $method;
/**
* @var integer ajax attribute input search value
*/
public $ajax;
/**
* @var string url attribute input search value
*/
public $url;
/**
* @var string status code attribute input search value
*/
public $statusCode;
/**
* @var integer sql count attribute input search value
*/
public $sqlCount;
/**
* @var integer total mail count attribute input search value
*/
public $mailCount;
/**
* @var array critical codes, used to determine grid row options.
*/
public $criticalCodes = [400, 404, 500];
/**
* @inheritdoc
*/
......
extensions/debug/models/search/Log.php
......@@ -23,17 +23,16 @@ class Log extends Base
* @var string ip attribute input search value
*/
public $level;
/**
* @var string method attribute input search value
*/
public $category;
/**
* @var integer message attribute input search value
*/
public $message;
/**
* @inheritdoc
*/
......
extensions/debug/models/search/Mail.php
......@@ -22,52 +22,44 @@ class Mail extends Base
* @var string from attribute input search value
*/
public $from;
/**
* @var string to attribute input search value
*/
public $to;
/**
* @var string reply attribute input search value
*/
public $reply;
/**
* @var string cc attribute input search value
*/
public $cc;
/**
* @var string bcc attribute input search value
*/
public $bcc;
/**
* @var string subject attribute input search value
*/
public $subject;
/**
* @var string body attribute input search value
*/
public $body;
/**
* @var string charset attribute input search value
*/
public $charset;
/**
* @var string headers attribute input search value
*/
public $headers;
/**
* @var string file attribute input search value
*/
public $file;
public function rules()
{
return [
......
extensions/debug/models/search/Profile.php
......@@ -23,12 +23,12 @@ class Profile extends Base
* @var string method attribute input search value
*/
public $category;
/**
* @var integer info attribute input search value
*/
public $info;
/**
* @inheritdoc
*/
......
extensions/debug/panels/DbPanel.php
......@@ -28,16 +28,17 @@ class DbPanel extends Panel
* the execution is considered taking critical number of DB queries.
*/
public $criticalQueryThreshold;
/**
* @var array db queries info extracted to array as models, to use with data provider.
*/
private $_models;
/**
* @var array current database request timings
*/
private $_timings;
/**
* @inheritdoc
*/
......
extensions/debug/panels/LogPanel.php
......@@ -25,6 +25,7 @@ class LogPanel extends Panel
*/
private $_models;
/**
* @inheritdoc
*/
......
extensions/debug/panels/MailPanel.php
......@@ -29,11 +29,13 @@ class MailPanel extends Panel
* @var string path where all emails will be saved. should be an alias.
*/
public $mailPath = '@runtime/debug/mail';
/**
* @var array current request sent messages
*/
private $_messages = [];
/**
* @inheritdoc
*/
......
extensions/debug/panels/ProfilingPanel.php
......@@ -25,6 +25,7 @@ class ProfilingPanel extends Panel
*/
private $_models;
/**
* @inheritdoc
*/
......
extensions/elasticsearch/ActiveRecord.php
......@@ -56,6 +56,7 @@ class ActiveRecord extends BaseActiveRecord
private $_version;
private $_highlight;
/**
* Returns the database connection used by this AR class.
* By default, the "elasticsearch" application component is used as the database connection.
......
extensions/elasticsearch/Command.php
......@@ -43,9 +43,9 @@ class Command extends Component
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-highlighting.html
*/
public $highlight;
public $options = [];
/**
* @param array $options
* @return mixed
......
extensions/elasticsearch/Connection.php
......@@ -46,7 +46,6 @@ class Connection extends Component
* @var array the active node. key of [[nodes]]. Will be randomly selected on [[open()]].
*/
public $activeNode;
// TODO http://www.elasticsearch.org/guide/en/elasticsearch/client/php-api/current/_configuration.html#_example_configuring_http_basic_auth
public $auth = [];
/**
......@@ -62,6 +61,7 @@ class Connection extends Component
*/
public $dataTimeout = null;
public function init()
{
foreach ($this->nodes as $node) {
......
extensions/elasticsearch/DebugAction.php
......@@ -36,6 +36,7 @@ class DebugAction extends Action
*/
public $controller;
public function run($logId, $tag)
{
$this->controller->loadData($tag);
......
extensions/elasticsearch/DebugPanel.php
......@@ -24,6 +24,7 @@ class DebugPanel extends Panel
{
public $db = 'elasticsearch';
public function init()
{
$this->actions['elasticsearch-query'] = [
......
extensions/elasticsearch/Query.php
......@@ -137,7 +137,6 @@ class Query extends Component implements QueryInterface
* on one or more fields.
*/
public $highlight;
public $facets = [];
......
extensions/elasticsearch/QueryBuilder.php
......@@ -24,6 +24,7 @@ class QueryBuilder extends \yii\base\Object
*/
public $db;
/**
* Constructor.
* @param Connection $connection the database connection.
......
extensions/faker/FixtureController.php
......@@ -164,6 +164,7 @@ class FixtureController extends \yii\console\controllers\FixtureController
* More info in [Faker](https://github.com/fzaninotto/Faker.) library docs.
*/
public $providers = [];
/**
* @var \Faker\Generator Faker generator instance
*/
......
extensions/gii/CodeFile.php
......@@ -54,6 +54,7 @@ class CodeFile extends Object
*/
public $operation;
/**
* Constructor.
* @param string $path the file path that the new code should be saved to.
......
extensions/gii/Generator.php
......@@ -58,6 +58,7 @@ abstract class Generator extends Model
*/
public $messageCategory = 'app';
/**
* @return string name of the code generator
*/
......
extensions/gii/components/ActiveField.php
......@@ -21,6 +21,7 @@ class ActiveField extends \yii\widgets\ActiveField
*/
public $model;
/**
* @inheritdoc
*/
......
extensions/gii/controllers/DefaultController.php
......@@ -27,6 +27,7 @@ class DefaultController extends Controller
*/
public $generator;
public function actionIndex()
{
$this->layout = 'main';
......
extensions/gii/generators/controller/Generator.php
......@@ -46,6 +46,7 @@ class Generator extends \yii\gii\Generator
*/
public $actions = 'index';
/**
* @inheritdoc
*/
......
extensions/gii/generators/crud/Generator.php
......@@ -38,6 +38,7 @@ class Generator extends \yii\gii\Generator
public $indexWidgetType = 'grid';
public $searchModelClass = '';
/**
* @inheritdoc
*/
......
extensions/gii/generators/extension/Generator.php
......@@ -34,6 +34,7 @@ class Generator extends \yii\gii\Generator
public $authorName;
public $authorEmail;
/**
* @inheritdoc
*/
......
extensions/gii/generators/extension/default/AutoloadExample.php
<?php
/**
* This is just an example.
*/
echo "<?php\n";
?>
<?= "<?php\n" ?>
namespace <?= substr($generator->namespace, 0, -1) ?>;
/**
* This is just an example.
*/
class AutoloadExample extends \yii\base\Widget
{
public function run()
......
extensions/gii/generators/form/Generator.php
......@@ -26,6 +26,7 @@ class Generator extends \yii\gii\Generator
public $viewName;
public $scenarioName;
/**
* @inheritdoc
*/
......
extensions/gii/generators/model/Generator.php
......@@ -32,6 +32,7 @@ class Generator extends \yii\gii\Generator
public $generateLabelsFromComments = false;
public $useTablePrefix = false;
/**
* @inheritdoc
*/
......
extensions/gii/generators/module/Generator.php
......@@ -26,6 +26,7 @@ class Generator extends \yii\gii\Generator
public $moduleClass;
public $moduleID;
/**
* @inheritdoc
*/
......
extensions/imagine/BaseImage.php
......@@ -41,6 +41,7 @@ class BaseImage
* gmagick driver definition.
*/
const DRIVER_GMAGICK = 'gmagick';
/**
* @var array|string the driver to use. This can be either a single driver name or an array of driver names.
* If the latter, the first available driver will be used.
......@@ -52,6 +53,7 @@ class BaseImage
*/
private static $_imagine;
/**
* Returns the `Imagine` object that supports various image manipulations.
* @return ImagineInterface the `Imagine` object
......
extensions/jui/Accordion.php
......@@ -85,6 +85,7 @@ class Accordion extends Widget
*/
public $headerOptions = [];
/**
* Renders the widget.
*/
......
extensions/jui/DatePicker.php
......@@ -60,6 +60,7 @@ class DatePicker extends InputWidget
*/
public $containerOptions = [];
/**
* @inheritdoc
*/
......
extensions/jui/InputWidget.php
......@@ -36,6 +36,7 @@ class InputWidget extends Widget
*/
public $value;
/**
* Initializes the widget.
* If you override this method, make sure you call the parent implementation first.
......
extensions/jui/Menu.php
......@@ -33,6 +33,7 @@ class Menu extends \yii\widgets\Menu
*/
public $clientEvents = [];
/**
* Initializes the widget.
* If you override this method, make sure you call the parent implementation first.
......
extensions/jui/Selectable.php
......@@ -79,6 +79,7 @@ class Selectable extends Widget
*/
public $itemOptions = [];
/**
* Renders the widget.
*/
......
extensions/jui/Slider.php
......@@ -37,6 +37,7 @@ class Slider extends Widget
'stop' => 'slidestop',
];
/**
* Executes the widget.
*/
......
extensions/jui/SliderInput.php
......@@ -44,6 +44,12 @@ use yii\helpers\Html;
class SliderInput extends InputWidget
{
/**
* @var array the HTML attributes for the container tag.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $containerOptions = [];
/**
* @inheritDoc
*/
protected $clientEventMap = [
......@@ -53,11 +59,7 @@ class SliderInput extends InputWidget
'start' => 'slidestart',
'stop' => 'slidestop',
];
/**
* @var array the HTML attributes for the container tag.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $containerOptions = [];
/**
* @inheritdoc
......
extensions/jui/Sortable.php
......@@ -88,6 +88,7 @@ class Sortable extends Widget
'update' => 'sortupdate',
];
/**
* Renders the widget.
*/
......
extensions/jui/Spinner.php
......@@ -44,6 +44,7 @@ class Spinner extends InputWidget
'spin' => 'spin',
];
/**
* Renders the widget.
*/
......
extensions/jui/Tabs.php
......@@ -98,6 +98,7 @@ class Tabs extends Widget
*/
public $encodeLabels = true;
/**
* Renders the widget.
*/
......
extensions/jui/Widget.php
......@@ -58,6 +58,7 @@ class Widget extends \yii\base\Widget
*/
protected $clientEventMap = [];
/**
* Initializes the widget.
* If you override this method, make sure you call the parent implementation first.
......
extensions/mongodb/ActiveFixture.php
......@@ -39,6 +39,7 @@ class ActiveFixture extends BaseActiveFixture
*/
public $collectionName;
/**
* @inheritdoc
*/
......
extensions/mongodb/Cache.php
......@@ -54,6 +54,7 @@ class Cache extends \yii\caching\Cache
*/
public $gcProbability = 100;
/**
* Initializes the Cache component.
* This method will initialize the [[db]] property to make sure it refers to a valid MongoDB connection.
......
extensions/mongodb/Collection.php
......@@ -72,6 +72,7 @@ class Collection extends Object
*/
public $mongoCollection;
/**
* @return string name of this collection.
*/
......
extensions/mongodb/Connection.php
......@@ -112,11 +112,13 @@ class Connection extends Component
* @var \MongoClient Mongo client instance.
*/
public $mongoClient;
/**
* @var Database[] list of Mongo databases
*/
private $_databases = [];
/**
* Returns the Mongo collection with the given name.
* @param string|null $name collection name, if null default one will be used.
......
extensions/mongodb/Database.php
......@@ -26,6 +26,7 @@ class Database extends Object
* @var \MongoDB Mongo database instance.
*/
public $mongoDb;
/**
* @var Collection[] list of collections.
*/
......@@ -35,6 +36,7 @@ class Database extends Object
*/
private $_fileCollections = [];
/**
* @return string name of this database.
*/
......
extensions/mongodb/Migration.php
......@@ -39,6 +39,7 @@ abstract class Migration extends Component implements MigrationInterface
*/
public $db = 'mongodb';
/**
* Initializes the migration.
* This method will set [[db]] to be the 'db' application component, if it is null.
......
extensions/mongodb/Query.php
......@@ -54,6 +54,7 @@ class Query extends Component implements QueryInterface
*/
public $from;
/**
* Returns the Mongo collection for this query.
* @param Connection $db Mongo connection.
......
extensions/mongodb/console/controllers/MigrateController.php
......@@ -69,6 +69,7 @@ class MigrateController extends BaseMigrateController
*/
public $db = 'mongodb';
/**
* @inheritdoc
*/
......
extensions/mongodb/file/Collection.php
......@@ -28,11 +28,13 @@ class Collection extends \yii\mongodb\Collection
* @var \MongoGridFS Mongo GridFS collection instance.
*/
public $mongoCollection;
/**
* @var \yii\mongodb\Collection file chunks Mongo collection.
*/
private $_chunkCollection;
/**
* Returns the Mongo collection for the file chunks.
* @param boolean $refresh whether to reload the collection instance even if it is found in the cache.
......
extensions/mongodb/gii/model/Generator.php
......@@ -29,6 +29,7 @@ class Generator extends \yii\gii\Generator
public $modelClass;
public $baseClass = 'yii\mongodb\ActiveRecord';
/**
* @inheritdoc
*/
......
extensions/mongodb/log/MongoDbTarget.php
......@@ -37,6 +37,7 @@ class MongoDbTarget extends Target
*/
public $logCollection = 'log';
/**
* Initializes the MongoDbTarget component.
* This method will initialize the [[db]] property to make sure it refers to a valid MongoDB connection.
......
extensions/redis/ActiveQuery.php
......@@ -82,6 +82,7 @@ class ActiveQuery extends Component implements ActiveQueryInterface
*/
const EVENT_INIT = 'init';
/**
* Constructor.
* @param array $modelClass the model class associated with this query
......
extensions/redis/Cache.php
......@@ -67,6 +67,7 @@ class Cache extends \yii\caching\Cache
*/
public $redis = 'redis';
/**
* Initializes the redis Cache component.
* This method will initialize the [[redis]] property to make sure it refers to a valid redis connection.
......
extensions/redis/Connection.php
......@@ -209,6 +209,7 @@ class Connection extends Component
'ZSCORE', // key member Get the score associated with the given member in a sorted set
'ZUNIONSTORE', // destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE SUM|MIN|MAX] Add multiple sorted sets and store the resulting sorted set in a new key
];
/**
* @var resource redis socket connection
*/
......
extensions/smarty/ViewRenderer.php
......@@ -25,17 +25,16 @@ class ViewRenderer extends BaseViewRenderer
* @var string the directory or path alias pointing to where Smarty cache will be stored.
*/
public $cachePath = '@runtime/Smarty/cache';
/**
* @var string the directory or path alias pointing to where Smarty compiled templates will be stored.
*/
public $compilePath = '@runtime/Smarty/compile';
/**
* @var Smarty
*/
public $smarty;
public function init()
{
$this->smarty = new Smarty();
......
extensions/sphinx/ActiveRecord.php
......@@ -54,6 +54,7 @@ abstract class ActiveRecord extends BaseActiveRecord
*/
private $_snippet;
/**
* Returns the Sphinx connection used by this AR class.
* By default, the "sphinx" application component is used as the Sphinx connection.
......
extensions/sphinx/ColumnSchema.php
......@@ -54,6 +54,7 @@ class ColumnSchema extends Object
*/
public $isMva;
/**
* Converts the input value according to [[phpType]] after retrieval from the database.
* If the value is null or an [[Expression]], it will not be converted.
......
extensions/sphinx/Command.php
......@@ -49,6 +49,7 @@ class Command extends \yii\db\Command
*/
public $db;
/**
* Creates a batch INSERT command.
* For example,
......
extensions/sphinx/Connection.php
......@@ -67,6 +67,7 @@ class Connection extends \yii\db\Connection
'mysql' => 'yii\sphinx\Schema', // MySQL
];
/**
* Obtains the schema information for the named index.
* @param string $name index name.
......
extensions/sphinx/IndexSchema.php
......@@ -40,6 +40,7 @@ class IndexSchema extends Object
*/
public $columns = [];
/**
* Gets the named column metadata.
* This is a convenient method for retrieving a named column even if it does not exist.
......
extensions/sphinx/Query.php
......@@ -125,11 +125,13 @@ class Query extends Component implements QueryInterface
* @var array query options for the call snippet.
*/
public $snippetOptions;
/**
* @var Connection the Sphinx connection used to generate the SQL statements.
*/
private $_connection;
/**
* @param Connection $connection Sphinx connection instance
* @return static the query object itself
......
extensions/sphinx/QueryBuilder.php
......@@ -38,6 +38,7 @@ class QueryBuilder extends Object
*/
public $separator = " ";
/**
* Constructor.
* @param Connection $connection the Sphinx connection.
......
extensions/sphinx/Schema.php
......@@ -60,6 +60,7 @@ class Schema extends Object
*/
private $_builder;
/**
* @var array mapping from physical column types (keys) to abstract column types (values)
*/
......
extensions/sphinx/gii/model/Generator.php
......@@ -29,6 +29,7 @@ class Generator extends \yii\gii\Generator
public $baseClass = 'yii\sphinx\ActiveRecord';
public $useIndexPrefix = false;
/**
* @inheritdoc
*/
......
extensions/swiftmailer/Mailer.php
......@@ -79,6 +79,7 @@ class Mailer extends BaseMailer
* @var string message default class name.
*/
public $messageClass = 'yii\swiftmailer\Message';
/**
* @var \Swift_Mailer Swift mailer instance.
*/
......@@ -88,6 +89,7 @@ class Mailer extends BaseMailer
*/
private $_transport = [];
/**
* @return array|\Swift_Mailer Swift mailer instance or array configuration.
*/
......
extensions/swiftmailer/Message.php
......@@ -29,6 +29,7 @@ class Message extends BaseMessage
*/
private $_swiftMessage;
/**
* @return \Swift_Message Swift message instance.
*/
......
extensions/twig/Extension.php
......@@ -24,17 +24,16 @@ class Extension extends \Twig_Extension
* @var array used namespaces
*/
protected $namespaces = [];
/**
* @var array used class aliases
*/
protected $aliases = [];
/**
* @var array used widgets
*/
protected $widgets = [];
/**
* Creates new instance
*
......
extensions/twig/FileLoader.php
......@@ -19,6 +19,7 @@ class FileLoader implements \Twig_LoaderInterface
*/
private $_dir;
/**
* @param string $dir path to directory
*/
......
extensions/twig/ViewRenderer.php
......@@ -26,13 +26,11 @@ class ViewRenderer extends BaseViewRenderer
* templates cache.
*/
public $cachePath = '@runtime/Twig/cache';
/**
* @var array Twig options.
* @see http://twig.sensiolabs.org/doc/api.html#environment-options
*/
public $options = [];
/**
* @var array Objects or static classes.
* Keys of the array are names to call in template, values are objects or names of static classes.
......@@ -40,7 +38,6 @@ class ViewRenderer extends BaseViewRenderer
* In the template you can use it like this: `{{ html.a('Login', 'site/login') | raw }}`.
*/
public $globals = [];
/**
* @var array Custom functions.
* Keys of the array are names to call in template, values are names of functions or static methods of some class.
......@@ -48,7 +45,6 @@ class ViewRenderer extends BaseViewRenderer
* In the template you can use it like this: `{{ rot13('test') }}` or `{{ a('Login', 'site/login') | raw }}`.
*/
public $functions = [];
/**
* @var array Custom filters.
* Keys of the array are names to call in template, values are names of functions or static methods of some class.
......@@ -56,13 +52,11 @@ class ViewRenderer extends BaseViewRenderer
* In the template you can use it like this: `{{ 'test'|rot13 }}` or `{{ model|jsonEncode }}`.
*/
public $filters = [];
/**
* @var array Custom extensions.
* Example: `['Twig_Extension_Sandbox', new \Twig_Extension_Text()]`
*/
public $extensions = [];
/**
* @var array Twig lexer options.
*
......@@ -77,7 +71,6 @@ class ViewRenderer extends BaseViewRenderer
* @see http://twig.sensiolabs.org/doc/recipes.html#customizing-the-syntax
*/
public $lexerOptions = [];
/**
* @var array namespaces and classes to import.
*
......@@ -92,12 +85,12 @@ class ViewRenderer extends BaseViewRenderer
* ```
*/
public $uses = [];
/**
* @var \Twig_Environment twig environment object that renders twig templates
*/
public $twig;
public function init()
{
$this->twig = new \Twig_Environment(null, array_merge([
......
extensions/twig/ViewRendererStaticClassProxy.php
......@@ -17,6 +17,7 @@ class ViewRendererStaticClassProxy
{
private $_staticClassName;
public function __construct($staticClassName)
{
$this->_staticClassName = $staticClassName;
......
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