doc fix.

build/controllers/PhpDocController.php

@@ -44,22 +44,26 @@ class PhpDocController extends Controller
 		$except = [];
 		if ($root === null) {
 			$root = dirname(dirname(YII_PATH));
-			Yii::setAlias('@yii/bootstrap', $root . '/extensions/bootstrap');
-			Yii::setAlias('@yii/debug', $root . '/extensions/debug');
-			Yii::setAlias('@yii/elasticsearch', $root . '/extensions/elasticsearch');
-			Yii::setAlias('@yii/gii', $root . '/extensions/gii');
-			Yii::setAlias('@yii/jui', $root . '/extensions/jui');
-			Yii::setAlias('@yii/redis', $root . '/extensions/redis');
-			Yii::setAlias('@yii/smarty', $root . '/extensions/smarty');
-			Yii::setAlias('@yii/sphinx', $root . '/extensions/sphinx');
-			Yii::setAlias('@yii/swiftmailer', $root . '/extensions/swiftmailer');
-			Yii::setAlias('@yii/twig', $root . '/extensions/twig');
+			$extension = "$root/extensions/yii";
+			Yii::setAlias('@yii/authclient', "$extension/authclient");
+			Yii::setAlias('@yii/bootstrap', "$extension/bootstrap");
+			Yii::setAlias('@yii/debug', "$extension/debug");
+			Yii::setAlias('@yii/elasticsearch', "$extension/elasticsearch");
+			Yii::setAlias('@yii/gii', "$extension/gii");
+			Yii::setAlias('@yii/jui', "$extension/jui");
+			Yii::setAlias('@yii/mongodb', "$extension/mongodb");
+			Yii::setAlias('@yii/redis', "$extension/redis");
+			Yii::setAlias('@yii/smarty', "$extension/smarty");
+			Yii::setAlias('@yii/sphinx', "$extension/sphinx");
+			Yii::setAlias('@yii/swiftmailer', "$extension/swiftmailer");
 
 			$except = [
 				'/apps/',
 				'/build/',
 				'/docs/',
-				'/extensions/composer/',
+				'/extensions/yii/codeception/',
+				'/extensions/yii/composer/',
+				'/extensions/yii/twig/',
 				'/tests/',
 				'/vendor/',
 			];

extensions/yii/authclient/AuthAction.php

@@ -48,6 +48,9 @@ use Yii;
  * @see Collection
  * @see \yii\authclient\widgets\Choice
  *
+ * @property string $cancelUrl Cancel URL.
+ * @property string $successUrl Successful URL.
+ *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0
  */

extensions/yii/authclient/BaseClient.php

@@ -18,13 +18,12 @@ use yii\helpers\StringHelper;
  *
  * @see ClientInterface
  *
- * @property string $id auth service id.
- * @property string $name auth service name.
- * @property string $title auth service title.
- * @property array $userAttributes authenticated user attributes.
- * @property array $normalizeUserAttributeMap map used to normalize user attributes fetched from
- * external auth service in format: rawAttributeName => normalizedAttributeName.
- * @property array $viewOptions view options in format: optionName => optionValue.
+ * @property string $id Service id.
+ * @property string $name Service name.
+ * @property array $normalizeUserAttributeMap Normalize user attribute map.
+ * @property string $title Service title.
+ * @property array $userAttributes List of user attributes.
+ * @property array $viewOptions View options in format: optionName => optionValue.
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0

extensions/yii/authclient/BaseOAuth.php

@@ -17,6 +17,13 @@ use yii\helpers\Json;
  *
  * @see http://oauth.net/
  *
+ * @property OAuthToken $accessToken Auth token instance. Note that the type of this property differs in
+ * 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.
+ *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0
  */

extensions/yii/authclient/Collection.php

@@ -35,7 +35,7 @@ use Yii;
  * ]
  * ~~~
  *
- * @property array $clients list of Auth clients with their configuration in format: 'clientId' => [...]
+ * @property ClientInterface[] $clients List of auth clients. This property is read-only.
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0

extensions/yii/authclient/OAuthToken.php

