diff --git a/Asset.php b/Asset.php index 0876018..27d8852 100644 --- a/Asset.php +++ b/Asset.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,55 +13,143 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Asset facade. + * Yii::$app->get('assetManager') facade. * - * Facades Yii::$app->get('assetManager') component. + * Methods * - * @see \yii\web\AssetManager * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * + * @method static string|bool getAssetPath(\yii\web\AssetBundle $bundle, string $asset) Returns the actual file path for the specified asset. + * @see \yii\web\AssetManager::getAssetPath + * + * @method static string getAssetUrl(\yii\web\AssetBundle $bundle, string $asset) Returns the actual URL for the specified asset. + * @see \yii\web\AssetManager::getAssetUrl + * + * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * + * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\base\Component::getBehaviors + * + * @method static \yii\web\AssetBundle getBundle(string $name, bool $publish = true) Returns the named asset bundle. + * @see \yii\web\AssetManager::getBundle + * + * @method static \yii\web\AssetConverterInterface getConverter() Returns the asset converter. + * @see \yii\web\AssetManager::getConverter + * + * @method static string|bool getPublishedPath(string $path) Returns the published path of a file path. + * @see \yii\web\AssetManager::getPublishedPath + * + * @method static string|bool getPublishedUrl(string $path) Returns the URL of a published file path. + * @see \yii\web\AssetManager::getPublishedUrl + * + * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * + * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * + * @method static array publish(string $path, array $options = []) Publishes a file or a directory. + * @see \yii\web\AssetManager::publish + * + * @method static void setConverter(array|\yii\web\AssetConverterInterface $value) Sets the asset converter. + * @see \yii\web\AssetManager::setConverter + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * Property accessors + * * @method static callable getAfterCopy() Returns a PHP callback that is called after a sub-directory or file is successfully copied. + * @see \yii\web\AssetManager::afterCopy + * * @method static bool getAppendTimestamp() Returns whether to append a timestamp to the URL of every published asset. + * @see \yii\web\AssetManager::appendTimestamp + * * @method static array getAssetMap() Returns mapping from source asset files (keys) to target asset files (values). - * @method static string|bool getAssetPath(\yii\web\AssetBundle $bundle, string $asset) Returns the actual file path for the specified asset. - * @method static string getAssetUrl(\yii\web\AssetBundle $bundle, string $asset) Returns the actual URL for the specified asset. + * @see \yii\web\AssetManager::assetMap + * * @method static string getBasePath() Returns the root directory storing the published asset files. + * @see \yii\web\AssetManager::basePath + * * @method static string getBaseUrl() Returns the base URL through which the published asset files can be accessed. + * @see \yii\web\AssetManager::baseUrl + * * @method static callable getBeforeCopy() Returns a PHP callback that is called before copying each sub-directory or file. - * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. - * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. - * @method static \yii\web\AssetBundle getBundle(string $name, bool $publish = true) Returns the named asset bundle. + * @see \yii\web\AssetManager::beforeCopy + * * @method static array|bool getBundles() Returns list of asset bundle configurations. - * @method static \yii\web\AssetConverterInterface getConverter() Returns the asset converter. + * @see \yii\web\AssetManager::bundles + * * @method static int getDirMode() Returns the permission to be set for newly generated asset directories. + * @see \yii\web\AssetManager::dirMode + * * @method static int getFileMode() Returns the permission to be set for newly published asset files. + * @see \yii\web\AssetManager::fileMode + * * @method static bool getForceCopy() Returns whether the directory being published should be copied even if it is found in the target directory. + * @see \yii\web\AssetManager::forceCopy + * * @method static callable getHashCallback() Returns a callback that will be called to produce hash for asset directory generation. + * @see \yii\web\AssetManager::hashCallback + * * @method static bool getLinkAssets() Returns whether to use symbolic link to publish asset files. - * @method static string|bool getPublishedPath(string $path) Returns the published path of a file path. - * @method static string|bool getPublishedUrl(string $path) Returns the URL of a published file path. - * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. - * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. - * @method static array publish(string $path, array $options = []) Publishes a file or a directory. - * @method static setAfterCopy(callable $value) Sets a PHP callback that is called after a sub-directory or file is successfully copied. - * @method static setAppendTimestamp(bool $value) Sets whether to append a timestamp to the URL of every published asset. - * @method static setAssetMap(array $value) Sets mapping from source asset files (keys) to target asset files (values). - * @method static setBasePath(string $value) Sets the root directory storing the published asset files. - * @method static setBaseUrl(string $value) Sets the base URL through which the published asset files can be accessed. - * @method static setBeforeCopy(callable $value) Sets a PHP callback that is called before copying each sub-directory or file. - * @method static setBundles(array|bool $value) Sets list of asset bundle configurations. - * @method static setConverter(array|\yii\web\AssetConverterInterface $value) Sets the asset converter. - * @method static setDirMode(int $value) Sets the permission to be set for newly generated asset directories. - * @method static setFileMode(int $value) Sets the permission to be set for newly published asset files. - * @method static setForceCopy(bool $value) Sets whether the directory being published should be copied even if it is found in the target directory. - * @method static setHashCallback(callable $value) Sets a callback that will be called to produce hash for asset directory generation. - * @method static setLinkAssets(bool $value) Sets whether to use symbolic link to publish asset files. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\web\AssetManager::linkAssets + * + * @method static void setAfterCopy(callable $value) Sets a PHP callback that is called after a sub-directory or file is successfully copied. + * @see \yii\web\AssetManager::afterCopy + * + * @method static void setAppendTimestamp(bool $value) Sets whether to append a timestamp to the URL of every published asset. + * @see \yii\web\AssetManager::appendTimestamp + * + * @method static void setAssetMap(array $value) Sets mapping from source asset files (keys) to target asset files (values). + * @see \yii\web\AssetManager::assetMap + * + * @method static void setBasePath(string $value) Sets the root directory storing the published asset files. + * @see \yii\web\AssetManager::basePath + * + * @method static void setBaseUrl(string $value) Sets the base URL through which the published asset files can be accessed. + * @see \yii\web\AssetManager::baseUrl + * + * @method static void setBeforeCopy(callable $value) Sets a PHP callback that is called before copying each sub-directory or file. + * @see \yii\web\AssetManager::beforeCopy + * + * @method static void setBundles(array|bool $value) Sets list of asset bundle configurations. + * @see \yii\web\AssetManager::bundles + * + * @method static void setDirMode(int $value) Sets the permission to be set for newly generated asset directories. + * @see \yii\web\AssetManager::dirMode + * + * @method static void setFileMode(int $value) Sets the permission to be set for newly published asset files. + * @see \yii\web\AssetManager::fileMode + * + * @method static void setForceCopy(bool $value) Sets whether the directory being published should be copied even if it is found in the target directory. + * @see \yii\web\AssetManager::forceCopy + * + * @method static void setHashCallback(callable $value) Sets a callback that will be called to produce hash for asset directory generation. + * @see \yii\web\AssetManager::hashCallback + * + * @method static void setLinkAssets(bool $value) Sets whether to use symbolic link to publish asset files. + * @see \yii\web\AssetManager::linkAssets */ class Asset extends Facade { diff --git a/Auth.php b/Auth.php index f14a5fd..1f7a8f0 100644 --- a/Auth.php +++ b/Auth.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,43 +13,108 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Auth facade. + * Yii::$app->get('auth') facade. * - * Facades Yii::$app->get('auth') component. + * Methods * - * @see \yii\rbac\ManagerInterface * @method static bool add(\yii\rbac\Role|\yii\rbac\Permission|\yii\rbac\Rule $object) Adds a role, permission or rule to the RBAC system. + * @see \yii\rbac\ManagerInterface::add + * * @method static bool addChild(\yii\rbac\Item $parent, \yii\rbac\Item $child) Adds an item as a child of another item. + * @see \yii\rbac\ManagerInterface::addChild + * * @method static \yii\rbac\Assignment assign(\yii\rbac\Role $role, string|int $userId) Assigns a role to a user. + * @see \yii\rbac\ManagerInterface::assign + * * @method static bool canAddChild(\yii\rbac\Item $parent, \yii\rbac\Item $child) Checks the possibility of adding a child to parent. + * @see \yii\rbac\ManagerInterface::canAddChild + * * @method static bool checkAccess(string|int $userId, string $permissionName, array $params = []) Checks if the user has the specified permission. + * @see \yii\rbac\CheckAccessInterface::checkAccess + * * @method static \yii\rbac\Permission createPermission(string $name) Creates a new Permission object. + * @see \yii\rbac\ManagerInterface::createPermission + * * @method static \yii\rbac\Role createRole(string $name) Creates a new Role object. + * @see \yii\rbac\ManagerInterface::createRole + * * @method static null|\yii\rbac\Assignment getAssignment(string $roleName, string|int $userId) Returns the assignment information regarding a role and a user. + * @see \yii\rbac\ManagerInterface::getAssignment + * * @method static \yii\rbac\Assignment[] getAssignments(string|int $userId) Returns all role assignment information for the specified user. + * @see \yii\rbac\ManagerInterface::getAssignments + * + * @method static \yii\rbac\Role[] getChildRoles(string $roleName) Returns the roles that are adding to the role via [[addChild()]] by recursive. + * @see \yii\rbac\ManagerInterface::getChildRoles + * * @method static \yii\rbac\Item[] getChildren(string $name) Returns the child permissions and/or roles. + * @see \yii\rbac\ManagerInterface::getChildren + * * @method static null|\yii\rbac\Permission getPermission(string $name) Returns the named permission. + * @see \yii\rbac\ManagerInterface::getPermission + * * @method static \yii\rbac\Permission[] getPermissions() Returns all permissions in the system. + * @see \yii\rbac\ManagerInterface::getPermissions + * * @method static \yii\rbac\Permission[] getPermissionsByRole(string $roleName) Returns all permissions that the specified role represents. + * @see \yii\rbac\ManagerInterface::getPermissionsByRole + * * @method static \yii\rbac\Permission[] getPermissionsByUser(string|int $userId) Returns all permissions that the user has. + * @see \yii\rbac\ManagerInterface::getPermissionsByUser + * * @method static null|\yii\rbac\Role getRole(string $name) Returns the named role. + * @see \yii\rbac\ManagerInterface::getRole + * * @method static \yii\rbac\Role[] getRoles() Returns all roles in the system. + * @see \yii\rbac\ManagerInterface::getRoles + * * @method static \yii\rbac\Role[] getRolesByUser(string|int $userId) Returns the roles that are assigned to the user via [[assign()]]. + * @see \yii\rbac\ManagerInterface::getRolesByUser + * * @method static null|\yii\rbac\Rule getRule(string $name) Returns the rule of the specified name. + * @see \yii\rbac\ManagerInterface::getRule + * * @method static \yii\rbac\Rule[] getRules() Returns all rules available in the system. + * @see \yii\rbac\ManagerInterface::getRules + * * @method static array getUserIdsByRole(string $roleName) Returns all user IDs assigned to the role specified. + * @see \yii\rbac\ManagerInterface::getUserIdsByRole + * * @method static bool hasChild(\yii\rbac\Item $parent, \yii\rbac\Item $child) Returns a value indicating whether the child already exists for the parent. + * @see \yii\rbac\ManagerInterface::hasChild + * * @method static bool remove(\yii\rbac\Role|\yii\rbac\Permission|\yii\rbac\Rule $object) Removes a role, permission or rule from the RBAC system. - * @method static removeAll() Removes all authorization data, including roles, permissions, rules, and assignments. - * @method static removeAllAssignments() Removes all role assignments. - * @method static removeAllPermissions() Removes all permissions. - * @method static removeAllRoles() Removes all roles. - * @method static removeAllRules() Removes all rules. + * @see \yii\rbac\ManagerInterface::remove + * + * @method static void removeAll() Removes all authorization data, including roles, permissions, rules, and assignments. + * @see \yii\rbac\ManagerInterface::removeAll + * + * @method static void removeAllAssignments() Removes all role assignments. + * @see \yii\rbac\ManagerInterface::removeAllAssignments + * + * @method static void removeAllPermissions() Removes all permissions. + * @see \yii\rbac\ManagerInterface::removeAllPermissions + * + * @method static void removeAllRoles() Removes all roles. + * @see \yii\rbac\ManagerInterface::removeAllRoles + * + * @method static void removeAllRules() Removes all rules. + * @see \yii\rbac\ManagerInterface::removeAllRules + * * @method static bool removeChild(\yii\rbac\Item $parent, \yii\rbac\Item $child) Removes a child from its parent. + * @see \yii\rbac\ManagerInterface::removeChild + * * @method static bool removeChildren(\yii\rbac\Item $parent) Removed all children form their parent. + * @see \yii\rbac\ManagerInterface::removeChildren + * * @method static bool revoke(\yii\rbac\Role $role, string|int $userId) Revokes a role from a user. + * @see \yii\rbac\ManagerInterface::revoke + * * @method static bool revokeAll(mixed $userId) Revokes all roles from a user. + * @see \yii\rbac\ManagerInterface::revokeAll + * * @method static bool update(string $name, \yii\rbac\Role|\yii\rbac\Permission|\yii\rbac\Rule $object) Updates the specified role, permission or rule in the system. + * @see \yii\rbac\ManagerInterface::update */ class Auth extends Facade { diff --git a/Cache.php b/Cache.php index f1a7caf..b0bc89e 100644 --- a/Cache.php +++ b/Cache.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,39 +13,98 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Cache facade. + * Yii::$app->get('cache') facade. * - * Facades Yii::$app->get('cache') component. + * Methods * - * @see \yii\caching\Cache * @method static bool add(mixed $key, mixed $value, int $duration = 0, \yii\caching\Dependency $dependency = null) Stores a value identified by a key into cache if the cache does not contain this key. + * @see \yii\caching\Cache::add + * * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static string buildKey(mixed $key) Builds a normalized cache key from a given key. + * @see \yii\caching\Cache::buildKey + * * @method static bool delete(mixed $key) Deletes a value with the specified key from cache. + * @see \yii\caching\Cache::delete + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static bool exists(mixed $key) Checks whether a specified key exists in the cache. + * @see \yii\caching\Cache::exists + * * @method static bool flush() Deletes all values from cache. + * @see \yii\caching\Cache::flush + * + * @method static mixed get(mixed $key) Retrieves a value from cache with a specified key. + * @see \yii\caching\Cache::get + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. - * @method static string getKeyPrefix() Returns a string prefixed to every cache key so that it is unique globally in the whole cache storage. - * @method static array|bool getSerializer() Returns the functions used to serialize and unserialize cached data. + * @see \yii\base\Component::getBehaviors + * * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * * @method static bool madd(array $items, int $duration = 0, \yii\caching\Dependency $dependency = null) Stores multiple items in cache. + * @see \yii\caching\Cache::madd + * * @method static array mget(string[] $keys) Retrieves multiple values from cache with the specified keys. + * @see \yii\caching\Cache::mget + * * @method static bool mset(array $items, int $duration = 0, \yii\caching\Dependency $dependency = null) Stores multiple items in cache. + * @see \yii\caching\Cache::mset + * * @method static bool multiAdd(array $items, int $duration = 0, \yii\caching\Dependency $dependency = null) Stores multiple items in cache. + * @see \yii\caching\Cache::multiAdd + * * @method static array multiGet(string[] $keys) Retrieves multiple values from cache with the specified keys. + * @see \yii\caching\Cache::multiGet + * * @method static bool multiSet(array $items, int $duration = 0, \yii\caching\Dependency $dependency = null) Stores multiple items in cache. + * @see \yii\caching\Cache::multiSet + * * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * * @method static bool set(mixed $key, mixed $value, int $duration = 0, \yii\caching\Dependency $dependency = null) Stores a value identified by a key into cache. - * @method static setKeyPrefix(string $value) Sets a string prefixed to every cache key so that it is unique globally in the whole cache storage. - * @method static setSerializer(array|bool $value) Sets the functions used to serialize and unserialize cached data. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\caching\Cache::set + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * Property accessors + * + * @method static string getKeyPrefix() Returns a string prefixed to every cache key so that it is unique globally in the whole cache storage. + * @see \yii\caching\Cache::keyPrefix + * + * @method static null|array|bool getSerializer() Returns the functions used to serialize and unserialize cached data. + * @see \yii\caching\Cache::serializer + * + * @method static void setKeyPrefix(string $value) Sets a string prefixed to every cache key so that it is unique globally in the whole cache storage. + * @see \yii\caching\Cache::keyPrefix + * + * @method static void setSerializer(null|array|bool $value) Sets the functions used to serialize and unserialize cached data. + * @see \yii\caching\Cache::serializer */ class Cache extends Facade { diff --git a/Db.php b/Db.php index df238bd..7a7578d 100644 --- a/Db.php +++ b/Db.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,99 +13,275 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Db facade. + * Yii::$app->get('db') facade. * - * Facades Yii::$app->get('db') component. + * Methods * - * @see \yii\db\Connection * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static \yii\db\Transaction beginTransaction(string|null $isolationLevel = null) Starts a transaction. + * @see \yii\db\Connection::beginTransaction + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static mixed cache(callable $callable, int $duration = null, \yii\caching\Dependency $dependency = null) Uses query cache for the queries performed with the callable. - * @method static close() Closes the currently active DB connection. + * @see \yii\db\Connection::cache + * + * @method static void close() Closes the currently active DB connection. + * @see \yii\db\Connection::close + * * @method static \yii\db\Command createCommand(string $sql = null, array $params = []) Creates a command for execution. + * @see \yii\db\Connection::createCommand + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. - * @method static array getAttributes() Returns PDO attributes (name => value) that should be set when calling [[open()]] to establish a DB connection. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\base\Component::getBehaviors + * + * @method static string getDriverName() Returns the name of the DB driver. + * @see \yii\db\Connection::getDriverName + * + * @method static bool getIsActive() Returns a value indicating whether the DB connection is established. + * @see \yii\db\Connection::getIsActive + * + * @method static string getLastInsertID(string $sequenceName = '') Returns the ID of the last inserted row or sequence value. + * @see \yii\db\Connection::getLastInsertID + * + * @method static \PDO getMasterPdo() Returns the PDO instance for the currently active master connection. + * @see \yii\db\Connection::getMasterPdo + * + * @method static \yii\db\QueryBuilder getQueryBuilder() Returns the query builder for the current DB connection. + * @see \yii\db\Connection::getQueryBuilder + * + * @method static array getQueryCacheInfo(int $duration, \yii\caching\Dependency $dependency) Returns the current query cache information. + * @see \yii\db\Connection::getQueryCacheInfo + * + * @method static \yii\db\Schema getSchema() Returns the schema information for the database opened by this connection. + * @see \yii\db\Connection::getSchema + * + * @method static \yii\db\Connection getSlave(bool $fallbackToMaster = true) Returns the currently active slave connection. + * @see \yii\db\Connection::getSlave + * + * @method static \PDO getSlavePdo(bool $fallbackToMaster = true) Returns the PDO instance for the currently active slave connection. + * @see \yii\db\Connection::getSlavePdo + * + * @method static \yii\db\TableSchema getTableSchema(string $name, bool $refresh = false) Obtains the schema information for the named table. + * @see \yii\db\Connection::getTableSchema + * + * @method static \yii\db\Transaction getTransaction() Returns the currently active transaction. + * @see \yii\db\Connection::getTransaction + * + * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * + * @method static mixed noCache(callable $callable) Disables query cache temporarily. + * @see \yii\db\Connection::noCache + * + * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * + * @method static void open() Establishes a DB connection. + * @see \yii\db\Connection::open + * + * @method static string quoteColumnName(string $name) Quotes a column name for use in a query. + * @see \yii\db\Connection::quoteColumnName + * + * @method static string quoteSql(string $sql) Processes a SQL statement by quoting table and column names that are enclosed within double brackets. + * @see \yii\db\Connection::quoteSql + * + * @method static string quoteTableName(string $name) Quotes a table name for use in a query. + * @see \yii\db\Connection::quoteTableName + * + * @method static string quoteValue(string $value) Quotes a string value for use in a query. + * @see \yii\db\Connection::quoteValue + * + * @method static void setDriverName(string $driverName) Changes the current driver name. + * @see \yii\db\Connection::setDriverName + * + * @method static mixed transaction(callable $callback, string|null $isolationLevel = null) Executes callback provided in a transaction. + * @see \yii\db\Connection::transaction + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * @method static mixed useMaster(callable $callback) Executes the provided callback by using the master connection. + * @see \yii\db\Connection::useMaster + * + * Property accessors + * + * @method static array getAttributes() Returns PDO attributes (name => value) that should be set when calling [[open()]] to establish a DB connection. + * @see \yii\db\Connection::attributes + * * @method static string getCharset() Returns the charset used for database connection. + * @see \yii\db\Connection::charset + * * @method static string getCommandClass() Returns the class used to create new database [[Command]] objects. - * @method static string getDriverName() Returns the name of the DB driver. + * @see \yii\db\Connection::commandClass + * * @method static string getDsn() Returns the Data Source Name, or DSN, contains the information required to connect to the database. + * @see \yii\db\Connection::dsn + * * @method static bool getEmulatePrepare() Returns whether to turn on prepare emulation. + * @see \yii\db\Connection::emulatePrepare + * * @method static bool getEnableQueryCache() Returns whether to enable query caching. + * @see \yii\db\Connection::enableQueryCache + * * @method static bool getEnableSavepoint() Returns whether to enable [savepoint](http://en.wikipedia.org/wiki/Savepoint). + * @see \yii\db\Connection::enableSavepoint + * * @method static bool getEnableSchemaCache() Returns whether to enable schema caching. + * @see \yii\db\Connection::enableSchemaCache + * * @method static bool getEnableSlaves() Returns whether to enable read/write splitting by using [[slaves]] to read data. - * @method static bool getIsActive() Returns a value indicating whether the DB connection is established. - * @method static string getLastInsertID(string $sequenceName = '') Returns the ID of the last inserted row or sequence value. + * @see \yii\db\Connection::enableSlaves + * * @method static array getMasterConfig() Returns the configuration that should be merged with every master configuration listed in [[masters]]. - * @method static \PDO getMasterPdo() Returns the PDO instance for the currently active master connection. + * @see \yii\db\Connection::masterConfig + * * @method static array getMasters() Returns list of master connection configurations. + * @see \yii\db\Connection::masters + * * @method static string getPassword() Returns the password for establishing DB connection. + * @see \yii\db\Connection::password + * * @method static \PDO getPdo() Returns the PHP PDO instance associated with this DB connection. + * @see \yii\db\Connection::pdo + * * @method static string getPdoClass() Returns Custom PDO wrapper class. - * @method static \yii\db\QueryBuilder getQueryBuilder() Returns the query builder for the current DB connection. + * @see \yii\db\Connection::pdoClass + * * @method static \yii\caching\Cache|string getQueryCache() Returns the cache object or the ID of the cache application component that is used for query caching. + * @see \yii\db\Connection::queryCache + * * @method static int getQueryCacheDuration() Returns the default number of seconds that query results can remain valid in cache. - * @method static array getQueryCacheInfo(int $duration, \yii\caching\Dependency $dependency) Returns the current query cache information. - * @method static \yii\db\Schema getSchema() Returns the schema information for the database opened by this connection. + * @see \yii\db\Connection::queryCacheDuration + * * @method static \yii\caching\Cache|string getSchemaCache() Returns the cache object or the ID of the cache application component that is used to cache the table metadata. + * @see \yii\db\Connection::schemaCache + * * @method static int getSchemaCacheDuration() Returns number of seconds that table metadata can remain valid in cache. + * @see \yii\db\Connection::schemaCacheDuration + * * @method static array getSchemaCacheExclude() Returns list of tables whose metadata should NOT be cached. + * @see \yii\db\Connection::schemaCacheExclude + * * @method static array getSchemaMap() Returns mapping between PDO driver names and [[Schema]] classes. + * @see \yii\db\Connection::schemaMap + * * @method static int getServerRetryInterval() Returns the retry interval in seconds for dead servers listed in [[masters]] and [[slaves]]. + * @see \yii\db\Connection::serverRetryInterval + * * @method static \yii\caching\Cache|string getServerStatusCache() Returns the cache object or the ID of the cache application component that is used to store the health status of the DB servers specified in [[masters]] and [[slaves]]. - * @method static \yii\db\Connection getSlave(bool $fallbackToMaster = true) Returns the currently active slave connection. + * @see \yii\db\Connection::serverStatusCache + * * @method static array getSlaveConfig() Returns the configuration that should be merged with every slave configuration listed in [[slaves]]. - * @method static \PDO getSlavePdo(bool $fallbackToMaster = true) Returns the PDO instance for the currently active slave connection. + * @see \yii\db\Connection::slaveConfig + * * @method static array getSlaves() Returns list of slave connection configurations. + * @see \yii\db\Connection::slaves + * * @method static string getTablePrefix() Returns the common prefix or suffix for table names. - * @method static \yii\db\TableSchema getTableSchema(string $name, bool $refresh = false) Obtains the schema information for the named table. - * @method static \yii\db\Transaction getTransaction() Returns the currently active transaction. + * @see \yii\db\Connection::tablePrefix + * * @method static string getUsername() Returns the username for establishing DB connection. - * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. - * @method static mixed noCache(callable $callable) Disables query cache temporarily. - * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. - * @method static open() Establishes a DB connection. - * @method static string quoteColumnName(string $name) Quotes a column name for use in a query. - * @method static string quoteSql(string $sql) Processes a SQL statement by quoting table and column names that are enclosed within double brackets. - * @method static string quoteTableName(string $name) Quotes a table name for use in a query. - * @method static string quoteValue(string $value) Quotes a string value for use in a query. - * @method static setAttributes(array $value) Sets PDO attributes (name => value) that should be set when calling [[open()]] to establish a DB connection. - * @method static setCharset(string $value) Sets the charset used for database connection. - * @method static setCommandClass(string $value) Sets the class used to create new database [[Command]] objects. - * @method static setDriverName(string $driverName) Changes the current driver name. - * @method static setDsn(string $value) Sets the Data Source Name, or DSN, contains the information required to connect to the database. - * @method static setEmulatePrepare(bool $value) Sets whether to turn on prepare emulation. - * @method static setEnableQueryCache(bool $value) Sets whether to enable query caching. - * @method static setEnableSavepoint(bool $value) Sets whether to enable [savepoint](http://en.wikipedia.org/wiki/Savepoint). - * @method static setEnableSchemaCache(bool $value) Sets whether to enable schema caching. - * @method static setEnableSlaves(bool $value) Sets whether to enable read/write splitting by using [[slaves]] to read data. - * @method static setMasterConfig(array $value) Sets the configuration that should be merged with every master configuration listed in [[masters]]. - * @method static setMasters(array $value) Sets list of master connection configurations. - * @method static setPassword(string $value) Sets the password for establishing DB connection. - * @method static setPdo(\PDO $value) Sets the PHP PDO instance associated with this DB connection. - * @method static setPdoClass(string $value) Sets Custom PDO wrapper class. - * @method static setQueryCache(\yii\caching\Cache|string $value) Sets the cache object or the ID of the cache application component that is used for query caching. - * @method static setQueryCacheDuration(int $value) Sets the default number of seconds that query results can remain valid in cache. - * @method static setSchemaCache(\yii\caching\Cache|string $value) Sets the cache object or the ID of the cache application component that is used to cache the table metadata. - * @method static setSchemaCacheDuration(int $value) Sets number of seconds that table metadata can remain valid in cache. - * @method static setSchemaCacheExclude(array $value) Sets list of tables whose metadata should NOT be cached. - * @method static setSchemaMap(array $value) Sets mapping between PDO driver names and [[Schema]] classes. - * @method static setServerRetryInterval(int $value) Sets the retry interval in seconds for dead servers listed in [[masters]] and [[slaves]]. - * @method static setServerStatusCache(\yii\caching\Cache|string $value) Sets the cache object or the ID of the cache application component that is used to store the health status of the DB servers specified in [[masters]] and [[slaves]]. - * @method static setSlaveConfig(array $value) Sets the configuration that should be merged with every slave configuration listed in [[slaves]]. - * @method static setSlaves(array $value) Sets list of slave connection configurations. - * @method static setTablePrefix(string $value) Sets the common prefix or suffix for table names. - * @method static setUsername(string $value) Sets the username for establishing DB connection. - * @method static mixed transaction(callable $callback, string|null $isolationLevel = null) Executes callback provided in a transaction. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. - * @method static mixed useMaster(callable $callback) Executes the provided callback by using the master connection. + * @see \yii\db\Connection::username + * + * @method static void setAttributes(array $value) Sets PDO attributes (name => value) that should be set when calling [[open()]] to establish a DB connection. + * @see \yii\db\Connection::attributes + * + * @method static void setCharset(string $value) Sets the charset used for database connection. + * @see \yii\db\Connection::charset + * + * @method static void setCommandClass(string $value) Sets the class used to create new database [[Command]] objects. + * @see \yii\db\Connection::commandClass + * + * @method static void setDsn(string $value) Sets the Data Source Name, or DSN, contains the information required to connect to the database. + * @see \yii\db\Connection::dsn + * + * @method static void setEmulatePrepare(bool $value) Sets whether to turn on prepare emulation. + * @see \yii\db\Connection::emulatePrepare + * + * @method static void setEnableQueryCache(bool $value) Sets whether to enable query caching. + * @see \yii\db\Connection::enableQueryCache + * + * @method static void setEnableSavepoint(bool $value) Sets whether to enable [savepoint](http://en.wikipedia.org/wiki/Savepoint). + * @see \yii\db\Connection::enableSavepoint + * + * @method static void setEnableSchemaCache(bool $value) Sets whether to enable schema caching. + * @see \yii\db\Connection::enableSchemaCache + * + * @method static void setEnableSlaves(bool $value) Sets whether to enable read/write splitting by using [[slaves]] to read data. + * @see \yii\db\Connection::enableSlaves + * + * @method static void setMasterConfig(array $value) Sets the configuration that should be merged with every master configuration listed in [[masters]]. + * @see \yii\db\Connection::masterConfig + * + * @method static void setMasters(array $value) Sets list of master connection configurations. + * @see \yii\db\Connection::masters + * + * @method static void setPassword(string $value) Sets the password for establishing DB connection. + * @see \yii\db\Connection::password + * + * @method static void setPdo(\PDO $value) Sets the PHP PDO instance associated with this DB connection. + * @see \yii\db\Connection::pdo + * + * @method static void setPdoClass(string $value) Sets Custom PDO wrapper class. + * @see \yii\db\Connection::pdoClass + * + * @method static void setQueryCache(\yii\caching\Cache|string $value) Sets the cache object or the ID of the cache application component that is used for query caching. + * @see \yii\db\Connection::queryCache + * + * @method static void setQueryCacheDuration(int $value) Sets the default number of seconds that query results can remain valid in cache. + * @see \yii\db\Connection::queryCacheDuration + * + * @method static void setSchemaCache(\yii\caching\Cache|string $value) Sets the cache object or the ID of the cache application component that is used to cache the table metadata. + * @see \yii\db\Connection::schemaCache + * + * @method static void setSchemaCacheDuration(int $value) Sets number of seconds that table metadata can remain valid in cache. + * @see \yii\db\Connection::schemaCacheDuration + * + * @method static void setSchemaCacheExclude(array $value) Sets list of tables whose metadata should NOT be cached. + * @see \yii\db\Connection::schemaCacheExclude + * + * @method static void setSchemaMap(array $value) Sets mapping between PDO driver names and [[Schema]] classes. + * @see \yii\db\Connection::schemaMap + * + * @method static void setServerRetryInterval(int $value) Sets the retry interval in seconds for dead servers listed in [[masters]] and [[slaves]]. + * @see \yii\db\Connection::serverRetryInterval + * + * @method static void setServerStatusCache(\yii\caching\Cache|string $value) Sets the cache object or the ID of the cache application component that is used to store the health status of the DB servers specified in [[masters]] and [[slaves]]. + * @see \yii\db\Connection::serverStatusCache + * + * @method static void setSlaveConfig(array $value) Sets the configuration that should be merged with every slave configuration listed in [[slaves]]. + * @see \yii\db\Connection::slaveConfig + * + * @method static void setSlaves(array $value) Sets list of slave connection configurations. + * @see \yii\db\Connection::slaves + * + * @method static void setTablePrefix(string $value) Sets the common prefix or suffix for table names. + * @see \yii\db\Connection::tablePrefix + * + * @method static void setUsername(string $value) Sets the username for establishing DB connection. + * @see \yii\db\Connection::username */ class Db extends Facade { diff --git a/Error.php b/Error.php index a62f50c..f1c2c54 100644 --- a/Error.php +++ b/Error.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,68 +13,179 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Error facade. + * Yii::$app->get('errorHandler') facade. * - * Facades Yii::$app->get('errorHandler') component. + * Methods * - * @see \yii\console\ErrorHandler - * @see \yii\web\ErrorHandler * @method static string addTypeLinks(string $code) Adds informational links to the given PHP type/class. + * @see \yii\web\ErrorHandler::addTypeLinks + * * @method static string argumentsToString(array $args) Converts arguments array to its string representation. + * @see \yii\web\ErrorHandler::argumentsToString + * * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. - * @method static clearOutput() Removes all output echoed before calling this method. - * @method static convertExceptionToError(\Exception $exception) Converts an exception into a PHP error. + * @see \yii\base\Component::behaviors + * + * @method static void clearOutput() Removes all output echoed before calling this method. + * @see \yii\base\ErrorHandler::clearOutput + * + * @method static void convertExceptionToError(\Exception $exception) Converts an exception into a PHP error. + * @see \yii\base\ErrorHandler::convertExceptionToError + * * @method static string convertExceptionToString(\Exception $exception) Converts an exception into a simple string. + * @see \yii\base\ErrorHandler::convertExceptionToString + * * @method static string createFrameworkVersionLink() Creates string containing HTML link which refers to the page with the current version. + * @see \yii\web\ErrorHandler::createFrameworkVersionLink + * * @method static string createHttpStatusLink(int $statusCode, string $statusDescription) Creates HTML containing link to the page with the information on given HTTP status code. + * @see \yii\web\ErrorHandler::createHttpStatusLink + * * @method static string createServerInformationLink() Creates string containing HTML link which refers to the home page of determined web-server software. + * @see \yii\web\ErrorHandler::createServerInformationLink + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. - * @method static string getCallStackItemView() Returns the path of the view file for rendering exceptions and errors call stack element. - * @method static bool getDiscardExistingOutput() Returns whether to discard any existing page output before error display. - * @method static array getDisplayVars() Returns list of the PHP predefined variables that should be displayed on the error page. - * @method static string getErrorAction() Returns the route (e.g. 'site/error') to the controller action that will be used to display external errors. - * @method static string getErrorView() Returns the path of the view file for rendering exceptions without call stack information. - * @method static \Exception getException() Returns the exception that is being handled currently. + * @see \yii\base\Component::getBehaviors + * * @method static string getExceptionName(\Exception $exception) Returns human-readable exception name. - * @method static string getExceptionView() Returns the path of the view file for rendering exceptions. - * @method static int getMaxSourceLines() Returns maximum number of source code lines to be displayed. - * @method static int getMaxTraceSourceLines() Returns maximum number of trace source code lines to be displayed. - * @method static int getMemoryReserveSize() Returns the size of the reserved memory. - * @method static string getPreviousExceptionView() Returns the path of the view file for rendering previous exceptions. + * @see \yii\web\ErrorHandler::getExceptionName + * * @method static bool handleError(int $code, string $message, string $file, int $line) Handles PHP execution errors such as warnings and notices. - * @method static handleException(\Exception $exception) Handles uncaught PHP exceptions. - * @method static handleFatalError() Handles fatal PHP errors. + * @see \yii\base\ErrorHandler::handleError + * + * @method static void handleException(\Exception $exception) Handles uncaught PHP exceptions. + * @see \yii\base\ErrorHandler::handleException + * + * @method static void handleFatalError() Handles fatal PHP errors. + * @see \yii\base\ErrorHandler::handleFatalError + * * @method static bool handleHhvmError(int $code, string $message, string $file, int $line, mixed $context, mixed $backtrace) Handles HHVM execution errors such as warnings and notices. + * @see \yii\base\ErrorHandler::handleHhvmError + * * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * * @method static string htmlEncode(string $text) Converts special characters to HTML entities. + * @see \yii\web\ErrorHandler::htmlEncode + * * @method static bool isCoreFile(string $file) Determines whether given name of the file belongs to the framework. - * @method static logException(\Exception $exception) Logs the given exception. + * @see \yii\web\ErrorHandler::isCoreFile + * + * @method static void logException(\Exception $exception) Logs the given exception. + * @see \yii\base\ErrorHandler::logException + * * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. - * @method static register() Register this error handler. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * + * @method static void register() Register this error handler. + * @see \yii\base\ErrorHandler::register + * * @method static string renderCallStackItem(string|null $file, int|null $line, string|null $class, string|null $method, array $args, int $index) Renders a single call stack element. + * @see \yii\web\ErrorHandler::renderCallStackItem + * * @method static string renderFile(string $_file_, array $_params_) Renders a view file as a PHP script. + * @see \yii\web\ErrorHandler::renderFile + * * @method static string renderPreviousExceptions(\Exception $exception) Renders the previous exception stack for a given Exception. + * @see \yii\web\ErrorHandler::renderPreviousExceptions + * * @method static string renderRequest() Renders the global variables of the request. - * @method static setCallStackItemView(string $value) Sets the path of the view file for rendering exceptions and errors call stack element. - * @method static setDiscardExistingOutput(bool $value) Sets whether to discard any existing page output before error display. - * @method static setDisplayVars(array $value) Sets list of the PHP predefined variables that should be displayed on the error page. - * @method static setErrorAction(string $value) Sets the route (e.g. 'site/error') to the controller action that will be used to display external errors. - * @method static setErrorView(string $value) Sets the path of the view file for rendering exceptions without call stack information. - * @method static setException(\Exception $value) Sets the exception that is being handled currently. - * @method static setExceptionView(string $value) Sets the path of the view file for rendering exceptions. - * @method static setMaxSourceLines(int $value) Sets maximum number of source code lines to be displayed. - * @method static setMaxTraceSourceLines(int $value) Sets maximum number of trace source code lines to be displayed. - * @method static setMemoryReserveSize(int $value) Sets the size of the reserved memory. - * @method static setPreviousExceptionView(string $value) Sets the path of the view file for rendering previous exceptions. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. - * @method static unregister() Unregisters this error handler by restoring the PHP error and exception handlers. + * @see \yii\web\ErrorHandler::renderRequest + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * @method static void unregister() Unregisters this error handler by restoring the PHP error and exception handlers. + * @see \yii\base\ErrorHandler::unregister + * + * Property accessors + * + * @method static string getCallStackItemView() Returns the path of the view file for rendering exceptions and errors call stack element. + * @see \yii\web\ErrorHandler::callStackItemView + * + * @method static bool getDiscardExistingOutput() Returns whether to discard any existing page output before error display. + * @see \yii\base\ErrorHandler::discardExistingOutput + * + * @method static array getDisplayVars() Returns list of the PHP predefined variables that should be displayed on the error page. + * @see \yii\web\ErrorHandler::displayVars + * + * @method static string getErrorAction() Returns the route (e.g. `site/error`) to the controller action that will be used to display external errors. + * @see \yii\web\ErrorHandler::errorAction + * + * @method static string getErrorView() Returns the path of the view file for rendering exceptions without call stack information. + * @see \yii\web\ErrorHandler::errorView + * + * @method static \Exception getException() Returns the exception that is being handled currently. + * @see \yii\base\ErrorHandler::exception + * + * @method static string getExceptionView() Returns the path of the view file for rendering exceptions. + * @see \yii\web\ErrorHandler::exceptionView + * + * @method static int getMaxSourceLines() Returns maximum number of source code lines to be displayed. + * @see \yii\web\ErrorHandler::maxSourceLines + * + * @method static int getMaxTraceSourceLines() Returns maximum number of trace source code lines to be displayed. + * @see \yii\web\ErrorHandler::maxTraceSourceLines + * + * @method static int getMemoryReserveSize() Returns the size of the reserved memory. + * @see \yii\base\ErrorHandler::memoryReserveSize + * + * @method static string getPreviousExceptionView() Returns the path of the view file for rendering previous exceptions. + * @see \yii\web\ErrorHandler::previousExceptionView + * + * @method static void setCallStackItemView(string $value) Sets the path of the view file for rendering exceptions and errors call stack element. + * @see \yii\web\ErrorHandler::callStackItemView + * + * @method static void setDiscardExistingOutput(bool $value) Sets whether to discard any existing page output before error display. + * @see \yii\base\ErrorHandler::discardExistingOutput + * + * @method static void setDisplayVars(array $value) Sets list of the PHP predefined variables that should be displayed on the error page. + * @see \yii\web\ErrorHandler::displayVars + * + * @method static void setErrorAction(string $value) Sets the route (e.g. `site/error`) to the controller action that will be used to display external errors. + * @see \yii\web\ErrorHandler::errorAction + * + * @method static void setErrorView(string $value) Sets the path of the view file for rendering exceptions without call stack information. + * @see \yii\web\ErrorHandler::errorView + * + * @method static void setException(\Exception $value) Sets the exception that is being handled currently. + * @see \yii\base\ErrorHandler::exception + * + * @method static void setExceptionView(string $value) Sets the path of the view file for rendering exceptions. + * @see \yii\web\ErrorHandler::exceptionView + * + * @method static void setMaxSourceLines(int $value) Sets maximum number of source code lines to be displayed. + * @see \yii\web\ErrorHandler::maxSourceLines + * + * @method static void setMaxTraceSourceLines(int $value) Sets maximum number of trace source code lines to be displayed. + * @see \yii\web\ErrorHandler::maxTraceSourceLines + * + * @method static void setMemoryReserveSize(int $value) Sets the size of the reserved memory. + * @see \yii\base\ErrorHandler::memoryReserveSize + * + * @method static void setPreviousExceptionView(string $value) Sets the path of the view file for rendering previous exceptions. + * @see \yii\web\ErrorHandler::previousExceptionView */ class Error extends Facade { diff --git a/Formatter.php b/Formatter.php index 8f1c085..cacc4b4 100644 --- a/Formatter.php +++ b/Formatter.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,80 +13,218 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Formatter facade. + * Yii::$app->get('formatter') facade. * - * Facades Yii::$app->get('formatter') component. + * Methods * - * @see \yii\i18n\Formatter * @method static string asBoolean(mixed $value) Formats the value as a boolean. + * @see \yii\i18n\Formatter::asBoolean + * * @method static string asCurrency(mixed $value, string $currency = null, array $options = [], array $textOptions = []) Formats the value as a currency number. + * @see \yii\i18n\Formatter::asCurrency + * * @method static string asDate(int|string|\DateTime $value, string $format = null) Formats the value as a date. + * @see \yii\i18n\Formatter::asDate + * * @method static string asDatetime(int|string|\DateTime $value, string $format = null) Formats the value as a datetime. + * @see \yii\i18n\Formatter::asDatetime + * * @method static string asDecimal(mixed $value, int $decimals = null, array $options = [], array $textOptions = []) Formats the value as a decimal number. + * @see \yii\i18n\Formatter::asDecimal + * * @method static string asDuration(\DateInterval|string|int $value, string $implodeString = ', ', string $negativeSign = '-') Represents the value as duration in human readable format. + * @see \yii\i18n\Formatter::asDuration + * * @method static string asEmail(string $value, array $options = []) Formats the value as a mailto link. + * @see \yii\i18n\Formatter::asEmail + * * @method static string asHtml(string $value, array|null $config = null) Formats the value as HTML text. + * @see \yii\i18n\Formatter::asHtml + * * @method static string asImage(mixed $value, array $options = []) Formats the value as an image tag. + * @see \yii\i18n\Formatter::asImage + * * @method static string asInteger(mixed $value, array $options = [], array $textOptions = []) Formats the value as an integer number by removing any decimal digits without rounding. + * @see \yii\i18n\Formatter::asInteger + * * @method static string asNtext(string $value) Formats the value as an HTML-encoded plain text with newlines converted into breaks. + * @see \yii\i18n\Formatter::asNtext + * * @method static string asOrdinal(mixed $value) Formats the value as a ordinal value of a number. + * @see \yii\i18n\Formatter::asOrdinal + * * @method static string asParagraphs(string $value) Formats the value as HTML-encoded text paragraphs. + * @see \yii\i18n\Formatter::asParagraphs + * * @method static string asPercent(mixed $value, int $decimals = null, array $options = [], array $textOptions = []) Formats the value as a percent number with "%" sign. + * @see \yii\i18n\Formatter::asPercent + * * @method static string asRaw(mixed $value) Formats the value as is without any formatting. + * @see \yii\i18n\Formatter::asRaw + * * @method static string asRelativeTime(int|string|\DateTime|\DateInterval $value, int|string|\DateTime $referenceTime = null) Formats the value as the time interval between a date and now in human readable form. + * @see \yii\i18n\Formatter::asRelativeTime + * * @method static string asScientific(mixed $value, int $decimals = null, array $options = [], array $textOptions = []) Formats the value as a scientific number. + * @see \yii\i18n\Formatter::asScientific + * * @method static string asShortSize(string|int|float $value, int $decimals = null, array $options = [], array $textOptions = []) Formats the value in bytes as a size in human readable form for example `12 KB`. + * @see \yii\i18n\Formatter::asShortSize + * * @method static string asSize(string|int|float $value, int $decimals = null, array $options = [], array $textOptions = []) Formats the value in bytes as a size in human readable form, for example `12 kilobytes`. + * @see \yii\i18n\Formatter::asSize + * * @method static string asSpellout(mixed $value) Formats the value as a number spellout. + * @see \yii\i18n\Formatter::asSpellout + * * @method static string asText(string $value) Formats the value as an HTML-encoded plain text. + * @see \yii\i18n\Formatter::asText + * * @method static string asTime(int|string|\DateTime $value, string $format = null) Formats the value as a time. + * @see \yii\i18n\Formatter::asTime + * * @method static string asTimestamp(int|string|\DateTime $value) Formats a date, time or datetime in a float number as UNIX timestamp (seconds since 01-01-1970). + * @see \yii\i18n\Formatter::asTimestamp + * * @method static string asUrl(mixed $value, array $options = []) Formats the value as a hyperlink. + * @see \yii\i18n\Formatter::asUrl + * * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static string format(mixed $value, string|array $format) Formats the value based on the given format type. + * @see \yii\i18n\Formatter::format + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\base\Component::getBehaviors + * + * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * + * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * Property accessors + * * @method static array getBooleanFormat() Returns the text to be displayed when formatting a boolean value. + * @see \yii\i18n\Formatter::booleanFormat + * * @method static \IntlCalendar|int|null getCalendar() Returns the calendar to be used for date formatting. + * @see \yii\i18n\Formatter::calendar + * * @method static string getCurrencyCode() Returns the 3-letter ISO 4217 currency code indicating the default currency to use for [[asCurrency]]. + * @see \yii\i18n\Formatter::currencyCode + * * @method static string getDateFormat() Returns the default format string to be used to format a [[asDate()|date]]. + * @see \yii\i18n\Formatter::dateFormat + * * @method static string getDatetimeFormat() Returns the default format string to be used to format a [[asDatetime()|date and time]]. + * @see \yii\i18n\Formatter::datetimeFormat + * * @method static string getDecimalSeparator() Returns the character displayed as the decimal point when formatting a number. + * @see \yii\i18n\Formatter::decimalSeparator + * * @method static string getDefaultTimeZone() Returns the time zone that is assumed for input values if they do not include a time zone explicitly. + * @see \yii\i18n\Formatter::defaultTimeZone + * * @method static string getLocale() Returns the locale ID that is used to localize the date and number formatting. + * @see \yii\i18n\Formatter::locale + * * @method static string getNullDisplay() Returns the text to be displayed when formatting a `null` value. + * @see \yii\i18n\Formatter::nullDisplay + * * @method static array getNumberFormatterOptions() Returns a list of name value pairs that are passed to the intl [Numberformatter::setAttribute()](http://php.net/manual/en/numberformatter.setattribute.php) method of all the number formatter objects created by [[createNumberFormatter()]]. + * @see \yii\i18n\Formatter::numberFormatterOptions + * * @method static array getNumberFormatterSymbols() Returns a list of name value pairs that are passed to the intl [Numberformatter::setSymbol()](http://php.net/manual/en/numberformatter.setsymbol.php) method of all the number formatter objects created by [[createNumberFormatter()]]. + * @see \yii\i18n\Formatter::numberFormatterSymbols + * * @method static array getNumberFormatterTextOptions() Returns a list of name value pairs that are passed to the intl [Numberformatter::setTextAttribute()](http://php.net/manual/en/numberformatter.settextattribute.php) method of all the number formatter objects created by [[createNumberFormatter()]]. + * @see \yii\i18n\Formatter::numberFormatterTextOptions + * * @method static int getSizeFormatBase() Returns the base at which a kilobyte is calculated (1000 or 1024 bytes per kilobyte), used by [[asSize]] and [[asShortSize]]. + * @see \yii\i18n\Formatter::sizeFormatBase + * * @method static string getThousandSeparator() Returns the character displayed as the thousands separator (also called grouping separator) character when formatting a number. + * @see \yii\i18n\Formatter::thousandSeparator + * * @method static string getTimeFormat() Returns the default format string to be used to format a [[asTime()|time]]. + * @see \yii\i18n\Formatter::timeFormat + * * @method static string getTimeZone() Returns the time zone to use for formatting time and date values. - * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. - * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. - * @method static setBooleanFormat(array $value) Sets the text to be displayed when formatting a boolean value. - * @method static setCalendar(\IntlCalendar|int|null $value) Sets the calendar to be used for date formatting. - * @method static setCurrencyCode(string $value) Sets the 3-letter ISO 4217 currency code indicating the default currency to use for [[asCurrency]]. - * @method static setDateFormat(string $value) Sets the default format string to be used to format a [[asDate()|date]]. - * @method static setDatetimeFormat(string $value) Sets the default format string to be used to format a [[asDatetime()|date and time]]. - * @method static setDecimalSeparator(string $value) Sets the character displayed as the decimal point when formatting a number. - * @method static setDefaultTimeZone(string $value) Sets the time zone that is assumed for input values if they do not include a time zone explicitly. - * @method static setLocale(string $value) Sets the locale ID that is used to localize the date and number formatting. - * @method static setNullDisplay(string $value) Sets the text to be displayed when formatting a `null` value. - * @method static setNumberFormatterOptions(array $value) Sets a list of name value pairs that are passed to the intl [Numberformatter::setAttribute()](http://php.net/manual/en/numberformatter.setattribute.php) method of all the number formatter objects created by [[createNumberFormatter()]]. - * @method static setNumberFormatterSymbols(array $value) Sets a list of name value pairs that are passed to the intl [Numberformatter::setSymbol()](http://php.net/manual/en/numberformatter.setsymbol.php) method of all the number formatter objects created by [[createNumberFormatter()]]. - * @method static setNumberFormatterTextOptions(array $value) Sets a list of name value pairs that are passed to the intl [Numberformatter::setTextAttribute()](http://php.net/manual/en/numberformatter.settextattribute.php) method of all the number formatter objects created by [[createNumberFormatter()]]. - * @method static setSizeFormatBase(int $value) Sets the base at which a kilobyte is calculated (1000 or 1024 bytes per kilobyte), used by [[asSize]] and [[asShortSize]]. - * @method static setThousandSeparator(string $value) Sets the character displayed as the thousands separator (also called grouping separator) character when formatting a number. - * @method static setTimeFormat(string $value) Sets the default format string to be used to format a [[asTime()|time]]. - * @method static setTimeZone(string $value) Sets the time zone to use for formatting time and date values. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\i18n\Formatter::timeZone + * + * @method static void setBooleanFormat(array $value) Sets the text to be displayed when formatting a boolean value. + * @see \yii\i18n\Formatter::booleanFormat + * + * @method static void setCalendar(\IntlCalendar|int|null $value) Sets the calendar to be used for date formatting. + * @see \yii\i18n\Formatter::calendar + * + * @method static void setCurrencyCode(string $value) Sets the 3-letter ISO 4217 currency code indicating the default currency to use for [[asCurrency]]. + * @see \yii\i18n\Formatter::currencyCode + * + * @method static void setDateFormat(string $value) Sets the default format string to be used to format a [[asDate()|date]]. + * @see \yii\i18n\Formatter::dateFormat + * + * @method static void setDatetimeFormat(string $value) Sets the default format string to be used to format a [[asDatetime()|date and time]]. + * @see \yii\i18n\Formatter::datetimeFormat + * + * @method static void setDecimalSeparator(string $value) Sets the character displayed as the decimal point when formatting a number. + * @see \yii\i18n\Formatter::decimalSeparator + * + * @method static void setDefaultTimeZone(string $value) Sets the time zone that is assumed for input values if they do not include a time zone explicitly. + * @see \yii\i18n\Formatter::defaultTimeZone + * + * @method static void setLocale(string $value) Sets the locale ID that is used to localize the date and number formatting. + * @see \yii\i18n\Formatter::locale + * + * @method static void setNullDisplay(string $value) Sets the text to be displayed when formatting a `null` value. + * @see \yii\i18n\Formatter::nullDisplay + * + * @method static void setNumberFormatterOptions(array $value) Sets a list of name value pairs that are passed to the intl [Numberformatter::setAttribute()](http://php.net/manual/en/numberformatter.setattribute.php) method of all the number formatter objects created by [[createNumberFormatter()]]. + * @see \yii\i18n\Formatter::numberFormatterOptions + * + * @method static void setNumberFormatterSymbols(array $value) Sets a list of name value pairs that are passed to the intl [Numberformatter::setSymbol()](http://php.net/manual/en/numberformatter.setsymbol.php) method of all the number formatter objects created by [[createNumberFormatter()]]. + * @see \yii\i18n\Formatter::numberFormatterSymbols + * + * @method static void setNumberFormatterTextOptions(array $value) Sets a list of name value pairs that are passed to the intl [Numberformatter::setTextAttribute()](http://php.net/manual/en/numberformatter.settextattribute.php) method of all the number formatter objects created by [[createNumberFormatter()]]. + * @see \yii\i18n\Formatter::numberFormatterTextOptions + * + * @method static void setSizeFormatBase(int $value) Sets the base at which a kilobyte is calculated (1000 or 1024 bytes per kilobyte), used by [[asSize]] and [[asShortSize]]. + * @see \yii\i18n\Formatter::sizeFormatBase + * + * @method static void setThousandSeparator(string $value) Sets the character displayed as the thousands separator (also called grouping separator) character when formatting a number. + * @see \yii\i18n\Formatter::thousandSeparator + * + * @method static void setTimeFormat(string $value) Sets the default format string to be used to format a [[asTime()|time]]. + * @see \yii\i18n\Formatter::timeFormat + * + * @method static void setTimeZone(string $value) Sets the time zone to use for formatting time and date values. + * @see \yii\i18n\Formatter::timeZone */ class Formatter extends Facade { diff --git a/Http.php b/Http.php index 3d61ade..86a8663 100644 --- a/Http.php +++ b/Http.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,51 +13,131 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Http facade. + * Yii::$app->get('httpClient') facade. * - * Facades Yii::$app->get('httpClient') component. + * Methods * - * @see \yii\httpclient\Client * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static \yii\httpclient\Response[] batchSend(\yii\httpclient\Request[] $requests) Performs multiple HTTP requests in parallel. + * @see \yii\httpclient\Client::batchSend + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static \yii\httpclient\Request createRequest() + * @see \yii\httpclient\Client::createRequest + * * @method static string createRequestLogToken(string $method, string $url, array $headers, string $content) Composes the log/profiling message token for the given HTTP request parameters. + * @see \yii\httpclient\Client::createRequestLogToken + * * @method static \yii\httpclient\Response createResponse(string $content = null, array $headers = []) Creates a response instance. + * @see \yii\httpclient\Client::createResponse + * * @method static \yii\httpclient\Request delete(string $url, array|string $data = null, array $headers = [], array $options = []) Creates 'DELETE' request. + * @see \yii\httpclient\Client::delete + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static \yii\httpclient\Request get(string $url, array|string $data = null, array $headers = [], array $options = []) Creates 'GET' request. - * @method static string getBaseUrl() Returns base request URL. + * @see \yii\httpclient\Client::get + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. - * @method static int getContentLoggingMaxSize() Returns maximum symbols count of the request content, which should be taken to compose a log and profile messages. + * @see \yii\base\Component::getBehaviors + * * @method static \yii\httpclient\FormatterInterface getFormatter(string $format) Returns HTTP message formatter instance for the specified format. - * @method static array getFormatters() Returns the formatters for converting data into the content of the specified [[format]]. + * @see \yii\httpclient\Client::getFormatter + * * @method static \yii\httpclient\ParserInterface getParser(string $format) Returns HTTP message parser instance for the specified format. - * @method static array getParsers() Returns the parsers for converting content of the specified [[format]] into the data. - * @method static array getRequestConfig() Returns request object configuration. - * @method static array getResponseConfig() Returns response config configuration. + * @see \yii\httpclient\Client::getParser + * * @method static \yii\httpclient\Transport getTransport() + * @see \yii\httpclient\Client::getTransport + * * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * * @method static \yii\httpclient\Request head(string $url, array $headers = [], array $options = []) Creates 'HEAD' request. + * @see \yii\httpclient\Client::head + * * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * * @method static \yii\httpclient\Request options(string $url, array $options = []) Creates 'OPTIONS' request. + * @see \yii\httpclient\Client::options + * * @method static \yii\httpclient\Request patch(string $url, array|string $data = null, array $headers = [], array $options = []) Creates 'PATCH' request. + * @see \yii\httpclient\Client::patch + * * @method static \yii\httpclient\Request post(string $url, array|string $data = null, array $headers = [], array $options = []) Creates 'POST' request. + * @see \yii\httpclient\Client::post + * * @method static \yii\httpclient\Request put(string $url, array|string $data = null, array $headers = [], array $options = []) Creates 'PUT' request. + * @see \yii\httpclient\Client::put + * * @method static \yii\httpclient\Response send(\yii\httpclient\Request $request) Performs given request. - * @method static setBaseUrl(string $value) Sets base request URL. - * @method static setContentLoggingMaxSize(int $value) Sets maximum symbols count of the request content, which should be taken to compose a log and profile messages. - * @method static setFormatters(array $value) Sets the formatters for converting data into the content of the specified [[format]]. - * @method static setParsers(array $value) Sets the parsers for converting content of the specified [[format]] into the data. - * @method static setRequestConfig(array $value) Sets request object configuration. - * @method static setResponseConfig(array $value) Sets response config configuration. - * @method static setTransport(\yii\httpclient\Transport|array|string $transport) Sets the HTTP message transport. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\httpclient\Client::send + * + * @method static void setTransport(\yii\httpclient\Transport|array|string $transport) Sets the HTTP message transport. + * @see \yii\httpclient\Client::setTransport + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * Property accessors + * + * @method static string getBaseUrl() Returns base request URL. + * @see \yii\httpclient\Client::baseUrl + * + * @method static int getContentLoggingMaxSize() Returns maximum symbols count of the request content, which should be taken to compose a log and profile messages. + * @see \yii\httpclient\Client::contentLoggingMaxSize + * + * @method static array getFormatters() Returns the formatters for converting data into the content of the specified [[format]]. + * @see \yii\httpclient\Client::formatters + * + * @method static array getParsers() Returns the parsers for converting content of the specified [[format]] into the data. + * @see \yii\httpclient\Client::parsers + * + * @method static array getRequestConfig() Returns request object configuration. + * @see \yii\httpclient\Client::requestConfig + * + * @method static array getResponseConfig() Returns response config configuration. + * @see \yii\httpclient\Client::responseConfig + * + * @method static void setBaseUrl(string $value) Sets base request URL. + * @see \yii\httpclient\Client::baseUrl + * + * @method static void setContentLoggingMaxSize(int $value) Sets maximum symbols count of the request content, which should be taken to compose a log and profile messages. + * @see \yii\httpclient\Client::contentLoggingMaxSize + * + * @method static void setFormatters(array $value) Sets the formatters for converting data into the content of the specified [[format]]. + * @see \yii\httpclient\Client::formatters + * + * @method static void setParsers(array $value) Sets the parsers for converting content of the specified [[format]] into the data. + * @see \yii\httpclient\Client::parsers + * + * @method static void setRequestConfig(array $value) Sets request object configuration. + * @see \yii\httpclient\Client::requestConfig + * + * @method static void setResponseConfig(array $value) Sets response config configuration. + * @see \yii\httpclient\Client::responseConfig */ class Http extends Facade { diff --git a/I18n.php b/I18n.php index 46182ea..1d1a621 100644 --- a/I18n.php +++ b/I18n.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,30 +13,68 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * I18n facade. + * Yii::$app->get('i18n') facade. * - * Facades Yii::$app->get('i18n') component. + * Methods * - * @see \yii\i18n\I18N * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static string format(string $message, array $params, string $language) Formats a message using [[MessageFormatter]]. + * @see \yii\i18n\I18N::format + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\base\Component::getBehaviors + * * @method static \yii\i18n\MessageFormatter getMessageFormatter() Returns the message formatter instance. + * @see \yii\i18n\I18N::getMessageFormatter + * * @method static \yii\i18n\MessageSource getMessageSource(string $category) Returns the message source for the given category. - * @method static array getTranslations() Returns list of [[MessageSource]] configurations or objects. + * @see \yii\i18n\I18N::getMessageSource + * * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. - * @method static setMessageFormatter(string|array|\yii\i18n\MessageFormatter $value) - * @method static setTranslations(array $value) Sets list of [[MessageSource]] configurations or objects. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * + * @method static void setMessageFormatter(string|array|\yii\i18n\MessageFormatter $value) + * @see \yii\i18n\I18N::setMessageFormatter + * * @method static string translate(string $category, string $message, array $params, string $language) Translates a message to the specified language. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\i18n\I18N::translate + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * Property accessors + * + * @method static array getTranslations() Returns list of [[MessageSource]] configurations or objects. + * @see \yii\i18n\I18N::translations + * + * @method static void setTranslations(array $value) Sets list of [[MessageSource]] configurations or objects. + * @see \yii\i18n\I18N::translations */ class I18n extends Facade { diff --git a/Log.php b/Log.php index 82631cd..048901b 100644 --- a/Log.php +++ b/Log.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,32 +13,74 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Log facade. + * Yii::$app->get('log') facade. * - * Facades Yii::$app->get('log') component. + * Methods * - * @see \yii\log\Dispatcher * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static dispatch(array $messages, bool $final) Dispatches the logged messages to [[targets]]. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void dispatch(array $messages, bool $final) Dispatches the logged messages to [[targets]]. + * @see \yii\log\Dispatcher::dispatch + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\base\Component::getBehaviors + * * @method static int getFlushInterval() + * @see \yii\log\Dispatcher::getFlushInterval + * * @method static \yii\log\Logger getLogger() Gets the connected logger. - * @method static array|\yii\log\Target[] getTargets() Returns the log targets. + * @see \yii\log\Dispatcher::getLogger + * * @method static int getTraceLevel() + * @see \yii\log\Dispatcher::getTraceLevel + * * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. - * @method static setFlushInterval(int $value) - * @method static setLogger(\yii\log\Logger|string|array $value) Sets the connected logger. - * @method static setTargets(array|\yii\log\Target[] $value) Sets the log targets. - * @method static setTraceLevel(int $value) - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * + * @method static void setFlushInterval(int $value) + * @see \yii\log\Dispatcher::setFlushInterval + * + * @method static void setLogger(\yii\log\Logger|string|array $value) Sets the connected logger. + * @see \yii\log\Dispatcher::setLogger + * + * @method static void setTraceLevel(int $value) + * @see \yii\log\Dispatcher::setTraceLevel + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * Property accessors + * + * @method static array|\yii\log\Target[] getTargets() Returns the log targets. + * @see \yii\log\Dispatcher::targets + * + * @method static void setTargets(array|\yii\log\Target[] $value) Sets the log targets. + * @see \yii\log\Dispatcher::targets */ class Log extends Facade { diff --git a/Mailer.php b/Mailer.php index f805efc..c00b2d2 100644 --- a/Mailer.php +++ b/Mailer.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,51 +13,131 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Mailer facade. + * Yii::$app->get('mailer') facade. * - * Facades Yii::$app->get('mailer') component. + * Methods * - * @see \yii\swiftmailer\Mailer * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static \yii\mail\MessageInterface compose(string|array|null $view = null, array $params = []) Creates a new message instance and optionally composes its body content via view rendering. + * @see \yii\mail\BaseMailer::compose + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static string generateMessageFileName() + * @see \yii\mail\BaseMailer::generateMessageFileName + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. - * @method static bool getEnableSwiftMailerLogging() Returns whether to enable writing of the SwiftMailer internal logs using Yii log mechanism. - * @method static callable getFileTransportCallback() Returns a PHP callback that will be called by [[send()]] when [[useFileTransport]] is true. - * @method static string getFileTransportPath() Returns the directory where the email messages are saved when [[useFileTransport]] is true. - * @method static string|bool getHtmlLayout() Returns HTML layout view name. - * @method static string getMessageClass() Returns message default class name. - * @method static array getMessageConfig() Returns the configuration that should be applied to any newly created email message instance by [[createMessage()]] or [[compose()]]. + * @see \yii\base\Component::getBehaviors + * * @method static array|\Swift_Mailer getSwiftMailer() - * @method static string|bool getTextLayout() Returns text layout view name. + * @see \yii\swiftmailer\Mailer::getSwiftMailer + * * @method static array|\Swift_Transport getTransport() - * @method static bool getUseFileTransport() Returns whether to save email messages as files under [[fileTransportPath]] instead of sending them to the actual recipients. + * @see \yii\swiftmailer\Mailer::getTransport + * * @method static \yii\web\View getView() + * @see \yii\mail\BaseMailer::getView + * * @method static string getViewPath() + * @see \yii\mail\BaseMailer::getViewPath + * * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * * @method static string render(string $view, array $params = [], string|bool $layout = false) Renders the specified view with optional parameters and layout. + * @see \yii\mail\BaseMailer::render + * * @method static bool send(\yii\mail\MessageInterface $message) Sends the given email message. + * @see \yii\mail\BaseMailer::send + * * @method static int sendMultiple(array $messages) Sends multiple messages at once. - * @method static setEnableSwiftMailerLogging(bool $value) Sets whether to enable writing of the SwiftMailer internal logs using Yii log mechanism. - * @method static setFileTransportCallback(callable $value) Sets a PHP callback that will be called by [[send()]] when [[useFileTransport]] is true. - * @method static setFileTransportPath(string $value) Sets the directory where the email messages are saved when [[useFileTransport]] is true. - * @method static setHtmlLayout(string|bool $value) Sets HTML layout view name. - * @method static setMessageClass(string $value) Sets message default class name. - * @method static setMessageConfig(array $value) Sets the configuration that should be applied to any newly created email message instance by [[createMessage()]] or [[compose()]]. - * @method static setTextLayout(string|bool $value) Sets text layout view name. - * @method static setTransport(array|\Swift_Transport $transport) - * @method static setUseFileTransport(bool $value) Sets whether to save email messages as files under [[fileTransportPath]] instead of sending them to the actual recipients. - * @method static setView(array|\yii\web\View $view) - * @method static setViewPath(string $path) - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\mail\BaseMailer::sendMultiple + * + * @method static void setTransport(array|\Swift_Transport $transport) + * @see \yii\swiftmailer\Mailer::setTransport + * + * @method static void setView(array|\yii\web\View $view) + * @see \yii\mail\BaseMailer::setView + * + * @method static void setViewPath(string $path) + * @see \yii\mail\BaseMailer::setViewPath + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * Property accessors + * + * @method static bool getEnableSwiftMailerLogging() Returns whether to enable writing of the SwiftMailer internal logs using Yii log mechanism. + * @see \yii\swiftmailer\Mailer::enableSwiftMailerLogging + * + * @method static callable getFileTransportCallback() Returns a PHP callback that will be called by [[send()]] when [[useFileTransport]] is true. + * @see \yii\mail\BaseMailer::fileTransportCallback + * + * @method static string getFileTransportPath() Returns the directory where the email messages are saved when [[useFileTransport]] is true. + * @see \yii\mail\BaseMailer::fileTransportPath + * + * @method static string|bool getHtmlLayout() Returns HTML layout view name. + * @see \yii\mail\BaseMailer::htmlLayout + * + * @method static string getMessageClass() Returns message default class name. + * @see \yii\swiftmailer\Mailer::messageClass + * + * @method static array getMessageConfig() Returns the configuration that should be applied to any newly created email message instance by [[createMessage()]] or [[compose()]]. + * @see \yii\mail\BaseMailer::messageConfig + * + * @method static string|bool getTextLayout() Returns text layout view name. + * @see \yii\mail\BaseMailer::textLayout + * + * @method static bool getUseFileTransport() Returns whether to save email messages as files under [[fileTransportPath]] instead of sending them to the actual recipients. + * @see \yii\mail\BaseMailer::useFileTransport + * + * @method static void setEnableSwiftMailerLogging(bool $value) Sets whether to enable writing of the SwiftMailer internal logs using Yii log mechanism. + * @see \yii\swiftmailer\Mailer::enableSwiftMailerLogging + * + * @method static void setFileTransportCallback(callable $value) Sets a PHP callback that will be called by [[send()]] when [[useFileTransport]] is true. + * @see \yii\mail\BaseMailer::fileTransportCallback + * + * @method static void setFileTransportPath(string $value) Sets the directory where the email messages are saved when [[useFileTransport]] is true. + * @see \yii\mail\BaseMailer::fileTransportPath + * + * @method static void setHtmlLayout(string|bool $value) Sets HTML layout view name. + * @see \yii\mail\BaseMailer::htmlLayout + * + * @method static void setMessageClass(string $value) Sets message default class name. + * @see \yii\swiftmailer\Mailer::messageClass + * + * @method static void setMessageConfig(array $value) Sets the configuration that should be applied to any newly created email message instance by [[createMessage()]] or [[compose()]]. + * @see \yii\mail\BaseMailer::messageConfig + * + * @method static void setTextLayout(string|bool $value) Sets text layout view name. + * @see \yii\mail\BaseMailer::textLayout + * + * @method static void setUseFileTransport(bool $value) Sets whether to save email messages as files under [[fileTransportPath]] instead of sending them to the actual recipients. + * @see \yii\mail\BaseMailer::useFileTransport */ class Mailer extends Facade { diff --git a/Redis.php b/Redis.php index 38b8d76..355f6f0 100644 --- a/Redis.php +++ b/Redis.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,47 +13,119 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Redis facade. + * Yii::$app->get('redis') facade. * - * Facades Yii::$app->get('redis') component. + * Methods * - * @see \yii\redis\Connection * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. - * @method static close() Closes the currently active DB connection. + * @see \yii\base\Component::behaviors + * + * @method static void close() Closes the currently active DB connection. + * @see \yii\redis\Connection::close + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static array|bool|null|string executeCommand(string $name, array $params = []) Executes a redis command. + * @see \yii\redis\Connection::executeCommand + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\base\Component::getBehaviors + * + * @method static string getDriverName() Returns the name of the DB driver for the current [[dsn]]. + * @see \yii\redis\Connection::getDriverName + * + * @method static bool getIsActive() Returns a value indicating whether the DB connection is established. + * @see \yii\redis\Connection::getIsActive + * + * @method static \yii\redis\LuaScriptBuilder getLuaScriptBuilder() + * @see \yii\redis\Connection::getLuaScriptBuilder + * + * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * + * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * + * @method static void open() Establishes a DB connection. + * @see \yii\redis\Connection::open + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * Property accessors + * * @method static float getConnectionTimeout() Returns timeout to use for connection to redis. + * @see \yii\redis\Connection::connectionTimeout + * * @method static float getDataTimeout() Returns timeout to use for redis socket when reading and writing data. + * @see \yii\redis\Connection::dataTimeout + * * @method static int getDatabase() Returns the redis database to use. - * @method static string getDriverName() Returns the name of the DB driver for the current [[dsn]]. + * @see \yii\redis\Connection::database + * * @method static string getHostname() Returns the hostname or ip address to use for connecting to the redis server. - * @method static bool getIsActive() Returns a value indicating whether the DB connection is established. - * @method static \yii\redis\LuaScriptBuilder getLuaScriptBuilder() + * @see \yii\redis\Connection::hostname + * * @method static string getPassword() Returns the password for establishing DB connection. + * @see \yii\redis\Connection::password + * * @method static int getPort() Returns the port to use for connecting to the redis server. + * @see \yii\redis\Connection::port + * * @method static array getRedisCommands() Returns List of available redis commands http://redis.io/commands. + * @see \yii\redis\Connection::redisCommands + * * @method static int getSocketClientFlags() Returns Bitmask field which may be set to any combination of connection flags passed to [stream_socket_client()](http://php.net/manual/en/function.stream-socket-client.php). + * @see \yii\redis\Connection::socketClientFlags + * * @method static string getUnixSocket() Returns the unix socket path (e.g. `/var/run/redis/redis.sock`) to use for connecting to the redis server. - * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. - * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. - * @method static open() Establishes a DB connection. - * @method static setConnectionTimeout(float $value) Sets timeout to use for connection to redis. - * @method static setDataTimeout(float $value) Sets timeout to use for redis socket when reading and writing data. - * @method static setDatabase(int $value) Sets the redis database to use. - * @method static setHostname(string $value) Sets the hostname or ip address to use for connecting to the redis server. - * @method static setPassword(string $value) Sets the password for establishing DB connection. - * @method static setPort(int $value) Sets the port to use for connecting to the redis server. - * @method static setRedisCommands(array $value) Sets List of available redis commands http://redis.io/commands. - * @method static setSocketClientFlags(int $value) Sets Bitmask field which may be set to any combination of connection flags passed to [stream_socket_client()](http://php.net/manual/en/function.stream-socket-client.php). - * @method static setUnixSocket(string $value) Sets the unix socket path (e.g. `/var/run/redis/redis.sock`) to use for connecting to the redis server. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\redis\Connection::unixSocket + * + * @method static void setConnectionTimeout(float $value) Sets timeout to use for connection to redis. + * @see \yii\redis\Connection::connectionTimeout + * + * @method static void setDataTimeout(float $value) Sets timeout to use for redis socket when reading and writing data. + * @see \yii\redis\Connection::dataTimeout + * + * @method static void setDatabase(int $value) Sets the redis database to use. + * @see \yii\redis\Connection::database + * + * @method static void setHostname(string $value) Sets the hostname or ip address to use for connecting to the redis server. + * @see \yii\redis\Connection::hostname + * + * @method static void setPassword(string $value) Sets the password for establishing DB connection. + * @see \yii\redis\Connection::password + * + * @method static void setPort(int $value) Sets the port to use for connecting to the redis server. + * @see \yii\redis\Connection::port + * + * @method static void setRedisCommands(array $value) Sets List of available redis commands http://redis.io/commands. + * @see \yii\redis\Connection::redisCommands + * + * @method static void setSocketClientFlags(int $value) Sets Bitmask field which may be set to any combination of connection flags passed to [stream_socket_client()](http://php.net/manual/en/function.stream-socket-client.php). + * @see \yii\redis\Connection::socketClientFlags + * + * @method static void setUnixSocket(string $value) Sets the unix socket path (e.g. `/var/run/redis/redis.sock`) to use for connecting to the redis server. + * @see \yii\redis\Connection::unixSocket */ class Redis extends Facade { diff --git a/Request.php b/Request.php index 53546d5..61f2285 100644 --- a/Request.php +++ b/Request.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,106 +13,296 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Request facade. + * Yii::$app->get('request') facade. * - * Facades Yii::$app->get('request') component. + * Methods * - * @see \yii\console\Request - * @see \yii\web\Request * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static array|mixed get(string $name = null, mixed $defaultValue = null) Returns GET parameter with a given name. + * @see \yii\web\Request::get + * * @method static string getAbsoluteUrl() Returns the currently requested absolute URL. + * @see \yii\web\Request::getAbsoluteUrl + * * @method static array getAcceptableContentTypes() Returns the content types acceptable by the end user. + * @see \yii\web\Request::getAcceptableContentTypes + * * @method static array getAcceptableLanguages() Returns the languages acceptable by the end user. + * @see \yii\web\Request::getAcceptableLanguages + * * @method static string|null getAuthPassword() + * @see \yii\web\Request::getAuthPassword + * * @method static string|null getAuthUser() + * @see \yii\web\Request::getAuthUser + * * @method static string getBaseUrl() Returns the relative URL for the application. + * @see \yii\web\Request::getBaseUrl + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\base\Component::getBehaviors + * * @method static mixed getBodyParam(string $name, mixed $defaultValue = null) Returns the named request body parameter value. + * @see \yii\web\Request::getBodyParam + * * @method static array getBodyParams() Returns the request parameters given in the request body. + * @see \yii\web\Request::getBodyParams + * * @method static string getContentType() Returns request content-type. - * @method static string getCookieValidationKey() Returns a secret key used for cookie validation. + * @see \yii\web\Request::getContentType + * * @method static \yii\web\CookieCollection getCookies() Returns the cookie collection. - * @method static array getCsrfCookie() Returns the configuration for creating the CSRF [[Cookie|cookie]]. - * @method static string getCsrfParam() Returns the name of the token used to prevent CSRF. + * @see \yii\web\Request::getCookies + * * @method static string getCsrfToken(bool $regenerate = false) Returns the token used to perform CSRF validation. + * @see \yii\web\Request::getCsrfToken + * * @method static string getCsrfTokenFromHeader() + * @see \yii\web\Request::getCsrfTokenFromHeader + * * @method static array getETags() Gets the Etags. - * @method static bool getEnableCookieValidation() Returns whether cookies should be validated to ensure they are not tampered. - * @method static bool getEnableCsrfCookie() Returns whether to use cookie to persist CSRF token. - * @method static bool getEnableCsrfValidation() Returns whether to enable CSRF (Cross-Site Request Forgery) validation. + * @see \yii\web\Request::getETags + * * @method static \yii\web\HeaderCollection getHeaders() Returns the header collection. - * @method static string getHostInfo() Returns the schema and host part of the current request URL. + * @see \yii\web\Request::getHeaders + * + * @method static string|null getHostInfo() Returns the schema and host part of the current request URL. + * @see \yii\web\Request::getHostInfo + * + * @method static string|null getHostName() Returns the host part of the current request URL. + * @see \yii\web\Request::getHostName + * * @method static bool getIsAjax() Returns whether this is an AJAX (XMLHttpRequest) request. + * @see \yii\web\Request::getIsAjax + * * @method static bool getIsConsoleRequest() Returns a value indicating whether the current request is made via command line. + * @see \yii\base\Request::getIsConsoleRequest + * * @method static bool getIsDelete() Returns whether this is a DELETE request. + * @see \yii\web\Request::getIsDelete + * * @method static bool getIsFlash() Returns whether this is an Adobe Flash or Flex request. + * @see \yii\web\Request::getIsFlash + * * @method static bool getIsGet() Returns whether this is a GET request. + * @see \yii\web\Request::getIsGet + * * @method static bool getIsHead() Returns whether this is a HEAD request. + * @see \yii\web\Request::getIsHead + * * @method static bool getIsOptions() Returns whether this is an OPTIONS request. + * @see \yii\web\Request::getIsOptions + * * @method static bool getIsPatch() Returns whether this is a PATCH request. + * @see \yii\web\Request::getIsPatch + * * @method static bool getIsPjax() Returns whether this is a PJAX request. + * @see \yii\web\Request::getIsPjax + * * @method static bool getIsPost() Returns whether this is a POST request. + * @see \yii\web\Request::getIsPost + * * @method static bool getIsPut() Returns whether this is a PUT request. + * @see \yii\web\Request::getIsPut + * * @method static bool getIsSecureConnection() Return if the request is sent via secure channel (https). + * @see \yii\web\Request::getIsSecureConnection + * * @method static string getMethod() Returns the method of the current request (e.g. GET, POST, HEAD, PUT, PATCH, DELETE). - * @method static string getMethodParam() Returns the name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE request tunneled through POST. + * @see \yii\web\Request::getMethod + * * @method static array getParams() Returns the command line arguments. - * @method static array getParsers() Returns the parsers for converting the raw HTTP request body into [[bodyParams]]. + * @see \yii\console\Request::getParams + * * @method static string getPathInfo() Returns the path info of the currently requested URL. + * @see \yii\web\Request::getPathInfo + * * @method static int getPort() Returns the port to use for insecure requests. + * @see \yii\web\Request::getPort + * * @method static string getPreferredLanguage(array $languages = []) Returns the user-preferred language that should be used by this application. + * @see \yii\web\Request::getPreferredLanguage + * * @method static mixed getQueryParam(string $name, mixed $defaultValue = null) Returns the named GET parameter value. + * @see \yii\web\Request::getQueryParam + * * @method static array getQueryParams() Returns the request parameters given in the [[queryString]]. + * @see \yii\web\Request::getQueryParams + * * @method static string getQueryString() Returns part of the request URL that is after the question mark. + * @see \yii\web\Request::getQueryString + * * @method static string getRawBody() Returns the raw HTTP request body. + * @see \yii\web\Request::getRawBody + * * @method static string|null getReferrer() Returns the URL referrer. + * @see \yii\web\Request::getReferrer + * * @method static string getScriptFile() Returns the entry script file path. + * @see \yii\web\Request::getScriptFile + * * @method static string getScriptUrl() Returns the relative URL of the entry script. + * @see \yii\web\Request::getScriptUrl + * * @method static int getSecurePort() Returns the port to use for secure requests. + * @see \yii\web\Request::getSecurePort + * * @method static string getServerName() Returns the server name. + * @see \yii\web\Request::getServerName + * * @method static int|null getServerPort() Returns the server port number. + * @see \yii\web\Request::getServerPort + * * @method static string getUrl() Returns the currently requested relative URL. + * @see \yii\web\Request::getUrl + * * @method static string|null getUserAgent() Returns the user agent. + * @see \yii\web\Request::getUserAgent + * * @method static string|null getUserHost() Returns the user host name. + * @see \yii\web\Request::getUserHost + * * @method static string|null getUserIP() Returns the user IP address. + * @see \yii\web\Request::getUserIP + * * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * * @method static array parseAcceptHeader(string $header) Parses the given `Accept` (or `Accept-Language`) header. + * @see \yii\web\Request::parseAcceptHeader + * * @method static array|mixed post(string $name = null, mixed $defaultValue = null) Returns POST parameter with a given name. + * @see \yii\web\Request::post + * * @method static array resolve() Resolves the current request into a route and the associated parameters. - * @method static setAcceptableContentTypes(array $value) Sets the acceptable content types. - * @method static setAcceptableLanguages(array $value) - * @method static setBaseUrl(string $value) Sets the relative URL for the application. - * @method static setBodyParams(array $values) Sets the request body parameters. - * @method static setCookieValidationKey(string $value) Sets a secret key used for cookie validation. - * @method static setCsrfCookie(array $value) Sets the configuration for creating the CSRF [[Cookie|cookie]]. - * @method static setCsrfParam(string $value) Sets the name of the token used to prevent CSRF. - * @method static setEnableCookieValidation(bool $value) Sets whether cookies should be validated to ensure they are not tampered. - * @method static setEnableCsrfCookie(bool $value) Sets whether to use cookie to persist CSRF token. - * @method static setEnableCsrfValidation(bool $value) Sets whether to enable CSRF (Cross-Site Request Forgery) validation. - * @method static setHostInfo(string $value) Sets the schema and host part of the application URL. - * @method static setIsConsoleRequest(bool $value) Sets the value indicating whether the current request is made via command line. - * @method static setMethodParam(string $value) Sets the name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE request tunneled through POST. - * @method static setParams(array $params) Sets the command line arguments. - * @method static setParsers(array $value) Sets the parsers for converting the raw HTTP request body into [[bodyParams]]. - * @method static setPathInfo(string $value) Sets the path info of the current request. - * @method static setPort(int $value) Sets the port to use for insecure requests. - * @method static setQueryParams(array $values) Sets the request [[queryString]] parameters. - * @method static setRawBody(string $rawBody) Sets the raw HTTP request body, this method is mainly used by test scripts to simulate raw HTTP requests. - * @method static setScriptFile(string $value) Sets the entry script file path. - * @method static setScriptUrl(string $value) Sets the relative URL for the application entry script. - * @method static setSecurePort(int $value) Sets the port to use for secure requests. - * @method static setUrl(string $value) Sets the currently requested relative URL. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\web\Request::resolve + * + * @method static void setAcceptableContentTypes(array $value) Sets the acceptable content types. + * @see \yii\web\Request::setAcceptableContentTypes + * + * @method static void setAcceptableLanguages(array $value) + * @see \yii\web\Request::setAcceptableLanguages + * + * @method static void setBaseUrl(string $value) Sets the relative URL for the application. + * @see \yii\web\Request::setBaseUrl + * + * @method static void setBodyParams(array $values) Sets the request body parameters. + * @see \yii\web\Request::setBodyParams + * + * @method static void setHostInfo(string|null $value) Sets the schema and host part of the application URL. + * @see \yii\web\Request::setHostInfo + * + * @method static void setIsConsoleRequest(bool $value) Sets the value indicating whether the current request is made via command line. + * @see \yii\base\Request::setIsConsoleRequest + * + * @method static void setParams(array $params) Sets the command line arguments. + * @see \yii\console\Request::setParams + * + * @method static void setPathInfo(string $value) Sets the path info of the current request. + * @see \yii\web\Request::setPathInfo + * + * @method static void setPort(int $value) Sets the port to use for insecure requests. + * @see \yii\web\Request::setPort + * + * @method static void setQueryParams(array $values) Sets the request [[queryString]] parameters. + * @see \yii\web\Request::setQueryParams + * + * @method static void setRawBody(string $rawBody) Sets the raw HTTP request body, this method is mainly used by test scripts to simulate raw HTTP requests. + * @see \yii\web\Request::setRawBody + * + * @method static void setScriptFile(string $value) Sets the entry script file path. + * @see \yii\web\Request::setScriptFile + * + * @method static void setScriptUrl(string $value) Sets the relative URL for the application entry script. + * @see \yii\web\Request::setScriptUrl + * + * @method static void setSecurePort(int $value) Sets the port to use for secure requests. + * @see \yii\web\Request::setSecurePort + * + * @method static void setUrl(string $value) Sets the currently requested relative URL. + * @see \yii\web\Request::setUrl + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * * @method static bool validateCsrfToken(string $token = null) Performs the CSRF validation. + * @see \yii\web\Request::validateCsrfToken + * + * Property accessors + * + * @method static string getCookieValidationKey() Returns a secret key used for cookie validation. + * @see \yii\web\Request::cookieValidationKey + * + * @method static array getCsrfCookie() Returns the configuration for creating the CSRF [[Cookie|cookie]]. + * @see \yii\web\Request::csrfCookie + * + * @method static string getCsrfParam() Returns the name of the token used to prevent CSRF. + * @see \yii\web\Request::csrfParam + * + * @method static bool getEnableCookieValidation() Returns whether cookies should be validated to ensure they are not tampered. + * @see \yii\web\Request::enableCookieValidation + * + * @method static bool getEnableCsrfCookie() Returns whether to use cookie to persist CSRF token. + * @see \yii\web\Request::enableCsrfCookie + * + * @method static bool getEnableCsrfValidation() Returns whether to enable CSRF (Cross-Site Request Forgery) validation. + * @see \yii\web\Request::enableCsrfValidation + * + * @method static string getMethodParam() Returns the name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE request tunneled through POST. + * @see \yii\web\Request::methodParam + * + * @method static array getParsers() Returns the parsers for converting the raw HTTP request body into [[bodyParams]]. + * @see \yii\web\Request::parsers + * + * @method static void setCookieValidationKey(string $value) Sets a secret key used for cookie validation. + * @see \yii\web\Request::cookieValidationKey + * + * @method static void setCsrfCookie(array $value) Sets the configuration for creating the CSRF [[Cookie|cookie]]. + * @see \yii\web\Request::csrfCookie + * + * @method static void setCsrfParam(string $value) Sets the name of the token used to prevent CSRF. + * @see \yii\web\Request::csrfParam + * + * @method static void setEnableCookieValidation(bool $value) Sets whether cookies should be validated to ensure they are not tampered. + * @see \yii\web\Request::enableCookieValidation + * + * @method static void setEnableCsrfCookie(bool $value) Sets whether to use cookie to persist CSRF token. + * @see \yii\web\Request::enableCsrfCookie + * + * @method static void setEnableCsrfValidation(bool $value) Sets whether to enable CSRF (Cross-Site Request Forgery) validation. + * @see \yii\web\Request::enableCsrfValidation + * + * @method static void setMethodParam(string $value) Sets the name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE request tunneled through POST. + * @see \yii\web\Request::methodParam + * + * @method static void setParsers(array $value) Sets the parsers for converting the raw HTTP request body into [[bodyParams]]. + * @see \yii\web\Request::parsers */ class Request extends Facade { diff --git a/Response.php b/Response.php index 931b7d3..2379413 100644 --- a/Response.php +++ b/Response.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,74 +13,197 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Response facade. + * Yii::$app->get('response') facade. * - * Facades Yii::$app->get('response') component. + * Methods * - * @see \yii\console\Response - * @see \yii\web\Response * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. - * @method static clear() Clears the headers, cookies, content, status code of the response. - * @method static clearOutputBuffers() Removes all existing output buffers. + * @see \yii\base\Component::behaviors + * + * @method static void clear() Clears the headers, cookies, content, status code of the response. + * @see \yii\web\Response::clear + * + * @method static void clearOutputBuffers() Removes all existing output buffers. + * @see \yii\base\Response::clearOutputBuffers + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. - * @method static string getAcceptMimeType() Returns the MIME type (e.g. `application/json`) from the request ACCEPT header chosen for this response. - * @method static array getAcceptParams() Returns the parameters (e.g. `['q' => 1, 'version' => '1.0']`) associated with the [[acceptMimeType|chosen MIME type]]. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. - * @method static string getCharset() Returns the charset of the text response. - * @method static string getContent() Returns the response content. + * @see \yii\base\Component::getBehaviors + * * @method static \yii\web\CookieCollection getCookies() Returns the cookie collection. - * @method static mixed getData() Returns the original response data. - * @method static int getExitStatus() Returns the exit status. - * @method static string getFormat() Returns the response format. - * @method static array getFormatters() Returns the formatters for converting data into the response content of the specified [[format]]. + * @see \yii\web\Response::getCookies + * * @method static \yii\web\HeaderCollection getHeaders() Returns the header collection. - * @method static array getHttpStatuses() Returns list of HTTP status codes and the corresponding texts. + * @see \yii\web\Response::getHeaders + * * @method static bool getIsClientError() + * @see \yii\web\Response::getIsClientError + * * @method static bool getIsEmpty() + * @see \yii\web\Response::getIsEmpty + * * @method static bool getIsForbidden() + * @see \yii\web\Response::getIsForbidden + * * @method static bool getIsInformational() + * @see \yii\web\Response::getIsInformational + * * @method static bool getIsInvalid() + * @see \yii\web\Response::getIsInvalid + * * @method static bool getIsNotFound() + * @see \yii\web\Response::getIsNotFound + * * @method static bool getIsOk() + * @see \yii\web\Response::getIsOk + * * @method static bool getIsRedirection() - * @method static bool getIsSent() Returns whether the response has been sent. + * @see \yii\web\Response::getIsRedirection + * * @method static bool getIsServerError() + * @see \yii\web\Response::getIsServerError + * * @method static bool getIsSuccessful() + * @see \yii\web\Response::getIsSuccessful + * * @method static int getStatusCode() - * @method static string getStatusText() Returns the HTTP status description that comes together with the status code. - * @method static resource|array getStream() Returns the stream to be sent. - * @method static string getVersion() Returns the version of the HTTP protocol to use. + * @see \yii\web\Response::getStatusCode + * * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * * @method static \yii\web\Response redirect(string|array $url, int $statusCode = 302, bool $checkAjax = true) Redirects the browser to the specified URL. + * @see \yii\web\Response::redirect + * * @method static \yii\web\Response refresh(string $anchor = '') Refreshes the current page. - * @method static send() Sends the response to the client. + * @see \yii\web\Response::refresh + * + * @method static void send() Sends the response to the client. + * @see \yii\web\Response::send + * * @method static \yii\web\Response sendContentAsFile(string $content, string $attachmentName, array $options = []) Sends the specified content as a file to the browser. + * @see \yii\web\Response::sendContentAsFile + * * @method static \yii\web\Response sendFile(string $filePath, string $attachmentName = null, array $options = []) Sends a file to the browser. + * @see \yii\web\Response::sendFile + * * @method static \yii\web\Response sendStreamAsFile(resource $handle, string $attachmentName, array $options = []) Sends the specified stream as a file to the browser. - * @method static setAcceptMimeType(string $value) Sets the MIME type (e.g. `application/json`) from the request ACCEPT header chosen for this response. - * @method static setAcceptParams(array $value) Sets the parameters (e.g. `['q' => 1, 'version' => '1.0']`) associated with the [[acceptMimeType|chosen MIME type]]. - * @method static setCharset(string $value) Sets the charset of the text response. - * @method static setContent(string $value) Sets the response content. - * @method static setData(mixed $value) Sets the original response data. + * @see \yii\web\Response::sendStreamAsFile + * * @method static \yii\web\Response setDownloadHeaders(string $attachmentName, string $mimeType = null, bool $inline = false, int $contentLength = null) Sets a default set of HTTP headers for file downloading purpose. - * @method static setExitStatus(int $value) Sets the exit status. - * @method static setFormat(string $value) Sets the response format. - * @method static setFormatters(array $value) Sets the formatters for converting data into the response content of the specified [[format]]. - * @method static setHttpStatuses(array $value) Sets list of HTTP status codes and the corresponding texts. - * @method static setIsSent(bool $value) Sets whether the response has been sent. - * @method static setStatusCode(int $value, string $text = null) Sets the response status code. - * @method static setStatusText(string $value) Sets the HTTP status description that comes together with the status code. - * @method static setStream(resource|array $value) Sets the stream to be sent. - * @method static setVersion(string $value) Sets the version of the HTTP protocol to use. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\web\Response::setDownloadHeaders + * + * @method static void setStatusCode(int $value, string $text = null) Sets the response status code. + * @see \yii\web\Response::setStatusCode + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * * @method static \yii\web\Response xSendFile(string $filePath, string $attachmentName = null, array $options = []) Sends existing file to a browser as a download using x-sendfile. + * @see \yii\web\Response::xSendFile + * + * Property accessors + * + * @method static string getAcceptMimeType() Returns the MIME type (e.g. `application/json`) from the request ACCEPT header chosen for this response. + * @see \yii\web\Response::acceptMimeType + * + * @method static array getAcceptParams() Returns the parameters (e.g. `['q' => 1, 'version' => '1.0']`) associated with the [[acceptMimeType|chosen MIME type]]. + * @see \yii\web\Response::acceptParams + * + * @method static string getCharset() Returns the charset of the text response. + * @see \yii\web\Response::charset + * + * @method static string getContent() Returns the response content. + * @see \yii\web\Response::content + * + * @method static mixed getData() Returns the original response data. + * @see \yii\web\Response::data + * + * @method static int getExitStatus() Returns the exit status. + * @see \yii\base\Response::exitStatus + * + * @method static string getFormat() Returns the response format. + * @see \yii\web\Response::format + * + * @method static array getFormatters() Returns the formatters for converting data into the response content of the specified [[format]]. + * @see \yii\web\Response::formatters + * + * @method static array getHttpStatuses() Returns list of HTTP status codes and the corresponding texts. + * @see \yii\web\Response::httpStatuses + * + * @method static bool getIsSent() Returns whether the response has been sent. + * @see \yii\web\Response::isSent + * + * @method static string getStatusText() Returns the HTTP status description that comes together with the status code. + * @see \yii\web\Response::statusText + * + * @method static resource|array getStream() Returns the stream to be sent. + * @see \yii\web\Response::stream + * + * @method static string getVersion() Returns the version of the HTTP protocol to use. + * @see \yii\web\Response::version + * + * @method static void setAcceptMimeType(string $value) Sets the MIME type (e.g. `application/json`) from the request ACCEPT header chosen for this response. + * @see \yii\web\Response::acceptMimeType + * + * @method static void setAcceptParams(array $value) Sets the parameters (e.g. `['q' => 1, 'version' => '1.0']`) associated with the [[acceptMimeType|chosen MIME type]]. + * @see \yii\web\Response::acceptParams + * + * @method static void setCharset(string $value) Sets the charset of the text response. + * @see \yii\web\Response::charset + * + * @method static void setContent(string $value) Sets the response content. + * @see \yii\web\Response::content + * + * @method static void setData(mixed $value) Sets the original response data. + * @see \yii\web\Response::data + * + * @method static void setExitStatus(int $value) Sets the exit status. + * @see \yii\base\Response::exitStatus + * + * @method static void setFormat(string $value) Sets the response format. + * @see \yii\web\Response::format + * + * @method static void setFormatters(array $value) Sets the formatters for converting data into the response content of the specified [[format]]. + * @see \yii\web\Response::formatters + * + * @method static void setHttpStatuses(array $value) Sets list of HTTP status codes and the corresponding texts. + * @see \yii\web\Response::httpStatuses + * + * @method static void setIsSent(bool $value) Sets whether the response has been sent. + * @see \yii\web\Response::isSent + * + * @method static void setStatusText(string $value) Sets the HTTP status description that comes together with the status code. + * @see \yii\web\Response::statusText + * + * @method static void setStream(resource|array $value) Sets the stream to be sent. + * @see \yii\web\Response::stream + * + * @method static void setVersion(string $value) Sets the version of the HTTP protocol to use. + * @see \yii\web\Response::version */ class Response extends Facade { diff --git a/Router.php b/Router.php index b1860a6..13a865a 100644 --- a/Router.php +++ b/Router.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -9,50 +11,133 @@ namespace sergeymakinen\facades; +/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Router facade. + * Yii::$app->get('urlManager') facade. + * + * Methods * - * Facades Yii::$app->get('urlManager') component. + * @method static void addRules(array $rules, bool $append = true) Adds additional URL rules. + * @see \yii\web\UrlManager::addRules * - * @see \yii\web\UrlManager - * @method static addRules(array $rules, bool $append = true) Adds additional URL rules. * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static string createAbsoluteUrl(string|array $params, string $scheme = null) Creates an absolute URL using the given route and query parameters. + * @see \yii\web\UrlManager::createAbsoluteUrl + * * @method static string createUrl(string|array $params) Creates a URL using the given route and query parameters. + * @see \yii\web\UrlManager::createUrl + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static string getBaseUrl() Returns the base URL that is used by [[createUrl()]] to prepend to created URLs. + * @see \yii\web\UrlManager::getBaseUrl + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\base\Component::getBehaviors + * + * @method static string getHostInfo() Returns the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs. + * @see \yii\web\UrlManager::getHostInfo + * + * @method static string getScriptUrl() Returns the entry script URL that is used by [[createUrl()]] to prepend to created URLs. + * @see \yii\web\UrlManager::getScriptUrl + * + * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * + * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * + * @method static array|bool parseRequest(\yii\web\Request $request) Parses the user request. + * @see \yii\web\UrlManager::parseRequest + * + * @method static void setBaseUrl(string $value) Sets the base URL that is used by [[createUrl()]] to prepend to created URLs. + * @see \yii\web\UrlManager::setBaseUrl + * + * @method static void setHostInfo(string $value) Sets the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs. + * @see \yii\web\UrlManager::setHostInfo + * + * @method static void setScriptUrl(string $value) Sets the entry script URL that is used by [[createUrl()]] to prepend to created URLs. + * @see \yii\web\UrlManager::setScriptUrl + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * Property accessors + * * @method static \yii\caching\Cache|string getCache() Returns the cache object or the application component ID of the cache object. + * @see \yii\web\UrlManager::cache + * * @method static bool getEnablePrettyUrl() Returns whether to enable pretty URLs. + * @see \yii\web\UrlManager::enablePrettyUrl + * * @method static bool getEnableStrictParsing() Returns whether to enable strict parsing. - * @method static string getHostInfo() Returns the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs. + * @see \yii\web\UrlManager::enableStrictParsing + * + * @method static \yii\web\UrlNormalizer|array|string|bool getNormalizer() Returns the configuration for [[UrlNormalizer]] used by this UrlManager. + * @see \yii\web\UrlManager::normalizer + * * @method static string getRouteParam() Returns the GET parameter name for route. + * @see \yii\web\UrlManager::routeParam + * * @method static array getRuleConfig() Returns the default configuration of URL rules. - * @method static array getRules() Returns the rules for creating and parsing URLs when [[enablePrettyUrl]] is true. - * @method static string getScriptUrl() Returns the entry script URL that is used by [[createUrl()]] to prepend to created URLs. + * @see \yii\web\UrlManager::ruleConfig + * + * @method static array getRules() Returns the rules for creating and parsing URLs when [[enablePrettyUrl]] is `true`. + * @see \yii\web\UrlManager::rules + * * @method static bool getShowScriptName() Returns whether to show entry script name in the constructed URL. - * @method static string getSuffix() Returns the URL suffix used when in 'path' format. - * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. - * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. - * @method static array|bool parseRequest(\yii\web\Request $request) Parses the user request. - * @method static setBaseUrl(string $value) Sets the base URL that is used by [[createUrl()]] to prepend to created URLs. - * @method static setCache(\yii\caching\Cache|string $value) Sets the cache object or the application component ID of the cache object. - * @method static setEnablePrettyUrl(bool $value) Sets whether to enable pretty URLs. - * @method static setEnableStrictParsing(bool $value) Sets whether to enable strict parsing. - * @method static setHostInfo(string $value) Sets the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs. - * @method static setRouteParam(string $value) Sets the GET parameter name for route. - * @method static setRuleConfig(array $value) Sets the default configuration of URL rules. - * @method static setRules(array $value) Sets the rules for creating and parsing URLs when [[enablePrettyUrl]] is true. - * @method static setScriptUrl(string $value) Sets the entry script URL that is used by [[createUrl()]] to prepend to created URLs. - * @method static setShowScriptName(bool $value) Sets whether to show entry script name in the constructed URL. - * @method static setSuffix(string $value) Sets the URL suffix used when in 'path' format. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\web\UrlManager::showScriptName + * + * @method static string getSuffix() Returns the URL suffix used when [[enablePrettyUrl]] is `true`. + * @see \yii\web\UrlManager::suffix + * + * @method static void setCache(\yii\caching\Cache|string $value) Sets the cache object or the application component ID of the cache object. + * @see \yii\web\UrlManager::cache + * + * @method static void setEnablePrettyUrl(bool $value) Sets whether to enable pretty URLs. + * @see \yii\web\UrlManager::enablePrettyUrl + * + * @method static void setEnableStrictParsing(bool $value) Sets whether to enable strict parsing. + * @see \yii\web\UrlManager::enableStrictParsing + * + * @method static void setNormalizer(\yii\web\UrlNormalizer|array|string|bool $value) Sets the configuration for [[UrlNormalizer]] used by this UrlManager. + * @see \yii\web\UrlManager::normalizer + * + * @method static void setRouteParam(string $value) Sets the GET parameter name for route. + * @see \yii\web\UrlManager::routeParam + * + * @method static void setRuleConfig(array $value) Sets the default configuration of URL rules. + * @see \yii\web\UrlManager::ruleConfig + * + * @method static void setRules(array $value) Sets the rules for creating and parsing URLs when [[enablePrettyUrl]] is `true`. + * @see \yii\web\UrlManager::rules + * + * @method static void setShowScriptName(bool $value) Sets whether to show entry script name in the constructed URL. + * @see \yii\web\UrlManager::showScriptName + * + * @method static void setSuffix(string $value) Sets the URL suffix used when [[enablePrettyUrl]] is `true`. + * @see \yii\web\UrlManager::suffix */ class Router extends Facade { diff --git a/Security.php b/Security.php index 6c65927..2f1985b 100644 --- a/Security.php +++ b/Security.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,52 +13,134 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Security facade. + * Yii::$app->get('security') facade. * - * Facades Yii::$app->get('security') component. + * Methods * - * @see \yii\base\Security * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static bool compareString($expected, string $actual) Performs string comparison using timing attack resistant approach. - * @method static bool|string decryptByKey(string $data, string $inputKey, string $info = null) Verifies and decrypts data encrypted with [[encryptByPassword()]]. + * @see \yii\base\Security::compareString + * + * @method static bool|string decryptByKey(string $data, string $inputKey, string $info = null) Verifies and decrypts data encrypted with [[encryptByKey()]]. + * @see \yii\base\Security::decryptByKey + * * @method static bool|string decryptByPassword(string $data, string $password) Verifies and decrypts data encrypted with [[encryptByPassword()]]. + * @see \yii\base\Security::decryptByPassword + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * * @method static string encryptByKey(string $data, string $inputKey, string $info = null) Encrypts data using a cryptographic key. + * @see \yii\base\Security::encryptByKey + * * @method static string encryptByPassword(string $data, string $password) Encrypts data using a password. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Security::encryptByPassword + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static string generatePasswordHash(string $password, int $cost = null) Generates a secure hash from a password and a random salt. + * @see \yii\base\Security::generatePasswordHash + * * @method static string generateRandomKey(int $length = 32) Generates specified number of random bytes. + * @see \yii\base\Security::generateRandomKey + * * @method static string generateRandomString(int $length = 32) Generates a random string of specified length. - * @method static array[] getAllowedCiphers() Returns Look-up table of block sizes and key sizes for each supported OpenSSL cipher. - * @method static string getAuthKeyInfo() Returns HKDF info value for derivation of message authentication key. + * @see \yii\base\Security::generateRandomString + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. - * @method static string getCipher() Returns The cipher to use for encryption and decryption. - * @method static int getDerivationIterations() Returns derivation iterations count. - * @method static string getKdfHash() Returns Hash algorithm for key derivation. - * @method static string getMacHash() Returns Hash algorithm for message authentication. - * @method static int getPasswordHashCost() Returns Default cost used for password hashing. - * @method static string getPasswordHashStrategy() Returns strategy, which should be used to generate password hash. + * @see \yii\base\Component::getBehaviors + * * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * * @method static string hashData(string $data, string $key, bool $rawHash = false) Prefixes data with a keyed hash value so that it can later be detected if it is tampered. + * @see \yii\base\Security::hashData + * * @method static string hkdf(string $algo, string $inputKey, string $salt = null, string $info = null, int $length = 0) Derives a key from the given input key using the standard HKDF algorithm. + * @see \yii\base\Security::hkdf + * * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * * @method static string pbkdf2(string $algo, string $password, string $salt, int $iterations, int $length = 0) Derives a key from the given password using the standard PBKDF2 algorithm. - * @method static setAllowedCiphers(array[] $value) Sets Look-up table of block sizes and key sizes for each supported OpenSSL cipher. - * @method static setAuthKeyInfo(string $value) Sets HKDF info value for derivation of message authentication key. - * @method static setCipher(string $value) Sets The cipher to use for encryption and decryption. - * @method static setDerivationIterations(int $value) Sets derivation iterations count. - * @method static setKdfHash(string $value) Sets Hash algorithm for key derivation. - * @method static setMacHash(string $value) Sets Hash algorithm for message authentication. - * @method static setPasswordHashCost(int $value) Sets Default cost used for password hashing. - * @method static setPasswordHashStrategy(string $value) Sets strategy, which should be used to generate password hash. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Security::pbkdf2 + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * * @method static string validateData(string $data, string $key, bool $rawHash = false) Validates if the given data is tampered. + * @see \yii\base\Security::validateData + * * @method static bool validatePassword(string $password, string $hash) Verifies a password against a hash. + * @see \yii\base\Security::validatePassword + * + * Property accessors + * + * @method static array[] getAllowedCiphers() Returns Look-up table of block sizes and key sizes for each supported OpenSSL cipher. + * @see \yii\base\Security::allowedCiphers + * + * @method static string getAuthKeyInfo() Returns HKDF info value for derivation of message authentication key. + * @see \yii\base\Security::authKeyInfo + * + * @method static string getCipher() Returns The cipher to use for encryption and decryption. + * @see \yii\base\Security::cipher + * + * @method static int getDerivationIterations() Returns derivation iterations count. + * @see \yii\base\Security::derivationIterations + * + * @method static string getKdfHash() Returns Hash algorithm for key derivation. + * @see \yii\base\Security::kdfHash + * + * @method static string getMacHash() Returns Hash algorithm for message authentication. + * @see \yii\base\Security::macHash + * + * @method static int getPasswordHashCost() Returns Default cost used for password hashing. + * @see \yii\base\Security::passwordHashCost + * + * @method static string getPasswordHashStrategy() Returns strategy, which should be used to generate password hash. + * @see \yii\base\Security::passwordHashStrategy + * + * @method static void setAllowedCiphers(array[] $value) Sets Look-up table of block sizes and key sizes for each supported OpenSSL cipher. + * @see \yii\base\Security::allowedCiphers + * + * @method static void setAuthKeyInfo(string $value) Sets HKDF info value for derivation of message authentication key. + * @see \yii\base\Security::authKeyInfo + * + * @method static void setCipher(string $value) Sets The cipher to use for encryption and decryption. + * @see \yii\base\Security::cipher + * + * @method static void setDerivationIterations(int $value) Sets derivation iterations count. + * @see \yii\base\Security::derivationIterations + * + * @method static void setKdfHash(string $value) Sets Hash algorithm for key derivation. + * @see \yii\base\Security::kdfHash + * + * @method static void setMacHash(string $value) Sets Hash algorithm for message authentication. + * @see \yii\base\Security::macHash + * + * @method static void setPasswordHashCost(int $value) Sets Default cost used for password hashing. + * @see \yii\base\Security::passwordHashCost + * + * @method static void setPasswordHashStrategy(string $value) Sets strategy, which should be used to generate password hash. + * @see \yii\base\Security::passwordHashStrategy */ class Security extends Facade { diff --git a/Session.php b/Session.php index 5b3be56..9937c63 100644 --- a/Session.php +++ b/Session.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,71 +13,191 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * Session facade. + * Yii::$app->get('session') facade. + * + * Methods * - * Facades Yii::$app->get('session') component. + * @method static void addFlash(string $key, mixed $value = true, bool $removeAfterAccess = true) Adds a flash message. + * @see \yii\web\Session::addFlash * - * @see \yii\web\Session - * @method static addFlash(string $key, mixed $value = true, bool $removeAfterAccess = true) Adds a flash message. * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. - * @method static close() Ends the current session and store session data. + * @see \yii\base\Component::behaviors + * + * @method static void close() Ends the current session and store session data. + * @see \yii\web\Session::close + * * @method static bool closeSession() Session close handler. + * @see \yii\web\Session::closeSession + * * @method static int count() Returns the number of items in the session. - * @method static destroy() Frees all session variables and destroys all data registered to a session. + * @see \yii\web\Session::count + * + * @method static void destroy() Frees all session variables and destroys all data registered to a session. + * @see \yii\web\Session::destroy + * * @method static bool destroySession(string $id) Session destroy handler. + * @see \yii\web\Session::destroySession + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static bool gcSession(int $maxLifetime) Session GC (garbage collection) handler. + * @see \yii\web\Session::gcSession + * * @method static mixed get(string $key, mixed $defaultValue = null) Returns the session variable value with the session variable name. + * @see \yii\web\Session::get + * * @method static array getAllFlashes(bool $delete = false) Returns all flash messages. + * @see \yii\web\Session::getAllFlashes + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\base\Component::getBehaviors + * * @method static array getCookieParams() + * @see \yii\web\Session::getCookieParams + * * @method static int getCount() Returns the number of items in the session. + * @see \yii\web\Session::getCount + * * @method static mixed getFlash(string $key, mixed $defaultValue = null, bool $delete = false) Returns a flash message. - * @method static string getFlashParam() Returns the name of the session variable that stores the flash message data. + * @see \yii\web\Session::getFlash + * * @method static float getGCProbability() - * @method static \SessionHandlerInterface|array getHandler() Returns an object implementing the SessionHandlerInterface or a configuration array. + * @see \yii\web\Session::getGCProbability + * * @method static bool getHasSessionId() Returns a value indicating whether the current request has sent the session ID. + * @see \yii\web\Session::getHasSessionId + * * @method static string getId() Gets the session ID. + * @see \yii\web\Session::getId + * * @method static bool getIsActive() + * @see \yii\web\Session::getIsActive + * * @method static string getName() Gets the name of the current session. + * @see \yii\web\Session::getName + * * @method static string getSavePath() Gets the current session save path. + * @see \yii\web\Session::getSavePath + * * @method static int getTimeout() + * @see \yii\web\Session::getTimeout + * * @method static bool|null getUseCookies() Returns the value indicating whether cookies should be used to store session IDs. + * @see \yii\web\Session::getUseCookies + * * @method static bool getUseCustomStorage() Returns a value indicating whether to use custom session storage. + * @see \yii\web\Session::getUseCustomStorage + * * @method static bool getUseTransparentSessionID() + * @see \yii\web\Session::getUseTransparentSessionID + * * @method static bool has(mixed $key) + * @see \yii\web\Session::has + * * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * * @method static bool hasFlash(string $key) Returns a value indicating whether there are flash messages associated with the specified key. + * @see \yii\web\Session::hasFlash + * * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. - * @method static open() Starts the session. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * + * @method static void open() Starts the session. + * @see \yii\web\Session::open + * * @method static bool openSession(string $savePath, string $sessionName) Session open handler. + * @see \yii\web\Session::openSession + * * @method static string readSession(string $id) Session read handler. - * @method static regenerateID(bool $deleteOldSession = false) Updates the current session ID with a newly generated one . + * @see \yii\web\Session::readSession + * + * @method static void regenerateID(bool $deleteOldSession = false) Updates the current session ID with a newly generated one . + * @see \yii\web\Session::regenerateID + * * @method static mixed remove(string $key) Removes a session variable. - * @method static removeAll() Removes all session variables. - * @method static removeAllFlashes() Removes all flash messages. + * @see \yii\web\Session::remove + * + * @method static void removeAll() Removes all session variables. + * @see \yii\web\Session::removeAll + * + * @method static void removeAllFlashes() Removes all flash messages. + * @see \yii\web\Session::removeAllFlashes + * * @method static mixed removeFlash(string $key) Removes a flash message. - * @method static set(string $key, mixed $value) Adds a session variable. - * @method static setCookieParams(array $value) Sets the session cookie parameters. - * @method static setFlash(string $key, mixed $value = true, bool $removeAfterAccess = true) Sets a flash message. - * @method static setFlashParam(string $value) Sets the name of the session variable that stores the flash message data. - * @method static setGCProbability(float $value) - * @method static setHandler(\SessionHandlerInterface|array $value) Sets an object implementing the SessionHandlerInterface or a configuration array. - * @method static setHasSessionId(bool $value) Sets the value indicating whether the current request has sent the session ID. - * @method static setId(string $value) Sets the session ID. - * @method static setName(string $value) Sets the name for the current session. - * @method static setSavePath(string $value) Sets the current session save path. - * @method static setTimeout(int $value) - * @method static setUseCookies(bool|null $value) Sets the value indicating whether cookies should be used to store session IDs. - * @method static setUseTransparentSessionID(bool $value) - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\web\Session::removeFlash + * + * @method static void set(string $key, mixed $value) Adds a session variable. + * @see \yii\web\Session::set + * + * @method static void setCookieParams(array $value) Sets the session cookie parameters. + * @see \yii\web\Session::setCookieParams + * + * @method static void setFlash(string $key, mixed $value = true, bool $removeAfterAccess = true) Sets a flash message. + * @see \yii\web\Session::setFlash + * + * @method static void setGCProbability(float $value) + * @see \yii\web\Session::setGCProbability + * + * @method static void setHasSessionId(bool $value) Sets the value indicating whether the current request has sent the session ID. + * @see \yii\web\Session::setHasSessionId + * + * @method static void setId(string $value) Sets the session ID. + * @see \yii\web\Session::setId + * + * @method static void setName(string $value) Sets the name for the current session. + * @see \yii\web\Session::setName + * + * @method static void setSavePath(string $value) Sets the current session save path. + * @see \yii\web\Session::setSavePath + * + * @method static void setTimeout(int $value) + * @see \yii\web\Session::setTimeout + * + * @method static void setUseCookies(bool|null $value) Sets the value indicating whether cookies should be used to store session IDs. + * @see \yii\web\Session::setUseCookies + * + * @method static void setUseTransparentSessionID(bool $value) + * @see \yii\web\Session::setUseTransparentSessionID + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * * @method static bool writeSession(string $id, string $data) Session write handler. + * @see \yii\web\Session::writeSession + * + * Property accessors + * + * @method static string getFlashParam() Returns the name of the session variable that stores the flash message data. + * @see \yii\web\Session::flashParam + * + * @method static \SessionHandlerInterface|array getHandler() Returns an object implementing the SessionHandlerInterface or a configuration array. + * @see \yii\web\Session::handler + * + * @method static void setFlashParam(string $value) Sets the name of the session variable that stores the flash message data. + * @see \yii\web\Session::flashParam + * + * @method static void setHandler(\SessionHandlerInterface|array $value) Sets an object implementing the SessionHandlerInterface or a configuration array. + * @see \yii\web\Session::handler */ class Session extends Facade { diff --git a/User.php b/User.php index 1c40bf4..74344e6 100644 --- a/User.php +++ b/User.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,63 +13,167 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * User facade. + * Yii::$app->get('user') facade. * - * Facades Yii::$app->get('user') component. + * Methods * - * @see \yii\web\User * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. + * @see \yii\base\Component::behaviors + * * @method static bool can(string $permissionName, array $params = [], bool $allowCaching = true) Checks if the user can perform the operation as specified by the given permission. + * @see \yii\web\User::can + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * + * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * + * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\base\Component::getBehaviors + * + * @method static string|int getId() Returns a value that uniquely represents the user. + * @see \yii\web\User::getId + * + * @method static \yii\web\IdentityInterface|null getIdentity(bool $autoRenew = true) Returns the identity object associated with the currently logged-in user. + * @see \yii\web\User::getIdentity + * + * @method static bool getIsGuest() Returns a value indicating whether the user is a guest (not authenticated). + * @see \yii\web\User::getIsGuest + * + * @method static string getReturnUrl(string|array $defaultUrl = null) Returns the URL that the browser should be redirected to after successful login. + * @see \yii\web\User::getReturnUrl + * + * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * + * @method static bool login(\yii\web\IdentityInterface $identity, int $duration = 0) Logs in a user. + * @see \yii\web\User::login + * + * @method static \yii\web\IdentityInterface|null loginByAccessToken(string $token, mixed $type = null) Logs in a user by the given access token. + * @see \yii\web\User::loginByAccessToken + * + * @method static \yii\web\Response loginRequired(bool $checkAjax = true, bool $checkAcceptHeader = true) Redirects the user browser to the login page. + * @see \yii\web\User::loginRequired + * + * @method static bool logout(bool $destroySession = true) Logs out the current user. + * @see \yii\web\User::logout + * + * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * + * @method static void setIdentity(\yii\web\IdentityInterface|null $identity) Sets the user identity object. + * @see \yii\web\User::setIdentity + * + * @method static void setReturnUrl(string|array $url) Remembers the URL in the session so that it can be retrieved back later by [[getReturnUrl()]]. + * @see \yii\web\User::setReturnUrl + * + * @method static void switchIdentity(\yii\web\IdentityInterface|null $identity, int $duration = 0) Switches to a new identity for the current user. + * @see \yii\web\User::switchIdentity + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * Property accessors + * * @method static int getAbsoluteAuthTimeout() Returns the number of seconds in which the user will be logged out automatically regardless of activity. + * @see \yii\web\User::absoluteAuthTimeout + * * @method static string getAbsoluteAuthTimeoutParam() Returns the session variable name used to store the value of absolute expiration timestamp of the authenticated state. + * @see \yii\web\User::absoluteAuthTimeoutParam + * * @method static array getAcceptableRedirectTypes() Returns MIME types for which this component should redirect to the [[loginUrl]]. - * @method static \yii\rbac\CheckAccessInterface getAccessChecker() Returns The acess checker to use for checking access. + * @see \yii\web\User::acceptableRedirectTypes + * + * @method static \yii\rbac\CheckAccessInterface getAccessChecker() Returns The access checker to use for checking access. + * @see \yii\web\User::accessChecker + * * @method static int getAuthTimeout() Returns the number of seconds in which the user will be logged out automatically if he remains inactive. + * @see \yii\web\User::authTimeout + * * @method static string getAuthTimeoutParam() Returns the session variable name used to store the value of expiration timestamp of the authenticated state. + * @see \yii\web\User::authTimeoutParam + * * @method static bool getAutoRenewCookie() Returns whether to automatically renew the identity cookie each time a page is requested. - * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. - * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\web\User::autoRenewCookie + * * @method static bool getEnableAutoLogin() Returns whether to enable cookie-based login. + * @see \yii\web\User::enableAutoLogin + * * @method static bool getEnableSession() Returns whether to use session to persist authentication status across multiple requests. - * @method static string|int getId() Returns a value that uniquely represents the user. + * @see \yii\web\User::enableSession + * * @method static string getIdParam() Returns the session variable name used to store the value of [[id]]. - * @method static \yii\web\IdentityInterface|null getIdentity(bool $autoRenew = true) Returns the identity object associated with the currently logged-in user. + * @see \yii\web\User::idParam + * * @method static string getIdentityClass() Returns the class name of the [[identity]] object. + * @see \yii\web\User::identityClass + * * @method static array getIdentityCookie() Returns the configuration of the identity cookie. - * @method static bool getIsGuest() Returns a value indicating whether the user is a guest (not authenticated). + * @see \yii\web\User::identityCookie + * * @method static string|array getLoginUrl() Returns the URL for login when [[loginRequired()]] is called. - * @method static string getReturnUrl(string|array $defaultUrl = null) Returns the URL that the browser should be redirected to after successful login. + * @see \yii\web\User::loginUrl + * * @method static string getReturnUrlParam() Returns the session variable name used to store the value of [[returnUrl]]. - * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. - * @method static bool login(\yii\web\IdentityInterface $identity, int $duration = 0) Logs in a user. - * @method static \yii\web\IdentityInterface|null loginByAccessToken(string $token, mixed $type = null) Logs in a user by the given access token. - * @method static \yii\web\Response loginRequired(bool $checkAjax = true, bool $checkAcceptHeader = true) Redirects the user browser to the login page. - * @method static bool logout(bool $destroySession = true) Logs out the current user. - * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. - * @method static setAbsoluteAuthTimeout(int $value) Sets the number of seconds in which the user will be logged out automatically regardless of activity. - * @method static setAbsoluteAuthTimeoutParam(string $value) Sets the session variable name used to store the value of absolute expiration timestamp of the authenticated state. - * @method static setAcceptableRedirectTypes(array $value) Sets MIME types for which this component should redirect to the [[loginUrl]]. - * @method static setAccessChecker(\yii\rbac\CheckAccessInterface $value) Sets The acess checker to use for checking access. - * @method static setAuthTimeout(int $value) Sets the number of seconds in which the user will be logged out automatically if he remains inactive. - * @method static setAuthTimeoutParam(string $value) Sets the session variable name used to store the value of expiration timestamp of the authenticated state. - * @method static setAutoRenewCookie(bool $value) Sets whether to automatically renew the identity cookie each time a page is requested. - * @method static setEnableAutoLogin(bool $value) Sets whether to enable cookie-based login. - * @method static setEnableSession(bool $value) Sets whether to use session to persist authentication status across multiple requests. - * @method static setIdParam(string $value) Sets the session variable name used to store the value of [[id]]. - * @method static setIdentity(\yii\web\IdentityInterface|null $identity) Sets the user identity object. - * @method static setIdentityClass(string $value) Sets the class name of the [[identity]] object. - * @method static setIdentityCookie(array $value) Sets the configuration of the identity cookie. - * @method static setLoginUrl(string|array $value) Sets the URL for login when [[loginRequired()]] is called. - * @method static setReturnUrl(string|array $url) Remembers the URL in the session so that it can be retrieved back later by [[getReturnUrl()]]. - * @method static setReturnUrlParam(string $value) Sets the session variable name used to store the value of [[returnUrl]]. - * @method static switchIdentity(\yii\web\IdentityInterface|null $identity, int $duration = 0) Switches to a new identity for the current user. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\web\User::returnUrlParam + * + * @method static void setAbsoluteAuthTimeout(int $value) Sets the number of seconds in which the user will be logged out automatically regardless of activity. + * @see \yii\web\User::absoluteAuthTimeout + * + * @method static void setAbsoluteAuthTimeoutParam(string $value) Sets the session variable name used to store the value of absolute expiration timestamp of the authenticated state. + * @see \yii\web\User::absoluteAuthTimeoutParam + * + * @method static void setAcceptableRedirectTypes(array $value) Sets MIME types for which this component should redirect to the [[loginUrl]]. + * @see \yii\web\User::acceptableRedirectTypes + * + * @method static void setAccessChecker(\yii\rbac\CheckAccessInterface $value) Sets The access checker to use for checking access. + * @see \yii\web\User::accessChecker + * + * @method static void setAuthTimeout(int $value) Sets the number of seconds in which the user will be logged out automatically if he remains inactive. + * @see \yii\web\User::authTimeout + * + * @method static void setAuthTimeoutParam(string $value) Sets the session variable name used to store the value of expiration timestamp of the authenticated state. + * @see \yii\web\User::authTimeoutParam + * + * @method static void setAutoRenewCookie(bool $value) Sets whether to automatically renew the identity cookie each time a page is requested. + * @see \yii\web\User::autoRenewCookie + * + * @method static void setEnableAutoLogin(bool $value) Sets whether to enable cookie-based login. + * @see \yii\web\User::enableAutoLogin + * + * @method static void setEnableSession(bool $value) Sets whether to use session to persist authentication status across multiple requests. + * @see \yii\web\User::enableSession + * + * @method static void setIdParam(string $value) Sets the session variable name used to store the value of [[id]]. + * @see \yii\web\User::idParam + * + * @method static void setIdentityClass(string $value) Sets the class name of the [[identity]] object. + * @see \yii\web\User::identityClass + * + * @method static void setIdentityCookie(array $value) Sets the configuration of the identity cookie. + * @see \yii\web\User::identityCookie + * + * @method static void setLoginUrl(string|array $value) Sets the URL for login when [[loginRequired()]] is called. + * @see \yii\web\User::loginUrl + * + * @method static void setReturnUrlParam(string $value) Sets the session variable name used to store the value of [[returnUrl]]. + * @see \yii\web\User::returnUrlParam */ class User extends Facade { diff --git a/View.php b/View.php index 6146914..77f0fe3 100644 --- a/View.php +++ b/View.php @@ -2,6 +2,8 @@ /** * Facades for Yii 2 * + * Generated on Yii 2.0.10 + * * @see https://github.com/sergeymakinen/yii2-facades * @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru) * @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License @@ -11,84 +13,230 @@ /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ /** - * View facade. + * Yii::$app->get('view') facade. + * + * Methods * - * Facades Yii::$app->get('view') component. + * @method static void addDynamicPlaceholder(string $placeholder, string $statements) Adds a placeholder for dynamic content. + * @see \yii\base\View::addDynamicPlaceholder * - * @see \yii\web\View - * @method static addDynamicPlaceholder(string $placeholder, string $statements) Adds a placeholder for dynamic content. * @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. - * @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehavior + * + * @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. + * @see \yii\base\Component::attachBehaviors + * * @method static \yii\widgets\Block beginBlock(string $id, bool $renderInPlace = false) Begins recording a block. - * @method static beginBody() Marks the beginning of an HTML body section. + * @see \yii\base\View::beginBlock + * + * @method static void beginBody() Marks the beginning of an HTML body section. + * @see \yii\web\View::beginBody + * * @method static bool beginCache(string $id, array $properties = []) Begins fragment caching. + * @see \yii\base\View::beginCache + * * @method static \yii\widgets\ContentDecorator beginContent(string $viewFile, array $params = []) Begins the rendering of content that is to be decorated by the specified view. - * @method static beginPage() Marks the beginning of a page. + * @see \yii\base\View::beginContent + * + * @method static void beginPage() Marks the beginning of a page. + * @see \yii\base\View::beginPage + * * @method static array behaviors() Returns a list of behaviors that this component should behave as. - * @method static clear() Clears up the registered meta tags, link tags, css/js scripts and files. + * @see \yii\base\Component::behaviors + * + * @method static void clear() Clears up the registered meta tags, link tags, css/js scripts and files. + * @see \yii\web\View::clear + * * @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. - * @method static detachBehaviors() Detaches all behaviors from the component. - * @method static endBlock() Ends recording a block. - * @method static endBody() Marks the ending of an HTML body section. - * @method static endCache() Ends fragment caching. - * @method static endContent() Ends the rendering of content. - * @method static endPage(bool $ajaxMode = false) Marks the ending of an HTML page. - * @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::detachBehavior + * + * @method static void detachBehaviors() Detaches all behaviors from the component. + * @see \yii\base\Component::detachBehaviors + * + * @method static void endBlock() Ends recording a block. + * @see \yii\base\View::endBlock + * + * @method static void endBody() Marks the ending of an HTML body section. + * @see \yii\web\View::endBody + * + * @method static void endCache() Ends fragment caching. + * @see \yii\base\View::endCache + * + * @method static void endContent() Ends the rendering of content. + * @see \yii\base\View::endContent + * + * @method static void endPage(bool $ajaxMode = false) Marks the ending of an HTML page. + * @see \yii\web\View::endPage + * + * @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. + * @see \yii\base\Component::ensureBehaviors + * * @method static mixed evaluateDynamicContent(string $statements) Evaluates the given PHP statements. - * @method static \yii\web\AssetBundle[] getAssetBundles() Returns list of the registered asset bundles. + * @see \yii\base\View::evaluateDynamicContent + * * @method static \yii\web\AssetManager getAssetManager() Registers the asset manager being used by this view object. + * @see \yii\web\View::getAssetManager + * * @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. + * @see \yii\base\Component::getBehavior + * * @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. + * @see \yii\base\Component::getBehaviors + * + * @method static string|bool getViewFile() + * @see \yii\base\View::getViewFile + * + * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. + * @see \yii\base\Component::hasEventHandlers + * + * @method static void head() Marks the position of an HTML head section. + * @see \yii\web\View::head + * + * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. + * @see \yii\base\Component::off + * + * @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. + * @see \yii\base\Component::on + * + * @method static \yii\web\AssetBundle registerAssetBundle(string $name, int|null $position = null) Registers the named asset bundle. + * @see \yii\web\View::registerAssetBundle + * + * @method static void registerCss(string $css, array $options = [], string $key = null) Registers a CSS code block. + * @see \yii\web\View::registerCss + * + * @method static void registerCssFile(string $url, array $options = [], string $key = null) Registers a CSS file. + * @see \yii\web\View::registerCssFile + * + * @method static void registerJs(string $js, int $position = 4, string $key = null) Registers a JS code block. + * @see \yii\web\View::registerJs + * + * @method static void registerJsFile(string $url, array $options = [], string $key = null) Registers a JS file. + * @see \yii\web\View::registerJsFile + * + * @method static void registerLinkTag(array $options, string $key = null) Registers a link tag. + * @see \yii\web\View::registerLinkTag + * + * @method static void registerMetaTag(array $options, string $key = null) Registers a meta tag. + * @see \yii\web\View::registerMetaTag + * + * @method static string render(string $view, array $params = [], object $context = null) Renders a view. + * @see \yii\base\View::render + * + * @method static string renderAjax(string $view, array $params = [], object $context = null) Renders a view in response to an AJAX request. + * @see \yii\web\View::renderAjax + * + * @method static string renderDynamic(string $statements) Renders dynamic content returned by the given PHP statements. + * @see \yii\base\View::renderDynamic + * + * @method static string renderFile(string $viewFile, array $params = [], object $context = null) Renders a view file. + * @see \yii\base\View::renderFile + * + * @method static string renderPhpFile(string $_file_, array $_params_ = []) Renders a view file as a PHP script. + * @see \yii\base\View::renderPhpFile + * + * @method static void setAssetManager(\yii\web\AssetManager $value) Sets the asset manager. + * @see \yii\web\View::setAssetManager + * + * @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\base\Component::trigger + * + * Property accessors + * + * @method static \yii\web\AssetBundle[] getAssetBundles() Returns list of the registered asset bundles. + * @see \yii\web\View::assetBundles + * * @method static array getBlocks() Returns a list of named output blocks. + * @see \yii\base\View::blocks + * * @method static array getCacheStack() Returns a list of currently active fragment cache widgets. + * @see \yii\base\View::cacheStack + * * @method static \yii\base\ViewContextInterface getContext() Returns the context under which the [[renderFile()]] method is being invoked. + * @see \yii\base\View::context + * * @method static array getCss() Returns the registered CSS code blocks. + * @see \yii\web\View::css + * * @method static array getCssFiles() Returns the registered CSS files. + * @see \yii\web\View::cssFiles + * * @method static string getDefaultExtension() Returns the default view file extension. + * @see \yii\base\View::defaultExtension + * * @method static array getDynamicPlaceholders() Returns a list of placeholders for embedding dynamic contents. + * @see \yii\base\View::dynamicPlaceholders + * * @method static array getJs() Returns the registered JS code blocks. + * @see \yii\web\View::js + * * @method static array getJsFiles() Returns the registered JS files. + * @see \yii\web\View::jsFiles + * * @method static array getLinkTags() Returns the registered link tags. + * @see \yii\web\View::linkTags + * * @method static array getMetaTags() Returns the registered meta tags. + * @see \yii\web\View::metaTags + * * @method static mixed getParams() Returns custom parameters that are shared among view templates. + * @see \yii\base\View::params + * * @method static array getRenderers() Returns a list of available renderers indexed by their corresponding supported file extensions. + * @see \yii\base\View::renderers + * * @method static \yii\base\Theme|array|string getTheme() Returns the theme object or the configuration for creating the theme object. + * @see \yii\base\View::theme + * * @method static string getTitle() Returns the page title. - * @method static string|bool getViewFile() - * @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. - * @method static head() Marks the position of an HTML head section. - * @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. - * @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. - * @method static \yii\web\AssetBundle registerAssetBundle(string $name, int|null $position = null) Registers the named asset bundle. - * @method static registerCss(string $css, array $options = [], string $key = null) Registers a CSS code block. - * @method static registerCssFile(string $url, array $options = [], string $key = null) Registers a CSS file. - * @method static registerJs(string $js, int $position = 4, string $key = null) Registers a JS code block. - * @method static registerJsFile(string $url, array $options = [], string $key = null) Registers a JS file. - * @method static registerLinkTag(array $options, string $key = null) Registers a link tag. - * @method static registerMetaTag(array $options, string $key = null) Registers a meta tag. - * @method static string render(string $view, array $params = [], object $context = null) Renders a view. - * @method static string renderAjax(string $view, array $params = [], object $context = null) Renders a view in response to an AJAX request. - * @method static string renderDynamic(string $statements) Renders dynamic content returned by the given PHP statements. - * @method static string renderFile(string $viewFile, array $params = [], object $context = null) Renders a view file. - * @method static string renderPhpFile(string $_file_, array $_params_ = []) Renders a view file as a PHP script. - * @method static setAssetBundles(\yii\web\AssetBundle[] $value) Sets list of the registered asset bundles. - * @method static setAssetManager(\yii\web\AssetManager $value) Sets the asset manager. - * @method static setBlocks(array $value) Sets a list of named output blocks. - * @method static setCacheStack(array $value) Sets a list of currently active fragment cache widgets. - * @method static setContext(\yii\base\ViewContextInterface $value) Sets the context under which the [[renderFile()]] method is being invoked. - * @method static setCss(array $value) Sets the registered CSS code blocks. - * @method static setCssFiles(array $value) Sets the registered CSS files. - * @method static setDefaultExtension(string $value) Sets the default view file extension. - * @method static setDynamicPlaceholders(array $value) Sets a list of placeholders for embedding dynamic contents. - * @method static setJs(array $value) Sets the registered JS code blocks. - * @method static setJsFiles(array $value) Sets the registered JS files. - * @method static setLinkTags(array $value) Sets the registered link tags. - * @method static setMetaTags(array $value) Sets the registered meta tags. - * @method static setParams(mixed $value) Sets custom parameters that are shared among view templates. - * @method static setRenderers(array $value) Sets a list of available renderers indexed by their corresponding supported file extensions. - * @method static setTheme(\yii\base\Theme|array|string $value) Sets the theme object or the configuration for creating the theme object. - * @method static setTitle(string $value) Sets the page title. - * @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event. + * @see \yii\web\View::title + * + * @method static void setAssetBundles(\yii\web\AssetBundle[] $value) Sets list of the registered asset bundles. + * @see \yii\web\View::assetBundles + * + * @method static void setBlocks(array $value) Sets a list of named output blocks. + * @see \yii\base\View::blocks + * + * @method static void setCacheStack(array $value) Sets a list of currently active fragment cache widgets. + * @see \yii\base\View::cacheStack + * + * @method static void setContext(\yii\base\ViewContextInterface $value) Sets the context under which the [[renderFile()]] method is being invoked. + * @see \yii\base\View::context + * + * @method static void setCss(array $value) Sets the registered CSS code blocks. + * @see \yii\web\View::css + * + * @method static void setCssFiles(array $value) Sets the registered CSS files. + * @see \yii\web\View::cssFiles + * + * @method static void setDefaultExtension(string $value) Sets the default view file extension. + * @see \yii\base\View::defaultExtension + * + * @method static void setDynamicPlaceholders(array $value) Sets a list of placeholders for embedding dynamic contents. + * @see \yii\base\View::dynamicPlaceholders + * + * @method static void setJs(array $value) Sets the registered JS code blocks. + * @see \yii\web\View::js + * + * @method static void setJsFiles(array $value) Sets the registered JS files. + * @see \yii\web\View::jsFiles + * + * @method static void setLinkTags(array $value) Sets the registered link tags. + * @see \yii\web\View::linkTags + * + * @method static void setMetaTags(array $value) Sets the registered meta tags. + * @see \yii\web\View::metaTags + * + * @method static void setParams(mixed $value) Sets custom parameters that are shared among view templates. + * @see \yii\base\View::params + * + * @method static void setRenderers(array $value) Sets a list of available renderers indexed by their corresponding supported file extensions. + * @see \yii\base\View::renderers + * + * @method static void setTheme(\yii\base\Theme|array|string $value) Sets the theme object or the configuration for creating the theme object. + * @see \yii\base\View::theme + * + * @method static void setTitle(string $value) Sets the page title. + * @see \yii\web\View::title */ class View extends Facade {