mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-13 20:59:12 +08:00
removed @link tags from apidoc and replaced with markdown
This commit is contained in:
@@ -18,9 +18,10 @@ use Yii;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* AuthAction performs authentication via different auth clients.
|
* AuthAction performs authentication via different auth clients.
|
||||||
* It supports [[OpenId]], [[OAuth1] and [[OAuth2]] client types.
|
* It supports [[OpenId]], [[OAuth1]] and [[OAuth2]] client types.
|
||||||
*
|
*
|
||||||
* Usage:
|
* Usage:
|
||||||
|
*
|
||||||
* ~~~
|
* ~~~
|
||||||
* class SiteController extends Controller
|
* class SiteController extends Controller
|
||||||
* {
|
* {
|
||||||
@@ -139,7 +140,7 @@ class AuthAction extends Action
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates default {@link successUrl} value.
|
* Creates default [[successUrl]] value.
|
||||||
* @return string success URL value.
|
* @return string success URL value.
|
||||||
*/
|
*/
|
||||||
protected function defaultSuccessUrl()
|
protected function defaultSuccessUrl()
|
||||||
@@ -148,7 +149,7 @@ class AuthAction extends Action
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates default {@link cancelUrl} value.
|
* Creates default [[cancelUrl]] value.
|
||||||
* @return string cancel URL value.
|
* @return string cancel URL value.
|
||||||
*/
|
*/
|
||||||
protected function defaultCancelUrl()
|
protected function defaultCancelUrl()
|
||||||
@@ -236,7 +237,7 @@ class AuthAction extends Action
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Redirect to the URL. If URL is null, {@link successUrl} will be used.
|
* Redirect to the URL. If URL is null, [[successUrl]] will be used.
|
||||||
* @param string $url URL to redirect.
|
* @param string $url URL to redirect.
|
||||||
* @return \yii\web\Response response instance.
|
* @return \yii\web\Response response instance.
|
||||||
*/
|
*/
|
||||||
@@ -249,7 +250,7 @@ class AuthAction extends Action
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Redirect to the {@link cancelUrl} or simply close the popup window.
|
* Redirect to the [[cancelUrl]] or simply close the popup window.
|
||||||
* @param string $url URL to redirect.
|
* @param string $url URL to redirect.
|
||||||
* @return \yii\web\Response response instance.
|
* @return \yii\web\Response response instance.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -226,7 +226,7 @@ abstract class BaseClient extends Component implements ClientInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normalize given user attributes according to {@link normalizeUserAttributeMap}.
|
* Normalize given user attributes according to [[normalizeUserAttributeMap]].
|
||||||
* @param array $attributes raw attributes.
|
* @param array $attributes raw attributes.
|
||||||
* @return array normalized attributes.
|
* @return array normalized attributes.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -58,7 +58,7 @@ abstract class BaseOAuth extends BaseClient implements ClientInterface
|
|||||||
public $scope;
|
public $scope;
|
||||||
/**
|
/**
|
||||||
* @var array cURL request options. Option values from this field will overwrite corresponding
|
* @var array cURL request options. Option values from this field will overwrite corresponding
|
||||||
* values from {@link defaultCurlOptions()}.
|
* values from [[defaultCurlOptions()]].
|
||||||
*/
|
*/
|
||||||
private $_curlOptions = [];
|
private $_curlOptions = [];
|
||||||
/**
|
/**
|
||||||
@@ -155,7 +155,7 @@ abstract class BaseOAuth extends BaseClient implements ClientInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Composes default {@link returnUrl} value.
|
* Composes default [[returnUrl]] value.
|
||||||
* @return string return URL.
|
* @return string return URL.
|
||||||
*/
|
*/
|
||||||
protected function defaultReturnUrl()
|
protected function defaultReturnUrl()
|
||||||
|
|||||||
@@ -147,7 +147,7 @@ class OAuth1 extends BaseOAuth
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sends HTTP request, signed by {@link signatureMethod}.
|
* Sends HTTP request, signed by [[signatureMethod]].
|
||||||
* @param string $method request type.
|
* @param string $method request type.
|
||||||
* @param string $url request URL.
|
* @param string $url request URL.
|
||||||
* @param array $params request params.
|
* @param array $params request params.
|
||||||
@@ -235,7 +235,7 @@ class OAuth1 extends BaseOAuth
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Composes default {@link returnUrl} value.
|
* Composes default [[returnUrl]] value.
|
||||||
* @return string return URL.
|
* @return string return URL.
|
||||||
*/
|
*/
|
||||||
protected function defaultReturnUrl()
|
protected function defaultReturnUrl()
|
||||||
@@ -281,7 +281,7 @@ class OAuth1 extends BaseOAuth
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sign request with {@link signatureMethod}.
|
* Sign request with [[signatureMethod]].
|
||||||
* @param string $method request method.
|
* @param string $method request method.
|
||||||
* @param string $url request URL.
|
* @param string $url request URL.
|
||||||
* @param array $params request params.
|
* @param array $params request params.
|
||||||
@@ -299,7 +299,7 @@ class OAuth1 extends BaseOAuth
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates signature base string, which will be signed by {@link signatureMethod}.
|
* Creates signature base string, which will be signed by [[signatureMethod]].
|
||||||
* @param string $method request method.
|
* @param string $method request method.
|
||||||
* @param string $url request URL.
|
* @param string $url request URL.
|
||||||
* @param array $params request params.
|
* @param array $params request params.
|
||||||
|
|||||||
@@ -166,7 +166,7 @@ class OAuth2 extends BaseOAuth
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Composes default {@link returnUrl} value.
|
* Composes default [[returnUrl]] value.
|
||||||
* @return string return URL.
|
* @return string return URL.
|
||||||
*/
|
*/
|
||||||
protected function defaultReturnUrl()
|
protected function defaultReturnUrl()
|
||||||
|
|||||||
@@ -27,15 +27,15 @@ use yii\base\Object;
|
|||||||
class OAuthToken extends Object
|
class OAuthToken extends Object
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @var string key in {@link _params} array, which stores token key.
|
* @var string key in [[params]] array, which stores token key.
|
||||||
*/
|
*/
|
||||||
public $tokenParamKey = 'oauth_token';
|
public $tokenParamKey = 'oauth_token';
|
||||||
/**
|
/**
|
||||||
* @var string key in {@link _params} array, which stores token secret key.
|
* @var string key in [[params]] array, which stores token secret key.
|
||||||
*/
|
*/
|
||||||
public $tokenSecretParamKey = 'oauth_token_secret';
|
public $tokenSecretParamKey = 'oauth_token_secret';
|
||||||
/**
|
/**
|
||||||
* @var string key in {@link _params} array, which stores token expiration duration.
|
* @var string key in [[params]] array, which stores token expiration duration.
|
||||||
* If not set will attempt to fetch its value automatically.
|
* If not set will attempt to fetch its value automatically.
|
||||||
*/
|
*/
|
||||||
private $_expireDurationParamKey;
|
private $_expireDurationParamKey;
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ use yii\base\NotSupportedException;
|
|||||||
/**
|
/**
|
||||||
* HmacSha1 represents 'HMAC-SHA1' signature method.
|
* HmacSha1 represents 'HMAC-SHA1' signature method.
|
||||||
*
|
*
|
||||||
* Note: This class require PHP "Hash" extension({@link http://php.net/manual/en/book.hash.php}).
|
* > **Note:** This class requires PHP "Hash" extension(<http://php.net/manual/en/book.hash.php>).
|
||||||
*
|
*
|
||||||
* @author Paul Klimov <klimov.paul@gmail.com>
|
* @author Paul Klimov <klimov.paul@gmail.com>
|
||||||
* @since 2.0
|
* @since 2.0
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ use yii\base\NotSupportedException;
|
|||||||
/**
|
/**
|
||||||
* RsaSha1 represents 'RSA-SHA1' signature method.
|
* RsaSha1 represents 'RSA-SHA1' signature method.
|
||||||
*
|
*
|
||||||
* Note: This class require PHP "OpenSSL" extension({@link http://php.net/manual/en/book.openssl.php}).
|
* > **Note:** This class requires PHP "OpenSSL" extension(<http://php.net/manual/en/book.openssl.php>).
|
||||||
*
|
*
|
||||||
* @property string $privateCertificate Private key certificate content.
|
* @property string $privateCertificate Private key certificate content.
|
||||||
* @property string $publicCertificate Public key certificate content.
|
* @property string $publicCertificate Public key certificate content.
|
||||||
@@ -25,12 +25,12 @@ class RsaSha1 extends BaseMethod
|
|||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @var string OpenSSL private key certificate content.
|
* @var string OpenSSL private key certificate content.
|
||||||
* This value can be fetched from file specified by {@link privateCertificateFile}.
|
* This value can be fetched from file specified by [[privateCertificateFile]].
|
||||||
*/
|
*/
|
||||||
protected $_privateCertificate;
|
protected $_privateCertificate;
|
||||||
/**
|
/**
|
||||||
* @var string OpenSSL public key certificate content.
|
* @var string OpenSSL public key certificate content.
|
||||||
* This value can be fetched from file specified by {@link publicCertificateFile}.
|
* This value can be fetched from file specified by [[publicCertificateFile]].
|
||||||
*/
|
*/
|
||||||
protected $_publicCertificate;
|
protected $_publicCertificate;
|
||||||
/**
|
/**
|
||||||
@@ -101,8 +101,8 @@ class RsaSha1 extends BaseMethod
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates initial value for {@link publicCertificate}.
|
* Creates initial value for [[publicCertificate]].
|
||||||
* This method will attempt to fetch the certificate value from {@link publicCertificateFile} file.
|
* This method will attempt to fetch the certificate value from [[publicCertificateFile]] file.
|
||||||
* @throws InvalidConfigException on failure.
|
* @throws InvalidConfigException on failure.
|
||||||
* @return string public certificate content.
|
* @return string public certificate content.
|
||||||
*/
|
*/
|
||||||
@@ -120,8 +120,8 @@ class RsaSha1 extends BaseMethod
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates initial value for {@link privateCertificate}.
|
* Creates initial value for [[privateCertificate]].
|
||||||
* This method will attempt to fetch the certificate value from {@link privateCertificateFile} file.
|
* This method will attempt to fetch the certificate value from [[privateCertificateFile]] file.
|
||||||
* @throws InvalidConfigException on failure.
|
* @throws InvalidConfigException on failure.
|
||||||
* @return string private certificate content.
|
* @return string private certificate content.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ use yii\authclient\ClientInterface;
|
|||||||
* ~~~
|
* ~~~
|
||||||
*
|
*
|
||||||
* You can customize the widget appearance by using [[begin()]] and [[end()]] syntax
|
* You can customize the widget appearance by using [[begin()]] and [[end()]] syntax
|
||||||
* along with using method {@link clientLink()} or {@link createClientUrl()}.
|
* along with using method [[clientLink()]] or [[createClientUrl()]].
|
||||||
* For example:
|
* For example:
|
||||||
*
|
*
|
||||||
* ~~~php
|
* ~~~php
|
||||||
|
|||||||
@@ -103,7 +103,7 @@ class QueryBuilder extends \yii\db\QueryBuilder
|
|||||||
* Builds a SQL statement for changing the definition of a column.
|
* Builds a SQL statement for changing the definition of a column.
|
||||||
* @param string $table the table whose column is to be changed. The table name will be properly quoted by the method.
|
* @param string $table the table whose column is to be changed. The table name will be properly quoted by the method.
|
||||||
* @param string $column the name of the column to be changed. The name will be properly quoted by the method.
|
* @param string $column the name of the column to be changed. The name will be properly quoted by the method.
|
||||||
* @param string $type the new column type. The {@link getColumnType} method will be invoked to convert abstract column type (if any)
|
* @param string $type the new column type. The [[getColumnType]] method will be invoked to convert abstract column type (if any)
|
||||||
* into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL.
|
* into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL.
|
||||||
* For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'.
|
* For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'.
|
||||||
* @return string the SQL statement for changing the definition of a column.
|
* @return string the SQL statement for changing the definition of a column.
|
||||||
|
|||||||
@@ -92,7 +92,7 @@ EOD;
|
|||||||
*
|
*
|
||||||
* @param string $table the table whose column is to be changed. The table name will be properly quoted by the method.
|
* @param string $table the table whose column is to be changed. The table name will be properly quoted by the method.
|
||||||
* @param string $column the name of the column to be changed. The name will be properly quoted by the method.
|
* @param string $column the name of the column to be changed. The name will be properly quoted by the method.
|
||||||
* @param string $type the new column type. The {@link getColumnType} method will be invoked to convert abstract column type (if any)
|
* @param string $type the new column type. The [[getColumnType]] method will be invoked to convert abstract column type (if any)
|
||||||
* into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL.
|
* into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL.
|
||||||
* For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'.
|
* For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'.
|
||||||
* @return string the SQL statement for changing the definition of a column.
|
* @return string the SQL statement for changing the definition of a column.
|
||||||
|
|||||||
Reference in New Issue
Block a user