@@ -12,9 +12,14 @@ use yii\base\Object;
 /**
  * Token represents OAuth token.
  *
- * @property array $params token parameters.
- * @property string $token token value.
- * @property string $tokenSecret token secret value.
+ * @property integer $expireDuration Token expiration duration. Note that the type of this property differs in
+ * getter and setter. See [[getExpireDuration()]] and [[setExpireDuration()]] for details.
+ * @property string $expireDurationParamKey Expire duration param key.
+ * @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 $tokenSecret Token secret value.
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0

extensions/yii/authclient/OpenId.php

@@ -36,9 +36,9 @@ use Yii;
  *
  * @see http://openid.net/
  *
- * @property string $returnUrl authentication return URL.
- * @property string $claimedId  claimed identifier (identity).
- * @property string $trustRoot client trust root (realm), by default [[\yii\web\Request::hostInfo]] value will be used.
+ * @property string $claimedId Claimed identifier (identity).
+ * @property string $returnUrl Authentication return URL.
+ * @property string $trustRoot Client trust root (realm).
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0

extensions/yii/authclient/signature/BaseMethod.php

@@ -12,8 +12,6 @@ use yii\base\Object;
 /**
  * BaseMethod is a base class for the OAuth signature methods.
  *
- * @property string $name method canonical name. This property is read-only.
- *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0
  */

extensions/yii/authclient/signature/RsaSha1.php

