Commit 1e754273 by Carsten Brandt

updated classmap and phpdoc

parent 777f4a28
......@@ -60,7 +60,7 @@ class ClassmapController extends Controller
throw new Exception("Something wrong: $file\n");
}
$path = str_replace('\\', '/', substr($file, strlen($root)));
$map[$path] = "\t'yii" . substr(str_replace('/', '\\', $path), 0, -4) . "' => YII_PATH . '$path',";
$map[$path] = " 'yii" . substr(str_replace('/', '\\', $path), 0, -4) . "' => YII_PATH . '$path',";
}
ksort($map);
$map = implode("\n", $map);
......
......@@ -61,7 +61,7 @@ class PhpDocController extends Controller
'/extensions/codeception/DbTestCase.php',
'/extensions/composer/',
'/extensions/gii/components/DiffRendererHtmlInline.php',
'/extensions/gii/generators/extension/templates/*',
'/extensions/gii/generators/extension/default/*',
'/extensions/twig/TwigSimpleFileLoader.php',
'/framework/BaseYii.php',
'/framework/Yii.php',
......
......@@ -21,8 +21,7 @@ use yii\helpers\Json;
* getter and setter. See [[getAccessToken()]] and [[setAccessToken()]] for details.
* @property array $curlOptions CURL options. This property is read-only.
* @property string $returnUrl Return URL.
* @property signature\BaseMethod $signatureMethod Signature method instance. Note that the type of this
* property differs in getter and setter. See [[getSignatureMethod()]] and [[setSignatureMethod()]] for details.
* @property signature\BaseMethod $signatureMethod Signature method instance. This property is read-only.
*
* @author Paul Klimov <klimov.paul@gmail.com>
* @since 2.0
......
......@@ -18,7 +18,7 @@ use yii\base\Object;
* @property boolean $isExpired Is token expired. This property is read-only.
* @property boolean $isValid Is token valid. This property is read-only.
* @property array $params This property is read-only.
* @property string $token Token value.
* @property string $token Token value. This property is read-only.
* @property string $tokenSecret Token secret value.
*
* @author Paul Klimov <klimov.paul@gmail.com>
......
......@@ -14,6 +14,7 @@ use yii\debug\Panel;
* Debugger panel that collects and displays application configuration and environment.
*
* @property array $extensions This property is read-only.
* @property array $phpInfo This property is read-only.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
......
......@@ -41,7 +41,7 @@ use yii\db\QueryTrait;
*
* Warning: even if you do not set any query limit, implicit LIMIT 0,20 is present by default!
*
* @property Connection $connection Sphinx connection instance.
* @property Connection $connection Sphinx connection instance. This property is read-only.
*
* @author Paul Klimov <klimov.paul@gmail.com>
* @since 2.0
......
......@@ -14,7 +14,8 @@ use yii\web\HttpException;
/**
* Application is the base class for all application classes.
*
* @property \yii\rbac\Manager $authManager The auth manager for this application. This property is read-only.
* @property \yii\rbac\Manager $authManager The auth manager for this application. Null is returned if auth
* manager is not configured. This property is read-only.
* @property string $basePath The root directory of the application.
* @property \yii\caching\Cache $cache The cache application component. Null if the component is not enabled.
* This property is read-only.
......
......@@ -25,7 +25,6 @@ use yii\di\ServiceLocator;
* with '@') and the array values are the corresponding paths or aliases. See [[setAliases()]] for an example.
* This property is write-only.
* @property string $basePath The root directory of the module.
* @property array $components The components (indexed by their IDs).
* @property string $controllerPath The directory that contains the controller classes. This property is
* read-only.
* @property string $layoutPath The root directory of layout files. Defaults to "[[viewPath]]/layouts".
......
......@@ -61,6 +61,11 @@ use yii\helpers\FileHelper;
* that contains the entry script of the application. If your theme is designed to handle modules,
* you may configure the [[pathMap]] property like described above.
*
* @property string $basePath The root path of this theme. All resources of this theme are located under this
* directory.
* @property string $baseUrl The base URL (without ending slash) for this theme. All resources of this theme
* are considered to be under this base URL. This property is read-only.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
......
......@@ -17,7 +17,9 @@ return [
'yii\base\Application' => YII_PATH . '/base/Application.php',
'yii\base\ArrayAccessTrait' => YII_PATH . '/base/ArrayAccessTrait.php',
'yii\base\Arrayable' => YII_PATH . '/base/Arrayable.php',
'yii\base\ArrayableTrait' => YII_PATH . '/base/ArrayableTrait.php',
'yii\base\Behavior' => YII_PATH . '/base/Behavior.php',
'yii\base\BootstrapInterface' => YII_PATH . '/base/BootstrapInterface.php',
'yii\base\Component' => YII_PATH . '/base/Component.php',
'yii\base\Controller' => YII_PATH . '/base/Controller.php',
'yii\base\DynamicModel' => YII_PATH . '/base/DynamicModel.php',
......@@ -25,7 +27,6 @@ return [
'yii\base\ErrorHandler' => YII_PATH . '/base/ErrorHandler.php',
'yii\base\Event' => YII_PATH . '/base/Event.php',
'yii\base\Exception' => YII_PATH . '/base/Exception.php',
'yii\base\Extension' => YII_PATH . '/base/Extension.php',
'yii\base\Formatter' => YII_PATH . '/base/Formatter.php',
'yii\base\InlineAction' => YII_PATH . '/base/InlineAction.php',
'yii\base\InvalidCallException' => YII_PATH . '/base/InvalidCallException.php',
......@@ -77,7 +78,6 @@ return [
'yii\data\ArrayDataProvider' => YII_PATH . '/data/ArrayDataProvider.php',
'yii\data\BaseDataProvider' => YII_PATH . '/data/BaseDataProvider.php',
'yii\data\DataProviderInterface' => YII_PATH . '/data/DataProviderInterface.php',
'yii\data\ModelSerializer' => YII_PATH . '/data/ModelSerializer.php',
'yii\data\Pagination' => YII_PATH . '/data/Pagination.php',
'yii\data\Sort' => YII_PATH . '/data/Sort.php',
'yii\data\SqlDataProvider' => YII_PATH . '/data/SqlDataProvider.php',
......@@ -86,8 +86,6 @@ return [
'yii\db\ActiveQueryTrait' => YII_PATH . '/db/ActiveQueryTrait.php',
'yii\db\ActiveRecord' => YII_PATH . '/db/ActiveRecord.php',
'yii\db\ActiveRecordInterface' => YII_PATH . '/db/ActiveRecordInterface.php',
'yii\db\ActiveRelation' => YII_PATH . '/db/ActiveRelation.php',
'yii\db\ActiveRelationInterface' => YII_PATH . '/db/ActiveRelationInterface.php',
'yii\db\ActiveRelationTrait' => YII_PATH . '/db/ActiveRelationTrait.php',
'yii\db\BaseActiveRecord' => YII_PATH . '/db/BaseActiveRecord.php',
'yii\db\BatchQueryResult' => YII_PATH . '/db/BatchQueryResult.php',
......@@ -121,6 +119,9 @@ return [
'yii\db\pgsql\Schema' => YII_PATH . '/db/pgsql/Schema.php',
'yii\db\sqlite\QueryBuilder' => YII_PATH . '/db/sqlite/QueryBuilder.php',
'yii\db\sqlite\Schema' => YII_PATH . '/db/sqlite/Schema.php',
'yii\di\Container' => YII_PATH . '/di/Container.php',
'yii\di\Instance' => YII_PATH . '/di/Instance.php',
'yii\di\ServiceLocator' => YII_PATH . '/di/ServiceLocator.php',
'yii\grid\ActionColumn' => YII_PATH . '/grid/ActionColumn.php',
'yii\grid\CheckboxColumn' => YII_PATH . '/grid/CheckboxColumn.php',
'yii\grid\Column' => YII_PATH . '/grid/Column.php',
......@@ -139,6 +140,7 @@ return [
'yii\helpers\BaseMarkdown' => YII_PATH . '/helpers/BaseMarkdown.php',
'yii\helpers\BaseSecurity' => YII_PATH . '/helpers/BaseSecurity.php',
'yii\helpers\BaseStringHelper' => YII_PATH . '/helpers/BaseStringHelper.php',
'yii\helpers\BaseUrl' => YII_PATH . '/helpers/BaseUrl.php',
'yii\helpers\BaseVarDumper' => YII_PATH . '/helpers/BaseVarDumper.php',
'yii\helpers\Console' => YII_PATH . '/helpers/Console.php',
'yii\helpers\FileHelper' => YII_PATH . '/helpers/FileHelper.php',
......@@ -149,6 +151,7 @@ return [
'yii\helpers\Markdown' => YII_PATH . '/helpers/Markdown.php',
'yii\helpers\Security' => YII_PATH . '/helpers/Security.php',
'yii\helpers\StringHelper' => YII_PATH . '/helpers/StringHelper.php',
'yii\helpers\Url' => YII_PATH . '/helpers/Url.php',
'yii\helpers\VarDumper' => YII_PATH . '/helpers/VarDumper.php',
'yii\i18n\DbMessageSource' => YII_PATH . '/i18n/DbMessageSource.php',
'yii\i18n\Formatter' => YII_PATH . '/i18n/Formatter.php',
......@@ -180,6 +183,23 @@ return [
'yii\rbac\Manager' => YII_PATH . '/rbac/Manager.php',
'yii\rbac\PhpManager' => YII_PATH . '/rbac/PhpManager.php',
'yii\requirements\YiiRequirementChecker' => YII_PATH . '/requirements/YiiRequirementChecker.php',
'yii\rest\Action' => YII_PATH . '/rest/Action.php',
'yii\rest\ActiveController' => YII_PATH . '/rest/ActiveController.php',
'yii\rest\AuthInterface' => YII_PATH . '/rest/AuthInterface.php',
'yii\rest\Controller' => YII_PATH . '/rest/Controller.php',
'yii\rest\CreateAction' => YII_PATH . '/rest/CreateAction.php',
'yii\rest\DeleteAction' => YII_PATH . '/rest/DeleteAction.php',
'yii\rest\HttpBasicAuth' => YII_PATH . '/rest/HttpBasicAuth.php',
'yii\rest\HttpBearerAuth' => YII_PATH . '/rest/HttpBearerAuth.php',
'yii\rest\IndexAction' => YII_PATH . '/rest/IndexAction.php',
'yii\rest\OptionsAction' => YII_PATH . '/rest/OptionsAction.php',
'yii\rest\QueryParamAuth' => YII_PATH . '/rest/QueryParamAuth.php',
'yii\rest\RateLimitInterface' => YII_PATH . '/rest/RateLimitInterface.php',
'yii\rest\RateLimiter' => YII_PATH . '/rest/RateLimiter.php',
'yii\rest\Serializer' => YII_PATH . '/rest/Serializer.php',
'yii\rest\UpdateAction' => YII_PATH . '/rest/UpdateAction.php',
'yii\rest\UrlRule' => YII_PATH . '/rest/UrlRule.php',
'yii\rest\ViewAction' => YII_PATH . '/rest/ViewAction.php',
'yii\test\ActiveFixture' => YII_PATH . '/test/ActiveFixture.php',
'yii\test\BaseActiveFixture' => YII_PATH . '/test/BaseActiveFixture.php',
'yii\test\DbFixture' => YII_PATH . '/test/DbFixture.php',
......@@ -216,6 +236,7 @@ return [
'yii\web\AssetManager' => YII_PATH . '/web/AssetManager.php',
'yii\web\BadRequestHttpException' => YII_PATH . '/web/BadRequestHttpException.php',
'yii\web\CacheSession' => YII_PATH . '/web/CacheSession.php',
'yii\web\CompositeUrlRule' => YII_PATH . '/web/CompositeUrlRule.php',
'yii\web\ConflictHttpException' => YII_PATH . '/web/ConflictHttpException.php',
'yii\web\Controller' => YII_PATH . '/web/Controller.php',
'yii\web\Cookie' => YII_PATH . '/web/Cookie.php',
......@@ -231,10 +252,13 @@ return [
'yii\web\JqueryAsset' => YII_PATH . '/web/JqueryAsset.php',
'yii\web\JsExpression' => YII_PATH . '/web/JsExpression.php',
'yii\web\JsonParser' => YII_PATH . '/web/JsonParser.php',
'yii\web\Link' => YII_PATH . '/web/Link.php',
'yii\web\Linkable' => YII_PATH . '/web/Linkable.php',
'yii\web\MethodNotAllowedHttpException' => YII_PATH . '/web/MethodNotAllowedHttpException.php',
'yii\web\NotAcceptableHttpException' => YII_PATH . '/web/NotAcceptableHttpException.php',
'yii\web\NotFoundHttpException' => YII_PATH . '/web/NotFoundHttpException.php',
'yii\web\PageCache' => YII_PATH . '/web/PageCache.php',
'yii\web\PrefixUrlRule' => YII_PATH . '/web/PrefixUrlRule.php',
'yii\web\Request' => YII_PATH . '/web/Request.php',
'yii\web\RequestParserInterface' => YII_PATH . '/web/RequestParserInterface.php',
'yii\web\Response' => YII_PATH . '/web/Response.php',
......@@ -247,6 +271,7 @@ return [
'yii\web\UploadedFile' => YII_PATH . '/web/UploadedFile.php',
'yii\web\UrlManager' => YII_PATH . '/web/UrlManager.php',
'yii\web\UrlRule' => YII_PATH . '/web/UrlRule.php',
'yii\web\UrlRuleInterface' => YII_PATH . '/web/UrlRuleInterface.php',
'yii\web\User' => YII_PATH . '/web/User.php',
'yii\web\UserEvent' => YII_PATH . '/web/UserEvent.php',
'yii\web\VerbFilter' => YII_PATH . '/web/VerbFilter.php',
......
......@@ -87,6 +87,9 @@ use yii\base\InvalidConfigException;
* $lister = new UserLister($finder);
* ```
*
* @property array $definitions The list of the object definitions or the loaded shared objects (type or ID =>
* definition or instance). This property is read-only.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
......
......@@ -41,6 +41,9 @@ use yii\base\InvalidConfigException;
*
* Because [[\yii\base\Module]] extends from ServiceLocator, modules and the application are all service locators.
*
* @property array $components The list of the component definitions or the loaded component instances (ID =>
* definition or instance). This property is read-only.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
......
......@@ -53,6 +53,7 @@ use yii\helpers\StringHelper;
* @property boolean $isHead Whether this is a HEAD request. This property is read-only.
* @property boolean $isOptions Whether this is a OPTIONS request. This property is read-only.
* @property boolean $isPatch Whether this is a PATCH request. This property is read-only.
* @property boolean $isPjax Whether this is a PJAX request. This property is read-only.
* @property boolean $isPost Whether this is a POST request. This property is read-only.
* @property boolean $isPut Whether this is a PUT request. This property is read-only.
* @property boolean $isSecureConnection If the request is sent via secure channel (https). This property is
......
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