@@ -15,8 +15,8 @@ use yii\base\NotSupportedException;
  *
  * Note: This class require PHP "OpenSSL" extension({@link http://php.net/manual/en/book.openssl.php}).
  *
- * @property string $privateCertificate OpenSSL private key certificate content.
- * @property string $publicCertificate OpenSSL public key certificate content.
+ * @property string $privateCertificate Private key certificate content.
+ * @property string $publicCertificate Public key certificate content.
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0

extensions/yii/authclient/widgets/Choice.php

@@ -42,8 +42,8 @@ use yii\authclient\ClientInterface;
  *
  * @see \yii\authclient\AuthAction
  *
- * @property ClientInterface[] $providers auth providers list.
- * @property array $baseAuthUrl configuration for the external services base authentication URL.
+ * @property array $baseAuthUrl Base auth URL configuration. This property is read-only.
+ * @property ClientInterface[] $clients Auth providers. This property is read-only.
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0

extensions/yii/mongodb/ActiveQuery.php

@@ -29,6 +29,8 @@ use yii\db\ActiveQueryTrait;
  * $customers = Customer::find()->with('orders')->asArray()->all();
  * ~~~
  *
+ * @property Collection $collection Collection instance. This property is read-only.
+ *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0
  */

extensions/yii/mongodb/Collection.php

@@ -58,9 +58,10 @@ use yii\helpers\Json;
  * even if they are plain strings. However if you have other columns, containing [[\MongoId]], you
  * should take care of possible typecast on your own.
  *
- * @property string $name name of this collection. This property is read-only.
- * @property string $fullName full name of this collection, including database name. This property is read-only.
- * @property array $lastError last error information. This property is read-only.
+ * @property string $fullName Full name of this collection, including database name. This property is
+ * read-only.
+ * @property array $lastError Last error information. This property is read-only.
+ * @property string $name Name of this collection. This property is read-only.
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0

extensions/yii/mongodb/Connection.php

@@ -63,6 +63,8 @@ use Yii;
  * ]
  * ~~~
  *
+ * @property Database $database Database instance. This property is read-only.
+ * @property file\Collection $fileCollection Mongo GridFS collection instance. This property is read-only.
  * @property boolean $isActive Whether the Mongo connection is established. This property is read-only.
  *
  * @author Paul Klimov <klimov.paul@gmail.com>

extensions/yii/mongodb/Database.php

@@ -14,7 +14,8 @@ use yii\helpers\Json;
 /**
  * Database represents the Mongo database information.
  *
- * @property string $name name of this database. This property is read-only.
+ * @property file\Collection $fileCollection Mongo GridFS collection. This property is read-only.
+ * @property string $name Name of this database. This property is read-only.
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0

extensions/yii/mongodb/Query.php

@@ -31,6 +31,8 @@ use Yii;
  * $rows = $query->all();
  * ~~~
  *
+ * @property Collection $collection Collection instance. This property is read-only.
+ *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0
  */

extensions/yii/mongodb/file/ActiveQuery.php

@@ -29,6 +29,8 @@ use yii\db\ActiveQueryTrait;
  * $images = ImageFile::find()->with('tags')->asArray()->all();
  * ~~~
  *
+ * @property Collection $collection Collection instance. This property is read-only.
+ *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0
  */

extensions/yii/mongodb/file/ActiveRecord.php

@@ -36,14 +36,8 @@ use yii\web\UploadedFile;
  *
  * Note: [[newFileContent]] always takes precedence over [[file]].
  *
- * @property \MongoId|string $_id primary key.
- * @property string $filename name of stored file.
- * @property \MongoDate $uploadDate file upload date.
- * @property integer $length file size.
- * @property integer $chunkSize file chunk size.
- * @property string $md5 file md5 hash.
- * @property \MongoGridFSFile|\yii\web\UploadedFile|string $file associated file.
- * @property string $newFileContent new file content.
+ * @property null|string $fileContent File content. This property is read-only.
+ * @property resource $fileResource File stream resource. This property is read-only.
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0

extensions/yii/mongodb/file/Collection.php

@@ -17,8 +17,7 @@ use Yii;
  *
  * File collection inherits all interface from regular [[\yii\mongo\Collection]], adding methods to store files.
  *
- * @property \yii\mongo\Collection $chunkCollection file chunks Mongo collection. This property is read-only.
- * @method \MongoGridFSCursor find() returns a cursor for the search results.
+ * @property \yii\mongodb\Collection $chunkCollection Mongo collection instance. This property is read-only.
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0

extensions/yii/mongodb/file/Query.php

@@ -16,6 +16,8 @@ use Yii;
  * Found files will be represented as arrays of file document attributes with
  * additional 'file' key, which stores [[\MongoGridFSFile]] instance.
  *
+ * @property Collection $collection Collection instance. This property is read-only.
+ *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0
  */

extensions/yii/sphinx/ActiveRecord.php

@@ -22,18 +22,6 @@ use yii\helpers\StringHelper;
  * Warning: optimistic lock will NOT work in case of updating fields (not attributes) for the
  * runtime indexes!
  *
- * @property array $dirtyAttributes The changed attribute values (name-value pairs). This property is
- * read-only.
- * @property boolean $isNewRecord Whether the record is new and should be inserted when calling [[save()]].
- * @property array $oldAttributes The old attribute values (name-value pairs).
- * @property mixed $oldPrimaryKey The old primary key value. An array (column name => column value) is
- * returned if the primary key is composite. A string is returned otherwise (null will be returned if the key
- * value is null). This property is read-only.
- * @property array $relatedRecords An array of the populated related records indexed by relation names. This property is
- * read-only.
- * @property mixed $primaryKey The primary key value. An array (column name => column value) is returned if
- * the primary key is composite. A string is returned otherwise (null will be returned if the key value is null).
- * This property is read-only.
  * @property string $snippet Snippet value.
  * @property string $snippetSource Snippet source string. This property is read-only.
  *

framework/yii/db/BaseActiveRecord.php

@@ -30,11 +30,11 @@ use yii\helpers\Inflector;
  * @property mixed $oldPrimaryKey The old primary key value. An array (column name => column value) is
  * returned if the primary key is composite. A string is returned otherwise (null will be returned if the key
  * value is null). This property is read-only.
- * @property array $relatedRecords An array of the populated related records indexed by relation names. This property is
- * read-only.
  * @property mixed $primaryKey The primary key value. An array (column name => column value) is returned if
  * the primary key is composite. A string is returned otherwise (null will be returned if the key value is null).
  * This property is read-only.
+ * @property array $relatedRecords An array of related records indexed by relation names. This property is
+ * read-only.
  *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @author Carsten Brandt <mail@cebe.cc>

framework/yii/db/oci/Schema.php

@@ -15,6 +15,8 @@ use yii\db\ColumnSchema;
  *
  * @todo mapping from physical types to abstract types
  *
+ * @property string $defaultSchema Default schema.
+ *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0
  */

framework/yii/web/Request.php

@@ -50,6 +50,7 @@ use yii\helpers\StringHelper;
  * @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
  * read-only.
+ * @property string $maskedCsrfToken The masked CSRF token. This property is read-only.
  * @property string $method Request method, such as GET, POST, HEAD, PUT, PATCH, DELETE. The value returned is
  * turned into upper case. This property is read-only.
  * @property array $patch The PATCH request parameter values. This property is read-only.