{"$schema":"https://yii2-framework.github.io/docs/reference/reference.schema.json","schemaVersion":1,"package":"yii2","title":"Yii 22.0","repository":"https://github.com/yiisoft/yii2","ref":"22.0","commit":"f126a8bfdbb83540656229be834cfd0bb3cf4ac0","generatedAt":"2026-10-18","url":"https://yii2-framework.github.io/docs/api/","types":{"Yii":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/global/yii/","summary":"Yii is a helper class serving common framework functionalities.","since":"2.0","extends":"yii\\BaseYii","inherited":{"properties":{"aliases":"yii\\BaseYii","app":"yii\\BaseYii","container":"yii\\BaseYii"},"methods":{"beginProfile":"yii\\BaseYii","configure":"yii\\BaseYii","createObject":"yii\\BaseYii","debug":"yii\\BaseYii","endProfile":"yii\\BaseYii","error":"yii\\BaseYii","getAlias":"yii\\BaseYii","getLogger":"yii\\BaseYii","getObjectVars":"yii\\BaseYii","getRootAlias":"yii\\BaseYii","getVersion":"yii\\BaseYii","info":"yii\\BaseYii","setAlias":"yii\\BaseYii","setLogger":"yii\\BaseYii","t":"yii\\BaseYii","warning":"yii\\BaseYii"}}},"YiiRequirementChecker":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/global/yiirequirementchecker/","summary":"YiiRequirementChecker allows checking, if current system meets the requirements for running the Yii application.","since":"2.0","properties":{"result":{"type":"array|null","default":"null","description":"The check results, this property is for internal usage only."}},"methods":{"check":{"signature":"public function check(array|string $requirements): $this","summary":"Check the given requirements, collecting results into internal field.","params":[{"name":"$requirements","type":"array|string","description":"Requirements to be checked. If an array, it is treated as the set of requirements; If a string, it is treated as the path of the file, which contains the requirements;"}],"return":{"type":"$this","description":"Self instance."}},"checkPhpExtensionVersion":{"signature":"public function checkPhpExtensionVersion(string $extensionName, string $version, string $compare = '>='): bool","summary":"Checks if the given PHP extension is available and its version matches the given one.","params":[{"name":"$extensionName","type":"string","description":"PHP extension name."},{"name":"$version","type":"string","description":"Required PHP extension version."},{"name":"$compare","type":"string","default":"'>='","optional":true,"description":"Comparison operator, by default '>='"}],"return":{"type":"bool","description":"If PHP extension version matches."}},"checkPhpIniOff":{"signature":"public function checkPhpIniOff(string $name): bool","summary":"Checks if PHP configuration option (from php.ini) is off.","params":[{"name":"$name","type":"string","description":"Configuration option name."}],"return":{"type":"bool","description":"Option is off."}},"checkPhpIniOn":{"signature":"public function checkPhpIniOn(string $name): bool","summary":"Checks if PHP configuration option (from php.ini) is on.","params":[{"name":"$name","type":"string","description":"Configuration option name."}],"return":{"type":"bool","description":"Option is on."}},"checkUploadMaxFileSize":{"signature":"public function checkUploadMaxFileSize(string|null $min = \\null, string|null $max = \\null): bool","summary":"Checks if upload max file size matches the given range.","params":[{"name":"$min","type":"string|null","default":"\\null","optional":true,"description":"Verbose file size minimum required value, pass null to skip minimum check."},{"name":"$max","type":"string|null","default":"\\null","optional":true,"description":"Verbose file size maximum required value, pass null to skip maximum check."}],"return":{"type":"bool","description":"Success."}},"checkYii":{"signature":"public function checkYii(): YiiRequirementChecker","summary":"Performs the check for the Yii core requirements.","return":{"type":"YiiRequirementChecker","description":"Self instance."}},"compareByteSize":{"signature":"public function compareByteSize(string $a, string $b, string $compare = '>='): bool","summary":"Compare byte sizes of values given in the verbose representation, like '5M', '15K' etc.","params":[{"name":"$a","type":"string","description":"First value."},{"name":"$b","type":"string","description":"Second value."},{"name":"$compare","type":"string","default":"'>='","optional":true,"description":"Comparison operator, by default '>='."}],"return":{"type":"bool","description":"Comparison result."}},"evaluateExpression":{"signature":"public function evaluateExpression(string $expression): mixed","summary":"Evaluates a PHP expression under the context of this class.","params":[{"name":"$expression","type":"string","description":"A PHP expression to be evaluated."}],"return":{"type":"mixed","description":"The expression result."}},"getByteSize":{"signature":"public function getByteSize(string $verboseSize): int","summary":"Gets the size in bytes from verbose size representation.","params":[{"name":"$verboseSize","type":"string","description":"Verbose size representation."}],"return":{"type":"int","description":"Actual size in bytes."}},"getNowDate":{"signature":"public function getNowDate(): string","summary":"Returns the now date if possible in string representation.","return":{"type":"string","description":"Now date."}},"getResult":{"signature":"public function getResult(): array|null","summary":"Return the check results.","return":{"type":"array|null","description":"Check results in format: ``` array( 'summary' => array( 'total' => total number of checks, 'errors' => number of errors, 'warnings' => number of warnings, ), 'requirements' => array( array( ... 'error' => is there an error, 'warning' => is there a warning, ), ... ), ) ```"}},"getServerInfo":{"signature":"public function getServerInfo(): string","summary":"Returns the server information.","return":{"type":"string","description":"Server information."}},"normalizeRequirement":{"signature":"public function normalizeRequirement(array $requirement, int $requirementKey = 0): array","summary":"Normalizes requirement ensuring it has correct format.","params":[{"name":"$requirement","type":"array","description":"Raw requirement."},{"name":"$requirementKey","type":"int","default":"0","optional":true,"description":"Requirement key in the list."}],"return":{"type":"array","description":"Normalized requirement."}},"render":{"signature":"public function render(): mixed","summary":"Renders the requirements check result.","return":{"type":"mixed"}},"renderViewFile":{"signature":"public function renderViewFile(string $_viewFile_, array|null $_data_ = \\null, bool $_return_ = \\false): string|null","summary":"Renders a view file.","params":[{"name":"$_viewFile_","type":"string","description":"View file"},{"name":"$_data_","type":"array|null","default":"\\null","optional":true,"description":"Data to be extracted and made available to the view file"},{"name":"$_return_","type":"bool","default":"\\false","optional":true,"description":"Whether the rendering result should be returned as a string"}],"return":{"type":"string|null","description":"The rendering result. Null if the rendering result is not required."}},"usageError":{"signature":"public function usageError(string $message): mixed","summary":"Displays a usage error.","params":[{"name":"$message","type":"string","description":"The error message"}],"return":{"type":"mixed"}}}},"yii\\BaseYii":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/baseyii/","summary":"BaseYii is the core helper class for the Yii framework.","since":"2.0","properties":{"aliases":{"type":"array","default":"['@yii' => __DIR__]","description":"Registered path aliases","static":true},"app":{"type":"yii\\console\\Application|yii\\web\\Application|null","default":"null","description":"The application instance","static":true},"container":{"type":"yii\\di\\Container","default":"null","description":"The dependency injection (DI) container used by `createObject()`.","static":true}},"methods":{"beginProfile":{"signature":"public static function beginProfile(string $token, string $category = 'application'): mixed","summary":"Marks the beginning of a code block for profiling.","params":[{"name":"$token","type":"string","description":"Token for the code block"},{"name":"$category","type":"string","default":"'application'","optional":true,"description":"The category of this log message"}],"return":{"type":"mixed"},"static":true},"configure":{"signature":"public static function configure(object $object, array $properties): object","summary":"Configures an object with the initial property values.","params":[{"name":"$object","type":"object","description":"The object to be configured"},{"name":"$properties","type":"array","description":"The property initial values given in terms of name-value pairs."}],"return":{"type":"object","description":"The object itself"},"static":true},"createObject":{"signature":"public static function createObject(class-string|array{class?: class-string, __class?: class-string}|callable(): yii\\T $type, array $params = []): yii\\T","summary":"Creates a new object using the given configuration.","params":[{"name":"$type","type":"class-string|array{class?: class-string, __class?: class-string}|callable(): yii\\T","description":"The object type. This can be specified in one of the following forms: - a string: representing the class name of the object to be created - a configuration array: the array must contain a `class` element which is treated as the object class, and the rest of the name-value pairs will be used to initialize the corresponding object properties - a PHP callable: either an anonymous function or an array representing a class method (`[$class or $object, $method]`). The callable should return a new instance of the object being created."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The constructor parameters"}],"return":{"type":"yii\\T","description":"The created object"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the configuration is invalid."}],"static":true},"debug":{"signature":"public static function debug(string|array $message, string $category = 'application'): mixed","summary":"Logs a debug message.","params":[{"name":"$message","type":"string|array","description":"The message to be logged. This can be a simple string or a more complex data structure, such as an array."},{"name":"$category","type":"string","default":"'application'","optional":true,"description":"The category of the message."}],"return":{"type":"mixed"},"static":true,"since":"2.0.14"},"endProfile":{"signature":"public static function endProfile(string $token, string $category = 'application'): mixed","summary":"Marks the end of a code block for profiling.","params":[{"name":"$token","type":"string","description":"Token for the code block"},{"name":"$category","type":"string","default":"'application'","optional":true,"description":"The category of this log message"}],"return":{"type":"mixed"},"static":true},"error":{"signature":"public static function error(string|array|Throwable $message, string $category = 'application'): mixed","summary":"Logs an error message.","params":[{"name":"$message","type":"string|array|Throwable","description":"The message to be logged. This can be a simple string or a more complex data structure, such as an array."},{"name":"$category","type":"string","default":"'application'","optional":true,"description":"The category of the message."}],"return":{"type":"mixed"},"static":true},"getAlias":{"signature":"public static function getAlias(string $alias, bool $throwException = true): ($throwException is true ? string : string|false)","summary":"Translates a path alias into an actual path.","params":[{"name":"$alias","type":"string","description":"The alias to be translated."},{"name":"$throwException","type":"bool","default":"true","optional":true,"description":"Whether to throw an exception if the given alias is invalid. If this is false and an invalid alias is given, false will be returned by this method."}],"return":{"type":"($throwException is true ? string : string|false)","description":"The path corresponding to the alias, false if the root alias is not previously registered."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the alias is invalid while $throwException is true."}],"static":true},"getLogger":{"signature":"public static function getLogger(): yii\\log\\Logger","return":{"type":"yii\\log\\Logger","description":"Message logger"},"static":true},"getObjectVars":{"signature":"public static function getObjectVars(object $object): array","summary":"Returns the public member variables of an object.","params":[{"name":"$object","type":"object","description":"The object to be handled"}],"return":{"type":"array","description":"The public member variables of the object"},"static":true},"getRootAlias":{"signature":"public static function getRootAlias(string $alias): string|false","summary":"Returns the root alias part of a given alias.","params":[{"name":"$alias","type":"string","description":"The alias"}],"return":{"type":"string|false","description":"The root alias, or false if no root alias is found"},"static":true},"getVersion":{"signature":"public static function getVersion(): string","summary":"Returns a string representing the current version of the Yii framework.","return":{"type":"string","description":"The version of Yii framework"},"static":true},"info":{"signature":"public static function info(string|array|Throwable $message, string $category = 'application'): mixed","summary":"Logs an informative message.","params":[{"name":"$message","type":"string|array|Throwable","description":"The message to be logged. This can be a simple string or a more complex data structure, such as an array."},{"name":"$category","type":"string","default":"'application'","optional":true,"description":"The category of the message."}],"return":{"type":"mixed"},"static":true},"setAlias":{"signature":"public static function setAlias(string $alias, string|null $path): mixed","summary":"Registers a path alias.","params":[{"name":"$alias","type":"string","description":"The alias name (e.g. \"@yii\"). It must start with a '@' character. It may contain the forward-slash '/' which serves as a boundary character when performing alias translation by `getAlias()`."},{"name":"$path","type":"string|null","description":"The path corresponding to the alias. If this is null, the alias will be removed. Trailing '/' and '\\' characters will be trimmed. This can be - a directory or a file path (e.g. `/tmp`, `/tmp/main.txt`) - a URL (e.g. `https://www.yiiframework.com`) - a path alias (e.g. `@yii/base`). In this case, the path alias will be converted into the actual path first by calling `getAlias()`."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if $path is an invalid alias."}],"static":true},"setLogger":{"signature":"public static function setLogger(yii\\log\\Logger|null $logger): mixed","summary":"Sets the logger object.","params":[{"name":"$logger","type":"yii\\log\\Logger|null","description":"The logger object."}],"return":{"type":"mixed"},"static":true},"t":{"signature":"public static function t(string $category, string $message, array $params = [], string|null $language = null): string","summary":"Translates a message to the specified language.","params":[{"name":"$category","type":"string","description":"The message category."},{"name":"$message","type":"string","description":"The message to be translated."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters that will be used to replace the corresponding placeholders in the message."},{"name":"$language","type":"string|null","default":"null","optional":true,"description":"The language code (e.g. `en-US`, `en`). If this is null, the current application language (`yii\\base\\Application::$language`) will be used."}],"return":{"type":"string","description":"The translated message."},"static":true},"warning":{"signature":"public static function warning(string|array|Throwable $message, string $category = 'application'): mixed","summary":"Logs a warning message.","params":[{"name":"$message","type":"string|array|Throwable","description":"The message to be logged. This can be a simple string or a more complex data structure, such as an array."},{"name":"$category","type":"string","default":"'application'","optional":true,"description":"The category of the message."}],"return":{"type":"mixed"},"static":true}}},"yii\\base\\Action":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/action/","summary":"Action is the base class for all controller action classes.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"controller":{"type":"yii\\base\\T|null","default":"null","description":"The controller that owns this action, or `null` when the action runs standalone. via `yii\\base\\Module::$actionMap`"},"id":{"type":"string|null","default":"null","description":"ID of the action; `null` between construction and dispatcher post-assignment for standalone actions resolved through `yii\\base\\Module::$actionMap` or `yii\\base\\Module::$actionNamespace`."},"module":{"type":"yii\\base\\Module|null","description":"The owning module, or `null` if neither a module nor a controller is attached.","virtual":true,"since":"22.0"},"uniqueId":{"type":"string","description":"The unique ID of this action among the whole application.","access":"read-only","virtual":true}},"methods":{"__construct":{"signature":"public function __construct(string|null $id = null, yii\\base\\T|null $controller = null, array $config = [])","summary":"Constructor.","params":[{"name":"$id","type":"string|null","default":"null","optional":true,"description":"The ID of this action, or `null` when the action is instantiated through the DI container and the ID is assigned afterwards by the dispatcher."},{"name":"$controller","type":"yii\\base\\T|null","default":"null","optional":true,"description":"The controller that owns this action, or `null` for standalone handlers."},{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties."}]},"afterRun":{"signature":"protected function afterRun(): mixed","summary":"This method is called right after `run()` is executed.","return":{"type":"mixed"},"visibility":"protected"},"beforeRun":{"signature":"protected function beforeRun(): bool","summary":"This method is called right before `run()` is executed.","return":{"type":"bool","description":"Whether to run the action."},"visibility":"protected"},"getModule":{"signature":"public function getModule(): yii\\base\\Module|null","summary":"Returns the module that owns this action when invoked standalone.","return":{"type":"yii\\base\\Module|null","description":"The owning module, or `null` if neither a module nor a controller is attached."},"since":"22.0"},"getUniqueId":{"signature":"public function getUniqueId(): string","summary":"Returns the unique ID of this action among the whole application.","return":{"type":"string","description":"The unique ID of this action among the whole application."}},"resolveStandaloneParams":{"signature":"protected function resolveStandaloneParams(array $params): array","summary":"Resolves typed parameters of `run()` when the action is invoked without a hosting controller.","params":[{"name":"$params","type":"array","description":"Route parameters to be matched by name against `run()`'s signature."}],"return":{"type":"array","description":"The resolved positional argument list for `run()`."},"visibility":"protected","since":"22.0"},"runWithParams":{"signature":"public function runWithParams(array $params): mixed","summary":"Runs this action with the specified parameters.","params":[{"name":"$params","type":"array","description":"The parameters to be bound to the action's `run()` method."}],"return":{"type":"mixed","description":"The result of the action."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the action class does not have a `run()` method."}]},"setModule":{"signature":"public function setModule(yii\\base\\Module|null $module): void","summary":"Sets the module that owns this action when invoked standalone.","params":[{"name":"$module","type":"yii\\base\\Module|null","description":"The owning module, or `null` to detach."}],"return":{"type":"void"},"since":"22.0"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\base\\ActionEvent":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/actionevent/","summary":"ActionEvent represents the event parameter used for an action event.","since":"2.0","extends":"yii\\base\\Event","implements":["yii\\base\\Configurable"],"properties":{"action":{"type":"yii\\base\\T","default":"null","description":"The action currently being executed"},"isValid":{"type":"bool","default":"true","description":"Whether to continue running the action."},"result":{"type":"mixed","default":"null","description":"The action result."}},"methods":{"__construct":{"signature":"public function __construct(yii\\base\\T $action, array $config = [])","summary":"Constructor.","params":[{"name":"$action","type":"yii\\base\\T","description":"The action associated with this action event."},{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties"}]}},"inherited":{"properties":{"data":"yii\\base\\Event","handled":"yii\\base\\Event","name":"yii\\base\\Event","sender":"yii\\base\\Event"},"methods":{"__call":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasHandlers":"yii\\base\\Event","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","off":"yii\\base\\Event","offAll":"yii\\base\\Event","on":"yii\\base\\Event","trigger":"yii\\base\\Event"}}},"yii\\base\\ActionFilter":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/actionfilter/","summary":"ActionFilter is the base class for action filters.","since":"2.0","extends":"yii\\base\\Behavior","implements":["yii\\base\\Configurable"],"properties":{"except":{"type":"array","default":"[]","description":"List of action IDs that this filter should not apply to."},"only":{"type":"array","default":"[]","description":"List of action IDs that this filter should apply to."}},"methods":{"afterAction":{"signature":"public function afterAction(yii\\base\\Action $action, mixed $result): mixed","summary":"This method is invoked right after an action is executed.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action just executed."},{"name":"$result","type":"mixed","description":"The action execution result"}],"return":{"type":"mixed","description":"The processed action result."}},"afterFilter":{"signature":"public function afterFilter(yii\\base\\ActionEvent $event): mixed","params":[{"name":"$event","type":"yii\\base\\ActionEvent"}],"return":{"type":"mixed"}},"attach":{"signature":"public function attach(mixed $owner): mixed","summary":"Attaches the behavior object to the component.","params":[{"name":"$owner","type":"mixed","description":"The component that this behavior is to be attached to."}],"return":{"type":"mixed"}},"beforeAction":{"signature":"public function beforeAction(yii\\base\\Action $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"beforeFilter":{"signature":"public function beforeFilter(yii\\base\\ActionEvent $event): mixed","params":[{"name":"$event","type":"yii\\base\\ActionEvent"}],"return":{"type":"mixed"}},"detach":{"signature":"public function detach(): mixed","summary":"Detaches the behavior object from the component.","return":{"type":"mixed"}},"getActionId":{"signature":"protected function getActionId(yii\\base\\Action $action): string","summary":"Returns an action ID by converting `yii\\base\\Action::$uniqueId` into an ID relative to the module.","params":[{"name":"$action","type":"yii\\base\\Action"}],"return":{"type":"string"},"visibility":"protected","since":"2.0.7"},"isActive":{"signature":"protected function isActive(yii\\base\\Action $action): bool","summary":"Returns a value indicating whether the filter is active for the given action.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action being filtered"}],"return":{"type":"bool","description":"Whether the filter is active for the given action."},"visibility":"protected"}},"inherited":{"properties":{"owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","events":"yii\\base\\Behavior","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\base\\Application":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/base/application/","summary":"Application is the base class for all application classes.","since":"2.0","extends":"yii\\base\\Module","implements":["yii\\base\\Configurable"],"properties":{"assetManager":{"type":"yii\\web\\AssetManager","description":"The asset manager application component.","access":"read-only","virtual":true},"authManager":{"type":"yii\\rbac\\ManagerInterface|null","description":"The auth manager application component or null if it's not configured.","access":"read-only","virtual":true},"basePath":{"type":"string","description":"The root directory of the application.","virtual":true},"bootstrap":{"type":"array","default":"[]","description":"List of components that should be run during the application bootstrapping process (`bootstrap()`)."},"cache":{"type":"yii\\caching\\CacheInterface|null","description":"The cache application component.","access":"read-only","virtual":true},"charset":{"type":"string","default":"'UTF-8'","description":"The charset currently used for the application."},"container":{"type":"array","description":"Values given in terms of name-value pairs.","access":"write-only","virtual":true},"controller":{"type":"yii\\base\\Controller|null","default":"null","description":"The currently active controller instance"},"controllerNamespace":{"type":"string","default":"'app\\controllers'","description":"The namespace that controller classes are located in."},"db":{"type":"yii\\db\\Connection","description":"The database connection.","access":"read-only","virtual":true},"errorHandler":{"type":"yii\\web\\ErrorHandler|yii\\console\\ErrorHandler","description":"The error handler application component.","access":"read-only","virtual":true},"extensions":{"type":"array|null","default":"null","description":"List of installed Yii extensions."},"formatter":{"type":"yii\\i18n\\Formatter","description":"The formatter application component.","access":"read-only","virtual":true},"i18n":{"type":"yii\\i18n\\I18N","description":"The internationalization application component.","access":"read-only","virtual":true},"language":{"type":"string","default":"'en-US'","description":"The language that is meant to be used for end users."},"layout":{"type":"string|bool","default":"'main'","description":"The layout that should be applied for views in this application."},"loadedModules":{"type":"array","default":"[]","description":"List of loaded modules indexed by their class names."},"log":{"type":"yii\\log\\Dispatcher","description":"The log dispatcher application component.","access":"read-only","virtual":true},"mailer":{"type":"yii\\mail\\MailerInterface","description":"The mailer application component.","access":"read-only","virtual":true},"name":{"type":"string","default":"'My Application'","description":"The application name."},"request":{"type":"yii\\web\\Request|yii\\console\\Request","description":"The request component.","access":"read-only","virtual":true},"requestedAction":{"type":"yii\\base\\Action|null","default":"null","description":"The requested Action."},"requestedParams":{"type":"array|null","default":"null","description":"The parameters supplied to the requested action."},"requestedRoute":{"type":"string","default":"null","description":"The requested route"},"response":{"type":"yii\\web\\Response|yii\\console\\Response","description":"The response component.","access":"read-only","virtual":true},"runtimePath":{"type":"string","description":"The directory that stores runtime files.","virtual":true},"security":{"type":"yii\\base\\Security","description":"The security application component.","access":"read-only","virtual":true},"sourceLanguage":{"type":"string","default":"'en-US'","description":"The language that the application is written in."},"state":{"type":"int","default":"null","description":"The current application state during a request handling life cycle."},"timeZone":{"type":"string","description":"The time zone used by this application.","virtual":true},"uniqueId":{"type":"string","description":"The unique ID of the module.","access":"read-only","virtual":true},"urlManager":{"type":"yii\\web\\UrlManager","description":"The URL manager for this application.","access":"read-only","virtual":true},"vendorPath":{"type":"string","description":"The directory that stores vendor files.","virtual":true},"view":{"type":"yii\\base\\View|yii\\web\\View","description":"The view application component that is used to render various view files.","access":"read-only","virtual":true}},"methods":{"__construct":{"signature":"public function __construct(array $config = [])","summary":"Constructor.","params":[{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties. Note that the configuration must contain both `$id` and `$basePath`."}],"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if either `$id` or `$basePath` configuration is missing."}]},"bootstrap":{"signature":"protected function bootstrap(): mixed","summary":"Initializes extensions and executes bootstrap components.","return":{"type":"mixed"},"visibility":"protected"},"coreComponents":{"signature":"public function coreComponents(): array","summary":"Returns the configuration of core application components.","return":{"type":"array"}},"end":{"signature":"public function end(int $status = 0, yii\\base\\Response|null $response = null): mixed","summary":"Terminates the application.","params":[{"name":"$status","type":"int","default":"0","optional":true,"description":"The exit status (value 0 means normal exit while other values mean abnormal exit)."},{"name":"$response","type":"yii\\base\\Response|null","default":"null","optional":true,"description":"The response to be sent. If not set, the default application `$response` component will be used."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\ExitException","description":"if the application is in testing mode"}]},"getAssetManager":{"signature":"public function getAssetManager(): yii\\web\\AssetManager","summary":"Returns the asset manager.","return":{"type":"yii\\web\\AssetManager","description":"The asset manager application component."}},"getAuthManager":{"signature":"public function getAuthManager(): yii\\rbac\\ManagerInterface|null","summary":"Returns the auth manager for this application.","return":{"type":"yii\\rbac\\ManagerInterface|null","description":"The auth manager application component or null if it's not configured."}},"getCache":{"signature":"public function getCache(): yii\\caching\\CacheInterface|null","summary":"Returns the cache component.","return":{"type":"yii\\caching\\CacheInterface|null","description":"The cache application component. Null if the component is not enabled."}},"getDb":{"signature":"public function getDb(): yii\\db\\Connection","summary":"Returns the database connection component.","return":{"type":"yii\\db\\Connection","description":"The database connection."}},"getErrorHandler":{"signature":"public function getErrorHandler(): yii\\web\\ErrorHandler|yii\\console\\ErrorHandler","summary":"Returns the error handler component.","return":{"type":"yii\\web\\ErrorHandler|yii\\console\\ErrorHandler","description":"The error handler application component."}},"getFormatter":{"signature":"public function getFormatter(): yii\\i18n\\Formatter","summary":"Returns the formatter component.","return":{"type":"yii\\i18n\\Formatter","description":"The formatter application component."}},"getI18n":{"signature":"public function getI18n(): yii\\i18n\\I18N","summary":"Returns the internationalization (i18n) component.","return":{"type":"yii\\i18n\\I18N","description":"The internationalization application component."}},"getLog":{"signature":"public function getLog(): yii\\log\\Dispatcher","summary":"Returns the log dispatcher component.","return":{"type":"yii\\log\\Dispatcher","description":"The log dispatcher application component."}},"getMailer":{"signature":"public function getMailer(): yii\\mail\\MailerInterface","summary":"Returns the mailer component.","return":{"type":"yii\\mail\\MailerInterface","description":"The mailer application component."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"If this component is not configured."}]},"getRequest":{"signature":"public function getRequest(): yii\\web\\Request|yii\\console\\Request","summary":"Returns the request component.","return":{"type":"yii\\web\\Request|yii\\console\\Request","description":"The request component."}},"getResponse":{"signature":"public function getResponse(): yii\\web\\Response|yii\\console\\Response","summary":"Returns the response component.","return":{"type":"yii\\web\\Response|yii\\console\\Response","description":"The response component."}},"getRuntimePath":{"signature":"public function getRuntimePath(): string","summary":"Returns the directory that stores runtime files.","return":{"type":"string","description":"The directory that stores runtime files. Defaults to the \"runtime\" subdirectory under `$basePath`."}},"getSecurity":{"signature":"public function getSecurity(): yii\\base\\Security","summary":"Returns the security component.","return":{"type":"yii\\base\\Security","description":"The security application component."}},"getTimeZone":{"signature":"public function getTimeZone(): string","summary":"Returns the time zone used by this application.","return":{"type":"string","description":"The time zone used by this application."}},"getUniqueId":{"signature":"public function getUniqueId(): string","summary":"Returns an ID that uniquely identifies this module among all modules within the current application.","return":{"type":"string","description":"The unique ID of the module."}},"getUrlManager":{"signature":"public function getUrlManager(): yii\\web\\UrlManager","summary":"Returns the URL manager for this application.","return":{"type":"yii\\web\\UrlManager","description":"The URL manager for this application."}},"getVendorPath":{"signature":"public function getVendorPath(): string","summary":"Returns the directory that stores vendor files.","return":{"type":"string","description":"The directory that stores vendor files. Defaults to \"vendor\" directory under `$basePath`."}},"getView":{"signature":"public function getView(): yii\\base\\View|yii\\web\\View","summary":"Returns the view object.","return":{"type":"yii\\base\\View|yii\\web\\View","description":"The view application component that is used to render various view files."}},"handleRequest":{"signature":"abstract public function handleRequest(yii\\base\\Request $request): yii\\base\\Response","summary":"Handles the specified request.","params":[{"name":"$request","type":"yii\\base\\Request","description":"The request to be handled"}],"return":{"type":"yii\\base\\Response","description":"The resulting response"},"abstract":true},"init":{"signature":"public function init(): mixed","summary":"Initializes the module.","return":{"type":"mixed"}},"preInit":{"signature":"public function preInit(array &$config): mixed","summary":"Pre-initializes the application.","params":[{"name":"$config","type":"array","byReference":true,"description":"The application configuration"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if either `$id` or `$basePath` configuration is missing."}]},"registerErrorHandler":{"signature":"protected function registerErrorHandler(array &$config): mixed","summary":"Registers the errorHandler component as a PHP error handler.","params":[{"name":"$config","type":"array","byReference":true,"description":"Application config"}],"return":{"type":"mixed"},"visibility":"protected"},"run":{"signature":"public function run(): int","summary":"Runs the application.","return":{"type":"int","description":"The exit status (0 means normal, non-zero values mean abnormal)"}},"setBasePath":{"signature":"public function setBasePath(string $path): mixed","summary":"Sets the root directory of the application and the @app alias.","params":[{"name":"$path","type":"string","description":"The root directory of the application."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the directory does not exist."}]},"setContainer":{"signature":"public function setContainer(array $config): mixed","summary":"Configures `Yii::$container` with the $config.","params":[{"name":"$config","type":"array","description":"Values given in terms of name-value pairs"}],"return":{"type":"mixed"},"since":"2.0.11"},"setRuntimePath":{"signature":"public function setRuntimePath(string $path): mixed","summary":"Sets the directory that stores runtime files.","params":[{"name":"$path","type":"string","description":"The directory that stores runtime files."}],"return":{"type":"mixed"}},"setTimeZone":{"signature":"public function setTimeZone(string $value): mixed","summary":"Sets the time zone used by this application.","params":[{"name":"$value","type":"string","description":"The time zone used by this application."}],"return":{"type":"mixed"}},"setVendorPath":{"signature":"public function setVendorPath(string $path): mixed","summary":"Sets the directory that stores vendor files.","params":[{"name":"$path","type":"string","description":"The directory that stores vendor files."}],"return":{"type":"mixed"}}},"constants":{"STATE_BEGIN":{"value":"0","description":"Application state used by `$state`: application just started."},"STATE_INIT":{"value":"1","description":"Application state used by `$state`: application is initializing."},"STATE_BEFORE_REQUEST":{"value":"2","description":"Application state used by `$state`: application is triggering `EVENT_BEFORE_REQUEST`."},"STATE_HANDLING_REQUEST":{"value":"3","description":"Application state used by `$state`: application is handling the request."},"STATE_AFTER_REQUEST":{"value":"4","description":"Application state used by `$state`: application is triggering `EVENT_AFTER_REQUEST`."},"STATE_SENDING_RESPONSE":{"value":"5","description":"Application state used by `$state`: application is about to send response."},"STATE_END":{"value":"6","description":"Application state used by `$state`: application has ended."}},"events":{"EVENT_BEFORE_REQUEST":{"value":"'beforeRequest'","type":"yii\\base\\Event","description":"An event raised before the application starts to handle a request."},"EVENT_AFTER_REQUEST":{"value":"'afterRequest'","type":"yii\\base\\Event","description":"An event raised after the application successfully handles a request (before the response is sent out)."}},"inherited":{"properties":{"actionMap":"yii\\base\\Module","actionNamespace":"yii\\base\\Module","aliases":"yii\\base\\Module","behaviors":"yii\\base\\Component","components":"yii\\di\\ServiceLocator","controllerMap":"yii\\base\\Module","controllerPath":"yii\\base\\Module","defaultRoute":"yii\\base\\Module","id":"yii\\base\\Module","layoutPath":"yii\\base\\Module","module":"yii\\base\\Module","modules":"yii\\base\\Module","params":"yii\\base\\Module","version":"yii\\base\\Module","viewPath":"yii\\base\\Module"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__get":"yii\\di\\ServiceLocator","__isset":"yii\\di\\ServiceLocator","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","afterAction":"yii\\base\\Module","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeAction":"yii\\base\\Module","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","clear":"yii\\di\\ServiceLocator","createController":"yii\\base\\Module","createControllerByID":"yii\\base\\Module","createStandaloneAction":"yii\\base\\Module","defaultVersion":"yii\\base\\Module","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","get":"yii\\base\\Module","getBasePath":"yii\\base\\Module","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getComponents":"yii\\di\\ServiceLocator","getControllerPath":"yii\\base\\Module","getInstance":"yii\\base\\Module","getLayoutPath":"yii\\base\\Module","getModule":"yii\\base\\Module","getModules":"yii\\base\\Module","getVersion":"yii\\base\\Module","getViewPath":"yii\\base\\Module","has":"yii\\base\\Module","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasModule":"yii\\base\\Module","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","runAction":"yii\\base\\Module","runMappedAction":"yii\\base\\Module","runStandaloneAction":"yii\\base\\Module","set":"yii\\di\\ServiceLocator","setAliases":"yii\\base\\Module","setComponents":"yii\\di\\ServiceLocator","setControllerPath":"yii\\base\\Module","setInstance":"yii\\base\\Module","setLayoutPath":"yii\\base\\Module","setModule":"yii\\base\\Module","setModules":"yii\\base\\Module","setVersion":"yii\\base\\Module","setViewPath":"yii\\base\\Module","trigger":"yii\\base\\Component"},"events":{"EVENT_BEFORE_ACTION":"yii\\base\\Module","EVENT_AFTER_ACTION":"yii\\base\\Module"}}},"yii\\base\\ArrayAccessTrait":{"kind":"trait","url":"https://yii2-framework.github.io/docs/api/yii/base/arrayaccesstrait/","summary":"ArrayAccessTrait provides the implementation for `IteratorAggregate`, `ArrayAccess` and `Countable`.","since":"2.0","properties":{"data":{"type":"array","virtual":true}},"methods":{"count":{"signature":"public function count(): int","summary":"Returns the number of data items.","return":{"type":"int","description":"Number of data elements."}},"getIterator":{"signature":"public function getIterator(): ArrayIterator","summary":"Returns an iterator for traversing the data.","return":{"type":"ArrayIterator","description":"An iterator for traversing the cookies in the collection."}},"offsetExists":{"signature":"public function offsetExists(int|string $offset): bool","summary":"This method is required by the interface `ArrayAccess`.","params":[{"name":"$offset","type":"int|string","description":"The offset to check on"}],"return":{"type":"bool"}},"offsetGet":{"signature":"public function offsetGet(int|string $offset): mixed","summary":"This method is required by the interface `ArrayAccess`.","params":[{"name":"$offset","type":"int|string","description":"The offset to retrieve element."}],"return":{"type":"mixed","description":"The element at the offset, null if no element is found at the offset"}},"offsetSet":{"signature":"public function offsetSet(int|string $offset, mixed $item): mixed","summary":"This method is required by the interface `ArrayAccess`.","params":[{"name":"$offset","type":"int|string","description":"The offset to set element"},{"name":"$item","type":"mixed","description":"The element value"}],"return":{"type":"mixed"}},"offsetUnset":{"signature":"public function offsetUnset(int|string $offset): mixed","summary":"This method is required by the interface `ArrayAccess`.","params":[{"name":"$offset","type":"int|string","description":"The offset to unset element"}],"return":{"type":"mixed"}}}},"yii\\base\\Arrayable":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/base/arrayable/","summary":"Arrayable is the interface that should be implemented by classes who want to support customizable representation of their instances.","since":"2.0","methods":{"extraFields":{"signature":"abstract public function extraFields(): array","summary":"Returns the list of additional fields that can be returned by `toArray()` in addition to those listed in `fields()`.","return":{"type":"array","description":"The list of expandable field names or field definitions. Please refer to `fields()` on the format of the return value."},"abstract":true},"fields":{"signature":"abstract public function fields(): array","summary":"Returns the list of fields that should be returned by default by `toArray()` when no specific fields are specified.","return":{"type":"array","description":"The list of field names or field definitions."},"abstract":true},"toArray":{"signature":"abstract public function toArray(array $fields = [], array $expand = [], bool $recursive = true): array","summary":"Converts the object into an array.","params":[{"name":"$fields","type":"array","default":"[]","optional":true,"description":"The fields that the output array should contain. Fields not specified in `fields()` will be ignored. If this parameter is empty, all fields as specified in `fields()` will be returned."},{"name":"$expand","type":"array","default":"[]","optional":true,"description":"The additional fields that the output array should contain. Fields not specified in `extraFields()` will be ignored. If this parameter is empty, no extra fields will be returned."},{"name":"$recursive","type":"bool","default":"true","optional":true,"description":"Whether to recursively return array representation of embedded objects."}],"return":{"type":"array","description":"The array representation of the object"},"abstract":true}}},"yii\\base\\ArrayableTrait":{"kind":"trait","url":"https://yii2-framework.github.io/docs/api/yii/base/arrayabletrait/","summary":"ArrayableTrait provides a common implementation of the `yii\\base\\Arrayable` interface.","since":"2.0","methods":{"extractFieldsFor":{"signature":"protected function extractFieldsFor(array $fields, string $rootField): array","summary":"Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: \"item.id\" The previous example would extract \"id\".","params":[{"name":"$fields","type":"array","description":"The fields requested for extraction"},{"name":"$rootField","type":"string","description":"The root field for which we want to extract the nested fields"}],"return":{"type":"array","description":"Nested fields extracted for the given field"},"visibility":"protected","since":"2.0.14"},"extractRootFields":{"signature":"protected function extractRootFields(array $fields): array","summary":"Extracts the root field names from nested fields.","params":[{"name":"$fields","type":"array","description":"The fields requested for extraction"}],"return":{"type":"array","description":"Root fields extracted from the given nested fields"},"visibility":"protected","since":"2.0.14"},"extraFields":{"signature":"public function extraFields(): array","summary":"Returns the list of fields that can be expanded further and returned by `toArray()`.","return":{"type":"array","description":"The list of expandable field names or field definitions. Please refer to `fields()` on the format of the return value."}},"fields":{"signature":"public function fields(): array","summary":"Returns the list of fields that should be returned by default by `toArray()` when no specific fields are specified.","return":{"type":"array","description":"The list of field names or field definitions."}},"resolveFields":{"signature":"protected function resolveFields(array $fields, array $expand): array","summary":"Determines which fields can be returned by `toArray()`.","params":[{"name":"$fields","type":"array","description":"The fields being requested for exporting"},{"name":"$expand","type":"array","description":"The additional fields being requested for exporting"}],"return":{"type":"array","description":"The list of fields to be exported. The array keys are the field names, and the array values are the corresponding object property names or PHP callables returning the field values."},"visibility":"protected"},"toArray":{"signature":"public function toArray(array $fields = [], array $expand = [], bool $recursive = true): array","summary":"Converts the model into an array.","params":[{"name":"$fields","type":"array","default":"[]","optional":true,"description":"The fields being requested. If empty or if it contains '*', all fields as specified by `fields()` will be returned. Fields can be nested, separated with dots (.). e.g.: item.field.sub-field `$recursive` must be true for nested fields to be extracted. If `$recursive` is false, only the root fields will be extracted."},{"name":"$expand","type":"array","default":"[]","optional":true,"description":"The additional fields being requested for exporting. Only fields declared in `extraFields()` will be considered. Expand can also be nested, separated with dots (.). e.g.: item.expand1.expand2 `$recursive` must be true for nested expands to be extracted. If `$recursive` is false, only the root expands will be extracted."},{"name":"$recursive","type":"bool","default":"true","optional":true,"description":"Whether to recursively return array representation of embedded objects."}],"return":{"type":"array","description":"The array representation of the object"}}}},"yii\\base\\BaseObject":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/baseobject/","summary":"BaseObject is the base class that implements the *property* feature.","since":"2.0.13","implements":["yii\\base\\Configurable"],"methods":{"__call":{"signature":"public function __call(string $name, array $params): mixed","summary":"Calls the named method which is not a class method.","params":[{"name":"$name","type":"string","description":"The method name"},{"name":"$params","type":"array","description":"Method parameters"}],"return":{"type":"mixed","description":"The method return value"},"throws":[{"type":"yii\\base\\UnknownMethodException","description":"when calling unknown method"}]},"__construct":{"signature":"public function __construct(array $config = [])","summary":"Constructor.","params":[{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties"}]},"__get":{"signature":"public function __get(string $name): mixed","summary":"Returns the value of an object property.","params":[{"name":"$name","type":"string","description":"The property name"}],"return":{"type":"mixed","description":"The property value"},"throws":[{"type":"yii\\base\\UnknownPropertyException","description":"if the property is not defined"},{"type":"yii\\base\\InvalidCallException","description":"if the property is write-only"}]},"__isset":{"signature":"public function __isset(string $name): bool","summary":"Checks if a property is set, i.e. defined and not null.","params":[{"name":"$name","type":"string","description":"The property name or the event name"}],"return":{"type":"bool","description":"Whether the named property is set (not null)."}},"__set":{"signature":"public function __set(string $name, mixed $value): mixed","summary":"Sets value of an object property.","params":[{"name":"$name","type":"string","description":"The property name or the event name"},{"name":"$value","type":"mixed","description":"The property value"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\UnknownPropertyException","description":"if the property is not defined"},{"type":"yii\\base\\InvalidCallException","description":"if the property is read-only"}]},"__unset":{"signature":"public function __unset(string $name): mixed","summary":"Sets an object property to null.","params":[{"name":"$name","type":"string","description":"The property name"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if the property is read only."}]},"canGetProperty":{"signature":"public function canGetProperty(string $name, bool $checkVars = true): bool","summary":"Returns a value indicating whether a property can be read.","params":[{"name":"$name","type":"string","description":"The property name"},{"name":"$checkVars","type":"bool","default":"true","optional":true,"description":"Whether to treat member variables as properties"}],"return":{"type":"bool","description":"Whether the property can be read"}},"canSetProperty":{"signature":"public function canSetProperty(string $name, bool $checkVars = true): bool","summary":"Returns a value indicating whether a property can be set.","params":[{"name":"$name","type":"string","description":"The property name"},{"name":"$checkVars","type":"bool","default":"true","optional":true,"description":"Whether to treat member variables as properties"}],"return":{"type":"bool","description":"Whether the property can be written"}},"className":{"signature":"public static function className(): string","summary":"Returns the fully qualified name of this class.","return":{"type":"string","description":"The fully qualified name of this class."},"static":true},"hasMethod":{"signature":"public function hasMethod(string $name): bool","summary":"Returns a value indicating whether a method is defined.","params":[{"name":"$name","type":"string","description":"The method name"}],"return":{"type":"bool","description":"Whether the method is defined"}},"hasProperty":{"signature":"public function hasProperty(string $name, bool $checkVars = true): bool","summary":"Returns a value indicating whether a property is defined.","params":[{"name":"$name","type":"string","description":"The property name"},{"name":"$checkVars","type":"bool","default":"true","optional":true,"description":"Whether to treat member variables as properties"}],"return":{"type":"bool","description":"Whether the property is defined"}},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}}}},"yii\\base\\Behavior":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/behavior/","summary":"Behavior is the base class for all behavior classes.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"owner":{"type":"yii\\base\\T|null","default":"null","description":"The owner of this behavior"}},"methods":{"attach":{"signature":"public function attach(yii\\base\\T $owner): mixed","summary":"Attaches the behavior object to the component.","params":[{"name":"$owner","type":"yii\\base\\T","description":"The component that this behavior is to be attached to."}],"return":{"type":"mixed"}},"detach":{"signature":"public function detach(): mixed","summary":"Detaches the behavior object from the component.","return":{"type":"mixed"}},"events":{"signature":"public function events(): array","summary":"Declares event handlers for the `$owner`'s events.","return":{"type":"array","description":"Events (array keys) and the corresponding event handler methods (array values)."}}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\base\\BootstrapInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/base/bootstrapinterface/","summary":"BootstrapInterface is the interface that should be implemented by classes who want to participate in the application bootstrap process.","since":"2.0","methods":{"bootstrap":{"signature":"abstract public function bootstrap(yii\\base\\Application $app): mixed","summary":"Bootstrap method to be called during application bootstrap stage.","params":[{"name":"$app","type":"yii\\base\\Application","description":"The application currently running"}],"return":{"type":"mixed"},"abstract":true}}},"yii\\base\\Component":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/component/","summary":"Component is the base class that implements the *property*, *event* and *behavior* features.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"behaviors":{"type":"array>","description":"List of behaviors attached to this component.","access":"read-only","virtual":true}},"methods":{"__call":{"signature":"public function __call(string $name, array $params): mixed","summary":"Calls the named method which is not a class method.","params":[{"name":"$name","type":"string","description":"The method name"},{"name":"$params","type":"array","description":"Method parameters"}],"return":{"type":"mixed","description":"The method return value"},"throws":[{"type":"yii\\base\\UnknownMethodException","description":"when calling unknown method"}]},"__clone":{"signature":"public function __clone(): mixed","summary":"This method is called after the object is created by cloning an existing one.","return":{"type":"mixed"}},"__get":{"signature":"public function __get(string $name): mixed","summary":"Returns the value of a component property.","params":[{"name":"$name","type":"string","description":"The property name"}],"return":{"type":"mixed","description":"The property value or the value of a behavior's property"},"throws":[{"type":"yii\\base\\UnknownPropertyException","description":"if the property is not defined"},{"type":"yii\\base\\InvalidCallException","description":"if the property is write-only."}]},"__isset":{"signature":"public function __isset(string $name): bool","summary":"Checks if a property is set, i.e. defined and not null.","params":[{"name":"$name","type":"string","description":"The property name or the event name"}],"return":{"type":"bool","description":"Whether the named property is set"}},"__set":{"signature":"public function __set(string $name, mixed $value): mixed","summary":"Sets the value of a component property.","params":[{"name":"$name","type":"string","description":"The property name or the event name"},{"name":"$value","type":"mixed","description":"The property value"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\UnknownPropertyException","description":"if the property is not defined"},{"type":"yii\\base\\InvalidCallException","description":"if the property is read-only."}]},"__unset":{"signature":"public function __unset(string $name): mixed","summary":"Sets a component property to be null.","params":[{"name":"$name","type":"string","description":"The property name"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if the property is read only."}]},"attachBehavior":{"signature":"public function attachBehavior(string $name, string|array|yii\\base\\Behavior $behavior): yii\\base\\Behavior","summary":"Attaches a behavior to this component.","params":[{"name":"$name","type":"string","description":"The name of the behavior."},{"name":"$behavior","type":"string|array|yii\\base\\Behavior","description":"The behavior configuration. This can be one of the following: - a `yii\\base\\Behavior` object - a string specifying the behavior class - an object configuration array that will be passed to `Yii::createObject()` to create the behavior object."}],"return":{"type":"yii\\base\\Behavior","description":"The behavior object"}},"attachBehaviors":{"signature":"public function attachBehaviors(array $behaviors): mixed","summary":"Attaches a list of behaviors to the component.","params":[{"name":"$behaviors","type":"array","description":"List of behaviors to be attached to the component"}],"return":{"type":"mixed"}},"behaviors":{"signature":"public function behaviors(): array","summary":"Returns a list of behaviors that this component should behave as.","return":{"type":"array","description":"The behavior configurations."}},"canGetProperty":{"signature":"public function canGetProperty(string $name, bool $checkVars = true, bool $checkBehaviors = true): bool","summary":"Returns a value indicating whether a property can be read.","params":[{"name":"$name","type":"string","description":"The property name"},{"name":"$checkVars","type":"bool","default":"true","optional":true,"description":"Whether to treat member variables as properties"},{"name":"$checkBehaviors","type":"bool","default":"true","optional":true,"description":"Whether to treat behaviors' properties as properties of this component"}],"return":{"type":"bool","description":"Whether the property can be read"}},"canSetProperty":{"signature":"public function canSetProperty(string $name, bool $checkVars = true, bool $checkBehaviors = true): bool","summary":"Returns a value indicating whether a property can be set.","params":[{"name":"$name","type":"string","description":"The property name"},{"name":"$checkVars","type":"bool","default":"true","optional":true,"description":"Whether to treat member variables as properties"},{"name":"$checkBehaviors","type":"bool","default":"true","optional":true,"description":"Whether to treat behaviors' properties as properties of this component"}],"return":{"type":"bool","description":"Whether the property can be written"}},"detachBehavior":{"signature":"public function detachBehavior(string $name): yii\\base\\Behavior|null","summary":"Detaches a behavior from the component.","params":[{"name":"$name","type":"string","description":"The behavior's name."}],"return":{"type":"yii\\base\\Behavior|null","description":"The detached behavior. Null if the behavior does not exist."}},"detachBehaviors":{"signature":"public function detachBehaviors(): mixed","summary":"Detaches all behaviors from the component.","return":{"type":"mixed"}},"ensureBehaviors":{"signature":"public function ensureBehaviors(): mixed","summary":"Makes sure that the behaviors declared in `behaviors()` are attached to this component.","return":{"type":"mixed"}},"getBehavior":{"signature":"public function getBehavior(string $name): yii\\base\\Behavior|null","summary":"Returns the named behavior object.","params":[{"name":"$name","type":"string","description":"The behavior name"}],"return":{"type":"yii\\base\\Behavior|null","description":"The behavior object, or null if the behavior does not exist"}},"getBehaviors":{"signature":"public function getBehaviors(): array>","summary":"Returns all behaviors attached to this component.","return":{"type":"array>","description":"List of behaviors attached to this component"}},"hasEventHandlers":{"signature":"public function hasEventHandlers(string $name): bool","summary":"Returns a value indicating whether there is any handler attached to the named event.","params":[{"name":"$name","type":"string","description":"The event name"}],"return":{"type":"bool","description":"Whether there is any handler attached to the event."}},"hasMethod":{"signature":"public function hasMethod(string $name, bool $checkBehaviors = true): bool","summary":"Returns a value indicating whether a method is defined.","params":[{"name":"$name","type":"string","description":"The property name"},{"name":"$checkBehaviors","type":"bool","default":"true","optional":true,"description":"Whether to treat behaviors' methods as methods of this component"}],"return":{"type":"bool","description":"Whether the method is defined"}},"hasProperty":{"signature":"public function hasProperty(string $name, bool $checkVars = true, bool $checkBehaviors = true): bool","summary":"Returns a value indicating whether a property is defined for this component.","params":[{"name":"$name","type":"string","description":"The property name"},{"name":"$checkVars","type":"bool","default":"true","optional":true,"description":"Whether to treat member variables as properties"},{"name":"$checkBehaviors","type":"bool","default":"true","optional":true,"description":"Whether to treat behaviors' properties as properties of this component"}],"return":{"type":"bool","description":"Whether the property is defined"}},"off":{"signature":"public function off(string $name, callable|null $handler = null): bool","summary":"Detaches an existing event handler from this component.","params":[{"name":"$name","type":"string","description":"Event name"},{"name":"$handler","type":"callable|null","default":"null","optional":true,"description":"The event handler to be removed. If it is null, all handlers attached to the named event will be removed."}],"return":{"type":"bool","description":"If a handler is found and detached"}},"on":{"signature":"public function on(string $name, callable $handler, mixed $data = null, bool $append = true): mixed","summary":"Attaches an event handler to an event.","params":[{"name":"$name","type":"string","description":"The event name"},{"name":"$handler","type":"callable","description":"The event handler"},{"name":"$data","type":"mixed","default":"null","optional":true,"description":"The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via `yii\\base\\Event::$data`."},{"name":"$append","type":"bool","default":"true","optional":true,"description":"Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list."}],"return":{"type":"mixed"}},"trigger":{"signature":"public function trigger(string $name, yii\\base\\Event|null $event = null): mixed","summary":"Triggers an event.","params":[{"name":"$name","type":"string","description":"The event name"},{"name":"$event","type":"yii\\base\\Event|null","default":"null","optional":true,"description":"The event instance. If not set, a default `yii\\base\\Event` object will be created."}],"return":{"type":"mixed"}}},"inherited":{"methods":{"__construct":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\base\\Configurable":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/base/configurable/","summary":"Configurable is the interface that should be implemented by classes who support configuring its properties through the last parameter to its constructor.","since":"2.0.3"},"yii\\base\\Controller":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/controller/","summary":"Controller is the base class for classes containing controller logic.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"action":{"type":"yii\\base\\Action|null","default":"null","description":"The action that is currently being executed."},"defaultAction":{"type":"string","default":"'index'","description":"The ID of the action that is used when the action ID is not specified in the request."},"id":{"type":"string","default":"null","description":"The ID of this controller."},"layout":{"type":"string|null|false","default":"null","description":"The name of the layout to be applied to this controller's views."},"module":{"type":"yii\\base\\T","default":"null","description":"The module that this controller belongs to."},"modules":{"type":"yii\\base\\Module[]","description":"All ancestor modules that this controller is located within.","access":"read-only","virtual":true},"request":{"type":"yii\\base\\Request|array|string","default":"'request'","description":"The request.","since":"2.0.36"},"response":{"type":"yii\\base\\Response|array|string","default":"'response'","description":"The response.","since":"2.0.36"},"route":{"type":"string","description":"The route (module ID, controller ID and action ID) of the current request.","access":"read-only","virtual":true},"uniqueId":{"type":"string","description":"The controller ID that is prefixed with the module ID (if any).","access":"read-only","virtual":true},"view":{"type":"yii\\base\\View|yii\\web\\View","description":"The view object that can be used to render views or view files.","virtual":true},"viewPath":{"type":"string","description":"The directory containing the view files for this controller.","virtual":true}},"methods":{"__construct":{"signature":"public function __construct(string $id, yii\\base\\T $module, array $config = [])","params":[{"name":"$id","type":"string","description":"The ID of this controller."},{"name":"$module","type":"yii\\base\\T","description":"The module that this controller belongs to."},{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties."}]},"actions":{"signature":"public function actions(): array","summary":"Declares external actions for the controller.","return":{"type":"array"}},"afterAction":{"signature":"public function afterAction(yii\\base\\Action $action, mixed $result): mixed","summary":"This method is invoked right after an action is executed.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action just executed."},{"name":"$result","type":"mixed","description":"The action return result."}],"return":{"type":"mixed","description":"The processed action result."}},"beforeAction":{"signature":"public function beforeAction(yii\\base\\Action $action): bool","summary":"This method is invoked right before an action is executed.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to run."}},"bindActionParams":{"signature":"public function bindActionParams(yii\\base\\Action $action, array $params): mixed[]","summary":"Binds the parameters to the action.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action to be bound with parameters."},{"name":"$params","type":"array","description":"The parameters to be bound to the action."}],"return":{"type":"mixed[]","description":"The valid parameters that the action can run with."}},"bindInjectedParams":{"signature":"final protected function bindInjectedParams(ReflectionNamedType $type, string $name, array &$args, array &$requestedParams): mixed","summary":"Fills parameters based on types and names in action method signature.","params":[{"name":"$type","type":"ReflectionNamedType","description":"The reflected type of the action parameter."},{"name":"$name","type":"string","description":"The name of the parameter."},{"name":"$args","type":"array","byReference":true,"description":"The array of arguments for the action, this function may append items to it."},{"name":"$requestedParams","type":"array","byReference":true,"description":"The array with requested params, this function may write specific keys to it."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\ErrorException","description":"when we cannot load a required service."},{"type":"yii\\base\\InvalidConfigException","description":"Thrown when there is an error in the DI configuration."},{"type":"yii\\di\\NotInstantiableException","description":"Thrown when a definition cannot be resolved to a concrete class (for example an interface type hint) without a proper definition in the container."}],"visibility":"protected","since":"2.0.36"},"createAction":{"signature":"public function createAction(string $id): yii\\base\\Action|null","summary":"Creates an action based on the given action ID.","params":[{"name":"$id","type":"string","description":"The action ID."}],"return":{"type":"yii\\base\\Action|null","description":"The newly created action instance. Null if the ID doesn't resolve into any action."}},"findLayoutFile":{"signature":"public function findLayoutFile(yii\\base\\View $view): string|bool","summary":"Finds the applicable layout file.","params":[{"name":"$view","type":"yii\\base\\View","description":"The view object to render the layout file."}],"return":{"type":"string|bool","description":"The layout file path, or false if layout is not needed. Please refer to `render()` on how to specify this parameter."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if an invalid path alias is used to specify the layout."}]},"getModules":{"signature":"public function getModules(): yii\\base\\Module[]","summary":"Returns all ancestor modules of this controller.","return":{"type":"yii\\base\\Module[]","description":"All ancestor modules that this controller is located within."}},"getRoute":{"signature":"public function getRoute(): string","summary":"Returns the route of the current request.","return":{"type":"string","description":"The route (module ID, controller ID and action ID) of the current request."}},"getUniqueId":{"signature":"public function getUniqueId(): string","summary":"Returns the unique ID of the controller.","return":{"type":"string","description":"The controller ID that is prefixed with the module ID (if any)."}},"getView":{"signature":"public function getView(): yii\\base\\View|yii\\web\\View","summary":"Returns the view object that can be used to render views or view files.","return":{"type":"yii\\base\\View|yii\\web\\View","description":"The view object that can be used to render views or view files."}},"getViewPath":{"signature":"public function getViewPath(): string","summary":"Returns the directory containing view files for this controller.","return":{"type":"string","description":"The directory containing the view files for this controller."}},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"},"since":"2.0.36"},"render":{"signature":"public function render(string $view, array $params = []): string","summary":"Renders a view and applies layout if available.","params":[{"name":"$view","type":"string","description":"The view name."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name-value pairs) that should be made available in the view. These parameters will not be available in the layout."}],"return":{"type":"string","description":"The rendering result."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the view file or the layout file does not exist."}]},"renderContent":{"signature":"public function renderContent(string $content): string","summary":"Renders a static string by applying a layout.","params":[{"name":"$content","type":"string","description":"The static string being rendered"}],"return":{"type":"string","description":"The rendering result of the layout with the given static string as the `$content` variable. If the layout is disabled, the string will be returned back."},"since":"2.0.1"},"renderFile":{"signature":"public function renderFile(string $file, array $params = []): string","summary":"Renders a view file.","params":[{"name":"$file","type":"string","description":"The view file to be rendered. This can be either a file path or a [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/)."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name-value pairs) that should be made available in the view."}],"return":{"type":"string","description":"The rendering result."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the view file does not exist."}]},"renderPartial":{"signature":"public function renderPartial(string $view, array $params = []): string","summary":"Renders a view without applying layout.","params":[{"name":"$view","type":"string","description":"The view name. Please refer to `render()` on how to specify a view name."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name-value pairs) that should be made available in the view."}],"return":{"type":"string","description":"The rendering result."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the view file does not exist."}]},"run":{"signature":"public function run(string $route, array $params = []): mixed","summary":"Runs a request specified in terms of a route.","params":[{"name":"$route","type":"string","description":"The route to be handled, e.g., 'view', 'comment/view', '/admin/comment/view'."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be passed to the action."}],"return":{"type":"mixed","description":"The result of the action."}},"runAction":{"signature":"public function runAction(string $id, array $params = []): mixed","summary":"Runs an action within this controller with the specified action ID and parameters.","params":[{"name":"$id","type":"string","description":"The ID of the action to be executed."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name-value pairs) to be passed to the action."}],"return":{"type":"mixed","description":"The result of the action."},"throws":[{"type":"yii\\base\\InvalidRouteException","description":"if the requested action ID cannot be resolved into an action successfully."}]},"setView":{"signature":"public function setView(yii\\base\\View|yii\\web\\View $view): mixed","summary":"Sets the view object to be used by this controller.","params":[{"name":"$view","type":"yii\\base\\View|yii\\web\\View","description":"The view object that can be used to render views or view files."}],"return":{"type":"mixed"}},"setViewPath":{"signature":"public function setViewPath(string $path): mixed","summary":"Sets the directory that contains the view files.","params":[{"name":"$path","type":"string","description":"The root directory of view files."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the directory is invalid"}],"since":"2.0.7"}},"events":{"EVENT_BEFORE_ACTION":{"value":"'beforeAction'","type":"yii\\base\\ActionEvent","description":"An event raised right before executing a controller action."},"EVENT_AFTER_ACTION":{"value":"'afterAction'","type":"yii\\base\\ActionEvent","description":"An event raised right after executing a controller action."}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\base\\DynamicContentAwareInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/base/dynamiccontentawareinterface/","summary":"DynamicContentAwareInterface is the interface that should be implemented by classes which support a `yii\\base\\View` dynamic content feature.","since":"2.0.14","methods":{"addDynamicPlaceholder":{"signature":"abstract public function addDynamicPlaceholder(string $name, string $statements): mixed","summary":"Adds a placeholder for dynamic content.","params":[{"name":"$name","type":"string","description":"The placeholder name."},{"name":"$statements","type":"string","description":"The PHP statements for generating the dynamic content."}],"return":{"type":"mixed"},"abstract":true},"getDynamicPlaceholders":{"signature":"abstract public function getDynamicPlaceholders(): array","summary":"Returns a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.","return":{"type":"array","description":"A list of placeholders."},"abstract":true},"setDynamicPlaceholders":{"signature":"abstract public function setDynamicPlaceholders(array $placeholders): mixed","summary":"Sets a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.","params":[{"name":"$placeholders","type":"array","description":"A list of placeholders."}],"return":{"type":"mixed"},"abstract":true}}},"yii\\base\\DynamicContentAwareTrait":{"kind":"trait","url":"https://yii2-framework.github.io/docs/api/yii/base/dynamiccontentawaretrait/","summary":"DynamicContentAwareTrait implements common methods for classes which support a `yii\\base\\View` dynamic content feature.","since":"2.0.14","methods":{"addDynamicPlaceholder":{"signature":"public function addDynamicPlaceholder(mixed $name, mixed $statements): mixed","summary":"Adds a placeholder for dynamic content.","params":[{"name":"$name","type":"mixed","description":"The placeholder name."},{"name":"$statements","type":"mixed","description":"The PHP statements for generating the dynamic content."}],"return":{"type":"mixed"}},"getDynamicPlaceholders":{"signature":"public function getDynamicPlaceholders(): array","summary":"Returns a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.","return":{"type":"array","description":"A list of placeholders."}},"getView":{"signature":"abstract protected function getView(): yii\\base\\View","summary":"Returns the view object that can be used to render views or view files using dynamic contents.","return":{"type":"yii\\base\\View","description":"The view object that can be used to render views or view files."},"visibility":"protected","abstract":true},"setDynamicPlaceholders":{"signature":"public function setDynamicPlaceholders(mixed $placeholders): mixed","summary":"Sets a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.","params":[{"name":"$placeholders","type":"mixed","description":"A list of placeholders."}],"return":{"type":"mixed"}},"updateDynamicContent":{"signature":"protected function updateDynamicContent(string $content, string[] $placeholders, bool $isRestoredFromCache = false): string","summary":"Replaces placeholders in $content with results of evaluated dynamic statements.","params":[{"name":"$content","type":"string","description":"Content to be parsed."},{"name":"$placeholders","type":"string[]","description":"Placeholders and their values."},{"name":"$isRestoredFromCache","type":"bool","default":"false","optional":true,"description":"Whether content is going to be restored from cache."}],"return":{"type":"string","description":"Final content."},"visibility":"protected"}}},"yii\\base\\DynamicModel":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/dynamicmodel/","summary":"DynamicModel is a model class that supports defining attributes at run-time (the so-called \"dynamic attributes\") using its constructor or `defineAttribute()`. DynamicModel can be used to support ad hoc data validation.","since":"2.0","extends":"yii\\base\\Model","implements":["yii\\base\\Configurable","yii\\base\\StaticInstanceInterface","IteratorAggregate","ArrayAccess","yii\\base\\Arrayable"],"traits":["yii\\base\\ArrayableTrait","yii\\base\\StaticInstanceTrait"],"properties":{"attributeLabels":{"type":"string[]","description":"Attribute labels.","access":"write-only","virtual":true}},"methods":{"__construct":{"signature":"public function __construct(array|string[] $attributes = [], array $config = [])","summary":"Constructor.","params":[{"name":"$attributes","type":"array|string[]","default":"[]","optional":true,"description":"The attributes (name-value pairs, or names) being defined."},{"name":"$config","type":"array","default":"[]","optional":true,"description":"The configuration array to be applied to this object."}]},"__get":{"signature":"public function __get(mixed $name): mixed","summary":"Returns the value of a component property.","params":[{"name":"$name","type":"mixed","description":"The property name"}],"return":{"type":"mixed","description":"The property value or the value of a behavior's property"},"throws":[{"type":"yii\\base\\UnknownPropertyException","description":"if the property is not defined"},{"type":"yii\\base\\InvalidCallException","description":"if the property is write-only."}]},"__isset":{"signature":"public function __isset(mixed $name): bool","summary":"Checks if a property is set, i.e. defined and not null.","params":[{"name":"$name","type":"mixed","description":"The property name or the event name"}],"return":{"type":"bool","description":"Whether the named property is set"}},"__set":{"signature":"public function __set(mixed $name, mixed $value): mixed","summary":"Sets the value of a component property.","params":[{"name":"$name","type":"mixed","description":"The property name or the event name"},{"name":"$value","type":"mixed","description":"The property value"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\UnknownPropertyException","description":"if the property is not defined"},{"type":"yii\\base\\InvalidCallException","description":"if the property is read-only."}]},"__unset":{"signature":"public function __unset(mixed $name): mixed","summary":"Sets a component property to be null.","params":[{"name":"$name","type":"mixed","description":"The property name"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if the property is read only."}]},"addRule":{"signature":"public function addRule(string|array $attributes, string|yii\\validators\\Validator|Closure $validator, array $options = []): $this","summary":"Adds a validation rule to this model.","params":[{"name":"$attributes","type":"string|array","description":"The attribute(s) to be validated by the rule."},{"name":"$validator","type":"string|yii\\validators\\Validator|Closure","description":"The validator. This can be either: * a built-in validator name listed in `builtInValidators`; * a method name of the model class; * an anonymous function; * a validator class name. * a Validator."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The options (name-value pairs) to be applied to the validator."}],"return":{"type":"$this"}},"attributeLabels":{"signature":"public function attributeLabels(): array","summary":"Returns the attribute labels.","return":{"type":"array","description":"Attribute labels (name => label)"}},"attributes":{"signature":"public function attributes(): string[]","summary":"Returns the list of attribute names.","return":{"type":"string[]","description":"List of attribute names."}},"canGetProperty":{"signature":"public function canGetProperty(mixed $name, mixed $checkVars = true, mixed $checkBehaviors = true): bool","summary":"Returns a value indicating whether a property can be read.","params":[{"name":"$name","type":"mixed","description":"The property name"},{"name":"$checkVars","type":"mixed","default":"true","optional":true,"description":"Whether to treat member variables as properties"},{"name":"$checkBehaviors","type":"mixed","default":"true","optional":true,"description":"Whether to treat behaviors' properties as properties of this component"}],"return":{"type":"bool","description":"Whether the property can be read"}},"canSetProperty":{"signature":"public function canSetProperty(mixed $name, mixed $checkVars = true, mixed $checkBehaviors = true): bool","summary":"Returns a value indicating whether a property can be set.","params":[{"name":"$name","type":"mixed","description":"The property name"},{"name":"$checkVars","type":"mixed","default":"true","optional":true,"description":"Whether to treat member variables as properties"},{"name":"$checkBehaviors","type":"mixed","default":"true","optional":true,"description":"Whether to treat behaviors' properties as properties of this component"}],"return":{"type":"bool","description":"Whether the property can be written"}},"defineAttribute":{"signature":"public function defineAttribute(string $name, mixed $value = null): mixed","summary":"Defines an attribute.","params":[{"name":"$name","type":"string","description":"The attribute name."},{"name":"$value","type":"mixed","default":"null","optional":true,"description":"The attribute value."}],"return":{"type":"mixed"}},"hasAttribute":{"signature":"public function hasAttribute(string $name): bool","summary":"Returns a value indicating whether the model has an attribute with the specified name.","params":[{"name":"$name","type":"string","description":"The name of the attribute."}],"return":{"type":"bool","description":"Whether the model has an attribute with the specified name."},"since":"2.0.16"},"setAttributeLabel":{"signature":"public function setAttributeLabel(string $attribute, string $label): $this","summary":"Sets a label for a single attribute.","params":[{"name":"$attribute","type":"string","description":"Attribute name."},{"name":"$label","type":"string","description":"Attribute label value."}],"return":{"type":"$this"},"since":"2.0.35"},"setAttributeLabels":{"signature":"public function setAttributeLabels(string[] $labels = []): $this","summary":"Sets the labels for all attributes.","params":[{"name":"$labels","type":"string[]","default":"[]","optional":true,"description":"Attribute labels."}],"return":{"type":"$this"},"since":"2.0.35"},"undefineAttribute":{"signature":"public function undefineAttribute(string $name): mixed","summary":"Undefines an attribute.","params":[{"name":"$name","type":"string","description":"The attribute name."}],"return":{"type":"mixed"}},"validateData":{"signature":"public static function validateData(array $data, array $rules = []): static","summary":"Validates the given data with the specified validation rules.","params":[{"name":"$data","type":"array","description":"The data (name-value pairs) to be validated."},{"name":"$rules","type":"array","default":"[]","optional":true,"description":"The validation rules. Please refer to `yii\\base\\Model::rules()` on the format of this parameter."}],"return":{"type":"static","description":"The model instance that contains the data being validated."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if a validation rule is not specified correctly."}],"static":true}},"inherited":{"properties":{"activeValidators":"yii\\base\\Model","attributes":"yii\\base\\Model","behaviors":"yii\\base\\Component","errors":"yii\\base\\Model","firstErrors":"yii\\base\\Model","iterator":"yii\\base\\Model","scenario":"yii\\base\\Model","validators":"yii\\base\\Model"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Model","activeAttributes":"yii\\base\\Model","addError":"yii\\base\\Model","addErrors":"yii\\base\\Model","afterValidate":"yii\\base\\Model","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","attributeHints":"yii\\base\\Model","beforeValidate":"yii\\base\\Model","behaviors":"yii\\base\\Component","className":"yii\\base\\BaseObject","clearErrors":"yii\\base\\Model","createValidators":"yii\\base\\Model","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","extractFieldsFor":"yii\\base\\ArrayableTrait","extractRootFields":"yii\\base\\ArrayableTrait","extraFields":"yii\\base\\ArrayableTrait","fields":"yii\\base\\Model","formName":"yii\\base\\Model","generateAttributeLabel":"yii\\base\\Model","getActiveValidators":"yii\\base\\Model","getAttributeHint":"yii\\base\\Model","getAttributeLabel":"yii\\base\\Model","getAttributes":"yii\\base\\Model","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getErrors":"yii\\base\\Model","getErrorSummary":"yii\\base\\Model","getFirstError":"yii\\base\\Model","getFirstErrors":"yii\\base\\Model","getIterator":"yii\\base\\Model","getScenario":"yii\\base\\Model","getValidators":"yii\\base\\Model","hasErrors":"yii\\base\\Model","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","instance":"yii\\base\\StaticInstanceTrait","isAttributeActive":"yii\\base\\Model","isAttributeRequired":"yii\\base\\Model","isAttributeSafe":"yii\\base\\Model","load":"yii\\base\\Model","loadMultiple":"yii\\base\\Model","off":"yii\\base\\Component","offsetExists":"yii\\base\\Model","offsetGet":"yii\\base\\Model","offsetSet":"yii\\base\\Model","offsetUnset":"yii\\base\\Model","on":"yii\\base\\Component","onUnsafeAttribute":"yii\\base\\Model","resolveFields":"yii\\base\\ArrayableTrait","rules":"yii\\base\\Model","safeAttributes":"yii\\base\\Model","scenarios":"yii\\base\\Model","setAttributes":"yii\\base\\Model","setScenario":"yii\\base\\Model","toArray":"yii\\base\\ArrayableTrait","trigger":"yii\\base\\Component","validate":"yii\\base\\Model","validateMultiple":"yii\\base\\Model"},"constants":{"SCENARIO_DEFAULT":"yii\\base\\Model"},"events":{"EVENT_BEFORE_VALIDATE":"yii\\base\\Model","EVENT_AFTER_VALIDATE":"yii\\base\\Model"}}},"yii\\base\\ErrorException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/errorexception/","summary":"ErrorException represents a PHP error.","since":"2.0","extends":"ErrorException","methods":{"__construct":{"signature":"public function __construct(string $message = '', int $code = 0, int $severity = 1, string $filename = __FILE__, int $lineno = __LINE__, Throwable|null $previous = null)","summary":"Constructs the exception.","params":[{"name":"$message","type":"string","default":"''","optional":true,"description":"[optional]"},{"name":"$code","type":"int","default":"0","optional":true,"description":"[optional]"},{"name":"$severity","type":"int","default":"1","optional":true,"description":"[optional]"},{"name":"$filename","type":"string","default":"__FILE__","optional":true,"description":"[optional]"},{"name":"$lineno","type":"int","default":"__LINE__","optional":true,"description":"[optional]"},{"name":"$previous","type":"Throwable|null","default":"null","optional":true,"description":"[optional]"}]},"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}},"isFatalError":{"signature":"public static function isFatalError(array $error): bool","summary":"Returns if error is one of fatal type.","params":[{"name":"$error","type":"array","description":"Error got from error_get_last()"}],"return":{"type":"bool","description":"If error is one of fatal type"},"static":true}}},"yii\\base\\ErrorHandler":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/base/errorhandler/","summary":"ErrorHandler handles uncaught PHP errors and exceptions.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"discardExistingOutput":{"type":"bool","default":"true","description":"Whether to discard any existing page output before error display."},"exception":{"type":"Throwable|null","default":"null","description":"The exception that is being handled currently."},"memoryReserveSize":{"type":"int","default":"262144","description":"The size of the reserved memory."},"silentExitOnException":{"type":"bool","default":"null","description":"If true - `handleException()` will finish script with `ExitCode::OK`. false - `ExitCode::UNSPECIFIED_ERROR`.","since":"2.0.36"}},"methods":{"clearOutput":{"signature":"public function clearOutput(): mixed","summary":"Removes all output echoed before calling this method.","return":{"type":"mixed"}},"convertExceptionToString":{"signature":"public static function convertExceptionToString(Throwable $exception): string","summary":"Converts an exception into a simple string.","params":[{"name":"$exception","type":"Throwable","description":"The exception being converted"}],"return":{"type":"string","description":"The string representation of the exception."},"static":true},"convertExceptionToVerboseString":{"signature":"public static function convertExceptionToVerboseString(Throwable $exception): string","summary":"Converts an exception into a string that has verbose information about the exception and its trace.","params":[{"name":"$exception","type":"Throwable","description":"The exception being converted"}],"return":{"type":"string","description":"The string representation of the exception."},"static":true,"since":"2.0.14"},"handleError":{"signature":"public function handleError(int $code, string $message, string $file, int $line): bool","summary":"Handles PHP execution errors such as warnings and notices.","params":[{"name":"$code","type":"int","description":"The level of the error raised."},{"name":"$message","type":"string","description":"The error message."},{"name":"$file","type":"string","description":"The filename that the error was raised in."},{"name":"$line","type":"int","description":"The line number the error was raised at."}],"return":{"type":"bool","description":"Whether the normal error handler continues."},"throws":[{"type":"yii\\base\\ErrorException"}]},"handleException":{"signature":"public function handleException(Throwable $exception): mixed","summary":"Handles uncaught PHP exceptions.","params":[{"name":"$exception","type":"Throwable","description":"The exception that is not caught"}],"return":{"type":"mixed"}},"handleFallbackExceptionMessage":{"signature":"protected function handleFallbackExceptionMessage(Throwable $exception, Throwable $previousException): mixed","summary":"Handles exception thrown during exception processing in `handleException()`.","params":[{"name":"$exception","type":"Throwable","description":"Exception that was thrown during main exception processing."},{"name":"$previousException","type":"Throwable","description":"Main exception processed in `handleException()`."}],"return":{"type":"mixed"},"visibility":"protected","since":"2.0.11"},"handleFatalError":{"signature":"public function handleFatalError(): mixed","summary":"Handles fatal PHP errors.","return":{"type":"mixed"}},"init":{"signature":"public function init(): mixed","return":{"type":"mixed"}},"logException":{"signature":"public function logException(Throwable $exception): mixed","summary":"Logs the given exception.","params":[{"name":"$exception","type":"Throwable","description":"The exception to be logged"}],"return":{"type":"mixed"}},"register":{"signature":"public function register(): mixed","summary":"Register this error handler.","return":{"type":"mixed"}},"renderException":{"signature":"abstract protected function renderException(Throwable $exception): mixed","summary":"Renders the exception.","params":[{"name":"$exception","type":"Throwable","description":"The exception to be rendered."}],"return":{"type":"mixed"},"visibility":"protected","abstract":true},"unregister":{"signature":"public function unregister(): mixed","summary":"Unregisters this error handler by restoring the PHP error and exception handlers.","return":{"type":"mixed"}}},"events":{"EVENT_SHUTDOWN":{"value":"'shutdown'","type":"yii\\base\\Event","description":"An event that is triggered when the handler is called by shutdown function via `handleFatalError()`.","since":"2.0.46"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\base\\Event":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/event/","summary":"Event is the base class for all event classes.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"data":{"type":"mixed","default":"null","description":"The data that is passed to `yii\\base\\Component::on()` when attaching an event handler."},"handled":{"type":"bool","default":"false","description":"Whether the event is handled."},"name":{"type":"string","default":"null","description":"The event name."},"sender":{"type":"object|null","default":"null","description":"The sender of this event."}},"methods":{"hasHandlers":{"signature":"public static function hasHandlers(string|object $class, string $name): bool","summary":"Returns a value indicating whether there is any handler attached to the specified class-level event.","params":[{"name":"$class","type":"string|object","description":"The object or the fully qualified class name specifying the class-level event."},{"name":"$name","type":"string","description":"The event name."}],"return":{"type":"bool","description":"Whether there is any handler attached to the event."},"static":true},"off":{"signature":"public static function off(string $class, string $name, callable|null $handler = null): bool","summary":"Detaches an event handler from a class-level event.","params":[{"name":"$class","type":"string","description":"The fully qualified class name from which the event handler needs to be detached."},{"name":"$name","type":"string","description":"The event name."},{"name":"$handler","type":"callable|null","default":"null","optional":true,"description":"The event handler to be removed. If it is `null`, all handlers attached to the named event will be removed."}],"return":{"type":"bool","description":"Whether a handler is found and detached."},"static":true},"offAll":{"signature":"public static function offAll(): mixed","summary":"Detaches all registered class-level event handlers.","return":{"type":"mixed"},"static":true,"since":"2.0.10"},"on":{"signature":"public static function on(string $class, string $name, callable $handler, mixed $data = null, bool $append = true): mixed","summary":"Attaches an event handler to a class-level event.","params":[{"name":"$class","type":"string","description":"The fully qualified class name to which the event handler needs to attach."},{"name":"$name","type":"string","description":"The event name."},{"name":"$handler","type":"callable","description":"The event handler."},{"name":"$data","type":"mixed","default":"null","optional":true,"description":"The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via `yii\\base\\Event::$data`."},{"name":"$append","type":"bool","default":"true","optional":true,"description":"Whether to append new event handler to the end of the existing handler list. If `false`, the new handler will be inserted at the beginning of the existing handler list."}],"return":{"type":"mixed"},"static":true},"trigger":{"signature":"public static function trigger(string|object $class, string $name, yii\\base\\Event|null $event = null): mixed","summary":"Triggers a class-level event.","params":[{"name":"$class","type":"string|object","description":"The object or the fully qualified class name specifying the class-level event."},{"name":"$name","type":"string","description":"The event name."},{"name":"$event","type":"yii\\base\\Event|null","default":"null","optional":true,"description":"The event parameter. If not set, a default `yii\\base\\Event` object will be created."}],"return":{"type":"mixed"},"static":true}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\base\\Exception":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/exception/","summary":"Exception represents a generic exception for all purposes.","since":"2.0","extends":"Exception","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\base\\ExitException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/exitexception/","summary":"ExitException represents a normal termination of an application.","since":"2.0","extends":"Exception","properties":{"statusCode":{"type":"int","default":"null","description":"The exit status code"}},"methods":{"__construct":{"signature":"public function __construct(int $status = 0, string $message = null, int $code = 0, Throwable|null $previous = null)","summary":"Constructor.","params":[{"name":"$status","type":"int","default":"0","optional":true,"description":"The exit status code"},{"name":"$message","type":"string","default":"null","optional":true,"description":"Error message"},{"name":"$code","type":"int","default":"0","optional":true,"description":"Error code"},{"name":"$previous","type":"Throwable|null","default":"null","optional":true,"description":"The previous exception used for the exception chaining."}]}}},"yii\\base\\InlineAction":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/inlineaction/","summary":"InlineAction represents an action that is defined as a controller method.","since":"2.0","extends":"yii\\base\\Action","implements":["yii\\base\\Configurable"],"properties":{"actionMethod":{"type":"string","default":"''","description":"The controller method that this inline action is associated with."}},"methods":{"__construct":{"signature":"public function __construct(string $id, yii\\base\\T $controller, string $actionMethod, array $config = [])","params":[{"name":"$id","type":"string","description":"The ID of this action"},{"name":"$controller","type":"yii\\base\\T","description":"The controller that owns this action"},{"name":"$actionMethod","type":"string","description":"The controller method that this inline action is associated with"},{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties"}]},"runWithParams":{"signature":"public function runWithParams(array $params): mixed","summary":"Runs this action with the specified parameters.","params":[{"name":"$params","type":"array","description":"Action parameters."}],"return":{"type":"mixed","description":"The result of the action, or `null` if `beforeRun()` returned `false`."}}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","controller":"yii\\base\\Action","id":"yii\\base\\Action","module":"yii\\base\\Action","uniqueId":"yii\\base\\Action"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","afterRun":"yii\\base\\Action","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeRun":"yii\\base\\Action","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getModule":"yii\\base\\Action","getUniqueId":"yii\\base\\Action","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","resolveStandaloneParams":"yii\\base\\Action","setModule":"yii\\base\\Action","trigger":"yii\\base\\Component"}}},"yii\\base\\InvalidArgumentException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/invalidargumentexception/","summary":"InvalidArgumentException represents an exception caused by invalid arguments passed to a method.","since":"2.0.14","extends":"BadMethodCallException","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\base\\InvalidCallException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/invalidcallexception/","summary":"InvalidCallException represents an exception caused by calling a method in a wrong way.","since":"2.0","extends":"BadMethodCallException","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\base\\InvalidConfigException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/invalidconfigexception/","summary":"InvalidConfigException represents an exception caused by incorrect object configuration.","since":"2.0","extends":"yii\\base\\Exception","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\base\\InvalidRouteException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/invalidrouteexception/","summary":"InvalidRouteException represents an exception caused by an invalid route.","since":"2.0","extends":"yii\\base\\UserException","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\base\\InvalidValueException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/invalidvalueexception/","summary":"InvalidValueException represents an exception caused by a function returning a value of unexpected type.","since":"2.0","extends":"UnexpectedValueException","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\base\\Model":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/model/","summary":"Model is the base class for data models.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\StaticInstanceInterface","IteratorAggregate","ArrayAccess","yii\\base\\Arrayable","yii\\base\\Configurable"],"traits":["yii\\base\\ArrayableTrait","yii\\base\\StaticInstanceTrait"],"properties":{"activeValidators":{"type":"yii\\validators\\Validator[]","description":"The validators applicable to the current `$scenario`.","access":"read-only","virtual":true},"attributes":{"type":"array","description":"Attribute values (name => value).","virtual":true},"errors":{"type":"array","description":"Errors for all attributes.","access":"read-only","virtual":true},"firstErrors":{"type":"array","description":"The first errors.","access":"read-only","virtual":true},"iterator":{"type":"ArrayIterator","description":"An iterator for traversing the items in the list.","access":"read-only","virtual":true},"scenario":{"type":"string","description":"The scenario that this model is in.","virtual":true},"validators":{"type":"ArrayObject|yii\\validators\\Validator[]","description":"All the validators declared in the model.","access":"read-only","virtual":true}},"methods":{"__clone":{"signature":"public function __clone(): mixed","summary":"This method is called after the object is created by cloning an existing one.","return":{"type":"mixed"}},"activeAttributes":{"signature":"public function activeAttributes(): string[]","summary":"Returns the attribute names that are subject to validation in the current scenario.","return":{"type":"string[]","description":"Safe attribute names"}},"addError":{"signature":"public function addError(string $attribute, string $error = ''): mixed","summary":"Adds a new error to the specified attribute.","params":[{"name":"$attribute","type":"string","description":"Attribute name"},{"name":"$error","type":"string","default":"''","optional":true,"description":"New error message"}],"return":{"type":"mixed"}},"addErrors":{"signature":"public function addErrors(array $items): mixed","summary":"Adds a list of errors.","params":[{"name":"$items","type":"array","description":"A list of errors. The array keys must be attribute names. The array values should be error messages. If an attribute has multiple errors, these errors must be given in terms of an array. You may use the result of `getErrors()` as the value for this parameter."}],"return":{"type":"mixed"},"since":"2.0.2"},"afterValidate":{"signature":"public function afterValidate(): mixed","summary":"This method is invoked after validation ends.","return":{"type":"mixed"}},"attributeHints":{"signature":"public function attributeHints(): array","summary":"Returns the attribute hints.","return":{"type":"array","description":"Attribute hints (name => hint)"},"since":"2.0.4"},"attributeLabels":{"signature":"public function attributeLabels(): array","summary":"Returns the attribute labels.","return":{"type":"array","description":"Attribute labels (name => label)"}},"attributes":{"signature":"public function attributes(): string[]","summary":"Returns the list of attribute names.","return":{"type":"string[]","description":"List of attribute names."}},"beforeValidate":{"signature":"public function beforeValidate(): bool","summary":"This method is invoked before validation starts.","return":{"type":"bool","description":"Whether the validation should be executed. Defaults to true. If false is returned, the validation will stop and the model is considered invalid."}},"clearErrors":{"signature":"public function clearErrors(string|null $attribute = null): mixed","summary":"Removes errors for all attributes or a single attribute.","params":[{"name":"$attribute","type":"string|null","default":"null","optional":true,"description":"Attribute name. Use null to remove errors for all attributes."}],"return":{"type":"mixed"}},"createValidators":{"signature":"public function createValidators(): ArrayObject","summary":"Creates validator objects based on the validation rules specified in `rules()`.","return":{"type":"ArrayObject","description":"Validators"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if any validation rule configuration is invalid"}]},"fields":{"signature":"public function fields(): array","summary":"Returns the list of fields that should be returned by default by `toArray()` when no specific fields are specified.","return":{"type":"array","description":"The list of field names or field definitions."}},"formName":{"signature":"public function formName(): string","summary":"Returns the form name that this model class should use.","return":{"type":"string","description":"The form name of this model class."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"when form is defined with anonymous class and `formName()` method is not overridden."}]},"generateAttributeLabel":{"signature":"public function generateAttributeLabel(string $name): string","summary":"Generates a user friendly attribute label based on the give attribute name.","params":[{"name":"$name","type":"string","description":"The column name"}],"return":{"type":"string","description":"The attribute label"}},"getActiveValidators":{"signature":"public function getActiveValidators(string|null $attribute = null): yii\\validators\\Validator[]","summary":"Returns the validators applicable to the current `$scenario`.","params":[{"name":"$attribute","type":"string|null","default":"null","optional":true,"description":"The name of the attribute whose applicable validators should be returned. If this is null, the validators for ALL attributes in the model will be returned."}],"return":{"type":"yii\\validators\\Validator[]","description":"The validators applicable to the current `$scenario`."}},"getAttributeHint":{"signature":"public function getAttributeHint(string $attribute): string","summary":"Returns the text hint for the specified attribute.","params":[{"name":"$attribute","type":"string","description":"The attribute name"}],"return":{"type":"string","description":"The attribute hint"},"since":"2.0.4"},"getAttributeLabel":{"signature":"public function getAttributeLabel(string $attribute): string","summary":"Returns the text label for the specified attribute.","params":[{"name":"$attribute","type":"string","description":"The attribute name"}],"return":{"type":"string","description":"The attribute label"}},"getAttributes":{"signature":"public function getAttributes(array|null $names = null, array $except = []): array","summary":"Returns attribute values.","params":[{"name":"$names","type":"array|null","default":"null","optional":true,"description":"List of attributes whose value needs to be returned. Defaults to null, meaning all attributes listed in `attributes()` will be returned. If it is an array, only the attributes in the array will be returned."},{"name":"$except","type":"array","default":"[]","optional":true,"description":"List of attributes whose value should NOT be returned."}],"return":{"type":"array","description":"Attribute values (name => value)."}},"getErrors":{"signature":"public function getErrors(string|null $attribute = null): ($attribute is null ? array : string[])","summary":"Returns the errors for all attributes or a single attribute.","params":[{"name":"$attribute","type":"string|null","default":"null","optional":true,"description":"Attribute name. Use null to retrieve errors for all attributes."}],"return":{"type":"($attribute is null ? array : string[])","description":"Errors for all attributes or the specified attribute. Empty array is returned if no error. Note that when returning errors for all attributes, the result is a two-dimensional array, like the following: ``` [ 'username' => [ 'Username is required.', 'Username must contain only word characters.', ], 'email' => [ 'Email address is invalid.', ] ] ```"}},"getErrorSummary":{"signature":"public function getErrorSummary(bool $showAllErrors): string[]","summary":"Returns the errors for all attributes as a one-dimensional array.","params":[{"name":"$showAllErrors","type":"bool","description":"Boolean, if set to true every error message for each attribute will be shown otherwise only the first error message for each attribute will be shown."}],"return":{"type":"string[]","description":"Errors for all attributes as a one-dimensional array. Empty array is returned if no error."},"since":"2.0.14"},"getFirstError":{"signature":"public function getFirstError(string $attribute): string|null","summary":"Returns the first error of the specified attribute.","params":[{"name":"$attribute","type":"string","description":"Attribute name."}],"return":{"type":"string|null","description":"The error message. Null is returned if no error."}},"getFirstErrors":{"signature":"public function getFirstErrors(): array","summary":"Returns the first error of every attribute in the model.","return":{"type":"array","description":"The first errors. The array keys are the attribute names, and the array values are the corresponding error messages. An empty array will be returned if there is no error."}},"getIterator":{"signature":"public function getIterator(): ArrayIterator","summary":"Returns an iterator for traversing the attributes in the model.","return":{"type":"ArrayIterator","description":"An iterator for traversing the items in the list."}},"getScenario":{"signature":"public function getScenario(): string","summary":"Returns the scenario that this model is used in.","return":{"type":"string","description":"The scenario that this model is in. Defaults to `SCENARIO_DEFAULT`."}},"getValidators":{"signature":"public function getValidators(): ArrayObject|yii\\validators\\Validator[]","summary":"Returns all the validators declared in `rules()`.","return":{"type":"ArrayObject|yii\\validators\\Validator[]","description":"All the validators declared in the model."}},"hasErrors":{"signature":"public function hasErrors(string|null $attribute = null): bool","summary":"Returns a value indicating whether there is any validation error.","params":[{"name":"$attribute","type":"string|null","default":"null","optional":true,"description":"Attribute name. Use null to check all attributes."}],"return":{"type":"bool","description":"Whether there is any error."}},"isAttributeActive":{"signature":"public function isAttributeActive(string $attribute): bool","summary":"Returns a value indicating whether the attribute is active in the current scenario.","params":[{"name":"$attribute","type":"string","description":"Attribute name"}],"return":{"type":"bool","description":"Whether the attribute is active in the current scenario"}},"isAttributeRequired":{"signature":"public function isAttributeRequired(string $attribute): bool","summary":"Returns a value indicating whether the attribute is required.","params":[{"name":"$attribute","type":"string","description":"Attribute name"}],"return":{"type":"bool","description":"Whether the attribute is required"}},"isAttributeSafe":{"signature":"public function isAttributeSafe(string $attribute): bool","summary":"Returns a value indicating whether the attribute is safe for massive assignments.","params":[{"name":"$attribute","type":"string","description":"Attribute name"}],"return":{"type":"bool","description":"Whether the attribute is safe for massive assignments"}},"load":{"signature":"public function load(array $data, string|null $formName = null): bool","summary":"Populates the model with input data.","params":[{"name":"$data","type":"array","description":"The data array to load, typically `$_POST` or `$_GET`."},{"name":"$formName","type":"string|null","default":"null","optional":true,"description":"The form name to use to load the data into the model, empty string when form not use. If not set, `formName()` is used."}],"return":{"type":"bool","description":"Whether `load()` found the expected form in `$data`."}},"loadMultiple":{"signature":"public static function loadMultiple(array $models, array $data, string|null $formName = null): bool","summary":"Populates a set of models with the data from end user.","params":[{"name":"$models","type":"array","description":"The models to be populated. Note that all models should have the same class."},{"name":"$data","type":"array","description":"The data array. This is usually `$_POST` or `$_GET`, but can also be any valid array supplied by end user."},{"name":"$formName","type":"string|null","default":"null","optional":true,"description":"The form name to be used for loading the data into the models. If not set, it will use the `formName()` value of the first model in `$models`. This parameter is available since version 2.0.1."}],"return":{"type":"bool","description":"Whether at least one of the models is successfully populated."},"static":true},"offsetExists":{"signature":"public function offsetExists(string $offset): bool","summary":"Returns whether there is an element at the specified offset.","params":[{"name":"$offset","type":"string","description":"The offset to check on."}],"return":{"type":"bool","description":"Whether or not an offset exists."}},"offsetGet":{"signature":"public function offsetGet(string $offset): mixed","summary":"Returns the element at the specified offset.","params":[{"name":"$offset","type":"string","description":"The offset to retrieve element."}],"return":{"type":"mixed","description":"The element at the offset, null if no element is found at the offset"}},"offsetSet":{"signature":"public function offsetSet(string $offset, mixed $value): mixed","summary":"Sets the element at the specified offset.","params":[{"name":"$offset","type":"string","description":"The offset to set element"},{"name":"$value","type":"mixed","description":"The element value"}],"return":{"type":"mixed"}},"offsetUnset":{"signature":"public function offsetUnset(string $offset): mixed","summary":"Sets the element value at the specified offset to null.","params":[{"name":"$offset","type":"string","description":"The offset to unset element"}],"return":{"type":"mixed"}},"onUnsafeAttribute":{"signature":"public function onUnsafeAttribute(string $name, mixed $value): mixed","summary":"This method is invoked when an unsafe attribute is being massively assigned.","params":[{"name":"$name","type":"string","description":"The unsafe attribute name"},{"name":"$value","type":"mixed","description":"The attribute value"}],"return":{"type":"mixed"}},"rules":{"signature":"public function rules(): array|yii\\validators\\Validator>","summary":"Returns the validation rules for attributes.","return":{"type":"array|yii\\validators\\Validator>","description":"Validation rules"}},"safeAttributes":{"signature":"public function safeAttributes(): string[]","summary":"Returns the attribute names that are safe to be massively assigned in the current scenario.","return":{"type":"string[]","description":"Safe attribute names"}},"scenarios":{"signature":"public function scenarios(): array","summary":"Returns a list of scenarios and the corresponding active attributes.","return":{"type":"array","description":"A list of scenarios and the corresponding active attributes."}},"setAttributes":{"signature":"public function setAttributes(array $values, bool $safeOnly = true): mixed","summary":"Sets the attribute values in a massive way.","params":[{"name":"$values","type":"array","description":"Attribute values (name => value) to be assigned to the model."},{"name":"$safeOnly","type":"bool","default":"true","optional":true,"description":"Whether the assignments should only be done to the safe attributes. A safe attribute is one that is associated with a validation rule in the current `$scenario`."}],"return":{"type":"mixed"}},"setScenario":{"signature":"public function setScenario(string $value): mixed","summary":"Sets the scenario for the model.","params":[{"name":"$value","type":"string","description":"The scenario that this model is in."}],"return":{"type":"mixed"}},"validate":{"signature":"public function validate(string[]|string|null $attributeNames = null, bool $clearErrors = true): bool","summary":"Performs the data validation.","params":[{"name":"$attributeNames","type":"string[]|string|null","default":"null","optional":true,"description":"Attribute name or list of attribute names that should be validated. If this parameter is empty, it means any attribute listed in the applicable validation rules should be validated."},{"name":"$clearErrors","type":"bool","default":"true","optional":true,"description":"Whether to call `clearErrors()` before performing validation"}],"return":{"type":"bool","description":"Whether the validation is successful without any error."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the current scenario is unknown."}]},"validateMultiple":{"signature":"public static function validateMultiple(array $models, array|null $attributeNames = null): bool","summary":"Validates multiple models.","params":[{"name":"$models","type":"array","description":"The models to be validated"},{"name":"$attributeNames","type":"array|null","default":"null","optional":true,"description":"List of attribute names that should be validated. If this parameter is empty, it means any attribute listed in the applicable validation rules should be validated."}],"return":{"type":"bool","description":"Whether all models are valid. False will be returned if one or multiple models have validation error."},"static":true}},"constants":{"SCENARIO_DEFAULT":{"value":"'default'","description":"The name of the default scenario."}},"events":{"EVENT_BEFORE_VALIDATE":{"value":"'beforeValidate'","type":"yii\\base\\ModelEvent","description":"An event raised at the beginning of `validate()`."},"EVENT_AFTER_VALIDATE":{"value":"'afterValidate'","type":"yii\\base\\Event","description":"An event raised at the end of `validate()`"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","extractFieldsFor":"yii\\base\\ArrayableTrait","extractRootFields":"yii\\base\\ArrayableTrait","extraFields":"yii\\base\\ArrayableTrait","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","instance":"yii\\base\\StaticInstanceTrait","off":"yii\\base\\Component","on":"yii\\base\\Component","resolveFields":"yii\\base\\ArrayableTrait","toArray":"yii\\base\\ArrayableTrait","trigger":"yii\\base\\Component"}}},"yii\\base\\ModelEvent":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/modelevent/","summary":"ModelEvent represents the parameter needed by `yii\\base\\Model` events.","since":"2.0","extends":"yii\\base\\Event","implements":["yii\\base\\Configurable"],"properties":{"isValid":{"type":"bool","default":"true","description":"Whether the model is in valid status."}},"inherited":{"properties":{"data":"yii\\base\\Event","handled":"yii\\base\\Event","name":"yii\\base\\Event","sender":"yii\\base\\Event"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasHandlers":"yii\\base\\Event","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","off":"yii\\base\\Event","offAll":"yii\\base\\Event","on":"yii\\base\\Event","trigger":"yii\\base\\Event"}}},"yii\\base\\Module":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/module/","summary":"Module is the base class for module and application classes.","since":"2.0","extends":"yii\\di\\ServiceLocator","implements":["yii\\base\\Configurable"],"properties":{"actionMap":{"type":"array>","default":"[]","description":"Mapping from action IDs to standalone `yii\\base\\Action` class configurations.","since":"22.0"},"actionNamespace":{"type":"string|null","default":"null","description":"The namespace where standalone `yii\\base\\Action` subclasses are located for convention-based discovery, parallel to `$controllerNamespace` for controllers.","since":"22.0"},"aliases":{"type":"array","description":"List of path aliases to be defined.","access":"write-only","virtual":true},"basePath":{"type":"string","description":"The root directory of the module.","virtual":true},"controllerMap":{"type":"array","default":"[]","description":"Mapping from controller ID to controller configurations."},"controllerNamespace":{"type":"string|null","default":"null","description":"The namespace that controller classes are in."},"controllerPath":{"type":"string","description":"The directory that contains the controller classes.","virtual":true},"defaultRoute":{"type":"string","default":"'default'","description":"The default route of this module."},"id":{"type":"string","default":"null","description":"An ID that uniquely identifies this module among other modules which have the same parent (`$module`)."},"layout":{"type":"string|bool|null","default":"null","description":"The layout that should be applied for views within this module."},"layoutPath":{"type":"string","description":"The root directory of layout files.","virtual":true},"module":{"type":"yii\\base\\Module|null","default":"null","description":"The parent module of this module. `null` if this module does not have a parent."},"modules":{"type":"array","description":"The modules (indexed by their IDs).","virtual":true},"params":{"type":"array","default":"[]","description":"Custom module parameters (name => value)."},"uniqueId":{"type":"string","description":"The unique ID of the module.","access":"read-only","virtual":true},"version":{"type":"string|callable|null","description":"The version of this module.","virtual":true},"viewPath":{"type":"string","description":"The root directory of view files.","virtual":true}},"methods":{"__construct":{"signature":"public function __construct(string $id, yii\\base\\Module|null $parent = null, array $config = [])","summary":"Constructor.","params":[{"name":"$id","type":"string","description":"The ID of this module."},{"name":"$parent","type":"yii\\base\\Module|null","default":"null","optional":true,"description":"The parent module (if any)."},{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties."}]},"afterAction":{"signature":"public function afterAction(yii\\base\\Action> $action, mixed $result): mixed","summary":"This method is invoked right after an action within this module is executed.","params":[{"name":"$action","type":"yii\\base\\Action>","description":"The action just executed."},{"name":"$result","type":"mixed","description":"The action return result."}],"return":{"type":"mixed","description":"The processed action result."}},"beforeAction":{"signature":"public function beforeAction(yii\\base\\Action> $action): bool","summary":"This method is invoked right before an action within this module is executed.","params":[{"name":"$action","type":"yii\\base\\Action>","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"createController":{"signature":"public function createController(string $route): array{yii\\base\\Controller, string}|false","summary":"Creates a controller instance based on the given route.","params":[{"name":"$route","type":"string","description":"The route consisting of module, controller and action IDs."}],"return":{"type":"array{yii\\base\\Controller, string}|false","description":"If the controller is created successfully, it will be returned together with the requested action ID. Otherwise `false` will be returned."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the controller class and its file do not match."}]},"createControllerByID":{"signature":"public function createControllerByID(string $id): yii\\base\\Controller|null","summary":"Creates a controller based on the given controller ID.","params":[{"name":"$id","type":"string","description":"The controller ID."}],"return":{"type":"yii\\base\\Controller|null","description":"The newly created controller instance, or `null` if the controller ID is invalid."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the controller class and its file name do not match. This exception is only thrown when in debug mode."}]},"createStandaloneAction":{"signature":"protected function createStandaloneAction(string $route): yii\\base\\Action|null","summary":"Resolves a route to a standalone `yii\\base\\Action` class through convention-based discovery under `$actionNamespace`.","params":[{"name":"$route","type":"string","description":"The route relative to this module."}],"return":{"type":"yii\\base\\Action|null","description":"A resolved standalone action ready for dispatch, or `null` when no class matches."},"visibility":"protected","since":"22.0"},"defaultVersion":{"signature":"protected function defaultVersion(): string","summary":"Returns default module version.","return":{"type":"string","description":"The version of this module."},"visibility":"protected","since":"2.0.11"},"get":{"signature":"public function get(mixed $id, mixed $throwException = true): ($throwException is true ? object : object|null)","summary":"Returns the component instance with the specified ID.","params":[{"name":"$id","type":"mixed","description":"Component ID (e.g. `db`)."},{"name":"$throwException","type":"mixed","default":"true","optional":true,"description":"Whether to throw an exception if `$id` is not registered with the locator before."}],"return":{"type":"($throwException is true ? object : object|null)","description":"The component of the specified ID. If `$throwException` is false and `$id` is not registered before, null will be returned."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$id` refers to a nonexistent component ID"}]},"getBasePath":{"signature":"public function getBasePath(): string","summary":"Returns the root directory of the module.","return":{"type":"string","description":"The root directory of the module."}},"getControllerPath":{"signature":"public function getControllerPath(): string","summary":"Returns the directory that contains the controller classes according to `$controllerNamespace`.","return":{"type":"string","description":"The directory that contains the controller classes."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if there is no alias defined for the root namespace of `$controllerNamespace`."}]},"getInstance":{"signature":"public static function getInstance(): static|null","summary":"Returns the currently requested instance of this module class.","return":{"type":"static|null","description":"The currently requested instance of this module class, or `null` if the module class is not requested."},"static":true},"getLayoutPath":{"signature":"public function getLayoutPath(): string","summary":"Returns the directory that contains layout view files for this module.","return":{"type":"string","description":"The root directory of layout files. Defaults to \"`$viewPath`/layouts\"."}},"getModule":{"signature":"public function getModule(string $id, bool $load = true): yii\\base\\Module|null","summary":"Retrieves the child module of the specified ID.","params":[{"name":"$id","type":"string","description":"Module ID (case-sensitive). To retrieve grand child modules, use ID path relative to this module (e.g. `admin/content`)."},{"name":"$load","type":"bool","default":"true","optional":true,"description":"Whether to load the module if it is not yet loaded."}],"return":{"type":"yii\\base\\Module|null","description":"The module instance, `null` if the module does not exist."}},"getModules":{"signature":"public function getModules(bool $loadedOnly = false): array","summary":"Returns the sub-modules in this module.","params":[{"name":"$loadedOnly","type":"bool","default":"false","optional":true,"description":"Whether to return the loaded sub-modules only. If this is set `false`, then all sub-modules registered in this module will be returned, whether they are loaded or not. Loaded modules will be returned as objects, while unloaded modules as configuration arrays."}],"return":{"type":"array","description":"The modules (indexed by their IDs)."}},"getUniqueId":{"signature":"public function getUniqueId(): string","summary":"Returns an ID that uniquely identifies this module among all modules within the current application.","return":{"type":"string","description":"The unique ID of the module."}},"getVersion":{"signature":"public function getVersion(): string","summary":"Returns current module version.","return":{"type":"string","description":"The version of this module."},"since":"2.0.11"},"getViewPath":{"signature":"public function getViewPath(): string","summary":"Returns the directory that contains the view files for this module.","return":{"type":"string","description":"The root directory of view files. Defaults to \"`$basePath`/views\"."}},"has":{"signature":"public function has(mixed $id, mixed $checkInstance = false): bool","summary":"Returns a value indicating whether the locator has the specified component definition or has instantiated the component.","params":[{"name":"$id","type":"mixed","description":"Component ID (e.g. `db`)."},{"name":"$checkInstance","type":"mixed","default":"false","optional":true,"description":"Whether the method should check if the component is shared and instantiated."}],"return":{"type":"bool","description":"Whether the locator has the specified component definition or has instantiated the component."}},"hasModule":{"signature":"public function hasModule(string $id): bool","summary":"Checks whether the child module of the specified ID exists.","params":[{"name":"$id","type":"string","description":"Module ID. For grand child modules, use ID path relative to this module (e.g. `admin/content`)."}],"return":{"type":"bool","description":"Whether the named module exists. Both loaded and unloaded modules are considered."}},"init":{"signature":"public function init(): mixed","summary":"Initializes the module.","return":{"type":"mixed"}},"runAction":{"signature":"public function runAction(string $route, array $params = []): mixed","summary":"Runs a controller action specified by a route.","params":[{"name":"$route","type":"string","description":"The route that specifies the action."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be passed to the action."}],"return":{"type":"mixed","description":"The result of the action."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if a controller method and a standalone Action class both match the same route."},{"type":"yii\\base\\InvalidRouteException","description":"if the requested route cannot be resolved into an action successfully."}]},"runMappedAction":{"signature":"protected function runMappedAction(string $id, array $params): mixed","summary":"Runs a standalone action registered in `$actionMap`.","params":[{"name":"$id","type":"string","description":"The action ID present in `$actionMap`."},{"name":"$params","type":"array","description":"The parameters to be matched against the action's `run()` signature."}],"return":{"type":"mixed","description":"The action result, or `null` if execution was canceled by a before-action listener."},"visibility":"protected","since":"22.0"},"runStandaloneAction":{"signature":"protected function runStandaloneAction(yii\\base\\Action $action, array $params): mixed","summary":"Runs a standalone `yii\\base\\Action` instance through the standard module/action event lifecycle.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action to run."},{"name":"$params","type":"array","description":"The parameters to be matched against the action's `run()` signature."}],"return":{"type":"mixed","description":"The action result, or `null` if execution was canceled by a before-action listener."},"visibility":"protected","since":"22.0"},"setAliases":{"signature":"public function setAliases(array $aliases): mixed","summary":"Defines path aliases.","params":[{"name":"$aliases","type":"array","description":"List of path aliases to be defined. The array keys are alias names (must start with `@`) and the array values are the corresponding paths or aliases. For example, ``` [ '@models' => '@app/models', // an existing alias '@backend' => __DIR__ . '/../backend', // a directory ] ```"}],"return":{"type":"mixed"}},"setBasePath":{"signature":"public function setBasePath(string $path): mixed","summary":"Sets the root directory of the module.","params":[{"name":"$path","type":"string","description":"The root directory of the module. This can be either a directory name or a [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/)."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the directory does not exist."}]},"setControllerPath":{"signature":"public function setControllerPath(string $path): mixed","summary":"Sets the directory that contains the controller classes.","params":[{"name":"$path","type":"string","description":"The root directory that contains the controller classes."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the directory is invalid."}],"since":"2.0.44"},"setInstance":{"signature":"public static function setInstance(yii\\base\\Module|null $instance): mixed","summary":"Sets the currently requested instance of this module class.","params":[{"name":"$instance","type":"yii\\base\\Module|null","description":"The currently requested instance of this module class. If it is `null`, the instance of the calling class will be removed, if any."}],"return":{"type":"mixed"},"static":true},"setLayoutPath":{"signature":"public function setLayoutPath(string $path): mixed","summary":"Sets the directory that contains the layout files.","params":[{"name":"$path","type":"string","description":"The root directory or [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/) of layout files."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the directory is invalid"}]},"setModule":{"signature":"public function setModule(string $id, yii\\base\\Module|array|null $module): mixed","summary":"Adds a sub-module to this module.","params":[{"name":"$id","type":"string","description":"Module ID."},{"name":"$module","type":"yii\\base\\Module|array|null","description":"The sub-module to be added to this module. This can be one of the following: - a `yii\\base\\Module` object - a configuration array: when `getModule()` is called initially, the array will be used to instantiate the sub-module - `null`: the named sub-module will be removed from this module"}],"return":{"type":"mixed"}},"setModules":{"signature":"public function setModules(array $modules): mixed","summary":"Registers sub-modules in the current module.","params":[{"name":"$modules","type":"array","description":"Modules (id => module configuration or instances)."}],"return":{"type":"mixed"}},"setVersion":{"signature":"public function setVersion(string|callable|null $version): mixed","summary":"Sets current module version.","params":[{"name":"$version","type":"string|callable|null","description":"The version of this module. Version can be specified as a PHP callback, which can accept module instance as an argument and should return the actual version. For example: ``` function (Module $module) { //return string } ```"}],"return":{"type":"mixed"},"since":"2.0.11"},"setViewPath":{"signature":"public function setViewPath(string $path): mixed","summary":"Sets the directory that contains the view files.","params":[{"name":"$path","type":"string","description":"The root directory of view files."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the directory is invalid."}]}},"events":{"EVENT_BEFORE_ACTION":{"value":"'beforeAction'","type":"yii\\base\\ActionEvent","description":"An event raised before executing a controller action."},"EVENT_AFTER_ACTION":{"value":"'afterAction'","type":"yii\\base\\ActionEvent","description":"An event raised after executing a controller action."}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","components":"yii\\di\\ServiceLocator"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__get":"yii\\di\\ServiceLocator","__isset":"yii\\di\\ServiceLocator","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","clear":"yii\\di\\ServiceLocator","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getComponents":"yii\\di\\ServiceLocator","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","set":"yii\\di\\ServiceLocator","setComponents":"yii\\di\\ServiceLocator","trigger":"yii\\base\\Component"}}},"yii\\base\\NotSupportedException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/notsupportedexception/","summary":"NotSupportedException represents an exception caused by accessing features that are not supported.","since":"2.0","extends":"yii\\base\\Exception","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\base\\Request":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/base/request/","summary":"Request represents a request that is handled by an `yii\\base\\Application`.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"isConsoleRequest":{"type":"bool","description":"The value indicating whether the current request is made via console.","virtual":true},"scriptFile":{"type":"string","description":"Entry script file path (processed w/ realpath()).","virtual":true}},"methods":{"getIsConsoleRequest":{"signature":"public function getIsConsoleRequest(): bool","summary":"Returns a value indicating whether the current request is made via command line.","return":{"type":"bool","description":"The value indicating whether the current request is made via console"}},"getScriptFile":{"signature":"public function getScriptFile(): string","summary":"Returns entry script file path.","return":{"type":"string","description":"Entry script file path (processed w/ realpath())"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the entry script file path cannot be determined automatically."}]},"resolve":{"signature":"abstract public function resolve(): array","summary":"Resolves the current request into a route and the associated parameters.","return":{"type":"array","description":"The first element is the route, and the second is the associated parameters."},"abstract":true},"setIsConsoleRequest":{"signature":"public function setIsConsoleRequest(bool $value): mixed","summary":"Sets the value indicating whether the current request is made via command line.","params":[{"name":"$value","type":"bool","description":"The value indicating whether the current request is made via command line"}],"return":{"type":"mixed"}},"setScriptFile":{"signature":"public function setScriptFile(string $value): mixed","summary":"Sets the entry script file path.","params":[{"name":"$value","type":"string","description":"The entry script file path. This can be either a file path or a [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/)."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the provided entry script file path is invalid."}]}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\base\\Response":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/response/","summary":"Response represents the response of an `yii\\base\\Application` to a `yii\\base\\Request`.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"exitStatus":{"type":"int","default":"0","description":"The exit status."}},"methods":{"clearOutputBuffers":{"signature":"public function clearOutputBuffers(): mixed","summary":"Removes all existing output buffers.","return":{"type":"mixed"}},"send":{"signature":"public function send(): mixed","summary":"Sends the response to client.","return":{"type":"mixed"}}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\base\\Security":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/security/","summary":"Security provides a set of methods to handle common security-related tasks.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"allowedCiphers":{"type":"array[]","default":"['AES-128-CBC' => [16, 16], 'AES-192-CBC' => [16, 24], 'AES-256-CBC' => [16, 32]]","description":"Look-up table of block sizes and key sizes for each supported OpenSSL cipher."},"authKeyInfo":{"type":"string","default":"'AuthorizationKey'","description":"HKDF info value for derivation of message authentication key."},"cipher":{"type":"string","default":"'AES-128-CBC'","description":"The cipher to use for encryption and decryption."},"derivationIterations":{"type":"int","default":"100000","description":"Derivation iterations count."},"kdfHash":{"type":"string","default":"'sha256'","description":"Hash algorithm for key derivation."},"macHash":{"type":"string","default":"'sha256'","description":"Hash algorithm for message authentication."},"passwordHashCost":{"type":"int","default":"13","description":"Default cost used for password hashing.","since":"2.0.6"}},"methods":{"compareString":{"signature":"public function compareString(string $expected, string $actual): bool","summary":"Performs string comparison using timing attack resistant approach.","params":[{"name":"$expected","type":"string","description":"String to compare."},{"name":"$actual","type":"string","description":"User-supplied string."}],"return":{"type":"bool","description":"Whether strings are equal."}},"decrypt":{"signature":"protected function decrypt(string $data, bool $passwordBased, string $secret, string|null $info): bool|string","summary":"Decrypts data.","params":[{"name":"$data","type":"string","description":"Encrypted data to be decrypted."},{"name":"$passwordBased","type":"bool","description":"Set true to use password-based key derivation"},{"name":"$secret","type":"string","description":"The decryption password or key"},{"name":"$info","type":"string|null","description":"Context/application specific information, @see encrypt()"}],"return":{"type":"bool|string","description":"The decrypted data or false on authentication failure"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"on OpenSSL not loaded"},{"type":"yii\\base\\Exception","description":"on OpenSSL error"}],"visibility":"protected"},"decryptByKey":{"signature":"public function decryptByKey(string $data, string $inputKey, string|null $info = null): bool|string","summary":"Verifies and decrypts data encrypted with `encryptByKey()`.","params":[{"name":"$data","type":"string","description":"The encrypted data to decrypt"},{"name":"$inputKey","type":"string","description":"The input to use for encryption and authentication"},{"name":"$info","type":"string|null","default":"null","optional":true,"description":"Optional context and application specific information, see `hkdf()`"}],"return":{"type":"bool|string","description":"The decrypted data or false on authentication failure"}},"decryptByPassword":{"signature":"public function decryptByPassword(string $data, string $password): bool|string","summary":"Verifies and decrypts data encrypted with `encryptByPassword()`.","params":[{"name":"$data","type":"string","description":"The encrypted data to decrypt"},{"name":"$password","type":"string","description":"The password to use for decryption"}],"return":{"type":"bool|string","description":"The decrypted data or false on authentication failure"}},"encrypt":{"signature":"protected function encrypt(string $data, bool $passwordBased, string $secret, string|null $info): string","summary":"Encrypts data.","params":[{"name":"$data","type":"string","description":"Data to be encrypted"},{"name":"$passwordBased","type":"bool","description":"Set true to use password-based key derivation"},{"name":"$secret","type":"string","description":"The encryption password or key"},{"name":"$info","type":"string|null","description":"Context/application specific information, e.g. a user ID See [RFC 5869 Section 3.2](https://tools.ietf.org/html/rfc5869#section-3.2) for more details."}],"return":{"type":"string","description":"The encrypted data as byte string"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"on OpenSSL not loaded"},{"type":"yii\\base\\Exception","description":"on OpenSSL error"}],"visibility":"protected"},"encryptByKey":{"signature":"public function encryptByKey(string $data, string $inputKey, string|null $info = null): string","summary":"Encrypts data using a cryptographic key.","params":[{"name":"$data","type":"string","description":"The data to encrypt"},{"name":"$inputKey","type":"string","description":"The input to use for encryption and authentication"},{"name":"$info","type":"string|null","default":"null","optional":true,"description":"Optional context and application specific information, see `hkdf()`"}],"return":{"type":"string","description":"The encrypted data as byte string"}},"encryptByPassword":{"signature":"public function encryptByPassword(string $data, string $password): string","summary":"Encrypts data using a password.","params":[{"name":"$data","type":"string","description":"The data to encrypt"},{"name":"$password","type":"string","description":"The password to use for encryption"}],"return":{"type":"string","description":"The encrypted data as byte string"}},"generatePasswordHash":{"signature":"public function generatePasswordHash(string $password, int|null $cost = null): string","summary":"Generates a secure hash from a password and a random salt.","params":[{"name":"$password","type":"string","description":"The password to be hashed."},{"name":"$cost","type":"int|null","default":"null","optional":true,"description":"Cost parameter used by the Blowfish hash algorithm. The higher the value of cost, the longer it takes to generate the hash and to verify a password against it. Higher cost therefore slows down a brute-force attack. For best protection against brute-force attacks, set it to the highest value that is tolerable on production servers. The time taken to compute the hash doubles for every increment by one of $cost."}],"return":{"type":"string","description":"The password hash string. The output length might increase in future versions of PHP (https://www.php.net/manual/en/function.password-hash.php)"},"throws":[{"type":"yii\\base\\Exception","description":"on bad password parameter or cost parameter."}]},"generateRandomKey":{"signature":"public function generateRandomKey(int $length = 32): string","summary":"Generates specified number of random bytes.","params":[{"name":"$length","type":"int","default":"32","optional":true,"description":"The number of bytes to generate"}],"return":{"type":"string","description":"The generated random bytes"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if wrong length is specified"},{"type":"yii\\base\\Exception","description":"on failure."}]},"generateRandomString":{"signature":"public function generateRandomString(int $length = 32): string","summary":"Generates a random string of specified length.","params":[{"name":"$length","type":"int","default":"32","optional":true,"description":"The length of the key in characters"}],"return":{"type":"string","description":"The generated random key"},"throws":[{"type":"yii\\base\\Exception","description":"on failure."}]},"hashData":{"signature":"public function hashData(string $data, string $key, bool $rawHash = false): string","summary":"Prefixes data with a keyed hash value so that it can later be detected if it is tampered.","params":[{"name":"$data","type":"string","description":"The data to be protected"},{"name":"$key","type":"string","description":"The secret key to be used for generating hash. Should be a secure cryptographic key."},{"name":"$rawHash","type":"bool","default":"false","optional":true,"description":"Whether the generated hash value is in raw binary format. If false, lowercase hex digits will be generated."}],"return":{"type":"string","description":"The data prefixed with the keyed hash"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"when HMAC generation fails."}]},"hkdf":{"signature":"public function hkdf(string $algo, string $inputKey, string|null $salt = null, string|null $info = null, int $length = 0): string","summary":"Derives a key from the given input key using the standard HKDF algorithm.","params":[{"name":"$algo","type":"string","description":"A hash algorithm supported by `hash_hmac()`, e.g. 'SHA-256'"},{"name":"$inputKey","type":"string","description":"The source key"},{"name":"$salt","type":"string|null","default":"null","optional":true,"description":"The random salt"},{"name":"$info","type":"string|null","default":"null","optional":true,"description":"Optional info to bind the derived key material to application- and context-specific information, e.g. a user ID or API version, see [RFC 5869](https://tools.ietf.org/html/rfc5869)"},{"name":"$length","type":"int","default":"0","optional":true,"description":"Length of the output key in bytes. If 0, the output key is the length of the hash algorithm output."}],"return":{"type":"string","description":"The derived key"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"when HMAC generation fails."}]},"maskToken":{"signature":"public function maskToken(string $token): string","summary":"Masks a token to make it uncompressible.","params":[{"name":"$token","type":"string","description":"An unmasked token."}],"return":{"type":"string","description":"A masked token."},"since":"2.0.12"},"pbkdf2":{"signature":"public function pbkdf2(string $algo, string $password, string $salt, int $iterations, int $length = 0): string","summary":"Derives a key from the given password using the standard PBKDF2 algorithm.","params":[{"name":"$algo","type":"string","description":"A hash algorithm supported by `hash_hmac()`, e.g. 'SHA-256'"},{"name":"$password","type":"string","description":"The source password"},{"name":"$salt","type":"string","description":"The random salt"},{"name":"$iterations","type":"int","description":"The number of iterations of the hash algorithm. Set as high as possible to hinder dictionary password attacks."},{"name":"$length","type":"int","default":"0","optional":true,"description":"Length of the output key in bytes. If 0, the output key is the length of the hash algorithm output."}],"return":{"type":"string","description":"The derived key"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"when hash generation fails due to invalid params given."}]},"unmaskToken":{"signature":"public function unmaskToken(string $maskedToken): string","summary":"Unmasks a token previously masked by `maskToken`.","params":[{"name":"$maskedToken","type":"string","description":"A masked token."}],"return":{"type":"string","description":"An unmasked token, or an empty string in case of token format is invalid."},"since":"2.0.12"},"validateData":{"signature":"public function validateData(string $data, string $key, bool $rawHash = false): string|false","summary":"Validates if the given data is tampered.","params":[{"name":"$data","type":"string","description":"The data to be validated. The data must be previously generated by `hashData()`."},{"name":"$key","type":"string","description":"The secret key that was previously used to generate the hash for the data in `hashData()`. function to see the supported hashing algorithms on your system. This must be the same as the value passed to `hashData()` when generating the hash for the data."},{"name":"$rawHash","type":"bool","default":"false","optional":true,"description":"This should take the same value as when you generate the data using `hashData()`. It indicates whether the hash value in the data is in binary format. If false, it means the hash value consists of lowercase hex digits only. hex digits will be generated."}],"return":{"type":"string|false","description":"The real data with the hash stripped off. False if the data is tampered."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"when HMAC generation fails."}]},"validatePassword":{"signature":"public function validatePassword(string $password, string $hash): bool","summary":"Verifies a password against a hash.","params":[{"name":"$password","type":"string","description":"The password to verify."},{"name":"$hash","type":"string","description":"The hash to verify the password against."}],"return":{"type":"bool","description":"Whether the password is correct."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"on bad password/hash parameters."}]}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\base\\StaticInstanceInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/base/staticinstanceinterface/","summary":"StaticInstanceInterface is the interface for providing static instances to classes, which can be used to obtain class meta information that can not be expressed in static methods.","since":"2.0.13","methods":{"instance":{"signature":"abstract public static function instance(bool $refresh = false): static","summary":"Returns static class instance, which can be used to obtain meta information.","params":[{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to re-create static instance even, if it is already cached."}],"return":{"type":"static","description":"Class instance."},"static":true,"abstract":true}}},"yii\\base\\StaticInstanceTrait":{"kind":"trait","url":"https://yii2-framework.github.io/docs/api/yii/base/staticinstancetrait/","summary":"StaticInstanceTrait provides methods to satisfy `yii\\base\\StaticInstanceInterface` interface.","since":"2.0.13","methods":{"instance":{"signature":"public static function instance(bool $refresh = false): static","summary":"Returns static class instance, which can be used to obtain meta information.","params":[{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to re-create static instance even, if it is already cached."}],"return":{"type":"static","description":"Class instance."},"static":true}}},"yii\\base\\Theme":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/theme/","summary":"Theme represents an application theme.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"basePath":{"type":"string","description":"The root path of this theme.","virtual":true},"baseUrl":{"type":"string|null","description":"The base URL (without ending slash) for this theme.","virtual":true},"pathMap":{"type":"array|null","default":"null","description":"The mapping between view directories and their corresponding themed versions."}},"methods":{"applyTo":{"signature":"public function applyTo(string $path): string","summary":"Converts a file to a themed file if possible.","params":[{"name":"$path","type":"string","description":"The file to be themed"}],"return":{"type":"string","description":"The themed file, or the original file if the themed version is not available."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$basePath` is not set"}]},"getBasePath":{"signature":"public function getBasePath(): string","return":{"type":"string","description":"The root path of this theme. All resources of this theme are located under this directory."}},"getBaseUrl":{"signature":"public function getBaseUrl(): string|null","return":{"type":"string|null","description":"The base URL (without ending slash) for this theme. All resources of this theme are considered to be under this base URL."}},"getPath":{"signature":"public function getPath(string $path): string","summary":"Converts a relative file path into an absolute one using `$basePath`.","params":[{"name":"$path","type":"string","description":"The relative file path to be converted."}],"return":{"type":"string","description":"The absolute file path"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$basePath` is not set"}]},"getUrl":{"signature":"public function getUrl(string $url): string","summary":"Converts a relative URL into an absolute URL using `$baseUrl`.","params":[{"name":"$url","type":"string","description":"The relative URL to be converted."}],"return":{"type":"string","description":"The absolute URL"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$baseUrl` is not set"}]},"setBasePath":{"signature":"public function setBasePath(string $path): mixed","params":[{"name":"$path","type":"string","description":"The root path or [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/) of this theme. All resources of this theme are located under this directory."}],"return":{"type":"mixed"}},"setBaseUrl":{"signature":"public function setBaseUrl(string|null $url): mixed","params":[{"name":"$url","type":"string|null","description":"The base URL or [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/) for this theme. All resources of this theme are considered to be under this base URL."}],"return":{"type":"mixed"}}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\base\\UnknownClassException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/unknownclassexception/","summary":"UnknownClassException represents an exception caused by using an unknown class.","since":"2.0","extends":"yii\\base\\Exception","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\base\\UnknownMethodException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/unknownmethodexception/","summary":"UnknownMethodException represents an exception caused by accessing an unknown object method.","since":"2.0","extends":"BadMethodCallException","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\base\\UnknownPropertyException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/unknownpropertyexception/","summary":"UnknownPropertyException represents an exception caused by accessing unknown object properties.","since":"2.0","extends":"yii\\base\\Exception","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\base\\UserException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/userexception/","summary":"UserException is the base class for exceptions that are meant to be shown to end users.","since":"2.0","extends":"yii\\base\\Exception","inherited":{"methods":{"getName":"yii\\base\\Exception"}}},"yii\\base\\View":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/view/","summary":"View represents a view object in the MVC pattern.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\DynamicContentAwareInterface","yii\\base\\Configurable"],"properties":{"blocks":{"type":"array","default":"null","description":"A list of named output blocks."},"context":{"type":"yii\\base\\ViewContextInterface","default":"null","description":"The context under which the `renderFile()` method is being invoked."},"defaultExtension":{"type":"string","default":"'php'","description":"The default view file extension."},"dynamicContents":{"type":"yii\\base\\DynamicContentAwareInterface[]","description":"Class instances supporting dynamic contents.","access":"read-only","virtual":true},"dynamicPlaceholders":{"type":"array","description":"A list of placeholders.","virtual":true},"params":{"type":"array","default":"[]","description":"Custom parameters that are shared among view templates."},"renderers":{"type":"array|null","default":"null","description":"A list of available renderers indexed by their corresponding supported file extensions."},"theme":{"type":"yii\\base\\Theme|array|string|null","default":"null","description":"The theme object or the configuration for creating the theme object."},"viewFile":{"type":"string|bool","description":"The view file currently being rendered.","access":"read-only","virtual":true}},"methods":{"addDynamicPlaceholder":{"signature":"public function addDynamicPlaceholder(mixed $placeholder, mixed $statements): mixed","summary":"Adds a placeholder for dynamic content.","params":[{"name":"$placeholder","type":"mixed"},{"name":"$statements","type":"mixed","description":"The PHP statements for generating the dynamic content."}],"return":{"type":"mixed"}},"afterRender":{"signature":"public function afterRender(string $viewFile, array $params, string &$output): mixed","summary":"This method is invoked right after `renderFile()` renders a view file.","params":[{"name":"$viewFile","type":"string","description":"The view file being rendered."},{"name":"$params","type":"array","description":"The parameter array passed to the `render()` method."},{"name":"$output","type":"string","byReference":true,"description":"The rendering result of the view file. Updates to this parameter will be passed back and returned by `renderFile()`."}],"return":{"type":"mixed"}},"beforeRender":{"signature":"public function beforeRender(string $viewFile, array $params): bool","summary":"This method is invoked right before `renderFile()` renders a view file.","params":[{"name":"$viewFile","type":"string","description":"The view file to be rendered."},{"name":"$params","type":"array","description":"The parameter array passed to the `render()` method."}],"return":{"type":"bool","description":"Whether to continue rendering the view file."}},"beginBlock":{"signature":"public function beginBlock(string $id, bool $renderInPlace = false): yii\\widgets\\Block","summary":"Begins recording a block.","params":[{"name":"$id","type":"string","description":"The block ID."},{"name":"$renderInPlace","type":"bool","default":"false","optional":true,"description":"Whether to render the block content in place. Defaults to false, meaning the captured block will not be displayed."}],"return":{"type":"yii\\widgets\\Block","description":"The Block widget instance"}},"beginCache":{"signature":"public function beginCache(string $id, array $properties = []): bool","summary":"Begins fragment caching.","params":[{"name":"$id","type":"string","description":"A unique ID identifying the fragment to be cached."},{"name":"$properties","type":"array","default":"[]","optional":true,"description":"Initial property values for `yii\\widgets\\FragmentCache`"}],"return":{"type":"bool","description":"Whether you should generate the content for caching. False if the cached version is available."}},"beginContent":{"signature":"public function beginContent(string $viewFile, array $params = []): yii\\widgets\\ContentDecorator","summary":"Begins the rendering of content that is to be decorated by the specified view.","params":[{"name":"$viewFile","type":"string","description":"The view file that will be used to decorate the content enclosed by this widget. This can be specified as either the view file path or [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/)."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The variables (name => value) to be extracted and made available in the decorative view."}],"return":{"type":"yii\\widgets\\ContentDecorator","description":"The ContentDecorator widget instance"}},"beginPage":{"signature":"public function beginPage(): mixed","summary":"Marks the beginning of a page.","return":{"type":"mixed"}},"endBlock":{"signature":"public function endBlock(): mixed","summary":"Ends recording a block.","return":{"type":"mixed"}},"endCache":{"signature":"public function endCache(): mixed","summary":"Ends fragment caching.","return":{"type":"mixed"}},"endContent":{"signature":"public function endContent(): mixed","summary":"Ends the rendering of content.","return":{"type":"mixed"}},"endPage":{"signature":"public function endPage(): mixed","summary":"Marks the ending of a page.","return":{"type":"mixed"}},"evaluateDynamicContent":{"signature":"public function evaluateDynamicContent(string $statements): mixed","summary":"Evaluates the given PHP statements.","params":[{"name":"$statements","type":"string","description":"The PHP statements to be evaluated."}],"return":{"type":"mixed","description":"The return value of the PHP statements."}},"findViewFile":{"signature":"protected function findViewFile(string $view, object|null $context = null): string","summary":"Finds the view file based on the given view name.","params":[{"name":"$view","type":"string","description":"The view name or the [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/) of the view file. Please refer to `render()` on how to specify this parameter."},{"name":"$context","type":"object|null","default":"null","optional":true,"description":"The context to be assigned to the view and can later be accessed via `$context` in the view. If the context implements `yii\\base\\ViewContextInterface`, it may also be used to locate the view file corresponding to a relative view name."}],"return":{"type":"string","description":"The view file path. Note that the file may not exist."},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if a relative view name is given while there is no active context to determine the corresponding view file."}],"visibility":"protected"},"getDynamicContents":{"signature":"public function getDynamicContents(): yii\\base\\DynamicContentAwareInterface[]","summary":"Returns a list of currently active dynamic content class instances.","return":{"type":"yii\\base\\DynamicContentAwareInterface[]","description":"Class instances supporting dynamic contents."},"since":"2.0.14"},"getDynamicPlaceholders":{"signature":"public function getDynamicPlaceholders(): array","summary":"Returns a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.","return":{"type":"array","description":"A list of placeholders."}},"getRequestedViewFile":{"signature":"protected function getRequestedViewFile(): string|bool","return":{"type":"string|bool","description":"The requested view currently being rendered. False if no view file is being rendered."},"visibility":"protected","since":"2.0.16"},"getViewFile":{"signature":"public function getViewFile(): string|bool","return":{"type":"string|bool","description":"The view file currently being rendered. False if no view file is being rendered."}},"init":{"signature":"public function init(): mixed","summary":"Initializes the view component.","return":{"type":"mixed"}},"popDynamicContent":{"signature":"public function popDynamicContent(): mixed","summary":"Removes a last class instance supporting dynamic contents from a list of currently active dynamic content class instances.","return":{"type":"mixed"},"since":"2.0.14"},"pushDynamicContent":{"signature":"public function pushDynamicContent(yii\\base\\DynamicContentAwareInterface $instance): mixed","summary":"Adds a class instance supporting dynamic contents to the end of a list of currently active dynamic content class instances.","params":[{"name":"$instance","type":"yii\\base\\DynamicContentAwareInterface","description":"Class instance supporting dynamic contents."}],"return":{"type":"mixed"},"since":"2.0.14"},"render":{"signature":"public function render(string $view, array $params = [], object|null $context = null): string","summary":"Renders a view.","params":[{"name":"$view","type":"string","description":"The view name."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name-value pairs) that will be extracted and made available in the view file."},{"name":"$context","type":"object|null","default":"null","optional":true,"description":"The context to be assigned to the view and can later be accessed via `$context` in the view. If the context implements `yii\\base\\ViewContextInterface`, it may also be used to locate the view file corresponding to a relative view name."}],"return":{"type":"string","description":"The rendering result"},"throws":[{"type":"yii\\base\\ViewNotFoundException","description":"if the view file does not exist."},{"type":"yii\\base\\InvalidCallException","description":"if the view cannot be resolved."}]},"renderDynamic":{"signature":"public function renderDynamic(string $statements): string","summary":"Renders dynamic content returned by the given PHP statements.","params":[{"name":"$statements","type":"string","description":"The PHP statements for generating the dynamic content."}],"return":{"type":"string","description":"The placeholder of the dynamic content, or the dynamic content if there is no active content cache currently. Note that most methods that indirectly modify layout such as registerJS() or registerJSFile() do not work with dynamic rendering."}},"renderFile":{"signature":"public function renderFile(string $viewFile, array $params = [], object|null $context = null): string","summary":"Renders a view file.","params":[{"name":"$viewFile","type":"string","description":"The view file. This can be either an absolute file path or an alias of it."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name-value pairs) that will be extracted and made available in the view file."},{"name":"$context","type":"object|null","default":"null","optional":true,"description":"The context that the view should use for rendering the view. If null, existing `$context` will be used."}],"return":{"type":"string","description":"The rendering result"},"throws":[{"type":"yii\\base\\ViewNotFoundException","description":"if the view file does not exist"}]},"renderPhpFile":{"signature":"public function renderPhpFile(string $_file_, array $_params_ = []): string","summary":"Renders a view file as a PHP script.","params":[{"name":"$_file_","type":"string","description":"The view file."},{"name":"$_params_","type":"array","default":"[]","optional":true,"description":"The parameters (name-value pairs) that will be extracted and made available in the view file."}],"return":{"type":"string","description":"The rendering result"},"throws":[{"type":"Throwable"}]},"setDynamicPlaceholders":{"signature":"public function setDynamicPlaceholders(mixed $placeholders): mixed","summary":"Sets a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.","params":[{"name":"$placeholders","type":"mixed","description":"A list of placeholders."}],"return":{"type":"mixed"}}},"events":{"EVENT_BEGIN_PAGE":{"value":"'beginPage'","type":"yii\\base\\Event","description":"An event that is triggered by `beginPage()`."},"EVENT_END_PAGE":{"value":"'endPage'","type":"yii\\base\\Event","description":"An event that is triggered by `endPage()`."},"EVENT_BEFORE_RENDER":{"value":"'beforeRender'","type":"yii\\base\\ViewEvent","description":"An event that is triggered by `renderFile()` right before it renders a view file."},"EVENT_AFTER_RENDER":{"value":"'afterRender'","type":"yii\\base\\ViewEvent","description":"An event that is triggered by `renderFile()` right after it renders a view file."}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\base\\ViewContextInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/base/viewcontextinterface/","summary":"ViewContextInterface is the interface that should implemented by classes who want to support relative view names.","since":"2.0","methods":{"getViewPath":{"signature":"abstract public function getViewPath(): string","return":{"type":"string","description":"The view path that may be prefixed to a relative view name."},"abstract":true}}},"yii\\base\\ViewEvent":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/viewevent/","summary":"ViewEvent represents events triggered by the `yii\\base\\View` component.","since":"2.0","extends":"yii\\base\\Event","implements":["yii\\base\\Configurable"],"properties":{"isValid":{"type":"bool","default":"true","description":"Whether to continue rendering the view file."},"output":{"type":"string","default":"null","description":"The rendering result of `yii\\base\\View::renderFile()`."},"params":{"type":"array","default":"null","description":"The parameter array passed to the `yii\\base\\View::render()` method."},"viewFile":{"type":"string","default":"null","description":"The view file being rendered."}},"inherited":{"properties":{"data":"yii\\base\\Event","handled":"yii\\base\\Event","name":"yii\\base\\Event","sender":"yii\\base\\Event"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasHandlers":"yii\\base\\Event","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","off":"yii\\base\\Event","offAll":"yii\\base\\Event","on":"yii\\base\\Event","trigger":"yii\\base\\Event"}}},"yii\\base\\ViewNotFoundException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/viewnotfoundexception/","summary":"ViewNotFoundException represents an exception caused by view file not found.","since":"2.0.10","extends":"yii\\base\\InvalidArgumentException","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\base\\ViewRenderer":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/base/viewrenderer/","summary":"ViewRenderer is the base class for view renderer classes.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"methods":{"render":{"signature":"abstract public function render(yii\\base\\View $view, string $file, array $params): string","summary":"Renders a view file.","params":[{"name":"$view","type":"yii\\base\\View","description":"The view object used for rendering the file."},{"name":"$file","type":"string","description":"The view file."},{"name":"$params","type":"array","description":"The parameters to be passed to the view file."}],"return":{"type":"string","description":"The rendering result"},"abstract":true}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\base\\Widget":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/widget/","summary":"Widget is the base class for widgets.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"autoIdPrefix":{"type":"string","default":"'w'","description":"The prefix to the automatically generated widget IDs.","static":true},"id":{"type":"string","description":"Id of the widget.","virtual":true},"view":{"type":"yii\\web\\View","description":"The view object that can be used to render views or view files.","virtual":true},"viewPath":{"type":"string","description":"The directory containing the view files for this widget.","access":"read-only","virtual":true}},"methods":{"afterRun":{"signature":"public function afterRun(mixed $result): mixed","summary":"This method is invoked right after a widget is executed.","params":[{"name":"$result","type":"mixed","description":"The widget return result."}],"return":{"type":"mixed","description":"The processed widget result."},"since":"2.0.11"},"beforeRun":{"signature":"public function beforeRun(): bool","summary":"This method is invoked right before the widget is executed.","return":{"type":"bool","description":"Whether the widget should continue to be executed."},"since":"2.0.11"},"begin":{"signature":"public static function begin(array $config = []): static","summary":"Begins a widget.","params":[{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties"}],"return":{"type":"static","description":"The newly created widget instance"},"static":true},"end":{"signature":"public static function end(): static","summary":"Ends a widget.","return":{"type":"static","description":"The widget instance that is ended."},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if `begin()` and `end()` calls are not properly nested"}],"static":true},"getId":{"signature":"public function getId(bool $autoGenerate = true): string|null","summary":"Returns the ID of the widget.","params":[{"name":"$autoGenerate","type":"bool","default":"true","optional":true,"description":"Whether to generate an ID if it is not set previously"}],"return":{"type":"string|null","description":"ID of the widget."}},"getView":{"signature":"public function getView(): yii\\web\\View","summary":"Returns the view object that can be used to render views or view files.","return":{"type":"yii\\web\\View","description":"The view object that can be used to render views or view files."}},"getViewPath":{"signature":"public function getViewPath(): string","summary":"Returns the directory containing the view files for this widget.","return":{"type":"string","description":"The directory containing the view files for this widget."}},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"render":{"signature":"public function render(string $view, array $params = []): string","summary":"Renders a view.","params":[{"name":"$view","type":"string","description":"The view name."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name-value pairs) that should be made available in the view."}],"return":{"type":"string","description":"The rendering result."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the view file does not exist."}]},"renderFile":{"signature":"public function renderFile(string $file, array $params = []): string","summary":"Renders a view file.","params":[{"name":"$file","type":"string","description":"The view file to be rendered. This can be either a file path or a [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/)."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name-value pairs) that should be made available in the view."}],"return":{"type":"string","description":"The rendering result."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the view file does not exist."}]},"run":{"signature":"public function run(): string|void","summary":"Executes the widget.","return":{"type":"string|void","description":"The rendering result may be directly \"echoed\" or returned as a string"}},"setId":{"signature":"public function setId(string $value): mixed","summary":"Sets the ID of the widget.","params":[{"name":"$value","type":"string","description":"Id of the widget."}],"return":{"type":"mixed"}},"setView":{"signature":"public function setView(yii\\web\\View $view): mixed","summary":"Sets the view object to be used by this widget.","params":[{"name":"$view","type":"yii\\web\\View","description":"The view object that can be used to render views or view files."}],"return":{"type":"mixed"}},"widget":{"signature":"public static function widget(array $config = []): string","summary":"Creates a widget instance and runs it.","params":[{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties"}],"return":{"type":"string","description":"The rendering result of the widget."},"throws":[{"type":"Throwable"}],"static":true}},"events":{"EVENT_INIT":{"value":"'init'","type":"yii\\base\\Event","description":"An event that is triggered when the widget is initialized via `init()`.","since":"2.0.11"},"EVENT_BEFORE_RUN":{"value":"'beforeRun'","type":"yii\\base\\WidgetEvent","description":"An event raised right before executing a widget.","since":"2.0.11"},"EVENT_AFTER_RUN":{"value":"'afterRun'","type":"yii\\base\\WidgetEvent","description":"An event raised right after executing a widget.","since":"2.0.11"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\base\\WidgetEvent":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/base/widgetevent/","summary":"WidgetEvent represents the event parameter used for a widget event.","since":"2.0.11","extends":"yii\\base\\Event","implements":["yii\\base\\Configurable"],"properties":{"isValid":{"type":"bool","default":"true","description":"Whether to continue running the widget."},"result":{"type":"mixed","default":"null","description":"The widget result."}},"inherited":{"properties":{"data":"yii\\base\\Event","handled":"yii\\base\\Event","name":"yii\\base\\Event","sender":"yii\\base\\Event"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasHandlers":"yii\\base\\Event","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","off":"yii\\base\\Event","offAll":"yii\\base\\Event","on":"yii\\base\\Event","trigger":"yii\\base\\Event"}}},"yii\\behaviors\\AttributeBehavior":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/behaviors/attributebehavior/","summary":"AttributeBehavior automatically assigns a specified value to one or multiple attributes of an ActiveRecord object when certain events happen.","since":"2.0","extends":"yii\\base\\Behavior","implements":["yii\\base\\Configurable"],"properties":{"attributes":{"type":"array","default":"[]","description":"List of attributes that are to be automatically filled with the value specified via `$value`."},"preserveNonEmptyValues":{"type":"bool","default":"false","description":"Whether to preserve non-empty attribute values.","since":"2.0.13"},"skipUpdateOnClean":{"type":"bool","default":"true","description":"Whether to skip this behavior when the `$owner` has not been modified","since":"2.0.8"},"value":{"type":"mixed","default":"null","description":"The value that will be assigned to the current attributes."}},"methods":{"evaluateAttributes":{"signature":"public function evaluateAttributes(yii\\base\\Event $event): mixed","summary":"Evaluates the attribute value and assigns it to the current attributes.","params":[{"name":"$event","type":"yii\\base\\Event"}],"return":{"type":"mixed"}},"events":{"signature":"public function events(): array","summary":"Declares event handlers for the `$owner`'s events.","return":{"type":"array","description":"Events (array keys) and the corresponding event handler methods (array values)."}},"getValue":{"signature":"protected function getValue(yii\\base\\Event $event): mixed","summary":"Returns the value for the current attributes.","params":[{"name":"$event","type":"yii\\base\\Event","description":"The event that triggers the current attribute updating."}],"return":{"type":"mixed","description":"The attribute value"},"visibility":"protected"}},"inherited":{"properties":{"owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","attach":"yii\\base\\Behavior","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\Behavior","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\behaviors\\AttributeTypecastBehavior":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/behaviors/attributetypecastbehavior/","summary":"AttributeTypecastBehavior provides an ability of automatic model attribute typecasting.","since":"2.0.10","extends":"yii\\base\\Behavior","implements":["yii\\base\\Configurable"],"properties":{"attributeTypes":{"type":"array|null","default":"null","description":"Attribute typecast map in format: attributeName => type."},"owner":{"type":"yii\\behaviors\\T|null","default":"null","description":"The owner of this behavior."},"skipOnNull":{"type":"bool","default":"true","description":"Whether to skip typecasting of `null` values."},"typecastAfterFind":{"type":"bool","default":"false","description":"Whether to perform typecasting after retrieving owner model data from the database (after find or refresh)."},"typecastAfterSave":{"type":"bool","default":"false","description":"Whether to perform typecasting after saving owner model (insert or update).","since":"2.0.14"},"typecastAfterValidate":{"type":"bool","default":"true","description":"Whether to perform typecasting after owner model validation."},"typecastBeforeSave":{"type":"bool","default":"false","description":"Whether to perform typecasting before saving owner model (insert or update)."}},"methods":{"afterFind":{"signature":"public function afterFind(yii\\base\\Event $event): mixed","summary":"Handles owner 'afterFind' event, ensuring attribute typecasting.","params":[{"name":"$event","type":"yii\\base\\Event","description":"Event instance."}],"return":{"type":"mixed"}},"afterSave":{"signature":"public function afterSave(yii\\base\\Event $event): mixed","summary":"Handles owner 'afterInsert' and 'afterUpdate' events, ensuring attribute typecasting.","params":[{"name":"$event","type":"yii\\base\\Event","description":"Event instance."}],"return":{"type":"mixed"},"since":"2.0.14"},"afterValidate":{"signature":"public function afterValidate(yii\\base\\Event $event): mixed","summary":"Handles owner 'afterValidate' event, ensuring attribute typecasting.","params":[{"name":"$event","type":"yii\\base\\Event","description":"Event instance."}],"return":{"type":"mixed"}},"attach":{"signature":"public function attach(mixed $owner): mixed","summary":"Attaches the behavior object to the component.","params":[{"name":"$owner","type":"mixed","description":"The component that this behavior is to be attached to."}],"return":{"type":"mixed"}},"beforeSave":{"signature":"public function beforeSave(yii\\base\\Event $event): mixed","summary":"Handles owner 'beforeInsert' and 'beforeUpdate' events, ensuring attribute typecasting.","params":[{"name":"$event","type":"yii\\base\\Event","description":"Event instance."}],"return":{"type":"mixed"}},"clearAutoDetectedAttributeTypes":{"signature":"public static function clearAutoDetectedAttributeTypes(): mixed","summary":"Clears internal static cache of auto detected `$attributeTypes` values over all affected owner classes.","return":{"type":"mixed"},"static":true},"detectAttributeTypes":{"signature":"protected function detectAttributeTypes(): array","summary":"Composes default value for `$attributeTypes` from the owner validation rules.","return":{"type":"array","description":"Attribute type map."},"visibility":"protected"},"events":{"signature":"public function events(): array","summary":"Declares event handlers for the `$owner`'s events.","return":{"type":"array","description":"Events (array keys) and the corresponding event handler methods (array values)."}},"resetOldAttributes":{"signature":"protected function resetOldAttributes(): mixed","summary":"Resets the old values of the named attributes.","return":{"type":"mixed"},"visibility":"protected"},"typecastAttributes":{"signature":"public function typecastAttributes(array|null $attributeNames = null): mixed","summary":"Typecast owner attributes according to `$attributeTypes`.","params":[{"name":"$attributeNames","type":"array|null","default":"null","optional":true,"description":"List of attribute names that should be type-casted. If this parameter is empty, it means any attribute listed in the `$attributeTypes` should be type-casted."}],"return":{"type":"mixed"}},"typecastValue":{"signature":"protected function typecastValue(mixed $value, string|callable $type): mixed","summary":"Casts the given value to the specified type.","params":[{"name":"$value","type":"mixed","description":"Value to be type-casted."},{"name":"$type","type":"string|callable","description":"Type name or typecast callable."}],"return":{"type":"mixed","description":"Typecast result."},"visibility":"protected"}},"constants":{"TYPE_INTEGER":{"value":"'integer'"},"TYPE_FLOAT":{"value":"'float'"},"TYPE_BOOLEAN":{"value":"'boolean'"},"TYPE_STRING":{"value":"'string'"}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\Behavior","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\behaviors\\AttributesBehavior":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/behaviors/attributesbehavior/","summary":"AttributesBehavior automatically assigns values specified to one or multiple attributes of an ActiveRecord object when certain events happen.","since":"2.0.13","extends":"yii\\base\\Behavior","implements":["yii\\base\\Configurable"],"properties":{"attributes":{"type":"array","default":"[]","description":"List of attributes that are to be automatically filled with the values specified via enclosed arrays."},"order":{"type":"array","default":"[]","description":"List of order of attributes that are to be automatically filled with the event."},"preserveNonEmptyValues":{"type":"bool","default":"false","description":"Whether to preserve non-empty attribute values."},"skipUpdateOnClean":{"type":"bool","default":"true","description":"Whether to skip this behavior when the `$owner` has not been modified"}},"methods":{"evaluateAttributes":{"signature":"public function evaluateAttributes(yii\\base\\Event $event): mixed","summary":"Evaluates the attributes values and assigns it to the current attributes.","params":[{"name":"$event","type":"yii\\base\\Event"}],"return":{"type":"mixed"}},"events":{"signature":"public function events(): array","summary":"Declares event handlers for the `$owner`'s events.","return":{"type":"array","description":"Events (array keys) and the corresponding event handler methods (array values)."}},"getValue":{"signature":"protected function getValue(string $attribute, yii\\base\\Event $event): mixed","summary":"Returns the value for the current attributes.","params":[{"name":"$attribute","type":"string","description":"Target attribute name"},{"name":"$event","type":"yii\\base\\Event","description":"The event that triggers the current attribute updating."}],"return":{"type":"mixed","description":"The attribute value"},"visibility":"protected"}},"inherited":{"properties":{"owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","attach":"yii\\base\\Behavior","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\Behavior","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\behaviors\\BlameableBehavior":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/behaviors/blameablebehavior/","summary":"BlameableBehavior automatically fills the specified attributes with the current user ID.","since":"2.0","extends":"yii\\behaviors\\AttributeBehavior","implements":["yii\\base\\Configurable"],"properties":{"createdByAttribute":{"type":"string|false","default":"'created_by'","description":"The attribute that will receive current user ID value Set this property to false if you do not want to record the creator ID."},"defaultValue":{"type":"mixed","default":"null","description":"Default value for cases when the user is guest","since":"2.0.14"},"updatedByAttribute":{"type":"string|false","default":"'updated_by'","description":"The attribute that will receive current user ID value Set this property to false if you do not want to record the updater ID."},"value":{"type":"mixed","default":"null"}},"methods":{"getDefaultValue":{"signature":"protected function getDefaultValue(yii\\base\\Event $event): array|mixed","summary":"Get default value","params":[{"name":"$event","type":"yii\\base\\Event"}],"return":{"type":"array|mixed"},"visibility":"protected","since":"2.0.14"},"getValue":{"signature":"protected function getValue(mixed $event): mixed","summary":"Returns the value for the current attributes.","params":[{"name":"$event","type":"mixed","description":"The event that triggers the current attribute updating."}],"return":{"type":"mixed","description":"The attribute value"},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}}},"inherited":{"properties":{"attributes":"yii\\behaviors\\AttributeBehavior","owner":"yii\\base\\Behavior","preserveNonEmptyValues":"yii\\behaviors\\AttributeBehavior","skipUpdateOnClean":"yii\\behaviors\\AttributeBehavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","attach":"yii\\base\\Behavior","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\Behavior","evaluateAttributes":"yii\\behaviors\\AttributeBehavior","events":"yii\\behaviors\\AttributeBehavior","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject"}}},"yii\\behaviors\\CacheableWidgetBehavior":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/behaviors/cacheablewidgetbehavior/","summary":"Cacheable widget behavior automatically caches widget contents according to duration and dependencies specified.","since":"2.0.14","extends":"yii\\base\\Behavior","implements":["yii\\base\\Configurable"],"properties":{"cache":{"type":"yii\\caching\\CacheInterface|string|array","default":"'cache'","description":"A cache object or a cache component ID or a configuration array for creating a cache object."},"cacheDependency":{"type":"yii\\caching\\Dependency|array|null","default":"null","description":"A cache dependency or a configuration array for creating a cache dependency or `null` meaning no cache dependency."},"cacheDuration":{"type":"int","default":"60","description":"Cache duration in seconds."},"cacheEnabled":{"type":"bool","default":"true","description":"Whether to enable caching or not."},"cacheKeyVariations":{"type":"string[]|string","default":"[]","description":"An array of strings or a single string which would cause the variation of the content being cached (e.g. an application language, a GET parameter)."}},"methods":{"afterRun":{"signature":"public function afterRun(yii\\base\\WidgetEvent $event): mixed","summary":"Outputs widget contents and ends fragment caching.","params":[{"name":"$event","type":"yii\\base\\WidgetEvent","description":"`Widget::EVENT_AFTER_RUN` event."}],"return":{"type":"mixed"}},"attach":{"signature":"public function attach(mixed $owner): mixed","summary":"Attaches the behavior object to the component.","params":[{"name":"$owner","type":"mixed","description":"The component that this behavior is to be attached to."}],"return":{"type":"mixed"}},"beforeRun":{"signature":"public function beforeRun(yii\\base\\WidgetEvent $event): mixed","summary":"Begins fragment caching. Prevents owner widget from execution if its contents can be retrieved from the cache.","params":[{"name":"$event","type":"yii\\base\\WidgetEvent","description":"`Widget::EVENT_BEFORE_RUN` event."}],"return":{"type":"mixed"}}},"inherited":{"properties":{"owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\Behavior","events":"yii\\base\\Behavior","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\behaviors\\OptimisticLockBehavior":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/behaviors/optimisticlockbehavior/","summary":"OptimisticLockBehavior automatically upgrades a model's lock version using the column name returned by optimisticLock() (`yii\\db\\BaseActiveRecord::optimisticLock()`).","since":"2.0.16","extends":"yii\\behaviors\\AttributeBehavior","implements":["yii\\base\\Configurable"],"properties":{"skipUpdateOnClean":{"type":"bool","default":"false","since":"2.0.8"},"value":{"type":"mixed","default":"null"}},"methods":{"attach":{"signature":"public function attach(mixed $owner): mixed","summary":"Attaches the behavior object to the component.","params":[{"name":"$owner","type":"mixed","description":"The component that this behavior is to be attached to."}],"return":{"type":"mixed"}},"events":{"signature":"public function events(): array","summary":"Declares event handlers for the `$owner`'s events.","return":{"type":"array","description":"Events (array keys) and the corresponding event handler methods (array values)."}},"getLockAttribute":{"signature":"protected function getLockAttribute(): string","summary":"Returns the column name to hold the version value as defined in optimisticLock() (`yii\\db\\BaseActiveRecord::optimisticLock()`).","return":{"type":"string","description":"The property name."},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if optimisticLock() (`yii\\db\\BaseActiveRecord::optimisticLock()`) is not properly configured."}],"visibility":"protected","since":"2.0.16"},"getValue":{"signature":"protected function getValue(mixed $event): mixed","summary":"Returns the value for the current attributes.","params":[{"name":"$event","type":"mixed","description":"The event that triggers the current attribute updating."}],"return":{"type":"mixed","description":"The attribute value"},"visibility":"protected"},"upgrade":{"signature":"public function upgrade(): mixed","summary":"Upgrades the version value by one and stores it to database.","return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if owner is a new record."}],"since":"2.0.16"}},"inherited":{"properties":{"attributes":"yii\\behaviors\\AttributeBehavior","owner":"yii\\base\\Behavior","preserveNonEmptyValues":"yii\\behaviors\\AttributeBehavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\Behavior","evaluateAttributes":"yii\\behaviors\\AttributeBehavior","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\behaviors\\SluggableBehavior":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/behaviors/sluggablebehavior/","summary":"SluggableBehavior automatically fills the specified attribute with a value that can be used a slug in a URL.","since":"2.0","extends":"yii\\behaviors\\AttributeBehavior","implements":["yii\\base\\Configurable"],"properties":{"attribute":{"type":"string|array|null","default":"null","description":"The attribute or list of attributes whose value will be converted into a slug or `null` meaning that the `$value` property will be used to generate a slug."},"ensureUnique":{"type":"bool","default":"false","description":"Whether to ensure generated slug value to be unique among owner class records."},"immutable":{"type":"bool","default":"false","description":"Whether to generate a new slug if it has already been generated before.","since":"2.0.2"},"skipOnEmpty":{"type":"bool","default":"false","description":"Whether to skip slug generation if `$attribute` is null or an empty string.","since":"2.0.13"},"slugAttribute":{"type":"string","default":"'slug'","description":"The attribute that will receive the slug value"},"uniqueSlugGenerator":{"type":"callable|null","default":"null","description":"Slug unique value generator."},"uniqueValidator":{"type":"array","default":"[]","description":"Configuration for slug uniqueness validator."},"value":{"type":"callable|string|null","default":"null","description":"The value that will be used as a slug."}},"methods":{"generateSlug":{"signature":"protected function generateSlug(array $slugParts): string","summary":"This method is called by `getValue()` to generate the slug.","params":[{"name":"$slugParts","type":"array","description":"An array of strings that should be concatenated and converted to generate the slug value."}],"return":{"type":"string","description":"The conversion result."},"visibility":"protected"},"generateUniqueSlug":{"signature":"protected function generateUniqueSlug(string $baseSlug, int $iteration): string","summary":"Generates slug using configured callback or increment of iteration.","params":[{"name":"$baseSlug","type":"string","description":"Base slug value"},{"name":"$iteration","type":"int","description":"Iteration number"}],"return":{"type":"string","description":"New slug value"},"throws":[{"type":"yii\\base\\InvalidConfigException"}],"visibility":"protected"},"getValue":{"signature":"protected function getValue(mixed $event): mixed","summary":"Returns the value for the current attributes.","params":[{"name":"$event","type":"mixed","description":"The event that triggers the current attribute updating."}],"return":{"type":"mixed","description":"The attribute value"},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"isEmpty":{"signature":"protected function isEmpty(string $slugPart): bool","summary":"Checks if $slugPart is empty string or null.","params":[{"name":"$slugPart","type":"string","description":"One of attributes that is used for slug generation."}],"return":{"type":"bool","description":"Whether $slugPart empty or not."},"visibility":"protected","since":"2.0.13"},"isNewSlugNeeded":{"signature":"protected function isNewSlugNeeded(): bool","summary":"Checks whether the new slug generation is needed This method is called by `getValue()` to check whether the new slug generation is needed.","return":{"type":"bool"},"visibility":"protected","since":"2.0.7"},"makeUnique":{"signature":"protected function makeUnique(string $slug): string","summary":"This method is called by `getValue()` when `$ensureUnique` is true to generate the unique slug.","params":[{"name":"$slug","type":"string","description":"Basic slug value"}],"return":{"type":"string","description":"Unique slug"},"visibility":"protected","since":"2.0.7"},"validateSlug":{"signature":"protected function validateSlug(string $slug): bool","summary":"Checks if given slug value is unique.","params":[{"name":"$slug","type":"string","description":"Slug value"}],"return":{"type":"bool","description":"Whether slug is unique."},"visibility":"protected"}},"inherited":{"properties":{"attributes":"yii\\behaviors\\AttributeBehavior","owner":"yii\\base\\Behavior","preserveNonEmptyValues":"yii\\behaviors\\AttributeBehavior","skipUpdateOnClean":"yii\\behaviors\\AttributeBehavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","attach":"yii\\base\\Behavior","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\Behavior","evaluateAttributes":"yii\\behaviors\\AttributeBehavior","events":"yii\\behaviors\\AttributeBehavior","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject"}}},"yii\\behaviors\\TimestampBehavior":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/behaviors/timestampbehavior/","summary":"TimestampBehavior automatically fills the specified attributes with the current timestamp.","since":"2.0","extends":"yii\\behaviors\\AttributeBehavior","implements":["yii\\base\\Configurable"],"properties":{"createdAtAttribute":{"type":"string|false","default":"'created_at'","description":"The attribute that will receive timestamp value Set this property to false if you do not want to record the creation time."},"updatedAtAttribute":{"type":"string|false","default":"'updated_at'","description":"The attribute that will receive timestamp value."},"value":{"type":"mixed","default":"null"}},"methods":{"getValue":{"signature":"protected function getValue(mixed $event): mixed","summary":"Returns the value for the current attributes.","params":[{"name":"$event","type":"mixed","description":"The event that triggers the current attribute updating."}],"return":{"type":"mixed","description":"The attribute value"},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"touch":{"signature":"public function touch(string $attribute): mixed","summary":"Updates a timestamp attribute to the current timestamp.","params":[{"name":"$attribute","type":"string","description":"The name of the attribute to update."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if owner is a new record (since version 2.0.6)."}]}},"inherited":{"properties":{"attributes":"yii\\behaviors\\AttributeBehavior","owner":"yii\\base\\Behavior","preserveNonEmptyValues":"yii\\behaviors\\AttributeBehavior","skipUpdateOnClean":"yii\\behaviors\\AttributeBehavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","attach":"yii\\base\\Behavior","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\Behavior","evaluateAttributes":"yii\\behaviors\\AttributeBehavior","events":"yii\\behaviors\\AttributeBehavior","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject"}}},"yii\\caching\\ApcuCache":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/apcucache/","summary":"ApcuCache provides APCu caching in terms of an application component.","since":"22.0","extends":"yii\\caching\\Cache","implements":["yii\\base\\Configurable","yii\\caching\\CacheInterface"],"methods":{"addValue":{"signature":"protected function addValue(string $key, mixed $value, int $duration): bool","summary":"Stores a value identified by a key into cache if the cache does not contain this key.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached."},{"name":"$value","type":"mixed","description":"The value to be cached. Most often it's a string. If you have disabled `$serializer`, it could be something else."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. `0` means never expire."}],"return":{"type":"bool","description":"`true` if the value is successfully stored into cache, `false` otherwise."},"visibility":"protected"},"addValues":{"signature":"protected function addValues(array $data, int $duration): array","summary":"Adds multiple key-value pairs to cache.","params":[{"name":"$data","type":"array","description":"Array where key corresponds to cache key while value is the value stored."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached values will expire. `0` means never expire."}],"return":{"type":"array","description":"Array of failed keys."},"visibility":"protected"},"deleteValue":{"signature":"protected function deleteValue(string $key): bool","summary":"Deletes a value with the specified key from cache.","params":[{"name":"$key","type":"string","description":"The key of the value to be deleted."}],"return":{"type":"bool","description":"If no error happens during deletion."},"visibility":"protected"},"exists":{"signature":"public function exists(mixed $key): bool","summary":"Checks whether a specified key exists in the cache.","params":[{"name":"$key","type":"mixed","description":"A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key."}],"return":{"type":"bool","description":"`true` if a value exists in cache, `false` if the value is not in the cache or expired."}},"flushValues":{"signature":"protected function flushValues(): bool","summary":"Deletes all values from cache.","return":{"type":"bool","description":"Whether the flush operation was successful."},"visibility":"protected"},"getValue":{"signature":"protected function getValue(string $key): mixed|false","summary":"Retrieves a value from cache with a specified key.","params":[{"name":"$key","type":"string","description":"A unique key identifying the cached value."}],"return":{"type":"mixed|false","description":"The value stored in cache, `false` if the value is not in the cache or expired."},"visibility":"protected"},"getValues":{"signature":"protected function getValues(array $keys): array","summary":"Retrieves multiple values from cache with the specified keys.","params":[{"name":"$keys","type":"array","description":"A list of keys identifying the cached values."}],"return":{"type":"array","description":"A list of cached values indexed by the keys."},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes this application component.","return":{"type":"mixed"}},"setValue":{"signature":"protected function setValue(string $key, mixed $value, int $duration): bool","summary":"Stores a value identified by a key in cache.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached."},{"name":"$value","type":"mixed","description":"The value to be cached. Most often it's a string. If you have disabled `$serializer`, it could be something else."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. `0` means never expire."}],"return":{"type":"bool","description":"`true` if the value is successfully stored into cache, `false` otherwise."},"visibility":"protected"},"setValues":{"signature":"protected function setValues(array $data, int $duration): array","summary":"Stores multiple key-value pairs in cache.","params":[{"name":"$data","type":"array","description":"Array where key corresponds to cache key while value is the value stored."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached values will expire. `0` means never expire."}],"return":{"type":"array","description":"Array of failed keys."},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","defaultDuration":"yii\\caching\\Cache","keyPrefix":"yii\\caching\\Cache","serializer":"yii\\caching\\Cache"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","add":"yii\\caching\\Cache","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","buildKey":"yii\\caching\\Cache","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","delete":"yii\\caching\\Cache","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","flush":"yii\\caching\\Cache","get":"yii\\caching\\Cache","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getOrSet":"yii\\caching\\Cache","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","multiAdd":"yii\\caching\\Cache","multiGet":"yii\\caching\\Cache","multiSet":"yii\\caching\\Cache","off":"yii\\base\\Component","offsetExists":"yii\\caching\\Cache","offsetGet":"yii\\caching\\Cache","offsetSet":"yii\\caching\\Cache","offsetUnset":"yii\\caching\\Cache","on":"yii\\base\\Component","set":"yii\\caching\\Cache","trigger":"yii\\base\\Component"}}},"yii\\caching\\ArrayCache":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/arraycache/","summary":"ArrayCache provides caching for the current request only by storing the values in an array.","since":"2.0","extends":"yii\\caching\\Cache","implements":["yii\\base\\Configurable","yii\\caching\\CacheInterface"],"methods":{"addValue":{"signature":"protected function addValue(mixed $key, mixed $value, mixed $duration): bool","summary":"Stores a value identified by a key into cache if the cache does not contain this key.","params":[{"name":"$key","type":"mixed","description":"The key identifying the value to be cached"},{"name":"$value","type":"mixed","description":"The value to be cached. Most often it's a string. If you have disabled `$serializer`, it could be something else."},{"name":"$duration","type":"mixed","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"},"deleteValue":{"signature":"protected function deleteValue(mixed $key): bool","summary":"Deletes a value with the specified key from cache This method should be implemented by child classes to delete the data from actual cache storage.","params":[{"name":"$key","type":"mixed","description":"The key of the value to be deleted"}],"return":{"type":"bool","description":"If no error happens during deletion"},"visibility":"protected"},"exists":{"signature":"public function exists(mixed $key): bool","summary":"Checks whether a specified key exists in the cache.","params":[{"name":"$key","type":"mixed","description":"A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key."}],"return":{"type":"bool","description":"True if a value exists in cache, false if the value is not in the cache or expired."}},"flushValues":{"signature":"protected function flushValues(): bool","summary":"Deletes all values from cache.","return":{"type":"bool","description":"Whether the flush operation was successful."},"visibility":"protected"},"getValue":{"signature":"protected function getValue(mixed $key): mixed|false","summary":"Retrieves a value from cache with a specified key.","params":[{"name":"$key","type":"mixed","description":"A unique key identifying the cached value"}],"return":{"type":"mixed|false","description":"The value stored in cache, false if the value is not in the cache or expired. Most often value is a string. If you have disabled `$serializer`, it could be something else."},"visibility":"protected"},"setValue":{"signature":"protected function setValue(mixed $key, mixed $value, mixed $duration): bool","summary":"Stores a value identified by a key in cache.","params":[{"name":"$key","type":"mixed","description":"The key identifying the value to be cached"},{"name":"$value","type":"mixed","description":"The value to be cached. Most often it's a string. If you have disabled `$serializer`, it could be something else."},{"name":"$duration","type":"mixed","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","defaultDuration":"yii\\caching\\Cache","keyPrefix":"yii\\caching\\Cache","serializer":"yii\\caching\\Cache"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","add":"yii\\caching\\Cache","addValues":"yii\\caching\\Cache","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","buildKey":"yii\\caching\\Cache","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","delete":"yii\\caching\\Cache","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","flush":"yii\\caching\\Cache","get":"yii\\caching\\Cache","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getOrSet":"yii\\caching\\Cache","getValues":"yii\\caching\\Cache","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\caching\\Cache","multiAdd":"yii\\caching\\Cache","multiGet":"yii\\caching\\Cache","multiSet":"yii\\caching\\Cache","off":"yii\\base\\Component","offsetExists":"yii\\caching\\Cache","offsetGet":"yii\\caching\\Cache","offsetSet":"yii\\caching\\Cache","offsetUnset":"yii\\caching\\Cache","on":"yii\\base\\Component","set":"yii\\caching\\Cache","setValues":"yii\\caching\\Cache","trigger":"yii\\base\\Component"}}},"yii\\caching\\Cache":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/caching/cache/","summary":"Cache is the base class for cache classes supporting different cache storage implementations.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\caching\\CacheInterface","yii\\base\\Configurable"],"properties":{"defaultDuration":{"type":"int","default":"0","description":"Default duration in seconds before a cache entry will expire.","since":"2.0.11"},"keyPrefix":{"type":"string","default":"null","description":"A string prefixed to every cache key so that it is unique globally in the whole cache storage."},"serializer":{"type":"array|null|false","default":"null","description":"The functions used to serialize and unserialize cached data."}},"methods":{"add":{"signature":"public function add(mixed $key, mixed $value, int $duration = 0, yii\\caching\\Dependency|null $dependency = null): bool","summary":"Stores a value identified by a key into cache if the cache does not contain this key.","params":[{"name":"$key","type":"mixed","description":"A key identifying the value to be cached. This can be a simple string or a complex data structure consisting of factors representing the key."},{"name":"$value","type":"mixed","description":"The value to be cached"},{"name":"$duration","type":"int","default":"0","optional":true,"description":"The number of seconds in which the cached value will expire. 0 means never expire."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"Dependency of the cached item. If the dependency changes, the corresponding value in the cache will be invalidated when it is fetched via `get()`. This parameter is ignored if `$serializer` is false."}],"return":{"type":"bool","description":"Whether the value is successfully stored into cache"}},"addValue":{"signature":"abstract protected function addValue(string $key, mixed $value, int $duration): bool","summary":"Stores a value identified by a key into cache if the cache does not contain this key.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"mixed","description":"The value to be cached. Most often it's a string. If you have disabled `$serializer`, it could be something else."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected","abstract":true},"addValues":{"signature":"protected function addValues(array $data, int $duration): array","summary":"Adds multiple key-value pairs to cache.","params":[{"name":"$data","type":"array","description":"Array where key corresponds to cache key while value is the value stored."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached values will expire. 0 means never expire."}],"return":{"type":"array","description":"Array of failed keys"},"visibility":"protected"},"buildKey":{"signature":"public function buildKey(mixed $key): string","summary":"Builds a normalized cache key from a given key.","params":[{"name":"$key","type":"mixed","description":"The key to be normalized"}],"return":{"type":"string","description":"The generated cache key"}},"delete":{"signature":"public function delete(mixed $key): bool","summary":"Deletes a value with the specified key from cache.","params":[{"name":"$key","type":"mixed","description":"A key identifying the value to be deleted from cache. This can be a simple string or a complex data structure consisting of factors representing the key."}],"return":{"type":"bool","description":"If no error happens during deletion"}},"deleteValue":{"signature":"abstract protected function deleteValue(string $key): bool","summary":"Deletes a value with the specified key from cache This method should be implemented by child classes to delete the data from actual cache storage.","params":[{"name":"$key","type":"string","description":"The key of the value to be deleted"}],"return":{"type":"bool","description":"If no error happens during deletion"},"visibility":"protected","abstract":true},"exists":{"signature":"public function exists(mixed $key): bool","summary":"Checks whether a specified key exists in the cache.","params":[{"name":"$key","type":"mixed","description":"A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key."}],"return":{"type":"bool","description":"True if a value exists in cache, false if the value is not in the cache or expired."}},"flush":{"signature":"public function flush(): bool","summary":"Deletes all values from cache.","return":{"type":"bool","description":"Whether the flush operation was successful."}},"flushValues":{"signature":"abstract protected function flushValues(): bool","summary":"Deletes all values from cache.","return":{"type":"bool","description":"Whether the flush operation was successful."},"visibility":"protected","abstract":true},"get":{"signature":"public function get(mixed $key): mixed","summary":"Retrieves a value from cache with a specified key.","params":[{"name":"$key","type":"mixed","description":"A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key."}],"return":{"type":"mixed","description":"The value stored in cache, false if the value is not in the cache, expired, or the dependency associated with the cached data has changed."}},"getOrSet":{"signature":"public function getOrSet(mixed $key, callable|Closure $callable, int|null $duration = null, yii\\caching\\Dependency|null $dependency = null): mixed","summary":"Method combines both `set()` and `get()` methods to retrieve value identified by a $key, or to store the result of $callable execution if there is no cache available for the $key.","params":[{"name":"$key","type":"mixed","description":"A key identifying the value to be cached. This can be a simple string or a complex data structure consisting of factors representing the key."},{"name":"$callable","type":"callable|Closure","description":"The callable or closure that will be used to generate a value to be cached. If you use $callable that can return `false`, then keep in mind that `getOrSet()` may work inefficiently because the `yii\\caching\\Cache::get()` method uses `false` return value to indicate the data item is not found in the cache. Thus, caching of `false` value will lead to unnecessary internal calls."},{"name":"$duration","type":"int|null","default":"null","optional":true,"description":"Default duration in seconds before the cache will expire. If not set, `$defaultDuration` value will be used."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"Dependency of the cached item. If the dependency changes, the corresponding value in the cache will be invalidated when it is fetched via `get()`. This parameter is ignored if `$serializer` is `false`."}],"return":{"type":"mixed","description":"Result of $callable execution"},"since":"2.0.11"},"getValue":{"signature":"abstract protected function getValue(string $key): mixed|false","summary":"Retrieves a value from cache with a specified key.","params":[{"name":"$key","type":"string","description":"A unique key identifying the cached value"}],"return":{"type":"mixed|false","description":"The value stored in cache, false if the value is not in the cache or expired. Most often value is a string. If you have disabled `$serializer`, it could be something else."},"visibility":"protected","abstract":true},"getValues":{"signature":"protected function getValues(array $keys): array","summary":"Retrieves multiple values from cache with the specified keys.","params":[{"name":"$keys","type":"array","description":"A list of keys identifying the cached values"}],"return":{"type":"array","description":"A list of cached values indexed by the keys"},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"multiAdd":{"signature":"public function multiAdd(array $items, int $duration = 0, yii\\caching\\Dependency|null $dependency = null): array","summary":"Stores multiple items in cache. Each item contains a value identified by a key.","params":[{"name":"$items","type":"array","description":"The items to be cached, as key-value pairs."},{"name":"$duration","type":"int","default":"0","optional":true,"description":"Default number of seconds in which the cached values will expire. 0 means never expire."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"Dependency of the cached items. If the dependency changes, the corresponding values in the cache will be invalidated when it is fetched via `get()`. This parameter is ignored if `$serializer` is false."}],"return":{"type":"array","description":"Array of failed keys"},"since":"2.0.7"},"multiGet":{"signature":"public function multiGet(string[] $keys): array","summary":"Retrieves multiple values from cache with the specified keys.","params":[{"name":"$keys","type":"string[]","description":"List of string keys identifying the cached values"}],"return":{"type":"array","description":"List of cached values corresponding to the specified keys. The array is returned in terms of (key, value) pairs. If a value is not cached or expired, the corresponding array value will be false."},"since":"2.0.7"},"multiSet":{"signature":"public function multiSet(array $items, int|null $duration = null, yii\\caching\\Dependency|null $dependency = null): array","summary":"Stores multiple items in cache. Each item contains a value identified by a key.","params":[{"name":"$items","type":"array","description":"The items to be cached, as key-value pairs."},{"name":"$duration","type":"int|null","default":"null","optional":true,"description":"Default duration in seconds before the cache will expire. If not set, default `$defaultDuration` value is used."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"Dependency of the cached items. If the dependency changes, the corresponding values in the cache will be invalidated when it is fetched via `get()`. This parameter is ignored if `$serializer` is false."}],"return":{"type":"array","description":"Array of failed keys"},"since":"2.0.7"},"offsetExists":{"signature":"public function offsetExists(string $key): bool","summary":"Returns whether there is a cache entry with a specified key.","params":[{"name":"$key","type":"string","description":"A key identifying the cached value"}],"return":{"type":"bool"}},"offsetGet":{"signature":"public function offsetGet(string $key): mixed","summary":"Retrieves the value from cache with a specified key.","params":[{"name":"$key","type":"string","description":"A key identifying the cached value"}],"return":{"type":"mixed","description":"The value stored in cache, false if the value is not in the cache or expired."}},"offsetSet":{"signature":"public function offsetSet(string $key, mixed $value): mixed","summary":"Stores the value identified by a key into cache.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"mixed","description":"The value to be cached"}],"return":{"type":"mixed"}},"offsetUnset":{"signature":"public function offsetUnset(string $key): mixed","summary":"Deletes the value with the specified key from cache This method is required by the interface `ArrayAccess`.","params":[{"name":"$key","type":"string","description":"The key of the value to be deleted"}],"return":{"type":"mixed"}},"set":{"signature":"public function set(mixed $key, mixed $value, int|null $duration = null, yii\\caching\\Dependency|null $dependency = null): bool","summary":"Stores a value identified by a key into cache.","params":[{"name":"$key","type":"mixed","description":"A key identifying the value to be cached. This can be a simple string or a complex data structure consisting of factors representing the key."},{"name":"$value","type":"mixed","description":"The value to be cached"},{"name":"$duration","type":"int|null","default":"null","optional":true,"description":"Default duration in seconds before the cache will expire. If not set, default `$defaultDuration` value is used."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"Dependency of the cached item. If the dependency changes, the corresponding value in the cache will be invalidated when it is fetched via `get()`. This parameter is ignored if `$serializer` is false."}],"return":{"type":"bool","description":"Whether the value is successfully stored into cache"}},"setValue":{"signature":"abstract protected function setValue(string $key, mixed $value, int $duration): bool","summary":"Stores a value identified by a key in cache.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"mixed","description":"The value to be cached. Most often it's a string. If you have disabled `$serializer`, it could be something else."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected","abstract":true},"setValues":{"signature":"protected function setValues(array $data, int $duration): array","summary":"Stores multiple key-value pairs in cache.","params":[{"name":"$data","type":"array","description":"Array where key corresponds to cache key while value is the value stored"},{"name":"$duration","type":"int","description":"The number of seconds in which the cached values will expire. 0 means never expire."}],"return":{"type":"array","description":"Array of failed keys"},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\caching\\CacheInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/caching/cacheinterface/","summary":"CacheInterface is the base interface for cache.","implements":["ArrayAccess"],"methods":{"add":{"signature":"abstract public function add(mixed $key, mixed $value, int $duration = 0, yii\\caching\\Dependency|null $dependency = null): bool","summary":"Stores a value identified by a key into cache if the cache does not contain this key.","params":[{"name":"$key","type":"mixed","description":"A key identifying the value to be cached. This can be a simple string or a complex data structure consisting of factors representing the key."},{"name":"$value","type":"mixed","description":"The value to be cached"},{"name":"$duration","type":"int","default":"0","optional":true,"description":"The number of seconds in which the cached value will expire. 0 means never expire."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"Dependency of the cached item. If the dependency changes, the corresponding value in the cache will be invalidated when it is fetched via `get()`. This parameter is ignored if `serializer` is false."}],"return":{"type":"bool","description":"Whether the value is successfully stored into cache"},"abstract":true},"buildKey":{"signature":"abstract public function buildKey(mixed $key): string","summary":"Builds a normalized cache key from a given key.","params":[{"name":"$key","type":"mixed","description":"The key to be normalized"}],"return":{"type":"string","description":"The generated cache key"},"abstract":true},"delete":{"signature":"abstract public function delete(mixed $key): bool","summary":"Deletes a value with the specified key from cache.","params":[{"name":"$key","type":"mixed","description":"A key identifying the value to be deleted from cache. This can be a simple string or a complex data structure consisting of factors representing the key."}],"return":{"type":"bool","description":"If no error happens during deletion"},"abstract":true},"exists":{"signature":"abstract public function exists(mixed $key): bool","summary":"Checks whether a specified key exists in the cache.","params":[{"name":"$key","type":"mixed","description":"A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key."}],"return":{"type":"bool","description":"True if a value exists in cache, false if the value is not in the cache or expired."},"abstract":true},"flush":{"signature":"abstract public function flush(): bool","summary":"Deletes all values from cache.","return":{"type":"bool","description":"Whether the flush operation was successful."},"abstract":true},"get":{"signature":"abstract public function get(mixed $key): mixed","summary":"Retrieves a value from cache with a specified key.","params":[{"name":"$key","type":"mixed","description":"A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key."}],"return":{"type":"mixed","description":"The value stored in cache, false if the value is not in the cache, expired, or the dependency associated with the cached data has changed."},"abstract":true},"getOrSet":{"signature":"abstract public function getOrSet(mixed $key, callable(): yii\\caching\\TResult|Closure(): yii\\caching\\TResult $callable, int|null $duration = null, yii\\caching\\Dependency|null $dependency = null): yii\\caching\\TResult","summary":"Method combines both `set()` and `get()` methods to retrieve value identified by a $key, or to store the result of $callable execution if there is no cache available for the $key.","params":[{"name":"$key","type":"mixed","description":"A key identifying the value to be cached. This can be a simple string or a complex data structure consisting of factors representing the key."},{"name":"$callable","type":"callable(): yii\\caching\\TResult|Closure(): yii\\caching\\TResult","description":"The callable or closure that will be used to generate a value to be cached. In case $callable returns `false`, the value will not be cached."},{"name":"$duration","type":"int|null","default":"null","optional":true,"description":"Default duration in seconds before the cache will expire. If not set, `defaultDuration` value will be used."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"Dependency of the cached item. If the dependency changes, the corresponding value in the cache will be invalidated when it is fetched via `get()`. This parameter is ignored if `serializer` is `false`."}],"return":{"type":"yii\\caching\\TResult","description":"Result of $callable execution"},"abstract":true},"multiAdd":{"signature":"abstract public function multiAdd(array $items, int $duration = 0, yii\\caching\\Dependency|null $dependency = null): array","summary":"Stores multiple items in cache. Each item contains a value identified by a key.","params":[{"name":"$items","type":"array","description":"The items to be cached, as key-value pairs."},{"name":"$duration","type":"int","default":"0","optional":true,"description":"Default number of seconds in which the cached values will expire. 0 means never expire."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"Dependency of the cached items. If the dependency changes, the corresponding values in the cache will be invalidated when it is fetched via `get()`. This parameter is ignored if `serializer` is false."}],"return":{"type":"array","description":"Array of failed keys"},"abstract":true},"multiGet":{"signature":"abstract public function multiGet(string[] $keys): array","summary":"Retrieves multiple values from cache with the specified keys.","params":[{"name":"$keys","type":"string[]","description":"List of string keys identifying the cached values"}],"return":{"type":"array","description":"List of cached values corresponding to the specified keys. The array is returned in terms of (key, value) pairs. If a value is not cached or expired, the corresponding array value will be false."},"abstract":true},"multiSet":{"signature":"abstract public function multiSet(array $items, int|null $duration = null, yii\\caching\\Dependency|null $dependency = null): array","summary":"Stores multiple items in cache. Each item contains a value identified by a key.","params":[{"name":"$items","type":"array","description":"The items to be cached, as key-value pairs."},{"name":"$duration","type":"int|null","default":"null","optional":true,"description":"Default duration in seconds before the cache will expire. If not set, default `defaultDuration` value is used."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"Dependency of the cached items. If the dependency changes, the corresponding values in the cache will be invalidated when it is fetched via `get()`. This parameter is ignored if `serializer` is false."}],"return":{"type":"array","description":"Array of failed keys"},"abstract":true},"set":{"signature":"abstract public function set(mixed $key, mixed $value, int|null $duration = null, yii\\caching\\Dependency|null $dependency = null): bool","summary":"Stores a value identified by a key into cache.","params":[{"name":"$key","type":"mixed","description":"A key identifying the value to be cached. This can be a simple string or a complex data structure consisting of factors representing the key."},{"name":"$value","type":"mixed","description":"The value to be cached"},{"name":"$duration","type":"int|null","default":"null","optional":true,"description":"Default duration in seconds before the cache will expire. If not set, default `defaultDuration` value is used."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"Dependency of the cached item. If the dependency changes, the corresponding value in the cache will be invalidated when it is fetched via `get()`. This parameter is ignored if `serializer` is false."}],"return":{"type":"bool","description":"Whether the value is successfully stored into cache"},"abstract":true}}},"yii\\caching\\CallbackDependency":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/callbackdependency/","summary":"CallbackDependency represents a dependency based on the result of a callback function.","since":"2.0.50","extends":"yii\\caching\\Dependency","implements":["yii\\base\\Configurable"],"properties":{"callback":{"type":"callable","default":"null","description":"The PHP callback that will be called to determine if the dependency has been changed."}},"methods":{"generateDependencyData":{"signature":"protected function generateDependencyData(yii\\caching\\CacheInterface $cache): mixed","summary":"Generates the data needed to determine if dependency has been changed.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"mixed","description":"The data needed to determine if dependency has been changed."},"visibility":"protected"}},"inherited":{"properties":{"data":"yii\\caching\\Dependency","reusable":"yii\\caching\\Dependency"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","evaluateDependency":"yii\\caching\\Dependency","generateReusableHash":"yii\\caching\\Dependency","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isChanged":"yii\\caching\\Dependency","resetReusableData":"yii\\caching\\Dependency"}}},"yii\\caching\\ChainedDependency":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/chaineddependency/","summary":"ChainedDependency represents a dependency which is composed of a list of other dependencies.","since":"2.0","extends":"yii\\caching\\Dependency","implements":["yii\\base\\Configurable"],"properties":{"dependencies":{"type":"yii\\caching\\Dependency[]","default":"[]","description":"List of dependencies that this dependency is composed of."},"dependOnAll":{"type":"bool","default":"true","description":"Whether this dependency is depending on every dependency in `$dependencies`."}},"methods":{"evaluateDependency":{"signature":"public function evaluateDependency(yii\\caching\\CacheInterface $cache): mixed","summary":"Evaluates the dependency by generating and saving the data related with dependency.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"mixed"}},"generateDependencyData":{"signature":"protected function generateDependencyData(yii\\caching\\CacheInterface $cache): mixed","summary":"Generates the data needed to determine if dependency has been changed.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"mixed","description":"The data needed to determine if dependency has been changed."},"visibility":"protected"},"isChanged":{"signature":"public function isChanged(mixed $cache): bool","summary":"Checks whether the dependency is changed.","params":[{"name":"$cache","type":"mixed","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"bool","description":"Whether the dependency has changed."},"since":"2.0.11"}},"inherited":{"properties":{"data":"yii\\caching\\Dependency","reusable":"yii\\caching\\Dependency"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","generateReusableHash":"yii\\caching\\Dependency","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","resetReusableData":"yii\\caching\\Dependency"}}},"yii\\caching\\DbCache":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/dbcache/","summary":"DbCache implements a cache application component by storing cached data in a database.","since":"2.0","extends":"yii\\caching\\Cache","implements":["yii\\caching\\CacheInterface","yii\\base\\Configurable"],"properties":{"cacheTable":{"type":"string","default":"'{{%cache}}'","description":"Name of the DB table to store cache content."},"db":{"type":"yii\\db\\Connection|array|string","default":"'db'","description":"The DB connection object or the application component ID of the DB connection."},"gcProbability":{"type":"int","default":"100","description":"The probability (parts per million) that garbage collection (GC) should be performed when storing a piece of data in the cache."}},"methods":{"addValue":{"signature":"protected function addValue(string $key, string $value, int $duration): bool","summary":"Stores a value identified by a key into cache if the cache does not contain this key.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"string","description":"The value to be cached. Other types (if you have disabled `$serializer`) cannot be saved."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"},"deleteValue":{"signature":"protected function deleteValue(string $key): bool","summary":"Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.","params":[{"name":"$key","type":"string","description":"The key of the value to be deleted"}],"return":{"type":"bool","description":"If no error happens during deletion"},"visibility":"protected"},"exists":{"signature":"public function exists(mixed $key): bool","summary":"Checks whether a specified key exists in the cache.","params":[{"name":"$key","type":"mixed","description":"A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key."}],"return":{"type":"bool","description":"True if a value exists in cache, false if the value is not in the cache or expired."}},"flushValues":{"signature":"protected function flushValues(): bool","summary":"Deletes all values from cache.","return":{"type":"bool","description":"Whether the flush operation was successful."},"visibility":"protected"},"gc":{"signature":"public function gc(bool $force = false): mixed","summary":"Removes the expired data values.","params":[{"name":"$force","type":"bool","default":"false","optional":true,"description":"Whether to enforce the garbage collection regardless of `$gcProbability`. Defaults to false, meaning the actual deletion happens with the probability as specified by `$gcProbability`."}],"return":{"type":"mixed"}},"getDataFieldName":{"signature":"protected function getDataFieldName(): string","summary":"Returns the name of the `data` column read by `getValue()` and `getValues()`.","return":{"type":"string","description":"Column name or expression aliased as `data`."},"visibility":"protected","since":"2.0.42"},"getDataFieldValue":{"signature":"protected function getDataFieldValue(mixed $value): mixed","params":[{"name":"$value","type":"mixed"}],"return":{"type":"mixed","description":"Value prepared by the `data` column schema."},"visibility":"protected","since":"2.0.42"},"getValue":{"signature":"protected function getValue(string $key): string|false","summary":"Retrieves a value from cache with a specified key.","params":[{"name":"$key","type":"string","description":"A unique key identifying the cached value"}],"return":{"type":"string|false","description":"The value stored in cache, false if the value is not in the cache or expired."},"visibility":"protected"},"getValues":{"signature":"protected function getValues(array $keys): array","summary":"Retrieves multiple values from cache with the specified keys.","params":[{"name":"$keys","type":"array","description":"A list of keys identifying the cached values."}],"return":{"type":"array","description":"A list of cached values indexed by the keys."},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes the DbCache component.","return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$db` is invalid."}]},"setValue":{"signature":"protected function setValue(string $key, string $value, int $duration): bool","summary":"Stores a value identified by a key in cache.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"string","description":"The value to be cached. Other types (if you have disabled `$serializer`) cannot be saved."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","defaultDuration":"yii\\caching\\Cache","keyPrefix":"yii\\caching\\Cache","serializer":"yii\\caching\\Cache"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","add":"yii\\caching\\Cache","addValues":"yii\\caching\\Cache","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","buildKey":"yii\\caching\\Cache","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","delete":"yii\\caching\\Cache","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","flush":"yii\\caching\\Cache","get":"yii\\caching\\Cache","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getOrSet":"yii\\caching\\Cache","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","multiAdd":"yii\\caching\\Cache","multiGet":"yii\\caching\\Cache","multiSet":"yii\\caching\\Cache","off":"yii\\base\\Component","offsetExists":"yii\\caching\\Cache","offsetGet":"yii\\caching\\Cache","offsetSet":"yii\\caching\\Cache","offsetUnset":"yii\\caching\\Cache","on":"yii\\base\\Component","set":"yii\\caching\\Cache","setValues":"yii\\caching\\Cache","trigger":"yii\\base\\Component"}}},"yii\\caching\\DbDependency":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/dbdependency/","summary":"DbDependency represents a dependency based on the query result of a SQL statement.","since":"2.0","extends":"yii\\caching\\Dependency","implements":["yii\\base\\Configurable"],"properties":{"db":{"type":"yii\\db\\Connection|string","default":"'db'","description":"The DB connection object or the application component ID of the DB connection."},"params":{"type":"array","default":"[]","description":"The parameters (name => value) to be bound to the SQL statement specified by `$sql`."},"sql":{"type":"string|null","default":"null","description":"The SQL query whose result is used to determine if the dependency has been changed."}},"methods":{"generateDependencyData":{"signature":"protected function generateDependencyData(yii\\caching\\CacheInterface $cache): mixed","summary":"Generates the data needed to determine if dependency has been changed.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"mixed","description":"The data needed to determine if dependency has been changed."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$db` is not a valid application component ID"}],"visibility":"protected"}},"inherited":{"properties":{"data":"yii\\caching\\Dependency","reusable":"yii\\caching\\Dependency"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","evaluateDependency":"yii\\caching\\Dependency","generateReusableHash":"yii\\caching\\Dependency","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isChanged":"yii\\caching\\Dependency","resetReusableData":"yii\\caching\\Dependency"}}},"yii\\caching\\DbQueryDependency":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/dbquerydependency/","summary":"DbQueryDependency represents a dependency based on the query result of an `yii\\db\\QueryInterface` instance.","since":"2.0.12","extends":"yii\\caching\\Dependency","implements":["yii\\base\\Configurable"],"properties":{"db":{"type":"string|array|object","default":"null","description":"The application component ID of the database connection, connection object or its array configuration."},"method":{"type":"string|callable|null","default":"null","description":"Method which should be invoked in over the `$query` object."},"query":{"type":"yii\\db\\QueryInterface","default":"null","description":"The query which result is used to determine if the dependency has been changed."}},"methods":{"generateDependencyData":{"signature":"protected function generateDependencyData(yii\\caching\\CacheInterface $cache): mixed","summary":"Generates the data needed to determine if dependency is changed.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"mixed","description":"The data needed to determine if dependency has been changed."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"on invalid configuration."}],"visibility":"protected"}},"inherited":{"properties":{"data":"yii\\caching\\Dependency","reusable":"yii\\caching\\Dependency"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","evaluateDependency":"yii\\caching\\Dependency","generateReusableHash":"yii\\caching\\Dependency","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isChanged":"yii\\caching\\Dependency","resetReusableData":"yii\\caching\\Dependency"}}},"yii\\caching\\Dependency":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/caching/dependency/","summary":"Dependency is the base class for cache dependency classes.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"data":{"type":"mixed","default":"null","description":"The dependency data that is saved in cache and later is compared with the latest dependency data."},"reusable":{"type":"bool","default":"false","description":"Whether this dependency is reusable or not."}},"methods":{"evaluateDependency":{"signature":"public function evaluateDependency(yii\\caching\\CacheInterface $cache): mixed","summary":"Evaluates the dependency by generating and saving the data related with dependency.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"mixed"}},"generateDependencyData":{"signature":"abstract protected function generateDependencyData(yii\\caching\\CacheInterface $cache): mixed","summary":"Generates the data needed to determine if dependency is changed.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"mixed","description":"The data needed to determine if dependency has been changed."},"visibility":"protected","abstract":true},"generateReusableHash":{"signature":"protected function generateReusableHash(): string","summary":"Generates a unique hash that can be used for retrieving reusable dependency data.","return":{"type":"string","description":"A unique hash value for this cache dependency."},"visibility":"protected"},"isChanged":{"signature":"public function isChanged(yii\\caching\\CacheInterface $cache): bool","summary":"Checks whether the dependency is changed.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"bool","description":"Whether the dependency has changed."},"since":"2.0.11"},"resetReusableData":{"signature":"public static function resetReusableData(): mixed","summary":"Resets all cached data for reusable dependencies.","return":{"type":"mixed"},"static":true}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\caching\\DummyCache":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/dummycache/","summary":"DummyCache is a placeholder cache component.","since":"2.0","extends":"yii\\caching\\Cache","implements":["yii\\caching\\CacheInterface","yii\\base\\Configurable"],"methods":{"addValue":{"signature":"protected function addValue(string $key, mixed $value, int $duration): bool","summary":"Stores a value identified by a key into cache if the cache does not contain this key.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"mixed","description":"The value to be cached"},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"},"deleteValue":{"signature":"protected function deleteValue(string $key): bool","summary":"Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.","params":[{"name":"$key","type":"string","description":"The key of the value to be deleted"}],"return":{"type":"bool","description":"If no error happens during deletion"},"visibility":"protected"},"flushValues":{"signature":"protected function flushValues(): bool","summary":"Deletes all values from cache.","return":{"type":"bool","description":"Whether the flush operation was successful."},"visibility":"protected"},"getValue":{"signature":"protected function getValue(string $key): mixed|false","summary":"Retrieves a value from cache with a specified key.","params":[{"name":"$key","type":"string","description":"A unique key identifying the cached value"}],"return":{"type":"mixed|false","description":"The value stored in cache, false if the value is not in the cache or expired."},"visibility":"protected"},"setValue":{"signature":"protected function setValue(string $key, mixed $value, int $duration): bool","summary":"Stores a value identified by a key in cache.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"mixed","description":"The value to be cached"},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","defaultDuration":"yii\\caching\\Cache","keyPrefix":"yii\\caching\\Cache","serializer":"yii\\caching\\Cache"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","add":"yii\\caching\\Cache","addValues":"yii\\caching\\Cache","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","buildKey":"yii\\caching\\Cache","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","delete":"yii\\caching\\Cache","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","exists":"yii\\caching\\Cache","flush":"yii\\caching\\Cache","get":"yii\\caching\\Cache","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getOrSet":"yii\\caching\\Cache","getValues":"yii\\caching\\Cache","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\caching\\Cache","multiAdd":"yii\\caching\\Cache","multiGet":"yii\\caching\\Cache","multiSet":"yii\\caching\\Cache","off":"yii\\base\\Component","offsetExists":"yii\\caching\\Cache","offsetGet":"yii\\caching\\Cache","offsetSet":"yii\\caching\\Cache","offsetUnset":"yii\\caching\\Cache","on":"yii\\base\\Component","set":"yii\\caching\\Cache","setValues":"yii\\caching\\Cache","trigger":"yii\\base\\Component"}}},"yii\\caching\\ExpressionDependency":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/expressiondependency/","summary":"ExpressionDependency represents a dependency based on the result of a PHP expression.","since":"2.0","extends":"yii\\caching\\Dependency","implements":["yii\\base\\Configurable"],"properties":{"expression":{"type":"string","default":"'true'","description":"The string representation of a PHP expression whose result is used to determine the dependency."},"params":{"type":"mixed","default":"null","description":"Custom parameters associated with this dependency."}},"methods":{"generateDependencyData":{"signature":"protected function generateDependencyData(yii\\caching\\CacheInterface $cache): mixed","summary":"Generates the data needed to determine if dependency has been changed.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"mixed","description":"The data needed to determine if dependency has been changed."},"visibility":"protected"}},"inherited":{"properties":{"data":"yii\\caching\\Dependency","reusable":"yii\\caching\\Dependency"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","evaluateDependency":"yii\\caching\\Dependency","generateReusableHash":"yii\\caching\\Dependency","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isChanged":"yii\\caching\\Dependency","resetReusableData":"yii\\caching\\Dependency"}}},"yii\\caching\\FileCache":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/filecache/","summary":"FileCache implements a cache component using files.","since":"2.0","extends":"yii\\caching\\Cache","implements":["yii\\caching\\CacheInterface","yii\\base\\Configurable"],"properties":{"cacheFileSuffix":{"type":"string","default":"'.bin'","description":"Cache file suffix."},"cachePath":{"type":"string","default":"'@runtime/cache'","description":"The directory to store cache files."},"directoryLevel":{"type":"int","default":"1","description":"The level of sub-directories to store cache files."},"dirMode":{"type":"int","default":"0775","description":"The permission to be set for newly created directories."},"fileMode":{"type":"int|null","default":"null","description":"The permission to be set for newly created cache files."},"gcProbability":{"type":"int","default":"10","description":"The probability (parts per million) that garbage collection (GC) should be performed when storing a piece of data in the cache."},"keyPrefix":{"type":"string","default":"''","description":"A string prefixed to every cache key."}},"methods":{"addValue":{"signature":"protected function addValue(string $key, string $value, int $duration): bool","summary":"Stores a value identified by a key into cache if the cache does not contain this key.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"string","description":"The value to be cached. Other types (if you have disabled `$serializer`) unable to get is correct in `getValue()`."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"},"deleteValue":{"signature":"protected function deleteValue(string $key): bool","summary":"Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.","params":[{"name":"$key","type":"string","description":"The key of the value to be deleted"}],"return":{"type":"bool","description":"If no error happens during deletion"},"visibility":"protected"},"exists":{"signature":"public function exists(mixed $key): bool","summary":"Checks whether a specified key exists in the cache.","params":[{"name":"$key","type":"mixed","description":"A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key."}],"return":{"type":"bool","description":"True if a value exists in cache, false if the value is not in the cache or expired."}},"flushValues":{"signature":"protected function flushValues(): bool","summary":"Deletes all values from cache.","return":{"type":"bool","description":"Whether the flush operation was successful."},"visibility":"protected"},"gc":{"signature":"public function gc(bool $force = false, bool $expiredOnly = true): mixed","summary":"Removes expired cache files.","params":[{"name":"$force","type":"bool","default":"false","optional":true,"description":"Whether to enforce the garbage collection regardless of `$gcProbability`. Defaults to false, meaning the actual deletion happens with the probability as specified by `$gcProbability`."},{"name":"$expiredOnly","type":"bool","default":"true","optional":true,"description":"Whether to removed expired cache files only. If false, all cache files under `$cachePath` will be removed."}],"return":{"type":"mixed"}},"gcRecursive":{"signature":"protected function gcRecursive(string $path, bool $expiredOnly): mixed","summary":"Recursively removing expired cache files under a directory.","params":[{"name":"$path","type":"string","description":"The directory under which expired cache files are removed."},{"name":"$expiredOnly","type":"bool","description":"Whether to only remove expired cache files. If false, all files under `$path` will be removed."}],"return":{"type":"mixed"},"visibility":"protected"},"getCacheFile":{"signature":"protected function getCacheFile(string $normalizedKey): string","summary":"Returns the cache file path given the normalized cache key.","params":[{"name":"$normalizedKey","type":"string","description":"Normalized cache key by `buildKey()` method"}],"return":{"type":"string","description":"The cache file path"},"visibility":"protected"},"getValue":{"signature":"protected function getValue(string $key): string|false","summary":"Retrieves a value from cache with a specified key.","params":[{"name":"$key","type":"string","description":"A unique key identifying the cached value"}],"return":{"type":"string|false","description":"The value stored in cache, false if the value is not in the cache or expired."},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes this component by ensuring the existence of the cache path.","return":{"type":"mixed"}},"setValue":{"signature":"protected function setValue(string $key, string $value, int $duration): bool","summary":"Stores a value identified by a key in cache.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"string","description":"The value to be cached. Other types (If you have disabled `$serializer`) unable to get is correct in `getValue()`."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. Fewer than or equal to 0 means 1 year expiration time."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","defaultDuration":"yii\\caching\\Cache","serializer":"yii\\caching\\Cache"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","add":"yii\\caching\\Cache","addValues":"yii\\caching\\Cache","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","buildKey":"yii\\caching\\Cache","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","delete":"yii\\caching\\Cache","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","flush":"yii\\caching\\Cache","get":"yii\\caching\\Cache","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getOrSet":"yii\\caching\\Cache","getValues":"yii\\caching\\Cache","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","multiAdd":"yii\\caching\\Cache","multiGet":"yii\\caching\\Cache","multiSet":"yii\\caching\\Cache","off":"yii\\base\\Component","offsetExists":"yii\\caching\\Cache","offsetGet":"yii\\caching\\Cache","offsetSet":"yii\\caching\\Cache","offsetUnset":"yii\\caching\\Cache","on":"yii\\base\\Component","set":"yii\\caching\\Cache","setValues":"yii\\caching\\Cache","trigger":"yii\\base\\Component"}}},"yii\\caching\\FileDependency":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/filedependency/","summary":"FileDependency represents a dependency based on a file's last modification time.","since":"2.0","extends":"yii\\caching\\Dependency","implements":["yii\\base\\Configurable"],"properties":{"fileName":{"type":"string","default":"null","description":"The file path or [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/) whose last modification time is used to check if the dependency has been changed."}},"methods":{"generateDependencyData":{"signature":"protected function generateDependencyData(yii\\caching\\CacheInterface $cache): mixed","summary":"Generates the data needed to determine if dependency has been changed.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"mixed","description":"The data needed to determine if dependency has been changed."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$fileName` is not set"}],"visibility":"protected"}},"inherited":{"properties":{"data":"yii\\caching\\Dependency","reusable":"yii\\caching\\Dependency"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","evaluateDependency":"yii\\caching\\Dependency","generateReusableHash":"yii\\caching\\Dependency","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isChanged":"yii\\caching\\Dependency","resetReusableData":"yii\\caching\\Dependency"}}},"yii\\caching\\MemCache":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/memcache/","summary":"MemCache implements a cache application component based on [memcache](https://pecl.php.net/package/memcache) and [memcached](https://pecl.php.net/package/memcached).","since":"2.0","extends":"yii\\caching\\Cache","implements":["yii\\caching\\CacheInterface","yii\\base\\Configurable"],"properties":{"memcache":{"type":"Memcache|Memcached","description":"The memcache (or memcached) object used by this cache component.","access":"read-only","virtual":true},"options":{"type":"array","default":"null","description":"Options for Memcached."},"password":{"type":"string","default":"null","description":"Memcached sasl password."},"persistentId":{"type":"string","default":"null","description":"An ID that identifies a Memcached instance."},"servers":{"type":"array","description":"List of memcache or memcached server configurations.","virtual":true},"useMemcached":{"type":"bool","default":"false","description":"Whether to use memcached or memcache as the underlying caching extension."},"username":{"type":"string","default":"null","description":"Memcached sasl username."}},"methods":{"addMemcachedServers":{"signature":"protected function addMemcachedServers(Memcached $cache, yii\\caching\\MemCacheServer[] $servers): mixed","summary":"Add servers to the server pool of the cache specified Used for memcached PECL extension.","params":[{"name":"$cache","type":"Memcached"},{"name":"$servers","type":"yii\\caching\\MemCacheServer[]"}],"return":{"type":"mixed"},"visibility":"protected"},"addMemcacheServers":{"signature":"protected function addMemcacheServers(Memcache $cache, yii\\caching\\MemCacheServer[] $servers): mixed","summary":"Add servers to the server pool of the cache specified Used for memcache PECL extension.","params":[{"name":"$cache","type":"Memcache"},{"name":"$servers","type":"yii\\caching\\MemCacheServer[]"}],"return":{"type":"mixed"},"visibility":"protected"},"addServers":{"signature":"protected function addServers(Memcache|Memcached $cache, yii\\caching\\MemCacheServer[] $servers): mixed","summary":"Add servers to the server pool of the cache specified.","params":[{"name":"$cache","type":"Memcache|Memcached"},{"name":"$servers","type":"yii\\caching\\MemCacheServer[]"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException"}],"visibility":"protected"},"addValue":{"signature":"protected function addValue(string $key, mixed $value, int $duration): bool","summary":"Stores a value identified by a key into cache if the cache does not contain this key.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"mixed","description":"The value to be cached"},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"},"deleteValue":{"signature":"protected function deleteValue(string $key): bool","summary":"Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.","params":[{"name":"$key","type":"string","description":"The key of the value to be deleted"}],"return":{"type":"bool","description":"If no error happens during deletion"},"visibility":"protected"},"flushValues":{"signature":"protected function flushValues(): bool","summary":"Deletes all values from cache.","return":{"type":"bool","description":"Whether the flush operation was successful."},"visibility":"protected"},"getMemcache":{"signature":"public function getMemcache(): Memcache|Memcached","summary":"Returns the underlying memcache (or memcached) object.","return":{"type":"Memcache|Memcached","description":"The memcache (or memcached) object used by this cache component."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if memcache or memcached extension is not loaded"}]},"getServers":{"signature":"public function getServers(): yii\\caching\\MemCacheServer[]","summary":"Returns the memcache or memcached server configurations.","return":{"type":"yii\\caching\\MemCacheServer[]","description":"List of memcache server configurations."}},"getValue":{"signature":"protected function getValue(string $key): mixed|false","summary":"Retrieves a value from cache with a specified key.","params":[{"name":"$key","type":"string","description":"A unique key identifying the cached value"}],"return":{"type":"mixed|false","description":"The value stored in cache, false if the value is not in the cache or expired."},"visibility":"protected"},"getValues":{"signature":"protected function getValues(array $keys): array","summary":"Retrieves multiple values from cache with the specified keys.","params":[{"name":"$keys","type":"array","description":"A list of keys identifying the cached values"}],"return":{"type":"array","description":"A list of cached values indexed by the keys"},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes this application component.","return":{"type":"mixed"}},"normalizeDuration":{"signature":"protected function normalizeDuration(int $duration): int","summary":"Normalizes duration value","params":[{"name":"$duration","type":"int"}],"return":{"type":"int"},"visibility":"protected","since":"2.0.31"},"setServers":{"signature":"public function setServers(array $config): mixed","params":[{"name":"$config","type":"array","description":"List of memcache or memcached server configurations. Each element must be an array with the following keys: host, port, persistent, weight, timeout, retryInterval, status."}],"return":{"type":"mixed"}},"setValue":{"signature":"protected function setValue(string $key, mixed $value, int $duration): bool","summary":"Stores a value identified by a key in cache.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"mixed","description":"The value to be cached."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"},"setValues":{"signature":"protected function setValues(array $data, int $duration): array","summary":"Stores multiple key-value pairs in cache.","params":[{"name":"$data","type":"array","description":"Array where key corresponds to cache key while value is the value stored"},{"name":"$duration","type":"int","description":"The number of seconds in which the cached values will expire. 0 means never expire."}],"return":{"type":"array","description":"Array of failed keys."},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","defaultDuration":"yii\\caching\\Cache","keyPrefix":"yii\\caching\\Cache","serializer":"yii\\caching\\Cache"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","add":"yii\\caching\\Cache","addValues":"yii\\caching\\Cache","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","buildKey":"yii\\caching\\Cache","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","delete":"yii\\caching\\Cache","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","exists":"yii\\caching\\Cache","flush":"yii\\caching\\Cache","get":"yii\\caching\\Cache","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getOrSet":"yii\\caching\\Cache","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","multiAdd":"yii\\caching\\Cache","multiGet":"yii\\caching\\Cache","multiSet":"yii\\caching\\Cache","off":"yii\\base\\Component","offsetExists":"yii\\caching\\Cache","offsetGet":"yii\\caching\\Cache","offsetSet":"yii\\caching\\Cache","offsetUnset":"yii\\caching\\Cache","on":"yii\\base\\Component","set":"yii\\caching\\Cache","trigger":"yii\\base\\Component"}}},"yii\\caching\\MemCacheServer":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/memcacheserver/","summary":"MemCacheServer represents the configuration data for a single memcache or memcached server.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"failureCallback":{"type":"Closure","default":"null","description":"This callback function will run upon encountering an error."},"host":{"type":"string","default":"null","description":"Memcache server hostname or IP address"},"persistent":{"type":"bool","default":"true","description":"Whether to use a persistent connection."},"port":{"type":"int","default":"11211","description":"Memcache server port"},"retryInterval":{"type":"int","default":"15","description":"How often a failed server will be retried (in seconds)."},"status":{"type":"bool","default":"true","description":"If the server should be flagged as online upon a failure."},"timeout":{"type":"int","default":"1000","description":"Timeout in milliseconds which will be used for connecting to the server."},"weight":{"type":"int","default":"1","description":"Probability of using this server among all servers."}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\caching\\TagDependency":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/tagdependency/","summary":"TagDependency associates a cached data item with one or multiple `$tags`.","since":"2.0","extends":"yii\\caching\\Dependency","implements":["yii\\base\\Configurable"],"properties":{"tags":{"type":"string|array","default":"[]","description":"A list of tag names for this dependency."}},"methods":{"generateDependencyData":{"signature":"protected function generateDependencyData(yii\\caching\\CacheInterface $cache): mixed","summary":"Generates the data needed to determine if dependency has been changed.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"mixed","description":"The data needed to determine if dependency has been changed."},"visibility":"protected"},"getTimestamps":{"signature":"protected function getTimestamps(yii\\caching\\CacheInterface $cache, string[] $tags): array","summary":"Returns the timestamps for the specified tags.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface"},{"name":"$tags","type":"string[]"}],"return":{"type":"array","description":"The timestamps indexed by the specified tags."},"visibility":"protected"},"invalidate":{"signature":"public static function invalidate(yii\\caching\\CacheInterface $cache, string|array $tags): mixed","summary":"Invalidates all of the cached data items that are associated with any of the specified `$tags`.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface","description":"The cache component that caches the data items"},{"name":"$tags","type":"string|array"}],"return":{"type":"mixed"},"static":true},"isChanged":{"signature":"public function isChanged(mixed $cache): bool","summary":"Checks whether the dependency is changed.","params":[{"name":"$cache","type":"mixed","description":"The cache component that is currently evaluating this dependency"}],"return":{"type":"bool","description":"Whether the dependency has changed."},"since":"2.0.11"},"touchKeys":{"signature":"protected static function touchKeys(yii\\caching\\CacheInterface $cache, string[] $keys): array","summary":"Generates the timestamp for the specified cache keys.","params":[{"name":"$cache","type":"yii\\caching\\CacheInterface"},{"name":"$keys","type":"string[]"}],"return":{"type":"array","description":"The timestamp indexed by cache keys"},"visibility":"protected","static":true}},"inherited":{"properties":{"data":"yii\\caching\\Dependency","reusable":"yii\\caching\\Dependency"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","evaluateDependency":"yii\\caching\\Dependency","generateReusableHash":"yii\\caching\\Dependency","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","resetReusableData":"yii\\caching\\Dependency"}}},"yii\\caching\\WinCache":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/caching/wincache/","summary":"WinCache provides Windows Cache caching in terms of an application component.","since":"2.0","extends":"yii\\caching\\Cache","implements":["yii\\caching\\CacheInterface","yii\\base\\Configurable"],"methods":{"addValue":{"signature":"protected function addValue(string $key, mixed $value, int $duration): bool","summary":"Stores a value identified by a key into cache if the cache does not contain this key.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"mixed","description":"The value to be cached. Most often it's a string. If you have disabled `$serializer`, it could be something else."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"},"addValues":{"signature":"protected function addValues(array $data, int $duration): array","summary":"Adds multiple key-value pairs to cache.","params":[{"name":"$data","type":"array","description":"Array where key corresponds to cache key while value is the value stored"},{"name":"$duration","type":"int","description":"The number of seconds in which the cached values will expire. 0 means never expire."}],"return":{"type":"array","description":"Array of failed keys"},"visibility":"protected"},"deleteValue":{"signature":"protected function deleteValue(string $key): bool","summary":"Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.","params":[{"name":"$key","type":"string","description":"The key of the value to be deleted"}],"return":{"type":"bool","description":"If no error happens during deletion"},"visibility":"protected"},"exists":{"signature":"public function exists(mixed $key): bool","summary":"Checks whether a specified key exists in the cache.","params":[{"name":"$key","type":"mixed","description":"A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key."}],"return":{"type":"bool","description":"True if a value exists in cache, false if the value is not in the cache or expired."}},"flushValues":{"signature":"protected function flushValues(): bool","summary":"Deletes all values from cache.","return":{"type":"bool","description":"Whether the flush operation was successful."},"visibility":"protected"},"getValue":{"signature":"protected function getValue(string $key): string|bool","summary":"Retrieves a value from cache with a specified key.","params":[{"name":"$key","type":"string","description":"A unique key identifying the cached value"}],"return":{"type":"string|bool","description":"The value stored in cache, false if the value is not in the cache or expired."},"visibility":"protected"},"getValues":{"signature":"protected function getValues(array $keys): array","summary":"Retrieves multiple values from cache with the specified keys.","params":[{"name":"$keys","type":"array","description":"A list of keys identifying the cached values"}],"return":{"type":"array","description":"A list of cached values indexed by the keys"},"visibility":"protected"},"setValue":{"signature":"protected function setValue(string $key, mixed $value, int $duration): bool","summary":"Stores a value identified by a key in cache.","params":[{"name":"$key","type":"string","description":"The key identifying the value to be cached"},{"name":"$value","type":"mixed","description":"The value to be cached. Most often it's a string. If you have disabled `$serializer`, it could be something else."},{"name":"$duration","type":"int","description":"The number of seconds in which the cached value will expire. 0 means never expire."}],"return":{"type":"bool","description":"True if the value is successfully stored into cache, false otherwise"},"visibility":"protected"},"setValues":{"signature":"protected function setValues(array $data, int $duration): array","summary":"Stores multiple key-value pairs in cache.","params":[{"name":"$data","type":"array","description":"Array where key corresponds to cache key while value is the value stored"},{"name":"$duration","type":"int","description":"The number of seconds in which the cached values will expire. 0 means never expire."}],"return":{"type":"array","description":"Array of failed keys"},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","defaultDuration":"yii\\caching\\Cache","keyPrefix":"yii\\caching\\Cache","serializer":"yii\\caching\\Cache"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","add":"yii\\caching\\Cache","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","buildKey":"yii\\caching\\Cache","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","delete":"yii\\caching\\Cache","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","flush":"yii\\caching\\Cache","get":"yii\\caching\\Cache","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getOrSet":"yii\\caching\\Cache","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\caching\\Cache","multiAdd":"yii\\caching\\Cache","multiGet":"yii\\caching\\Cache","multiSet":"yii\\caching\\Cache","off":"yii\\base\\Component","offsetExists":"yii\\caching\\Cache","offsetGet":"yii\\caching\\Cache","offsetSet":"yii\\caching\\Cache","offsetUnset":"yii\\caching\\Cache","on":"yii\\base\\Component","set":"yii\\caching\\Cache","trigger":"yii\\base\\Component"}}},"yii\\captcha\\Captcha":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/captcha/captcha/","summary":"Captcha renders a CAPTCHA image and an input field that takes user-entered verification code.","since":"2.0","extends":"yii\\widgets\\InputWidget","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"captchaAction":{"type":"string|array","default":"'site/captcha'","description":"The route of the action that generates the CAPTCHA images."},"clientOptions":{"type":"array","description":"The options","access":"read-only","virtual":true},"clientScript":{"type":"array|yii\\web\\client\\ClientScriptInterface|null","default":"null","description":"Client script strategy used to register CAPTCHA client-side behaviour."},"imageOptions":{"type":"array","default":"[]","description":"HTML attributes to be applied to the CAPTCHA image tag."},"options":{"type":"array","default":"[]","description":"The HTML attributes for the input tag."},"template":{"type":"string","default":"'{image} {input}'","description":"The template for arranging the CAPTCHA image tag and the text input tag."}},"methods":{"checkRequirements":{"signature":"public static function checkRequirements(): string","summary":"Checks if there is graphic extension available to generate CAPTCHA images.","return":{"type":"string","description":"The name of the graphic extension, either \"imagick\" or \"gd\"."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if neither ImageMagick nor GD is installed."}],"static":true},"getClientOptions":{"signature":"public function getClientOptions(): array","summary":"Returns the options for the captcha JS widget.","return":{"type":"array","description":"The options"}},"init":{"signature":"public function init(): mixed","summary":"Initializes the widget.","return":{"type":"mixed"}},"registerClientScript":{"signature":"public function registerClientScript(): mixed","summary":"Registers the needed JavaScript.","return":{"type":"mixed"}},"run":{"signature":"public function run(): mixed","summary":"Renders the widget.","return":{"type":"mixed"}}},"inherited":{"properties":{"attribute":"yii\\widgets\\InputWidget","autoIdPrefix":"yii\\base\\Widget","behaviors":"yii\\base\\Component","field":"yii\\widgets\\InputWidget","id":"yii\\base\\Widget","model":"yii\\widgets\\InputWidget","name":"yii\\widgets\\InputWidget","value":"yii\\widgets\\InputWidget","view":"yii\\base\\Widget","viewPath":"yii\\base\\Widget"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","afterRun":"yii\\base\\Widget","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeRun":"yii\\base\\Widget","begin":"yii\\base\\Widget","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","end":"yii\\base\\Widget","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getId":"yii\\base\\Widget","getView":"yii\\base\\Widget","getViewPath":"yii\\base\\Widget","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasModel":"yii\\widgets\\InputWidget","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","render":"yii\\base\\Widget","renderFile":"yii\\base\\Widget","renderInputHtml":"yii\\widgets\\InputWidget","setId":"yii\\base\\Widget","setView":"yii\\base\\Widget","trigger":"yii\\base\\Component","widget":"yii\\base\\Widget"},"events":{"EVENT_INIT":"yii\\base\\Widget","EVENT_BEFORE_RUN":"yii\\base\\Widget","EVENT_AFTER_RUN":"yii\\base\\Widget"}}},"yii\\captcha\\CaptchaAction":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/captcha/captchaaction/","summary":"CaptchaAction renders a CAPTCHA image.","since":"2.0","extends":"yii\\base\\Action","implements":["yii\\base\\Configurable"],"properties":{"backColor":{"type":"int","default":"0xffffff","description":"The background color."},"fixedVerifyCode":{"type":"string|null","default":"null","description":"The fixed verification code."},"fontFile":{"type":"string","default":"'@yii/captcha/SpicyRice.ttf'","description":"The TrueType font file."},"foreColor":{"type":"int","default":"0x2040a0","description":"The font color."},"height":{"type":"int","default":"50","description":"The height of the generated CAPTCHA image."},"imageLibrary":{"type":"string|null","default":"null","description":"The rendering library to use.","since":"2.0.7"},"maxLength":{"type":"int","default":"7","description":"The maximum length for randomly generated word."},"minLength":{"type":"int","default":"6","description":"The minimum length for randomly generated word."},"offset":{"type":"int","default":"-2","description":"The offset between characters."},"padding":{"type":"int","default":"2","description":"Padding around the text."},"testLimit":{"type":"int","default":"3","description":"How many times should the same CAPTCHA be displayed."},"transparent":{"type":"bool","default":"false","description":"Whether to use transparent background."},"verifyCode":{"type":"string","description":"The verification code.","access":"read-only","virtual":true},"width":{"type":"int","default":"120","description":"The width of the generated CAPTCHA image."}},"methods":{"generateValidationHash":{"signature":"public function generateValidationHash(string $code): int","summary":"Generates a hash code that can be used for client-side validation.","params":[{"name":"$code","type":"string","description":"The CAPTCHA code"}],"return":{"type":"int","description":"A hash code generated from the CAPTCHA code"}},"generateVerifyCode":{"signature":"protected function generateVerifyCode(): string","summary":"Generates a new verification code.","return":{"type":"string","description":"The generated verification code"},"visibility":"protected"},"getSessionKey":{"signature":"protected function getSessionKey(): string","summary":"Returns the session variable name used to store verification code.","return":{"type":"string","description":"The session variable name"},"visibility":"protected"},"getVerifyCode":{"signature":"public function getVerifyCode(bool $regenerate = false): string","summary":"Gets the verification code.","params":[{"name":"$regenerate","type":"bool","default":"false","optional":true,"description":"Whether the verification code should be regenerated."}],"return":{"type":"string","description":"The verification code."}},"init":{"signature":"public function init(): mixed","summary":"Initializes the action.","return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the font file does not exist."}]},"renderImage":{"signature":"protected function renderImage(string $code): string","summary":"Renders the CAPTCHA image.","params":[{"name":"$code","type":"string","description":"The verification code"}],"return":{"type":"string","description":"Image contents"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if imageLibrary is not supported"}],"visibility":"protected"},"renderImageByGD":{"signature":"protected function renderImageByGD(string $code): string","summary":"Renders the CAPTCHA image based on the code using GD library.","params":[{"name":"$code","type":"string","description":"The verification code"}],"return":{"type":"string","description":"Image contents in PNG format."},"visibility":"protected"},"renderImageByImagick":{"signature":"protected function renderImageByImagick(string $code): string","summary":"Renders the CAPTCHA image based on the code using ImageMagick library.","params":[{"name":"$code","type":"string","description":"The verification code"}],"return":{"type":"string","description":"Image contents in PNG format."},"visibility":"protected"},"run":{"signature":"public function run(): mixed","summary":"Runs the action.","return":{"type":"mixed"}},"setHttpHeaders":{"signature":"protected function setHttpHeaders(): mixed","summary":"Sets the HTTP headers needed by image response.","return":{"type":"mixed"},"visibility":"protected"},"validate":{"signature":"public function validate(string $input, bool $caseSensitive): bool","summary":"Validates the input to see if it matches the generated code.","params":[{"name":"$input","type":"string","description":"User input"},{"name":"$caseSensitive","type":"bool","description":"Whether the comparison should be case-sensitive"}],"return":{"type":"bool","description":"Whether the input is valid"}}},"constants":{"REFRESH_GET_VAR":{"value":"'refresh'","description":"The name of the GET parameter indicating whether the CAPTCHA image should be regenerated."}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","controller":"yii\\base\\Action","id":"yii\\base\\Action","module":"yii\\base\\Action","uniqueId":"yii\\base\\Action"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\Action","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","afterRun":"yii\\base\\Action","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeRun":"yii\\base\\Action","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getModule":"yii\\base\\Action","getUniqueId":"yii\\base\\Action","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","resolveStandaloneParams":"yii\\base\\Action","runWithParams":"yii\\base\\Action","setModule":"yii\\base\\Action","trigger":"yii\\base\\Component"}}},"yii\\captcha\\CaptchaAsset":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/captcha/captchaasset/","summary":"This asset bundle provides the javascript files needed for the `yii\\captcha\\Captcha` widget.","since":"2.0","extends":"yii\\web\\AssetBundle","implements":["yii\\base\\Configurable"],"properties":{"depends":{"default":"['yii\\web\\YiiAsset']"},"js":{"default":"['yii.captcha.js']"},"sourcePath":{"default":"'@yii/assets'"}},"inherited":{"properties":{"basePath":"yii\\web\\AssetBundle","baseUrl":"yii\\web\\AssetBundle","css":"yii\\web\\AssetBundle","cssOptions":"yii\\web\\AssetBundle","jsOptions":"yii\\web\\AssetBundle","publishOptions":"yii\\web\\AssetBundle"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\web\\AssetBundle","publish":"yii\\web\\AssetBundle","register":"yii\\web\\AssetBundle","registerAssetFiles":"yii\\web\\AssetBundle"}}},"yii\\captcha\\CaptchaValidator":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/captcha/captchavalidator/","summary":"CaptchaValidator validates that the attribute value is the same as the verification code displayed in the CAPTCHA.","since":"2.0","extends":"yii\\validators\\Validator","implements":["yii\\base\\Configurable"],"properties":{"captchaAction":{"type":"string","default":"'site/captcha'","description":"The route of the controller action that renders the CAPTCHA image."},"caseSensitive":{"type":"bool","default":"false","description":"Whether the comparison is case sensitive."},"clientScript":{"type":"array|yii\\validators\\client\\ClientValidatorScriptInterface|null","default":"null","description":"Client script strategy used to register CAPTCHA client-side validation."},"skipOnEmpty":{"type":"bool","default":"false","description":"Whether to skip this validator if the input is empty."}},"methods":{"clientValidateAttribute":{"signature":"public function clientValidateAttribute(mixed $model, mixed $attribute, mixed $view): string|null","summary":"Returns the JavaScript needed for performing client-side validation.","params":[{"name":"$model","type":"mixed","description":"The data model being validated"},{"name":"$attribute","type":"mixed","description":"The name of the attribute to be validated."},{"name":"$view","type":"mixed","description":"The view object that is going to be used to render views or view files containing a model form with this validator applied."}],"return":{"type":"string|null","description":"The client-side validation script. Null if the validator does not support client-side validation."}},"createCaptchaAction":{"signature":"public function createCaptchaAction(): yii\\captcha\\CaptchaAction","summary":"Creates the CAPTCHA action object from the route specified by `$captchaAction`.","return":{"type":"yii\\captcha\\CaptchaAction","description":"The action object"},"throws":[{"type":"yii\\base\\InvalidConfigException"}]},"getClientOptions":{"signature":"public function getClientOptions(mixed $model, mixed $attribute): array","summary":"Returns the client-side validation options.","params":[{"name":"$model","type":"mixed","description":"The model being validated"},{"name":"$attribute","type":"mixed","description":"The attribute name being validated"}],"return":{"type":"array","description":"The client-side validation options"},"since":"2.0.11"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"validateValue":{"signature":"protected function validateValue(mixed $value): array|null","summary":"Validates a value.","params":[{"name":"$value","type":"mixed","description":"The data value to be validated."}],"return":{"type":"array|null","description":"The error message and the array of parameters to be inserted into the error message. ``` if (!$valid) { return [$this->message, [ 'param1' => $this->param1, 'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()), 'mimeTypes' => implode(', ', $this->mimeTypes), 'param4' => 'etc...', ]]; } return null; ``` for this example `message` template can contain `{param1}`, `{formattedLimit}`, `{mimeTypes}`, `{param4}` Null should be returned if the data is valid."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if the validator does not supporting data validation without a model"}],"visibility":"protected"}},"inherited":{"properties":{"attributeNames":"yii\\validators\\Validator","attributes":"yii\\validators\\Validator","behaviors":"yii\\base\\Component","builtInValidators":"yii\\validators\\Validator","enableClientValidation":"yii\\validators\\Validator","except":"yii\\validators\\Validator","isEmpty":"yii\\validators\\Validator","message":"yii\\validators\\Validator","on":"yii\\validators\\Validator","skipOnError":"yii\\validators\\Validator","validationAttributes":"yii\\validators\\Validator","when":"yii\\validators\\Validator","whenClient":"yii\\validators\\Validator"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","addError":"yii\\validators\\Validator","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","createValidator":"yii\\validators\\Validator","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","formatMessage":"yii\\validators\\Validator","getAttributeNames":"yii\\validators\\Validator","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getFormattedClientMessage":"yii\\validators\\Validator","getValidationAttributes":"yii\\validators\\Validator","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","isActive":"yii\\validators\\Validator","isEmpty":"yii\\validators\\Validator","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component","validate":"yii\\validators\\Validator","validateAttribute":"yii\\validators\\Validator","validateAttributes":"yii\\validators\\Validator"}}},"yii\\console\\Application":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/application/","summary":"Application represents a console application.","since":"2.0","extends":"yii\\base\\Application","implements":["yii\\base\\Configurable"],"properties":{"controller":{"type":"yii\\console\\Controller|null","default":"null","description":"The currently active controller instance"},"defaultRoute":{"type":"string","default":"'help'","description":"The default route of this application."},"enableCoreCommands":{"type":"bool","default":"true","description":"Whether to enable the commands provided by the core framework."},"errorHandler":{"type":"yii\\console\\ErrorHandler","description":"The error handler application component.","access":"read-only","virtual":true},"request":{"type":"yii\\console\\Request","description":"The request component.","access":"read-only","virtual":true},"response":{"type":"yii\\console\\Response","description":"The response component.","access":"read-only","virtual":true}},"methods":{"__construct":{"signature":"public function __construct(mixed $config = [])","summary":"Constructor.","params":[{"name":"$config","type":"mixed","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties. Note that the configuration must contain both `$id` and `$basePath`."}],"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if either `$id` or `$basePath` configuration is missing."}]},"coreCommands":{"signature":"public function coreCommands(): array","summary":"Returns the configuration of the built-in commands.","return":{"type":"array","description":"The configuration of the built-in commands."}},"coreComponents":{"signature":"public function coreComponents(): array","summary":"Returns the configuration of core application components.","return":{"type":"array"}},"getErrorHandler":{"signature":"public function getErrorHandler(): yii\\console\\ErrorHandler","summary":"Returns the error handler component.","return":{"type":"yii\\console\\ErrorHandler","description":"The error handler application component."}},"getRequest":{"signature":"public function getRequest(): yii\\console\\Request","summary":"Returns the request component.","return":{"type":"yii\\console\\Request","description":"The request component."}},"getResponse":{"signature":"public function getResponse(): yii\\console\\Response","summary":"Returns the response component.","return":{"type":"yii\\console\\Response","description":"The response component."}},"handleRequest":{"signature":"public function handleRequest(yii\\console\\Request $request): yii\\console\\Response","summary":"Handles the specified request.","params":[{"name":"$request","type":"yii\\console\\Request","description":"The request to be handled"}],"return":{"type":"yii\\console\\Response","description":"The resulting response"}},"init":{"signature":"public function init(): mixed","summary":"Initialize the application.","return":{"type":"mixed"}},"loadConfig":{"signature":"protected function loadConfig(array $config): array","summary":"Loads the configuration.","params":[{"name":"$config","type":"array","description":"The configuration provided in the constructor."}],"return":{"type":"array","description":"The actual configuration to be used by the application."},"visibility":"protected"},"runAction":{"signature":"public function runAction(string $route, array $params = []): int|yii\\console\\Response|null","summary":"Runs a controller action specified by a route.","params":[{"name":"$route","type":"string","description":"The route that specifies the action."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be passed to the action"}],"return":{"type":"int|yii\\console\\Response|null","description":"The result of the action. This can be either an exit code or Response object. Exit code 0 means normal, and other values mean abnormal. Exit code of `null` is treated as `0` as well."},"throws":[{"type":"yii\\console\\Exception","description":"if the route is invalid"}]}},"constants":{"OPTION_APPCONFIG":{"value":"'appconfig'","description":"The option name for specifying the application configuration file path."}},"inherited":{"properties":{"actionMap":"yii\\base\\Module","actionNamespace":"yii\\base\\Module","aliases":"yii\\base\\Module","assetManager":"yii\\base\\Application","authManager":"yii\\base\\Application","basePath":"yii\\base\\Application","behaviors":"yii\\base\\Component","bootstrap":"yii\\base\\Application","cache":"yii\\base\\Application","charset":"yii\\base\\Application","components":"yii\\di\\ServiceLocator","container":"yii\\base\\Application","controllerMap":"yii\\base\\Module","controllerNamespace":"yii\\base\\Application","controllerPath":"yii\\base\\Module","db":"yii\\base\\Application","extensions":"yii\\base\\Application","formatter":"yii\\base\\Application","i18n":"yii\\base\\Application","id":"yii\\base\\Module","language":"yii\\base\\Application","layout":"yii\\base\\Application","layoutPath":"yii\\base\\Module","loadedModules":"yii\\base\\Application","log":"yii\\base\\Application","mailer":"yii\\base\\Application","module":"yii\\base\\Module","modules":"yii\\base\\Module","name":"yii\\base\\Application","params":"yii\\base\\Module","requestedAction":"yii\\base\\Application","requestedParams":"yii\\base\\Application","requestedRoute":"yii\\base\\Application","runtimePath":"yii\\base\\Application","security":"yii\\base\\Application","sourceLanguage":"yii\\base\\Application","state":"yii\\base\\Application","timeZone":"yii\\base\\Application","uniqueId":"yii\\base\\Application","urlManager":"yii\\base\\Application","vendorPath":"yii\\base\\Application","version":"yii\\base\\Module","view":"yii\\base\\Application","viewPath":"yii\\base\\Module"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__get":"yii\\di\\ServiceLocator","__isset":"yii\\di\\ServiceLocator","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","afterAction":"yii\\base\\Module","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeAction":"yii\\base\\Module","behaviors":"yii\\base\\Component","bootstrap":"yii\\base\\Application","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","clear":"yii\\di\\ServiceLocator","createController":"yii\\base\\Module","createControllerByID":"yii\\base\\Module","createStandaloneAction":"yii\\base\\Module","defaultVersion":"yii\\base\\Module","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","end":"yii\\base\\Application","ensureBehaviors":"yii\\base\\Component","get":"yii\\base\\Module","getAssetManager":"yii\\base\\Application","getAuthManager":"yii\\base\\Application","getBasePath":"yii\\base\\Module","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getCache":"yii\\base\\Application","getComponents":"yii\\di\\ServiceLocator","getControllerPath":"yii\\base\\Module","getDb":"yii\\base\\Application","getFormatter":"yii\\base\\Application","getI18n":"yii\\base\\Application","getInstance":"yii\\base\\Module","getLayoutPath":"yii\\base\\Module","getLog":"yii\\base\\Application","getMailer":"yii\\base\\Application","getModule":"yii\\base\\Module","getModules":"yii\\base\\Module","getRuntimePath":"yii\\base\\Application","getSecurity":"yii\\base\\Application","getTimeZone":"yii\\base\\Application","getUniqueId":"yii\\base\\Application","getUrlManager":"yii\\base\\Application","getVendorPath":"yii\\base\\Application","getVersion":"yii\\base\\Module","getView":"yii\\base\\Application","getViewPath":"yii\\base\\Module","has":"yii\\base\\Module","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasModule":"yii\\base\\Module","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","preInit":"yii\\base\\Application","registerErrorHandler":"yii\\base\\Application","run":"yii\\base\\Application","runMappedAction":"yii\\base\\Module","runStandaloneAction":"yii\\base\\Module","set":"yii\\di\\ServiceLocator","setAliases":"yii\\base\\Module","setBasePath":"yii\\base\\Application","setComponents":"yii\\di\\ServiceLocator","setContainer":"yii\\base\\Application","setControllerPath":"yii\\base\\Module","setInstance":"yii\\base\\Module","setLayoutPath":"yii\\base\\Module","setModule":"yii\\base\\Module","setModules":"yii\\base\\Module","setRuntimePath":"yii\\base\\Application","setTimeZone":"yii\\base\\Application","setVendorPath":"yii\\base\\Application","setVersion":"yii\\base\\Module","setViewPath":"yii\\base\\Module","trigger":"yii\\base\\Component"},"constants":{"STATE_BEGIN":"yii\\base\\Application","STATE_INIT":"yii\\base\\Application","STATE_BEFORE_REQUEST":"yii\\base\\Application","STATE_HANDLING_REQUEST":"yii\\base\\Application","STATE_AFTER_REQUEST":"yii\\base\\Application","STATE_SENDING_RESPONSE":"yii\\base\\Application","STATE_END":"yii\\base\\Application"},"events":{"EVENT_BEFORE_REQUEST":"yii\\base\\Application","EVENT_AFTER_REQUEST":"yii\\base\\Application","EVENT_BEFORE_ACTION":"yii\\base\\Module","EVENT_AFTER_ACTION":"yii\\base\\Module"}}},"yii\\console\\Controller":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/controller/","summary":"Controller is the base class of console command classes.","since":"2.0","extends":"yii\\base\\Controller","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"color":{"type":"bool|null","default":"null","description":"Whether to enable ANSI color in the output."},"help":{"type":"bool","default":"false","description":"Whether to display help information about current command.","since":"2.0.10"},"helpSummary":{"type":"string","description":"The one-line short summary describing this controller.","access":"read-only","virtual":true},"interactive":{"type":"bool","default":"true","description":"Whether to run the command interactively."},"passedOptions":{"type":"array","description":"The names of the options passed during execution.","access":"read-only","virtual":true},"passedOptionValues":{"type":"array","description":"The properties corresponding to the passed options.","access":"read-only","virtual":true},"request":{"type":"yii\\console\\Request","description":"The request object.","virtual":true},"response":{"type":"yii\\console\\Response","description":"The response object.","virtual":true},"silentExitOnException":{"type":"bool|null","default":"null","description":"If true - script finish with `ExitCode::OK` in case of exception. false - `ExitCode::UNSPECIFIED_ERROR`.","since":"2.0.36"}},"methods":{"ansiFormat":{"signature":"public function ansiFormat(string $string): string","summary":"Formats a string with ANSI codes.","params":[{"name":"$string","type":"string","description":"The string to be formatted"}],"return":{"type":"string"}},"beforeAction":{"signature":"public function beforeAction(mixed $action): bool","summary":"This method is invoked right before an action is executed.","params":[{"name":"$action","type":"mixed","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to run."}},"bindActionParams":{"signature":"public function bindActionParams(yii\\base\\Action $action, array $params): mixed[]","summary":"Binds the parameters to the action.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action to be bound with parameters"},{"name":"$params","type":"array","description":"The parameters to be bound to the action"}],"return":{"type":"mixed[]","description":"The valid parameters that the action can run with."},"throws":[{"type":"yii\\console\\Exception","description":"if there are unknown options or missing arguments"}]},"confirm":{"signature":"public function confirm(string $message, bool $default = false): bool","summary":"Asks user to confirm by typing y or n.","params":[{"name":"$message","type":"string","description":"To echo out before waiting for user input"},{"name":"$default","type":"bool","default":"false","optional":true,"description":"This value is returned if no selection is made."}],"return":{"type":"bool","description":"Whether user confirmed. Will return true if `$interactive` is false."}},"getActionArgsHelp":{"signature":"public function getActionArgsHelp(yii\\base\\Action $action): array","summary":"Returns the help information for the anonymous arguments for the action.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action instance"}],"return":{"type":"array","description":"The help information of the action arguments"}},"getActionHelp":{"signature":"public function getActionHelp(yii\\base\\Action $action): string","summary":"Returns the detailed help information for the specified action.","params":[{"name":"$action","type":"yii\\base\\Action","description":"Action to get help for"}],"return":{"type":"string","description":"The detailed help information for the specified action."}},"getActionHelpSummary":{"signature":"public function getActionHelpSummary(yii\\base\\Action $action): string","summary":"Returns a one-line short summary describing the specified action.","params":[{"name":"$action","type":"yii\\base\\Action","description":"Action to get summary for"}],"return":{"type":"string","description":"A one-line short summary describing the specified action."}},"getActionMethodReflection":{"signature":"protected function getActionMethodReflection(yii\\base\\Action $action): ReflectionFunctionAbstract","params":[{"name":"$action","type":"yii\\base\\Action"}],"return":{"type":"ReflectionFunctionAbstract"},"visibility":"protected"},"getActionOptionsHelp":{"signature":"public function getActionOptionsHelp(yii\\base\\Action $action): array","summary":"Returns the help information for the options for the action.","params":[{"name":"$action","type":"yii\\base\\Action"}],"return":{"type":"array","description":"The help information of the action options"}},"getHelp":{"signature":"public function getHelp(): string","summary":"Returns help information for this controller.","return":{"type":"string","description":"The help information for this controller."}},"getHelpSummary":{"signature":"public function getHelpSummary(): string","summary":"Returns one-line short summary describing this controller.","return":{"type":"string","description":"The one-line short summary describing this controller."}},"getOptionValues":{"signature":"public function getOptionValues(string $actionID): array","summary":"Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.","params":[{"name":"$actionID","type":"string","description":"The action id of the current request"}],"return":{"type":"array","description":"Properties corresponding to the options for the action"}},"getPassedOptions":{"signature":"public function getPassedOptions(): array","summary":"Returns the names of valid options passed during execution.","return":{"type":"array","description":"The names of the options passed during execution"}},"getPassedOptionValues":{"signature":"public function getPassedOptionValues(): array","summary":"Returns the properties corresponding to the passed options.","return":{"type":"array","description":"The properties corresponding to the passed options"}},"isColorEnabled":{"signature":"public function isColorEnabled(resource $stream = \\STDOUT): bool","summary":"Returns a value indicating whether ANSI color is enabled.","params":[{"name":"$stream","type":"resource","default":"\\STDOUT","optional":true,"description":"The stream to check."}],"return":{"type":"bool","description":"Whether to enable ANSI style in output."}},"optionAliases":{"signature":"public function optionAliases(): array","summary":"Returns option alias names.","return":{"type":"array","description":"The options alias names valid for the action where the keys is alias name for option and value is option name."},"since":"2.0.8"},"options":{"signature":"public function options(string $actionID): string[]","summary":"Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.","params":[{"name":"$actionID","type":"string","description":"The action id of the current request"}],"return":{"type":"string[]","description":"The names of the options valid for the action"}},"parseDocCommentDetail":{"signature":"protected function parseDocCommentDetail(ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract $reflection): string","summary":"Returns full description from the docblock.","params":[{"name":"$reflection","type":"ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract"}],"return":{"type":"string"},"visibility":"protected"},"parseDocCommentSummary":{"signature":"protected function parseDocCommentSummary(ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract $reflection): string","summary":"Returns the first line of docblock.","params":[{"name":"$reflection","type":"ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract"}],"return":{"type":"string"},"visibility":"protected"},"parseDocCommentTags":{"signature":"protected function parseDocCommentTags(ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract $reflection): array","summary":"Parses the comment block into tags.","params":[{"name":"$reflection","type":"ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract","description":"The comment block"}],"return":{"type":"array","description":"The parsed tags"},"visibility":"protected"},"prompt":{"signature":"public function prompt(string $text, array $options = []): string","summary":"Prompts the user for input and validates it.","params":[{"name":"$text","type":"string","description":"Prompt string"},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The options to validate the input: - required: whether it is required or not - default: default value if no input is inserted by the user - pattern: regular expression pattern to validate user input - validator: a callable function to validate input. The function must accept two parameters: - $input: the user input to validate - $error: the error value passed by reference if validation failed. An example of how to use the prompt method with a validator function. ``` $code = $this->prompt('Enter 4-Chars-Pin', ['required' => true, 'validator' => function($input, &$error) { if (strlen($input) !== 4) { $error = 'The Pin must be exactly 4 chars!'; return false; } return true; }]); ```"}],"return":{"type":"string","description":"The user input"}},"runAction":{"signature":"public function runAction(string $id, array $params = []): mixed","summary":"Runs an action with the specified action ID and parameters.","params":[{"name":"$id","type":"string","description":"The ID of the action to be executed."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name-value pairs) to be passed to the action."}],"return":{"type":"mixed","description":"The result of the action."},"throws":[{"type":"yii\\base\\InvalidRouteException","description":"if the requested action ID cannot be resolved into an action successfully."},{"type":"yii\\console\\Exception","description":"if there are unknown options or missing arguments"}]},"select":{"signature":"public function select(string $prompt, array $options = [], string|null $default = null): string","summary":"Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations.","params":[{"name":"$prompt","type":"string","description":"The prompt message"},{"name":"$options","type":"array","default":"[]","optional":true,"description":"Key-value array of options to choose from"},{"name":"$default","type":"string|null","default":"null","optional":true,"description":"Value to use when the user doesn't provide an option. If the default is `null`, the user is required to select an option."}],"return":{"type":"string","description":"An option character the user chose"}},"stderr":{"signature":"public function stderr(string $string): int|bool","summary":"Prints a string to STDERR.","params":[{"name":"$string","type":"string","description":"The string to print"}],"return":{"type":"int|bool","description":"Number of bytes printed or false on error"}},"stdout":{"signature":"public function stdout(string $string): int|bool","summary":"Prints a string to STDOUT.","params":[{"name":"$string","type":"string","description":"The string to print"}],"return":{"type":"int|bool","description":"Number of bytes printed or false on error"}}},"inherited":{"properties":{"action":"yii\\base\\Controller","behaviors":"yii\\base\\Component","defaultAction":"yii\\base\\Controller","id":"yii\\base\\Controller","layout":"yii\\base\\Controller","module":"yii\\base\\Controller","modules":"yii\\base\\Controller","route":"yii\\base\\Controller","uniqueId":"yii\\base\\Controller","view":"yii\\base\\Controller","viewPath":"yii\\base\\Controller"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\Controller","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","actions":"yii\\base\\Controller","afterAction":"yii\\base\\Controller","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","bindInjectedParams":"yii\\base\\Controller","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","createAction":"yii\\base\\Controller","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","findLayoutFile":"yii\\base\\Controller","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getModules":"yii\\base\\Controller","getRoute":"yii\\base\\Controller","getUniqueId":"yii\\base\\Controller","getView":"yii\\base\\Controller","getViewPath":"yii\\base\\Controller","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\Controller","off":"yii\\base\\Component","on":"yii\\base\\Component","render":"yii\\base\\Controller","renderContent":"yii\\base\\Controller","renderFile":"yii\\base\\Controller","renderPartial":"yii\\base\\Controller","run":"yii\\base\\Controller","setView":"yii\\base\\Controller","setViewPath":"yii\\base\\Controller","trigger":"yii\\base\\Component"},"events":{"EVENT_BEFORE_ACTION":"yii\\base\\Controller","EVENT_AFTER_ACTION":"yii\\base\\Controller"}}},"yii\\console\\ErrorHandler":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/errorhandler/","summary":"ErrorHandler handles uncaught PHP errors and exceptions.","since":"2.0","extends":"yii\\base\\ErrorHandler","implements":["yii\\base\\Configurable"],"methods":{"formatMessage":{"signature":"protected function formatMessage(string $message, array $format = [\\yii\\helpers\\Console::FG_RED, \\yii\\helpers\\Console::BOLD]): string","summary":"Colorizes a message for console output.","params":[{"name":"$message","type":"string","description":"The message to colorize."},{"name":"$format","type":"array","default":"[\\yii\\helpers\\Console::FG_RED, \\yii\\helpers\\Console::BOLD]","optional":true,"description":"The message format."}],"return":{"type":"string","description":"The colorized message."},"visibility":"protected"},"renderException":{"signature":"protected function renderException(Throwable $exception): mixed","summary":"Renders an exception using ansi format for console output.","params":[{"name":"$exception","type":"Throwable","description":"The exception to be rendered."}],"return":{"type":"mixed"},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","discardExistingOutput":"yii\\base\\ErrorHandler","exception":"yii\\base\\ErrorHandler","memoryReserveSize":"yii\\base\\ErrorHandler","silentExitOnException":"yii\\base\\ErrorHandler"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","clearOutput":"yii\\base\\ErrorHandler","convertExceptionToString":"yii\\base\\ErrorHandler","convertExceptionToVerboseString":"yii\\base\\ErrorHandler","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","handleError":"yii\\base\\ErrorHandler","handleException":"yii\\base\\ErrorHandler","handleFallbackExceptionMessage":"yii\\base\\ErrorHandler","handleFatalError":"yii\\base\\ErrorHandler","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\ErrorHandler","logException":"yii\\base\\ErrorHandler","off":"yii\\base\\Component","on":"yii\\base\\Component","register":"yii\\base\\ErrorHandler","trigger":"yii\\base\\Component","unregister":"yii\\base\\ErrorHandler"},"events":{"EVENT_SHUTDOWN":"yii\\base\\ErrorHandler"}}},"yii\\console\\Exception":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/exception/","summary":"Exception represents an exception caused by incorrect usage of a console command.","since":"2.0","extends":"yii\\base\\UserException","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\console\\ExitCode":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/exitcode/","summary":"This class provides constants for defining console command exit codes.","since":"2.0.13","properties":{"reasons":{"type":"array","default":"[self::OK => 'Success', self::UNSPECIFIED_ERROR => 'Unspecified error', self::USAGE => 'Incorrect usage, argument or option error', self::DATAERR => 'Error in input data', self::NOINPUT => 'Input file not found or unreadable', self::NOUSER => 'User not found', self::NOHOST => 'Host not found', self::UNAVAILABLE => 'A required service is unavailable', self::SOFTWARE => 'Internal error', self::OSERR => 'Error making system call or using OS service', self::OSFILE => 'Error accessing system file', self::CANTCREAT => 'Cannot create output file', self::IOERR => 'I/O error', self::TEMPFAIL => 'Temporary failure', self::PROTOCOL => 'Unexpected remote service behavior', self::NOPERM => 'Insufficient permissions', self::CONFIG => 'Configuration error']","description":"A map of reason descriptions for exit codes.","static":true}},"methods":{"getReason":{"signature":"public static function getReason(int $exitCode): string","summary":"Returns a short reason text for the given exit code.","params":[{"name":"$exitCode","type":"int","description":"One of the constants defined in this class."}],"return":{"type":"string","description":"The reason text, or `\"Unknown exit code\"` if the code is not listed in `$reasons`."},"static":true}},"constants":{"OK":{"value":"0","description":"The command completed successfully."},"UNSPECIFIED_ERROR":{"value":"1","description":"The command exited with an error code that says nothing about the error."},"USAGE":{"value":"64","description":"The command was used incorrectly, e.g., with the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever."},"DATAERR":{"value":"65","description":"The input data was incorrect in some way. This should only be used for user's data and not system files."},"NOINPUT":{"value":"66","description":"An input file (not a system file) did not exist or was not readable."},"NOUSER":{"value":"67","description":"The user specified did not exist. This might be used for mail addresses or remote logins."},"NOHOST":{"value":"68","description":"The host specified did not exist. This is used in mail addresses or network requests."},"UNAVAILABLE":{"value":"69","description":"A service is unavailable. This can occur if a support program or file does not exist. This can also be used as a catchall message when something you wanted to do does not work, but you do not know why."},"SOFTWARE":{"value":"70","description":"An internal software error has been detected. This should be limited to non-operating system related errors as possible."},"OSERR":{"value":"71","description":"An operating system error has been detected. This is intended to be used for such things as ``cannot fork'', ``cannot create pipe'', or the like. It includes things like getuid returning a user that does not exist in the passwd file."},"OSFILE":{"value":"72","description":"Some system file (e.g., /etc/passwd, /var/run/utx.active, etc.) does not exist, cannot be opened, or has some sort of error (e.g., syntax error)."},"CANTCREAT":{"value":"73","description":"A (user specified) output file cannot be created."},"IOERR":{"value":"74","description":"An error occurred while doing I/O on some file."},"TEMPFAIL":{"value":"75","description":"Temporary failure, indicating something that is not really an error. In sendmail, this means that a mailer (e.g.) could not create a connection, and the request should be reattempted later."},"PROTOCOL":{"value":"76","description":"The remote system returned something that was ``not possible'' during a protocol exchange."},"NOPERM":{"value":"77","description":"You did not have sufficient permission to perform the operation. This is not intended for file system problems, which should use NOINPUT or CANTCREAT, but rather for higher level permissions."},"CONFIG":{"value":"78","description":"Something was found in an unconfigured or misconfigured state."}}},"yii\\console\\Markdown":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/markdown/","summary":"A Markdown parser that enhances markdown for reading in console environments.","since":"2.0","extends":"cebe\\markdown\\Parser","traits":["cebe\\markdown\\block\\FencedCodeTrait","cebe\\markdown\\inline\\CodeTrait","cebe\\markdown\\inline\\EmphStrongTrait","cebe\\markdown\\inline\\StrikeoutTrait"],"properties":{"escapeCharacters":{"type":"array","default":"['\\\\', '`', '*', '_', '~']","description":"These are \"escapeable\" characters.","visibility":"protected"}},"methods":{"renderCode":{"signature":"protected function renderCode(array $block): string","summary":"Renders a code block.","params":[{"name":"$block","type":"array"}],"return":{"type":"string"},"visibility":"protected"},"renderEmph":{"signature":"protected function renderEmph(array $element): string","summary":"Renders empathized elements.","params":[{"name":"$element","type":"array"}],"return":{"type":"string"},"visibility":"protected"},"renderInlineCode":{"signature":"protected function renderInlineCode(array $element): string","summary":"Renders an inline code span `` ` ``.","params":[{"name":"$element","type":"array"}],"return":{"type":"string"},"visibility":"protected"},"renderParagraph":{"signature":"protected function renderParagraph(array $block): string","summary":"Render a paragraph block.","params":[{"name":"$block","type":"array"}],"return":{"type":"string"},"visibility":"protected"},"renderStrike":{"signature":"protected function renderStrike(array $element): string","summary":"Renders the strike through feature.","params":[{"name":"$element","type":"array"}],"return":{"type":"string"},"visibility":"protected"},"renderStrong":{"signature":"protected function renderStrong(array $element): string","summary":"Renders strong elements.","params":[{"name":"$element","type":"array"}],"return":{"type":"string"},"visibility":"protected"}}},"yii\\console\\Request":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/request/","summary":"The console Request represents the environment information for a console application.","since":"2.0","extends":"yii\\base\\Request","implements":["yii\\base\\Configurable"],"properties":{"params":{"type":"array","description":"The command line arguments.","virtual":true}},"methods":{"getParams":{"signature":"public function getParams(): array","summary":"Returns the command line arguments.","return":{"type":"array","description":"The command line arguments. It does not include the entry script name."}},"resolve":{"signature":"public function resolve(): array","summary":"Resolves the current request into a route and the associated parameters.","return":{"type":"array","description":"The first element is the route, and the second is the associated parameters."},"throws":[{"type":"yii\\console\\Exception","description":"when parameter is wrong and can not be resolved"}]},"setParams":{"signature":"public function setParams(array $params): mixed","summary":"Sets the command line arguments.","params":[{"name":"$params","type":"array","description":"The command line arguments"}],"return":{"type":"mixed"}}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","isConsoleRequest":"yii\\base\\Request","scriptFile":"yii\\base\\Request"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getIsConsoleRequest":"yii\\base\\Request","getScriptFile":"yii\\base\\Request","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","setIsConsoleRequest":"yii\\base\\Request","setScriptFile":"yii\\base\\Request","trigger":"yii\\base\\Component"}}},"yii\\console\\Response":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/response/","summary":"The console Response represents the result of a console application.","since":"2.0","extends":"yii\\base\\Response","implements":["yii\\base\\Configurable"],"inherited":{"properties":{"behaviors":"yii\\base\\Component","exitStatus":"yii\\base\\Response"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","clearOutputBuffers":"yii\\base\\Response","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","send":"yii\\base\\Response","trigger":"yii\\base\\Component"}}},"yii\\console\\UnknownCommandException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/unknowncommandexception/","summary":"UnknownCommandException represents an exception caused by incorrect usage of a console command.","since":"2.0.11","extends":"yii\\console\\Exception","properties":{"application":{"type":"yii\\console\\Application","default":"null","visibility":"protected"},"command":{"type":"string","default":"null","description":"The name of the command that could not be recognized."}},"methods":{"__construct":{"signature":"public function __construct(string $route, yii\\console\\Application $application, int $code = 0, Throwable|null $previous = null)","summary":"Construct the exception.","params":[{"name":"$route","type":"string","description":"The route of the command that could not be found."},{"name":"$application","type":"yii\\console\\Application","description":"The console application instance involved."},{"name":"$code","type":"int","default":"0","optional":true,"description":"The Exception code."},{"name":"$previous","type":"Throwable|null","default":"null","optional":true,"description":"The previous exception used for the exception chaining."}]},"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}},"getSuggestedAlternatives":{"signature":"public function getSuggestedAlternatives(): array","summary":"Suggest alternative commands for `$command` based on string similarity.","return":{"type":"array","description":"A list of suggested alternatives sorted by similarity."}}}},"yii\\console\\controllers\\AssetController":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/controllers/assetcontroller/","summary":"Allows you to combine and compress your JavaScript and CSS files.","since":"2.0","extends":"yii\\console\\Controller","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"assetManager":{"type":"yii\\web\\AssetManager|array","description":"Asset manager instance or its array configuration.","virtual":true},"bundles":{"type":"array","default":"[]","description":"List of asset bundles to be compressed."},"cssCompressor":{"type":"string|callable","default":"'java -jar yuicompressor.jar --type css {from} -o {to}'","description":"CSS file compressor."},"defaultAction":{"type":"string","default":"'compress'","description":"Controller default action ID."},"deleteSource":{"type":"bool","default":"false","description":"Whether to delete asset source files after compression.","since":"2.0.10"},"jsCompressor":{"type":"string|callable","default":"'java -jar compiler.jar --js {from} --js_output_file {to}'","description":"JavaScript file compressor."},"targets":{"type":"array","default":"[]","description":"List of asset bundles, which represents output compressed files."}},"methods":{"actionCompress":{"signature":"public function actionCompress(string $configFile, string $bundleFile): mixed","summary":"Combines and compresses the asset files according to the given configuration.","params":[{"name":"$configFile","type":"string","description":"Configuration file name."},{"name":"$bundleFile","type":"string","description":"Output asset bundles configuration file name."}],"return":{"type":"mixed"}},"actionTemplate":{"signature":"public function actionTemplate(string $configFile): int","summary":"Creates template of configuration file for `actionCompress()`.","params":[{"name":"$configFile","type":"string","description":"Output file name."}],"return":{"type":"int","description":"CLI exit code"},"throws":[{"type":"yii\\console\\Exception","description":"on failure."}]},"adjustCssUrl":{"signature":"protected function adjustCssUrl(string $cssContent, string $inputFilePath, string $outputFilePath): string","summary":"Adjusts CSS content allowing URL references pointing to the original resources.","params":[{"name":"$cssContent","type":"string","description":"Source CSS content."},{"name":"$inputFilePath","type":"string","description":"Input CSS file name."},{"name":"$outputFilePath","type":"string","description":"Output CSS file name."}],"return":{"type":"string","description":"Adjusted CSS content."},"visibility":"protected"},"adjustDependency":{"signature":"protected function adjustDependency(yii\\web\\AssetBundle[] $targets, yii\\web\\AssetBundle[] $bundles): yii\\web\\AssetBundle[]","summary":"Adjust dependencies between asset bundles in the way source bundles begin to depend on output ones.","params":[{"name":"$targets","type":"yii\\web\\AssetBundle[]","description":"Output asset bundles."},{"name":"$bundles","type":"yii\\web\\AssetBundle[]","description":"Source asset bundles."}],"return":{"type":"yii\\web\\AssetBundle[]","description":"Output asset bundles."},"visibility":"protected"},"buildTarget":{"signature":"protected function buildTarget(yii\\web\\AssetBundle $target, string $type, yii\\web\\AssetBundle[] $bundles): mixed","summary":"Builds output asset bundle.","params":[{"name":"$target","type":"yii\\web\\AssetBundle","description":"Output asset bundle"},{"name":"$type","type":"string","description":"Either 'js' or 'css'."},{"name":"$bundles","type":"yii\\web\\AssetBundle[]","description":"Source asset bundles."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"on failure."}],"visibility":"protected"},"combineCssFiles":{"signature":"public function combineCssFiles(array $inputFiles, string $outputFile): mixed","summary":"Combines CSS files into a single one.","params":[{"name":"$inputFiles","type":"array","description":"Source file names."},{"name":"$outputFile","type":"string","description":"Output file name."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"on failure."}]},"combineJsFiles":{"signature":"public function combineJsFiles(array $inputFiles, string $outputFile): mixed","summary":"Combines JavaScript files into a single one.","params":[{"name":"$inputFiles","type":"array","description":"Source file names."},{"name":"$outputFile","type":"string","description":"Output file name."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"on failure."}]},"compressCssFiles":{"signature":"protected function compressCssFiles(array $inputFiles, string $outputFile): mixed","summary":"Compresses given CSS files and combines them into the single one.","params":[{"name":"$inputFiles","type":"array","description":"List of source file names."},{"name":"$outputFile","type":"string","description":"Output file name."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"on failure"}],"visibility":"protected"},"compressJsFiles":{"signature":"protected function compressJsFiles(array $inputFiles, string $outputFile): mixed","summary":"Compresses given JavaScript files and combines them into the single one.","params":[{"name":"$inputFiles","type":"array","description":"List of source file names."},{"name":"$outputFile","type":"string","description":"Output file name."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"on failure"}],"visibility":"protected"},"getAssetManager":{"signature":"public function getAssetManager(): yii\\web\\AssetManager","summary":"Returns the asset manager instance.","return":{"type":"yii\\web\\AssetManager","description":"Asset manager instance."},"throws":[{"type":"yii\\console\\Exception","description":"on invalid configuration."}]},"loadBundles":{"signature":"protected function loadBundles(string[] $bundles): yii\\web\\AssetBundle[]","summary":"Creates full list of source asset bundles.","params":[{"name":"$bundles","type":"string[]","description":"List of asset bundle names"}],"return":{"type":"yii\\web\\AssetBundle[]","description":"List of source asset bundles."},"visibility":"protected"},"loadConfiguration":{"signature":"protected function loadConfiguration(string $configFile): mixed","summary":"Applies configuration from the given file to self instance.","params":[{"name":"$configFile","type":"string","description":"Configuration file name."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"on failure."}],"visibility":"protected"},"loadDependency":{"signature":"protected function loadDependency(yii\\web\\AssetBundle $bundle, array &$result): mixed","summary":"Loads asset bundle dependencies recursively.","params":[{"name":"$bundle","type":"yii\\web\\AssetBundle","description":"Bundle instance"},{"name":"$result","type":"array","byReference":true,"description":"Already loaded bundles list."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"on failure."}],"visibility":"protected"},"loadTargets":{"signature":"protected function loadTargets(array $targets, yii\\web\\AssetBundle[] $bundles): yii\\web\\AssetBundle[]","summary":"Creates full list of output asset bundles.","params":[{"name":"$targets","type":"array","description":"Output asset bundles configuration."},{"name":"$bundles","type":"yii\\web\\AssetBundle[]","description":"List of source asset bundles."}],"return":{"type":"yii\\web\\AssetBundle[]","description":"List of output asset bundles."},"throws":[{"type":"yii\\console\\Exception","description":"on failure."}],"visibility":"protected"},"registerBundle":{"signature":"protected function registerBundle(yii\\web\\AssetBundle[] $bundles, string $name, array &$registered): mixed","summary":"Registers asset bundles including their dependencies.","params":[{"name":"$bundles","type":"yii\\web\\AssetBundle[]","description":"Asset bundles list."},{"name":"$name","type":"string","description":"Bundle name."},{"name":"$registered","type":"array","byReference":true,"description":"Stores already registered names."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"if circular dependency is detected."}],"visibility":"protected"},"saveTargets":{"signature":"protected function saveTargets(yii\\web\\AssetBundle[] $targets, string $bundleFile): mixed","summary":"Saves new asset bundles configuration.","params":[{"name":"$targets","type":"yii\\web\\AssetBundle[]","description":"List of asset bundles to be saved."},{"name":"$bundleFile","type":"string","description":"Output file name."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"on failure."}],"visibility":"protected"},"setAssetManager":{"signature":"public function setAssetManager(yii\\web\\AssetManager|array $assetManager): mixed","summary":"Sets asset manager instance or configuration.","params":[{"name":"$assetManager","type":"yii\\web\\AssetManager|array","description":"Asset manager instance or its array configuration."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"on invalid argument type."}]}},"inherited":{"properties":{"action":"yii\\base\\Controller","behaviors":"yii\\base\\Component","color":"yii\\console\\Controller","help":"yii\\console\\Controller","helpSummary":"yii\\console\\Controller","id":"yii\\base\\Controller","interactive":"yii\\console\\Controller","layout":"yii\\base\\Controller","module":"yii\\base\\Controller","modules":"yii\\base\\Controller","passedOptions":"yii\\console\\Controller","passedOptionValues":"yii\\console\\Controller","request":"yii\\console\\Controller","response":"yii\\console\\Controller","route":"yii\\base\\Controller","silentExitOnException":"yii\\console\\Controller","uniqueId":"yii\\base\\Controller","view":"yii\\base\\Controller","viewPath":"yii\\base\\Controller"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\Controller","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","actions":"yii\\base\\Controller","afterAction":"yii\\base\\Controller","ansiFormat":"yii\\console\\Controller","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeAction":"yii\\console\\Controller","behaviors":"yii\\base\\Component","bindActionParams":"yii\\console\\Controller","bindInjectedParams":"yii\\base\\Controller","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","confirm":"yii\\console\\Controller","createAction":"yii\\base\\Controller","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","findLayoutFile":"yii\\base\\Controller","getActionArgsHelp":"yii\\console\\Controller","getActionHelp":"yii\\console\\Controller","getActionHelpSummary":"yii\\console\\Controller","getActionMethodReflection":"yii\\console\\Controller","getActionOptionsHelp":"yii\\console\\Controller","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getHelp":"yii\\console\\Controller","getHelpSummary":"yii\\console\\Controller","getModules":"yii\\base\\Controller","getOptionValues":"yii\\console\\Controller","getPassedOptions":"yii\\console\\Controller","getPassedOptionValues":"yii\\console\\Controller","getRoute":"yii\\base\\Controller","getUniqueId":"yii\\base\\Controller","getView":"yii\\base\\Controller","getViewPath":"yii\\base\\Controller","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\Controller","isColorEnabled":"yii\\console\\Controller","off":"yii\\base\\Component","on":"yii\\base\\Component","optionAliases":"yii\\console\\Controller","options":"yii\\console\\Controller","parseDocCommentDetail":"yii\\console\\Controller","parseDocCommentSummary":"yii\\console\\Controller","parseDocCommentTags":"yii\\console\\Controller","prompt":"yii\\console\\Controller","render":"yii\\base\\Controller","renderContent":"yii\\base\\Controller","renderFile":"yii\\base\\Controller","renderPartial":"yii\\base\\Controller","run":"yii\\base\\Controller","runAction":"yii\\console\\Controller","select":"yii\\console\\Controller","setView":"yii\\base\\Controller","setViewPath":"yii\\base\\Controller","stderr":"yii\\console\\Controller","stdout":"yii\\console\\Controller","trigger":"yii\\base\\Component"},"events":{"EVENT_BEFORE_ACTION":"yii\\base\\Controller","EVENT_AFTER_ACTION":"yii\\base\\Controller"}}},"yii\\console\\controllers\\BaseMigrateController":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/console/controllers/basemigratecontroller/","summary":"BaseMigrateController is the base class for migrate controllers.","since":"2.0","extends":"yii\\console\\Controller","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"compact":{"type":"bool","default":"false","description":"Indicates whether the console output should be compacted.","since":"2.0.13"},"defaultAction":{"type":"string","default":"'up'","description":"The default command action."},"migrationNamespaces":{"type":"array","default":"[]","description":"List of namespaces containing the migration classes.","since":"2.0.10"},"migrationPath":{"type":"string|array|null","default":"['@app/migrations']","description":"The directory containing the migration classes."},"newFileMode":{"type":"int|null","default":"null","description":"The permission to be set for newly generated migration files.","since":"2.0.43"},"newFileOwnership":{"type":"string|int|null","default":"null","description":"The user and/or group ownership to be set for newly generated migration files.","since":"2.0.43"},"templateFile":{"type":"string","default":"null","description":"The template file for generating new migrations."}},"methods":{"actionCreate":{"signature":"public function actionCreate(string $name): mixed","summary":"Creates a new migration.","params":[{"name":"$name","type":"string","description":"The name of the new migration. This should only contain letters, digits, underscores and/or backslashes. Note: If the migration name is of a special form, for example create_xxx or drop_xxx, then the generated migration file will contain extra code, in this case for creating/dropping tables."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"if the name argument is invalid."}]},"actionDown":{"signature":"public function actionDown(int|string $limit = 1): int","summary":"Downgrades the application by reverting old migrations.","params":[{"name":"$limit","type":"int|string","default":"1","optional":true,"description":"The number of migrations to be reverted. Defaults to 1, meaning the last applied migration will be reverted. When value is \"all\", all migrations will be reverted."}],"return":{"type":"int","description":"The status of the action execution. 0 means normal, other values mean abnormal."},"throws":[{"type":"yii\\console\\Exception","description":"if the number of the steps specified is less than 1."}]},"actionFresh":{"signature":"public function actionFresh(): mixed","summary":"Drops all tables and related constraints. Starts the migration from the beginning.","return":{"type":"mixed"},"since":"2.0.13"},"actionHistory":{"signature":"public function actionHistory(int|string $limit = 10): mixed","summary":"Displays the migration history.","params":[{"name":"$limit","type":"int|string","default":"10","optional":true,"description":"The maximum number of migrations to be displayed. If it is \"all\", the whole migration history will be displayed."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"if invalid limit value passed"}]},"actionMark":{"signature":"public function actionMark(string $version): int","summary":"Modifies the migration history to the specified version.","params":[{"name":"$version","type":"string","description":"The version at which the migration history should be marked. This can be either the timestamp or the full name of the migration. You may specify the name `m000000_000000_base` to set the migration history to a state where no migration has been applied."}],"return":{"type":"int","description":"CLI exit code"},"throws":[{"type":"yii\\console\\Exception","description":"if the version argument is invalid or the version cannot be found."}]},"actionNew":{"signature":"public function actionNew(int|string $limit = 10): mixed","summary":"Displays the un-applied new migrations.","params":[{"name":"$limit","type":"int|string","default":"10","optional":true,"description":"The maximum number of new migrations to be displayed. If it is `all`, all available new migrations will be displayed."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"if invalid limit value passed"}]},"actionRedo":{"signature":"public function actionRedo(int|string $limit = 1): int","summary":"Redoes the last few migrations.","params":[{"name":"$limit","type":"int|string","default":"1","optional":true,"description":"The number of migrations to be redone. Defaults to 1, meaning the last applied migration will be redone. When equals \"all\", all migrations will be redone."}],"return":{"type":"int","description":"The status of the action execution. 0 means normal, other values mean abnormal."},"throws":[{"type":"yii\\console\\Exception","description":"if the number of the steps specified is less than 1."}]},"actionTo":{"signature":"public function actionTo(string $version): mixed","summary":"Upgrades or downgrades till the specified version.","params":[{"name":"$version","type":"string","description":"Either the version name or the certain time value in the past that the application should be migrated to. This can be either the timestamp, the full name of the migration, the UNIX timestamp, or the parseable datetime string."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"if the version argument is invalid."}]},"actionUp":{"signature":"public function actionUp(int $limit = 0): int","summary":"Upgrades the application by applying new migrations.","params":[{"name":"$limit","type":"int","default":"0","optional":true,"description":"The number of new migrations to be applied. If 0, it means applying all available new migrations."}],"return":{"type":"int","description":"The status of the action execution. 0 means normal, other values mean abnormal."}},"addMigrationHistory":{"signature":"abstract protected function addMigrationHistory(string $version): mixed","summary":"Adds new migration entry to the history.","params":[{"name":"$version","type":"string","description":"Migration version name."}],"return":{"type":"mixed"},"visibility":"protected","abstract":true},"beforeAction":{"signature":"public function beforeAction(yii\\base\\Action $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) It checks the existence of the `$migrationPath`.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if directory specified in migrationPath doesn't exist and action isn't \"create\"."}]},"createMigration":{"signature":"protected function createMigration(string $class): yii\\db\\MigrationInterface","summary":"Creates a new migration instance.","params":[{"name":"$class","type":"string","description":"The migration class name"}],"return":{"type":"yii\\db\\MigrationInterface","description":"The migration instance"},"visibility":"protected"},"generateMigrationSourceCode":{"signature":"protected function generateMigrationSourceCode(array $params): string","summary":"Generates new migration source PHP code.","params":[{"name":"$params","type":"array","description":"Generation parameters, usually following parameters are present: - name: string migration base name - className: string migration class name"}],"return":{"type":"string","description":"Generated PHP code."},"visibility":"protected","since":"2.0.8"},"getMigrationHistory":{"signature":"abstract protected function getMigrationHistory(int|null $limit): array","summary":"Returns the migration history.","params":[{"name":"$limit","type":"int|null","description":"The maximum number of records in the history to be returned. `null` for \"no limit\"."}],"return":{"type":"array","description":"The migration history"},"visibility":"protected","abstract":true},"getMigrationNameLimit":{"signature":"protected function getMigrationNameLimit(): int|null","summary":"Return the maximum name length for a migration.","return":{"type":"int|null","description":"The maximum name length for a migration or `null` if no limit applies."},"visibility":"protected","since":"2.0.13"},"getNewMigrations":{"signature":"protected function getNewMigrations(): array","summary":"Returns the migrations that are not applied.","return":{"type":"array","description":"List of new migrations"},"visibility":"protected"},"includeMigrationFile":{"signature":"protected function includeMigrationFile(string $class): mixed","summary":"Includes the migration file for a given migration class name.","params":[{"name":"$class","type":"string","description":"The migration class name."}],"return":{"type":"mixed"},"visibility":"protected","since":"2.0.12"},"migrateDown":{"signature":"protected function migrateDown(string $class): bool","summary":"Downgrades with the specified migration class.","params":[{"name":"$class","type":"string","description":"The migration class name"}],"return":{"type":"bool","description":"Whether the migration is successful"},"visibility":"protected"},"migrateToTime":{"signature":"protected function migrateToTime(int $time): mixed","summary":"Migrates to the specified apply time in the past.","params":[{"name":"$time","type":"int","description":"UNIX timestamp value."}],"return":{"type":"mixed"},"visibility":"protected"},"migrateToVersion":{"signature":"protected function migrateToVersion(string $version): int","summary":"Migrates to the certain version.","params":[{"name":"$version","type":"string","description":"Name in the full format."}],"return":{"type":"int","description":"CLI exit code"},"throws":[{"type":"yii\\console\\Exception","description":"if the provided version cannot be found."}],"visibility":"protected"},"migrateUp":{"signature":"protected function migrateUp(string $class): bool","summary":"Upgrades with the specified migration class.","params":[{"name":"$class","type":"string","description":"The migration class name"}],"return":{"type":"bool","description":"Whether the migration is successful"},"visibility":"protected"},"options":{"signature":"public function options(mixed $actionID): string[]","summary":"Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.","params":[{"name":"$actionID","type":"mixed","description":"The action id of the current request"}],"return":{"type":"string[]","description":"The names of the options valid for the action"}},"removeMigrationHistory":{"signature":"abstract protected function removeMigrationHistory(string $version): mixed","summary":"Removes existing migration from the history.","params":[{"name":"$version","type":"string","description":"Migration version name."}],"return":{"type":"mixed"},"visibility":"protected","abstract":true},"truncateDatabase":{"signature":"protected function truncateDatabase(): mixed","summary":"Truncates the database.","return":{"type":"mixed"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if not overridden"}],"visibility":"protected","since":"2.0.13"}},"constants":{"BASE_MIGRATION":{"value":"'m000000_000000_base'","description":"The name of the dummy migration that marks the beginning of the whole migration history."}},"inherited":{"properties":{"action":"yii\\base\\Controller","behaviors":"yii\\base\\Component","color":"yii\\console\\Controller","help":"yii\\console\\Controller","helpSummary":"yii\\console\\Controller","id":"yii\\base\\Controller","interactive":"yii\\console\\Controller","layout":"yii\\base\\Controller","module":"yii\\base\\Controller","modules":"yii\\base\\Controller","passedOptions":"yii\\console\\Controller","passedOptionValues":"yii\\console\\Controller","request":"yii\\console\\Controller","response":"yii\\console\\Controller","route":"yii\\base\\Controller","silentExitOnException":"yii\\console\\Controller","uniqueId":"yii\\base\\Controller","view":"yii\\base\\Controller","viewPath":"yii\\base\\Controller"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\Controller","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","actions":"yii\\base\\Controller","afterAction":"yii\\base\\Controller","ansiFormat":"yii\\console\\Controller","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","bindActionParams":"yii\\console\\Controller","bindInjectedParams":"yii\\base\\Controller","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","confirm":"yii\\console\\Controller","createAction":"yii\\base\\Controller","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","findLayoutFile":"yii\\base\\Controller","getActionArgsHelp":"yii\\console\\Controller","getActionHelp":"yii\\console\\Controller","getActionHelpSummary":"yii\\console\\Controller","getActionMethodReflection":"yii\\console\\Controller","getActionOptionsHelp":"yii\\console\\Controller","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getHelp":"yii\\console\\Controller","getHelpSummary":"yii\\console\\Controller","getModules":"yii\\base\\Controller","getOptionValues":"yii\\console\\Controller","getPassedOptions":"yii\\console\\Controller","getPassedOptionValues":"yii\\console\\Controller","getRoute":"yii\\base\\Controller","getUniqueId":"yii\\base\\Controller","getView":"yii\\base\\Controller","getViewPath":"yii\\base\\Controller","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\Controller","isColorEnabled":"yii\\console\\Controller","off":"yii\\base\\Component","on":"yii\\base\\Component","optionAliases":"yii\\console\\Controller","parseDocCommentDetail":"yii\\console\\Controller","parseDocCommentSummary":"yii\\console\\Controller","parseDocCommentTags":"yii\\console\\Controller","prompt":"yii\\console\\Controller","render":"yii\\base\\Controller","renderContent":"yii\\base\\Controller","renderFile":"yii\\base\\Controller","renderPartial":"yii\\base\\Controller","run":"yii\\base\\Controller","runAction":"yii\\console\\Controller","select":"yii\\console\\Controller","setView":"yii\\base\\Controller","setViewPath":"yii\\base\\Controller","stderr":"yii\\console\\Controller","stdout":"yii\\console\\Controller","trigger":"yii\\base\\Component"},"events":{"EVENT_BEFORE_ACTION":"yii\\base\\Controller","EVENT_AFTER_ACTION":"yii\\base\\Controller"}}},"yii\\console\\controllers\\CacheController":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/controllers/cachecontroller/","summary":"Allows you to flush cache.","since":"2.0","extends":"yii\\console\\Controller","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"methods":{"actionFlush":{"signature":"public function actionFlush(): mixed","summary":"Flushes given cache components.","return":{"type":"mixed"}},"actionFlushAll":{"signature":"public function actionFlushAll(): mixed","summary":"Flushes all caches registered in the system.","return":{"type":"mixed"}},"actionFlushSchema":{"signature":"public function actionFlushSchema(string $db = 'db'): int","summary":"Clears DB schema cache for a given connection component.","params":[{"name":"$db","type":"string","default":"'db'","optional":true,"description":"Id connection component"}],"return":{"type":"int","description":"Exit code"},"throws":[{"type":"yii\\console\\Exception"},{"type":"yii\\base\\InvalidConfigException"}],"since":"2.0.1"},"actionIndex":{"signature":"public function actionIndex(): mixed","summary":"Lists the caches that can be flushed.","return":{"type":"mixed"}}},"inherited":{"properties":{"action":"yii\\base\\Controller","behaviors":"yii\\base\\Component","color":"yii\\console\\Controller","defaultAction":"yii\\base\\Controller","help":"yii\\console\\Controller","helpSummary":"yii\\console\\Controller","id":"yii\\base\\Controller","interactive":"yii\\console\\Controller","layout":"yii\\base\\Controller","module":"yii\\base\\Controller","modules":"yii\\base\\Controller","passedOptions":"yii\\console\\Controller","passedOptionValues":"yii\\console\\Controller","request":"yii\\console\\Controller","response":"yii\\console\\Controller","route":"yii\\base\\Controller","silentExitOnException":"yii\\console\\Controller","uniqueId":"yii\\base\\Controller","view":"yii\\base\\Controller","viewPath":"yii\\base\\Controller"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\Controller","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","actions":"yii\\base\\Controller","afterAction":"yii\\base\\Controller","ansiFormat":"yii\\console\\Controller","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeAction":"yii\\console\\Controller","behaviors":"yii\\base\\Component","bindActionParams":"yii\\console\\Controller","bindInjectedParams":"yii\\base\\Controller","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","confirm":"yii\\console\\Controller","createAction":"yii\\base\\Controller","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","findLayoutFile":"yii\\base\\Controller","getActionArgsHelp":"yii\\console\\Controller","getActionHelp":"yii\\console\\Controller","getActionHelpSummary":"yii\\console\\Controller","getActionMethodReflection":"yii\\console\\Controller","getActionOptionsHelp":"yii\\console\\Controller","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getHelp":"yii\\console\\Controller","getHelpSummary":"yii\\console\\Controller","getModules":"yii\\base\\Controller","getOptionValues":"yii\\console\\Controller","getPassedOptions":"yii\\console\\Controller","getPassedOptionValues":"yii\\console\\Controller","getRoute":"yii\\base\\Controller","getUniqueId":"yii\\base\\Controller","getView":"yii\\base\\Controller","getViewPath":"yii\\base\\Controller","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\Controller","isColorEnabled":"yii\\console\\Controller","off":"yii\\base\\Component","on":"yii\\base\\Component","optionAliases":"yii\\console\\Controller","options":"yii\\console\\Controller","parseDocCommentDetail":"yii\\console\\Controller","parseDocCommentSummary":"yii\\console\\Controller","parseDocCommentTags":"yii\\console\\Controller","prompt":"yii\\console\\Controller","render":"yii\\base\\Controller","renderContent":"yii\\base\\Controller","renderFile":"yii\\base\\Controller","renderPartial":"yii\\base\\Controller","run":"yii\\base\\Controller","runAction":"yii\\console\\Controller","select":"yii\\console\\Controller","setView":"yii\\base\\Controller","setViewPath":"yii\\base\\Controller","stderr":"yii\\console\\Controller","stdout":"yii\\console\\Controller","trigger":"yii\\base\\Component"},"events":{"EVENT_BEFORE_ACTION":"yii\\base\\Controller","EVENT_AFTER_ACTION":"yii\\base\\Controller"}}},"yii\\console\\controllers\\FixtureController":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/controllers/fixturecontroller/","summary":"Manages fixture data loading and unloading.","since":"2.0","extends":"yii\\console\\Controller","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"traits":["yii\\test\\FixtureTrait"],"properties":{"defaultAction":{"type":"string","default":"'load'","description":"Controller default action ID."},"globalFixtures":{"type":"array","default":"['yii\\test\\InitDbFixture']","description":"Global fixtures that should be applied when loading and unloading."},"namespace":{"type":"string","default":"'tests\\unit\\fixtures'","description":"Default namespace to search fixtures in"}},"methods":{"actionLoad":{"signature":"public function actionLoad(array $fixturesInput = []): int","summary":"Loads the specified fixture data.","params":[{"name":"$fixturesInput","type":"array","default":"[]","optional":true}],"return":{"type":"int","description":"Return code"},"throws":[{"type":"yii\\console\\Exception","description":"if the specified fixture does not exist."}]},"actionUnload":{"signature":"public function actionUnload(array $fixturesInput = []): int","summary":"Unloads the specified fixtures.","params":[{"name":"$fixturesInput","type":"array","default":"[]","optional":true}],"return":{"type":"int","description":"Return code"},"throws":[{"type":"yii\\console\\Exception","description":"if the specified fixture does not exist."}]},"needToApplyAll":{"signature":"public function needToApplyAll(string $fixture): bool","summary":"Checks if needed to apply all fixtures.","params":[{"name":"$fixture","type":"string"}],"return":{"type":"bool"}},"notifyNothingToLoad":{"signature":"public function notifyNothingToLoad(array $foundFixtures, array $except): mixed","summary":"Notifies user that there are no fixtures to load according input conditions.","params":[{"name":"$foundFixtures","type":"array","description":"Array of found fixtures"},{"name":"$except","type":"array","description":"Array of names of fixtures that should not be loaded"}],"return":{"type":"mixed"}},"notifyNothingToUnload":{"signature":"public function notifyNothingToUnload(array $foundFixtures, array $except): mixed","summary":"Notifies user that there are no fixtures to unload according input conditions.","params":[{"name":"$foundFixtures","type":"array","description":"Array of found fixtures"},{"name":"$except","type":"array","description":"Array of names of fixtures that should not be loaded"}],"return":{"type":"mixed"}},"optionAliases":{"signature":"public function optionAliases(): array","summary":"Returns option alias names.","return":{"type":"array","description":"The options alias names valid for the action where the keys is alias name for option and value is option name."},"since":"2.0.8"},"options":{"signature":"public function options(mixed $actionID): string[]","summary":"Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.","params":[{"name":"$actionID","type":"mixed","description":"The action id of the current request"}],"return":{"type":"string[]","description":"The names of the options valid for the action"}}},"inherited":{"properties":{"action":"yii\\base\\Controller","behaviors":"yii\\base\\Component","color":"yii\\console\\Controller","fixtures":"yii\\test\\FixtureTrait","help":"yii\\console\\Controller","helpSummary":"yii\\console\\Controller","id":"yii\\base\\Controller","interactive":"yii\\console\\Controller","layout":"yii\\base\\Controller","module":"yii\\base\\Controller","modules":"yii\\base\\Controller","passedOptions":"yii\\console\\Controller","passedOptionValues":"yii\\console\\Controller","request":"yii\\console\\Controller","response":"yii\\console\\Controller","route":"yii\\base\\Controller","silentExitOnException":"yii\\console\\Controller","uniqueId":"yii\\base\\Controller","view":"yii\\base\\Controller","viewPath":"yii\\base\\Controller"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\Controller","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","actions":"yii\\base\\Controller","afterAction":"yii\\base\\Controller","ansiFormat":"yii\\console\\Controller","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeAction":"yii\\console\\Controller","behaviors":"yii\\base\\Component","bindActionParams":"yii\\console\\Controller","bindInjectedParams":"yii\\base\\Controller","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","confirm":"yii\\console\\Controller","createAction":"yii\\base\\Controller","createFixtures":"yii\\test\\FixtureTrait","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","findLayoutFile":"yii\\base\\Controller","fixtures":"yii\\test\\FixtureTrait","getActionArgsHelp":"yii\\console\\Controller","getActionHelp":"yii\\console\\Controller","getActionHelpSummary":"yii\\console\\Controller","getActionMethodReflection":"yii\\console\\Controller","getActionOptionsHelp":"yii\\console\\Controller","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getFixture":"yii\\test\\FixtureTrait","getFixtures":"yii\\test\\FixtureTrait","getHelp":"yii\\console\\Controller","getHelpSummary":"yii\\console\\Controller","getModules":"yii\\base\\Controller","getOptionValues":"yii\\console\\Controller","getPassedOptions":"yii\\console\\Controller","getPassedOptionValues":"yii\\console\\Controller","getRoute":"yii\\base\\Controller","getUniqueId":"yii\\base\\Controller","getView":"yii\\base\\Controller","getViewPath":"yii\\base\\Controller","globalFixtures":"yii\\test\\FixtureTrait","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\Controller","initFixtures":"yii\\test\\FixtureTrait","isColorEnabled":"yii\\console\\Controller","loadFixtures":"yii\\test\\FixtureTrait","off":"yii\\base\\Component","on":"yii\\base\\Component","parseDocCommentDetail":"yii\\console\\Controller","parseDocCommentSummary":"yii\\console\\Controller","parseDocCommentTags":"yii\\console\\Controller","prompt":"yii\\console\\Controller","render":"yii\\base\\Controller","renderContent":"yii\\base\\Controller","renderFile":"yii\\base\\Controller","renderPartial":"yii\\base\\Controller","run":"yii\\base\\Controller","runAction":"yii\\console\\Controller","select":"yii\\console\\Controller","setView":"yii\\base\\Controller","setViewPath":"yii\\base\\Controller","stderr":"yii\\console\\Controller","stdout":"yii\\console\\Controller","trigger":"yii\\base\\Component","unloadFixtures":"yii\\test\\FixtureTrait"},"events":{"EVENT_BEFORE_ACTION":"yii\\base\\Controller","EVENT_AFTER_ACTION":"yii\\base\\Controller"}}},"yii\\console\\controllers\\HelpController":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/controllers/helpcontroller/","summary":"Provides help information about console commands.","since":"2.0","extends":"yii\\console\\Controller","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"commands":{"type":"array","description":"All available command names.","access":"read-only","virtual":true}},"methods":{"actionIndex":{"signature":"public function actionIndex(string|null $command = null): int","summary":"Displays available commands or the detailed information about a particular command.","params":[{"name":"$command","type":"string|null","default":"null","optional":true,"description":"The name of the command to show help about. If not provided, all available commands will be displayed."}],"return":{"type":"int","description":"The exit status"},"throws":[{"type":"yii\\console\\Exception","description":"if the command for help is unknown"}]},"actionList":{"signature":"public function actionList(): mixed","summary":"List all available controllers and actions in machine readable format.","return":{"type":"mixed"},"since":"2.0.11"},"actionListActionOptions":{"signature":"public function actionListActionOptions(string $action): mixed","summary":"List all available options for the $action in machine readable format.","params":[{"name":"$action","type":"string","description":"Route to action"}],"return":{"type":"mixed"},"since":"2.0.11"},"actionUsage":{"signature":"public function actionUsage(string $action): mixed","summary":"Displays usage information for $action.","params":[{"name":"$action","type":"string","description":"Route to action"}],"return":{"type":"mixed"},"since":"2.0.11"},"formatOptionAliases":{"signature":"protected function formatOptionAliases(yii\\console\\Controller $controller, string $option): string","params":[{"name":"$controller","type":"yii\\console\\Controller","description":"The controller instance"},{"name":"$option","type":"string","description":"The option name"}],"return":{"type":"string","description":"The formatted string for the alias argument or option"},"visibility":"protected","since":"2.0.8"},"formatOptionHelp":{"signature":"protected function formatOptionHelp(string $name, bool $required, string $type, mixed $defaultValue, string $comment): string","summary":"Generates a well-formed string for an argument or option.","params":[{"name":"$name","type":"string","description":"The name of the argument or option"},{"name":"$required","type":"bool","description":"Whether the argument is required"},{"name":"$type","type":"string","description":"The type of the option or argument"},{"name":"$defaultValue","type":"mixed","description":"The default value of the option or argument"},{"name":"$comment","type":"string","description":"Comment about the option or argument"}],"return":{"type":"string","description":"The formatted string for the argument or option"},"visibility":"protected"},"getActions":{"signature":"public function getActions(yii\\console\\Controller $controller): array","summary":"Returns all available actions of the specified controller.","params":[{"name":"$controller","type":"yii\\console\\Controller","description":"The controller instance"}],"return":{"type":"array","description":"All available action IDs."}},"getCommandDescriptions":{"signature":"protected function getCommandDescriptions(): array","summary":"Returns an array of commands an their descriptions.","return":{"type":"array","description":"All available commands as keys and their description as values."},"visibility":"protected"},"getCommandHelp":{"signature":"protected function getCommandHelp(yii\\console\\Controller $controller): mixed","summary":"Displays the overall information of the command.","params":[{"name":"$controller","type":"yii\\console\\Controller","description":"The controller instance"}],"return":{"type":"mixed"},"visibility":"protected"},"getCommands":{"signature":"public function getCommands(): array","summary":"Returns all available command names.","return":{"type":"array","description":"All available command names"}},"getDefaultHelp":{"signature":"protected function getDefaultHelp(): mixed","summary":"Displays all available commands.","return":{"type":"mixed"},"visibility":"protected"},"getDefaultHelpHeader":{"signature":"protected function getDefaultHelpHeader(): string","summary":"Return a default help header.","return":{"type":"string","description":"Default help header."},"visibility":"protected","since":"2.0.11"},"getModuleCommands":{"signature":"protected function getModuleCommands(yii\\base\\Module $module): array","summary":"Returns available commands of a specified module.","params":[{"name":"$module","type":"yii\\base\\Module","description":"The module instance"}],"return":{"type":"array","description":"The available command names"},"visibility":"protected"},"getScriptName":{"signature":"protected function getScriptName(): string","return":{"type":"string","description":"The name of the cli script currently running."},"visibility":"protected"},"getSubCommandHelp":{"signature":"protected function getSubCommandHelp(yii\\console\\Controller $controller, string $actionID): mixed","summary":"Displays the detailed information of a command action.","params":[{"name":"$controller","type":"yii\\console\\Controller","description":"The controller instance"},{"name":"$actionID","type":"string","description":"Action ID"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"if the action does not exist"}],"visibility":"protected"},"validateControllerClass":{"signature":"protected function validateControllerClass(string $controllerClass): bool","summary":"Validates if the given class is a valid console controller class.","params":[{"name":"$controllerClass","type":"string"}],"return":{"type":"bool"},"visibility":"protected"}},"inherited":{"properties":{"action":"yii\\base\\Controller","behaviors":"yii\\base\\Component","color":"yii\\console\\Controller","defaultAction":"yii\\base\\Controller","help":"yii\\console\\Controller","helpSummary":"yii\\console\\Controller","id":"yii\\base\\Controller","interactive":"yii\\console\\Controller","layout":"yii\\base\\Controller","module":"yii\\base\\Controller","modules":"yii\\base\\Controller","passedOptions":"yii\\console\\Controller","passedOptionValues":"yii\\console\\Controller","request":"yii\\console\\Controller","response":"yii\\console\\Controller","route":"yii\\base\\Controller","silentExitOnException":"yii\\console\\Controller","uniqueId":"yii\\base\\Controller","view":"yii\\base\\Controller","viewPath":"yii\\base\\Controller"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\Controller","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","actions":"yii\\base\\Controller","afterAction":"yii\\base\\Controller","ansiFormat":"yii\\console\\Controller","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeAction":"yii\\console\\Controller","behaviors":"yii\\base\\Component","bindActionParams":"yii\\console\\Controller","bindInjectedParams":"yii\\base\\Controller","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","confirm":"yii\\console\\Controller","createAction":"yii\\base\\Controller","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","findLayoutFile":"yii\\base\\Controller","getActionArgsHelp":"yii\\console\\Controller","getActionHelp":"yii\\console\\Controller","getActionHelpSummary":"yii\\console\\Controller","getActionMethodReflection":"yii\\console\\Controller","getActionOptionsHelp":"yii\\console\\Controller","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getHelp":"yii\\console\\Controller","getHelpSummary":"yii\\console\\Controller","getModules":"yii\\base\\Controller","getOptionValues":"yii\\console\\Controller","getPassedOptions":"yii\\console\\Controller","getPassedOptionValues":"yii\\console\\Controller","getRoute":"yii\\base\\Controller","getUniqueId":"yii\\base\\Controller","getView":"yii\\base\\Controller","getViewPath":"yii\\base\\Controller","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\Controller","isColorEnabled":"yii\\console\\Controller","off":"yii\\base\\Component","on":"yii\\base\\Component","optionAliases":"yii\\console\\Controller","options":"yii\\console\\Controller","parseDocCommentDetail":"yii\\console\\Controller","parseDocCommentSummary":"yii\\console\\Controller","parseDocCommentTags":"yii\\console\\Controller","prompt":"yii\\console\\Controller","render":"yii\\base\\Controller","renderContent":"yii\\base\\Controller","renderFile":"yii\\base\\Controller","renderPartial":"yii\\base\\Controller","run":"yii\\base\\Controller","runAction":"yii\\console\\Controller","select":"yii\\console\\Controller","setView":"yii\\base\\Controller","setViewPath":"yii\\base\\Controller","stderr":"yii\\console\\Controller","stdout":"yii\\console\\Controller","trigger":"yii\\base\\Component"},"events":{"EVENT_BEFORE_ACTION":"yii\\base\\Controller","EVENT_AFTER_ACTION":"yii\\base\\Controller"}}},"yii\\console\\controllers\\MessageController":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/controllers/messagecontroller/","summary":"Extracts messages to be translated from source files.","since":"2.0","extends":"yii\\console\\Controller","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"catalog":{"type":"string","default":"'messages'","description":"Name of the file that will be used for translations for \"po\" format."},"config":{"type":"array","default":"null","description":"Config for messages extraction.","visibility":"protected","since":"2.0.13"},"db":{"type":"string","default":"'db'","description":"Connection component ID for \"db\" format."},"defaultAction":{"type":"string","default":"'extract'","description":"Controller default action ID."},"except":{"type":"array|null","default":"['.*', '/.*', '/messages', '/tests', '/runtime', '/vendor', '/BaseYii.php']","description":"List of patterns that specify which files/directories should NOT be processed."},"format":{"type":"string","default":"'php'","description":"Generated file format."},"ignoreCategories":{"type":"array","default":"[]","description":"Message categories to ignore."},"languages":{"type":"array","default":"[]","description":"Required, list of language codes that the extracted messages should be translated to."},"markUnused":{"type":"bool","default":"true","description":"Whether to mark messages that no longer appear in the source code."},"messagePath":{"type":"string","default":"'@yii/messages'","description":"Required, root directory containing message translations."},"messageTable":{"type":"string","default":"'{{%message}}'","description":"Custom name for translation message table for \"db\" format."},"only":{"type":"array|null","default":"['*.php']","description":"List of patterns that specify which files (not directories) should be processed."},"overwrite":{"type":"bool","default":"true","description":"Whether the message file should be overwritten with the merged messages"},"phpDocBlock":{"type":"string|null","default":"null","description":"DocBlock used for messages array in generated PHP file.","since":"2.0.13"},"phpFileHeader":{"type":"string","default":"''","description":"File header in generated PHP file with messages.","since":"2.0.13"},"removeUnused":{"type":"bool","default":"false","description":"Whether to remove messages that no longer appear in the source code."},"sort":{"type":"bool","default":"false","description":"Whether to sort messages by keys when merging new messages with the existing ones."},"sourceMessageTable":{"type":"string","default":"'{{%source_message}}'","description":"Custom name for source message table for \"db\" format."},"sourcePath":{"type":"string","default":"'@yii'","description":"Required, root directory of all source files."},"translator":{"type":"string|string[]","default":"['Yii::t', '\\Yii::t']","description":"The name of the function for translating messages."}},"methods":{"actionConfig":{"signature":"public function actionConfig(string $filePath): int","summary":"Creates a configuration file for the \"extract\" command using command line options specified.","params":[{"name":"$filePath","type":"string","description":"Output file name or alias."}],"return":{"type":"int","description":"CLI exit code"},"throws":[{"type":"yii\\console\\Exception","description":"on failure."}]},"actionConfigTemplate":{"signature":"public function actionConfigTemplate(string $filePath): int","summary":"Creates a configuration file template for the \"extract\" command.","params":[{"name":"$filePath","type":"string","description":"Output file name or alias."}],"return":{"type":"int","description":"CLI exit code"},"throws":[{"type":"yii\\console\\Exception","description":"on failure."}]},"actionExtract":{"signature":"public function actionExtract(string|null $configFile = null): mixed","summary":"Extracts messages to be translated from source code.","params":[{"name":"$configFile","type":"string|null","default":"null","optional":true,"description":"The path or alias of the configuration file. You may use the \"yii message/config\" command to generate this file and then customize it for your needs."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"on failure."}]},"extractMessages":{"signature":"protected function extractMessages(string $fileName, string $translator, array $ignoreCategories = []): array","summary":"Extracts messages from a file.","params":[{"name":"$fileName","type":"string","description":"Name of the file to extract messages from"},{"name":"$translator","type":"string","description":"Name of the function used to translate messages"},{"name":"$ignoreCategories","type":"array","default":"[]","optional":true,"description":"Message categories to ignore. This parameter is available since version 2.0.4."}],"return":{"type":"array"},"visibility":"protected"},"extractMessagesFromTokens":{"signature":"protected function extractMessagesFromTokens(array $tokens, array $translatorTokens, array $ignoreCategories): array","summary":"Extracts messages from a parsed PHP tokens list.","params":[{"name":"$tokens","type":"array","description":"Tokens to be processed."},{"name":"$translatorTokens","type":"array","description":"Translator tokens."},{"name":"$ignoreCategories","type":"array","description":"Message categories to ignore."}],"return":{"type":"array","description":"Messages."},"visibility":"protected"},"getLine":{"signature":"protected function getLine(array $tokens): int|string","summary":"Finds out a line of the first non-char PHP token found.","params":[{"name":"$tokens","type":"array"}],"return":{"type":"int|string"},"visibility":"protected","since":"2.0.1"},"initConfig":{"signature":"protected function initConfig(string $configFile): mixed","params":[{"name":"$configFile","type":"string"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\console\\Exception","description":"If configuration file does not exists."}],"visibility":"protected","since":"2.0.13"},"isCategoryIgnored":{"signature":"protected function isCategoryIgnored(string $category, array $ignoreCategories): bool","summary":"The method checks, whether the $category is ignored according to $ignoreCategories array.","params":[{"name":"$category","type":"string","description":"Category that is checked"},{"name":"$ignoreCategories","type":"array","description":"Message categories to ignore."}],"return":{"type":"bool"},"visibility":"protected","since":"2.0.7"},"optionAliases":{"signature":"public function optionAliases(): array","summary":"Returns option alias names.","return":{"type":"array","description":"The options alias names valid for the action where the keys is alias name for option and value is option name."},"since":"2.0.8"},"options":{"signature":"public function options(mixed $actionID): string[]","summary":"Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.","params":[{"name":"$actionID","type":"mixed","description":"The action id of the current request"}],"return":{"type":"string[]","description":"The names of the options valid for the action"}},"saveMessagesCategoryToPHP":{"signature":"protected function saveMessagesCategoryToPHP(array $messages, string $fileName, bool $overwrite, bool $removeUnused, bool $sort, string $category, bool $markUnused): int","summary":"Writes category messages into PHP file.","params":[{"name":"$messages","type":"array"},{"name":"$fileName","type":"string","description":"Name of the file to write to"},{"name":"$overwrite","type":"bool","description":"If existing file should be overwritten without backup"},{"name":"$removeUnused","type":"bool","description":"If obsolete translations should be removed"},{"name":"$sort","type":"bool","description":"If translations should be sorted"},{"name":"$category","type":"string","description":"Message category"},{"name":"$markUnused","type":"bool","description":"If obsolete translations should be marked"}],"return":{"type":"int","description":"Exit code"},"visibility":"protected"},"saveMessagesToDb":{"signature":"protected function saveMessagesToDb(array $messages, yii\\db\\Connection $db, string $sourceMessageTable, string $messageTable, bool $removeUnused, array $languages, bool $markUnused): mixed","summary":"Saves messages to database.","params":[{"name":"$messages","type":"array"},{"name":"$db","type":"yii\\db\\Connection"},{"name":"$sourceMessageTable","type":"string"},{"name":"$messageTable","type":"string"},{"name":"$removeUnused","type":"bool"},{"name":"$languages","type":"array"},{"name":"$markUnused","type":"bool"}],"return":{"type":"mixed"},"visibility":"protected"},"saveMessagesToPHP":{"signature":"protected function saveMessagesToPHP(array $messages, string $dirName, bool $overwrite, bool $removeUnused, bool $sort, bool $markUnused): mixed","summary":"Writes messages into PHP files.","params":[{"name":"$messages","type":"array"},{"name":"$dirName","type":"string","description":"Name of the directory to write to"},{"name":"$overwrite","type":"bool","description":"If existing file should be overwritten without backup"},{"name":"$removeUnused","type":"bool","description":"If obsolete translations should be removed"},{"name":"$sort","type":"bool","description":"If translations should be sorted"},{"name":"$markUnused","type":"bool","description":"If obsolete translations should be marked"}],"return":{"type":"mixed"},"visibility":"protected"},"saveMessagesToPO":{"signature":"protected function saveMessagesToPO(array $messages, string $dirName, bool $overwrite, bool $removeUnused, bool $sort, string $catalog, bool $markUnused): mixed","summary":"Writes messages into PO file.","params":[{"name":"$messages","type":"array"},{"name":"$dirName","type":"string","description":"Name of the directory to write to"},{"name":"$overwrite","type":"bool","description":"If existing file should be overwritten without backup"},{"name":"$removeUnused","type":"bool","description":"If obsolete translations should be removed"},{"name":"$sort","type":"bool","description":"If translations should be sorted"},{"name":"$catalog","type":"string","description":"Message catalog"},{"name":"$markUnused","type":"bool","description":"If obsolete translations should be marked"}],"return":{"type":"mixed"},"visibility":"protected"},"saveMessagesToPOT":{"signature":"protected function saveMessagesToPOT(array $messages, string $dirName, string $catalog): mixed","summary":"Writes messages into POT file.","params":[{"name":"$messages","type":"array"},{"name":"$dirName","type":"string","description":"Name of the directory to write to"},{"name":"$catalog","type":"string","description":"Message catalog"}],"return":{"type":"mixed"},"visibility":"protected","since":"2.0.6"},"tokensEqual":{"signature":"protected function tokensEqual(array|string $a, array|string $b): bool","summary":"Finds out if two PHP tokens are equal.","params":[{"name":"$a","type":"array|string"},{"name":"$b","type":"array|string"}],"return":{"type":"bool"},"visibility":"protected","since":"2.0.1"}},"inherited":{"properties":{"action":"yii\\base\\Controller","behaviors":"yii\\base\\Component","color":"yii\\console\\Controller","help":"yii\\console\\Controller","helpSummary":"yii\\console\\Controller","id":"yii\\base\\Controller","interactive":"yii\\console\\Controller","layout":"yii\\base\\Controller","module":"yii\\base\\Controller","modules":"yii\\base\\Controller","passedOptions":"yii\\console\\Controller","passedOptionValues":"yii\\console\\Controller","request":"yii\\console\\Controller","response":"yii\\console\\Controller","route":"yii\\base\\Controller","silentExitOnException":"yii\\console\\Controller","uniqueId":"yii\\base\\Controller","view":"yii\\base\\Controller","viewPath":"yii\\base\\Controller"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\Controller","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","actions":"yii\\base\\Controller","afterAction":"yii\\base\\Controller","ansiFormat":"yii\\console\\Controller","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeAction":"yii\\console\\Controller","behaviors":"yii\\base\\Component","bindActionParams":"yii\\console\\Controller","bindInjectedParams":"yii\\base\\Controller","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","confirm":"yii\\console\\Controller","createAction":"yii\\base\\Controller","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","findLayoutFile":"yii\\base\\Controller","getActionArgsHelp":"yii\\console\\Controller","getActionHelp":"yii\\console\\Controller","getActionHelpSummary":"yii\\console\\Controller","getActionMethodReflection":"yii\\console\\Controller","getActionOptionsHelp":"yii\\console\\Controller","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getHelp":"yii\\console\\Controller","getHelpSummary":"yii\\console\\Controller","getModules":"yii\\base\\Controller","getOptionValues":"yii\\console\\Controller","getPassedOptions":"yii\\console\\Controller","getPassedOptionValues":"yii\\console\\Controller","getRoute":"yii\\base\\Controller","getUniqueId":"yii\\base\\Controller","getView":"yii\\base\\Controller","getViewPath":"yii\\base\\Controller","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\Controller","isColorEnabled":"yii\\console\\Controller","off":"yii\\base\\Component","on":"yii\\base\\Component","parseDocCommentDetail":"yii\\console\\Controller","parseDocCommentSummary":"yii\\console\\Controller","parseDocCommentTags":"yii\\console\\Controller","prompt":"yii\\console\\Controller","render":"yii\\base\\Controller","renderContent":"yii\\base\\Controller","renderFile":"yii\\base\\Controller","renderPartial":"yii\\base\\Controller","run":"yii\\base\\Controller","runAction":"yii\\console\\Controller","select":"yii\\console\\Controller","setView":"yii\\base\\Controller","setViewPath":"yii\\base\\Controller","stderr":"yii\\console\\Controller","stdout":"yii\\console\\Controller","trigger":"yii\\base\\Component"},"events":{"EVENT_BEFORE_ACTION":"yii\\base\\Controller","EVENT_AFTER_ACTION":"yii\\base\\Controller"}}},"yii\\console\\controllers\\MigrateController":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/controllers/migratecontroller/","summary":"Manages application migrations.","since":"2.0","extends":"yii\\console\\controllers\\BaseMigrateController","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"comment":{"type":"string","default":"''","description":"The comment for the table being created.","since":"2.0.14"},"db":{"type":"yii\\db\\Connection|array|string","default":"'db'","description":"The DB connection object or the application component ID of the DB connection to use when applying migrations."},"fields":{"type":"array","default":"[]","description":"Column definition strings used for creating migration code.","since":"2.0.7"},"generatorTemplateFiles":{"type":"array","default":"['create_table' => '@yii/views/createTableMigration.php', 'drop_table' => '@yii/views/dropTableMigration.php', 'add_column' => '@yii/views/addColumnMigration.php', 'drop_column' => '@yii/views/dropColumnMigration.php', 'create_junction' => '@yii/views/createTableMigration.php']","description":"A set of template paths for generating migration code automatically.","since":"2.0.7"},"migrationTable":{"type":"string","default":"'{{%migration}}'","description":"The name of the table for keeping applied migration information."},"templateFile":{"type":"string","default":"'@yii/views/migration.php'"},"useTablePrefix":{"type":"bool","default":"true","description":"Indicates whether the table names generated should consider the `tablePrefix` setting of the DB connection.","since":"2.0.8"}},"methods":{"addDefaultPrimaryKey":{"signature":"protected function addDefaultPrimaryKey(array &$fields): mixed","summary":"Adds default primary key to fields list if there's no primary key specified.","params":[{"name":"$fields","type":"array","byReference":true,"description":"Parsed fields"}],"return":{"type":"mixed"},"visibility":"protected","since":"2.0.7"},"addMigrationHistory":{"signature":"protected function addMigrationHistory(mixed $version): mixed","summary":"Adds new migration entry to the history.","params":[{"name":"$version","type":"mixed","description":"Migration version name."}],"return":{"type":"mixed"},"visibility":"protected"},"beforeAction":{"signature":"public function beforeAction(yii\\base\\Action $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) It checks the existence of the `$migrationPath`.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"createMigration":{"signature":"protected function createMigration(string $class): yii\\db\\Migration","summary":"Creates a new migration instance.","params":[{"name":"$class","type":"string","description":"The migration class name"}],"return":{"type":"yii\\db\\Migration","description":"The migration instance"},"visibility":"protected"},"createMigrationHistoryTable":{"signature":"protected function createMigrationHistoryTable(): mixed","summary":"Creates the migration history table.","return":{"type":"mixed"},"visibility":"protected"},"generateMigrationSourceCode":{"signature":"protected function generateMigrationSourceCode(mixed $params): string","summary":"Generates new migration source PHP code.","params":[{"name":"$params","type":"mixed","description":"Generation parameters, usually following parameters are present: - name: string migration base name - className: string migration class name"}],"return":{"type":"string","description":"Generated PHP code."},"visibility":"protected","since":"2.0.8"},"generateTableName":{"signature":"protected function generateTableName(string $tableName): string","summary":"If `useTablePrefix` equals true, then the table name will contain the prefix format.","params":[{"name":"$tableName","type":"string","description":"The table name to generate."}],"return":{"type":"string"},"visibility":"protected","since":"2.0.8"},"getMigrationHistory":{"signature":"protected function getMigrationHistory(mixed $limit): array","summary":"Returns the migration history.","params":[{"name":"$limit","type":"mixed","description":"The maximum number of records in the history to be returned. `null` for \"no limit\"."}],"return":{"type":"array","description":"The migration history"},"visibility":"protected"},"getMigrationNameLimit":{"signature":"protected function getMigrationNameLimit(): int|null","summary":"Return the maximum name length for a migration.","return":{"type":"int|null","description":"The maximum name length for a migration or `null` if no limit applies."},"visibility":"protected","since":"2.0.13"},"optionAliases":{"signature":"public function optionAliases(): array","summary":"Returns option alias names.","return":{"type":"array","description":"The options alias names valid for the action where the keys is alias name for option and value is option name."},"since":"2.0.8"},"options":{"signature":"public function options(mixed $actionID): string[]","summary":"Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.","params":[{"name":"$actionID","type":"mixed","description":"The action id of the current request"}],"return":{"type":"string[]","description":"The names of the options valid for the action"}},"parseFields":{"signature":"protected function parseFields(): array","summary":"Parse the command line migration fields.","return":{"type":"array","description":"Parse result with following fields: - fields: array, parsed fields - foreignKeys: array, detected foreign keys"},"visibility":"protected","since":"2.0.7"},"removeMigrationHistory":{"signature":"protected function removeMigrationHistory(mixed $version): mixed","summary":"Removes existing migration from the history.","params":[{"name":"$version","type":"mixed","description":"Migration version name."}],"return":{"type":"mixed"},"visibility":"protected"},"splitFieldIntoChunks":{"signature":"protected function splitFieldIntoChunks(string $field): string[]|false","summary":"Splits field into chunks","params":[{"name":"$field","type":"string"}],"return":{"type":"string[]|false"},"visibility":"protected"},"truncateDatabase":{"signature":"protected function truncateDatabase(): mixed","summary":"Truncates the database.","return":{"type":"mixed"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if not overridden"}],"visibility":"protected","since":"2.0.13"}},"constants":{"MAX_NAME_LENGTH":{"value":"180","description":"Maximum length of a migration name.","since":"2.0.13"}},"inherited":{"properties":{"action":"yii\\base\\Controller","behaviors":"yii\\base\\Component","color":"yii\\console\\Controller","compact":"yii\\console\\controllers\\BaseMigrateController","defaultAction":"yii\\console\\controllers\\BaseMigrateController","help":"yii\\console\\Controller","helpSummary":"yii\\console\\Controller","id":"yii\\base\\Controller","interactive":"yii\\console\\Controller","layout":"yii\\base\\Controller","migrationNamespaces":"yii\\console\\controllers\\BaseMigrateController","migrationPath":"yii\\console\\controllers\\BaseMigrateController","module":"yii\\base\\Controller","modules":"yii\\base\\Controller","newFileMode":"yii\\console\\controllers\\BaseMigrateController","newFileOwnership":"yii\\console\\controllers\\BaseMigrateController","passedOptions":"yii\\console\\Controller","passedOptionValues":"yii\\console\\Controller","request":"yii\\console\\Controller","response":"yii\\console\\Controller","route":"yii\\base\\Controller","silentExitOnException":"yii\\console\\Controller","uniqueId":"yii\\base\\Controller","view":"yii\\base\\Controller","viewPath":"yii\\base\\Controller"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\Controller","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","actionCreate":"yii\\console\\controllers\\BaseMigrateController","actionDown":"yii\\console\\controllers\\BaseMigrateController","actionFresh":"yii\\console\\controllers\\BaseMigrateController","actionHistory":"yii\\console\\controllers\\BaseMigrateController","actionMark":"yii\\console\\controllers\\BaseMigrateController","actionNew":"yii\\console\\controllers\\BaseMigrateController","actionRedo":"yii\\console\\controllers\\BaseMigrateController","actions":"yii\\base\\Controller","actionTo":"yii\\console\\controllers\\BaseMigrateController","actionUp":"yii\\console\\controllers\\BaseMigrateController","afterAction":"yii\\base\\Controller","ansiFormat":"yii\\console\\Controller","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","bindActionParams":"yii\\console\\Controller","bindInjectedParams":"yii\\base\\Controller","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","confirm":"yii\\console\\Controller","createAction":"yii\\base\\Controller","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","findLayoutFile":"yii\\base\\Controller","getActionArgsHelp":"yii\\console\\Controller","getActionHelp":"yii\\console\\Controller","getActionHelpSummary":"yii\\console\\Controller","getActionMethodReflection":"yii\\console\\Controller","getActionOptionsHelp":"yii\\console\\Controller","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getHelp":"yii\\console\\Controller","getHelpSummary":"yii\\console\\Controller","getModules":"yii\\base\\Controller","getNewMigrations":"yii\\console\\controllers\\BaseMigrateController","getOptionValues":"yii\\console\\Controller","getPassedOptions":"yii\\console\\Controller","getPassedOptionValues":"yii\\console\\Controller","getRoute":"yii\\base\\Controller","getUniqueId":"yii\\base\\Controller","getView":"yii\\base\\Controller","getViewPath":"yii\\base\\Controller","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","includeMigrationFile":"yii\\console\\controllers\\BaseMigrateController","init":"yii\\base\\Controller","isColorEnabled":"yii\\console\\Controller","migrateDown":"yii\\console\\controllers\\BaseMigrateController","migrateToTime":"yii\\console\\controllers\\BaseMigrateController","migrateToVersion":"yii\\console\\controllers\\BaseMigrateController","migrateUp":"yii\\console\\controllers\\BaseMigrateController","off":"yii\\base\\Component","on":"yii\\base\\Component","parseDocCommentDetail":"yii\\console\\Controller","parseDocCommentSummary":"yii\\console\\Controller","parseDocCommentTags":"yii\\console\\Controller","prompt":"yii\\console\\Controller","render":"yii\\base\\Controller","renderContent":"yii\\base\\Controller","renderFile":"yii\\base\\Controller","renderPartial":"yii\\base\\Controller","run":"yii\\base\\Controller","runAction":"yii\\console\\Controller","select":"yii\\console\\Controller","setView":"yii\\base\\Controller","setViewPath":"yii\\base\\Controller","stderr":"yii\\console\\Controller","stdout":"yii\\console\\Controller","trigger":"yii\\base\\Component"},"constants":{"BASE_MIGRATION":"yii\\console\\controllers\\BaseMigrateController"},"events":{"EVENT_BEFORE_ACTION":"yii\\base\\Controller","EVENT_AFTER_ACTION":"yii\\base\\Controller"}}},"yii\\console\\controllers\\ServeController":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/controllers/servecontroller/","summary":"Runs PHP built-in web server.","since":"2.0.7","extends":"yii\\console\\Controller","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"docroot":{"type":"string","default":"'@app/web'","description":"Path or [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/) to directory to serve"},"port":{"type":"int","default":"8080","description":"Port to serve on."},"router":{"type":"string","default":"null","description":"Path or [path alias](https://yii2-framework.github.io/docs/guide/concept-aliases/) to router script."}},"methods":{"actionIndex":{"signature":"public function actionIndex(string $address = 'localhost'): int","summary":"Runs PHP built-in web server.","params":[{"name":"$address","type":"string","default":"'localhost'","optional":true,"description":"Address to serve on. Either \"host\" or \"host:port\"."}],"return":{"type":"int"}},"isAddressTaken":{"signature":"protected function isAddressTaken(string $address): bool","params":[{"name":"$address","type":"string","description":"Server address"}],"return":{"type":"bool","description":"If address is already in use"},"visibility":"protected"},"optionAliases":{"signature":"public function optionAliases(): array","summary":"Returns option alias names.","return":{"type":"array","description":"The options alias names valid for the action where the keys is alias name for option and value is option name."},"since":"2.0.8"},"options":{"signature":"public function options(mixed $actionID): string[]","summary":"Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.","params":[{"name":"$actionID","type":"mixed","description":"The action id of the current request"}],"return":{"type":"string[]","description":"The names of the options valid for the action"}},"runCommand":{"signature":"protected function runCommand(mixed $command): mixed","params":[{"name":"$command","type":"mixed"}],"return":{"type":"mixed"},"visibility":"protected"}},"constants":{"EXIT_CODE_NO_DOCUMENT_ROOT":{"value":"2"},"EXIT_CODE_NO_ROUTING_FILE":{"value":"3"},"EXIT_CODE_ADDRESS_TAKEN_BY_ANOTHER_SERVER":{"value":"4"},"EXIT_CODE_ADDRESS_TAKEN_BY_ANOTHER_PROCESS":{"value":"5"}},"inherited":{"properties":{"action":"yii\\base\\Controller","behaviors":"yii\\base\\Component","color":"yii\\console\\Controller","defaultAction":"yii\\base\\Controller","help":"yii\\console\\Controller","helpSummary":"yii\\console\\Controller","id":"yii\\base\\Controller","interactive":"yii\\console\\Controller","layout":"yii\\base\\Controller","module":"yii\\base\\Controller","modules":"yii\\base\\Controller","passedOptions":"yii\\console\\Controller","passedOptionValues":"yii\\console\\Controller","request":"yii\\console\\Controller","response":"yii\\console\\Controller","route":"yii\\base\\Controller","silentExitOnException":"yii\\console\\Controller","uniqueId":"yii\\base\\Controller","view":"yii\\base\\Controller","viewPath":"yii\\base\\Controller"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\Controller","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","actions":"yii\\base\\Controller","afterAction":"yii\\base\\Controller","ansiFormat":"yii\\console\\Controller","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeAction":"yii\\console\\Controller","behaviors":"yii\\base\\Component","bindActionParams":"yii\\console\\Controller","bindInjectedParams":"yii\\base\\Controller","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","confirm":"yii\\console\\Controller","createAction":"yii\\base\\Controller","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","findLayoutFile":"yii\\base\\Controller","getActionArgsHelp":"yii\\console\\Controller","getActionHelp":"yii\\console\\Controller","getActionHelpSummary":"yii\\console\\Controller","getActionMethodReflection":"yii\\console\\Controller","getActionOptionsHelp":"yii\\console\\Controller","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getHelp":"yii\\console\\Controller","getHelpSummary":"yii\\console\\Controller","getModules":"yii\\base\\Controller","getOptionValues":"yii\\console\\Controller","getPassedOptions":"yii\\console\\Controller","getPassedOptionValues":"yii\\console\\Controller","getRoute":"yii\\base\\Controller","getUniqueId":"yii\\base\\Controller","getView":"yii\\base\\Controller","getViewPath":"yii\\base\\Controller","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\Controller","isColorEnabled":"yii\\console\\Controller","off":"yii\\base\\Component","on":"yii\\base\\Component","parseDocCommentDetail":"yii\\console\\Controller","parseDocCommentSummary":"yii\\console\\Controller","parseDocCommentTags":"yii\\console\\Controller","prompt":"yii\\console\\Controller","render":"yii\\base\\Controller","renderContent":"yii\\base\\Controller","renderFile":"yii\\base\\Controller","renderPartial":"yii\\base\\Controller","run":"yii\\base\\Controller","runAction":"yii\\console\\Controller","select":"yii\\console\\Controller","setView":"yii\\base\\Controller","setViewPath":"yii\\base\\Controller","stderr":"yii\\console\\Controller","stdout":"yii\\console\\Controller","trigger":"yii\\base\\Component"},"events":{"EVENT_BEFORE_ACTION":"yii\\base\\Controller","EVENT_AFTER_ACTION":"yii\\base\\Controller"}}},"yii\\console\\widgets\\Table":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/console/widgets/table/","summary":"Table class displays a table in console.","since":"2.0.13","extends":"yii\\base\\Widget","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"chars":{"type":"array","default":"[self::CHAR_TOP => '═', self::CHAR_TOP_MID => '╤', self::CHAR_TOP_LEFT => '╔', self::CHAR_TOP_RIGHT => '╗', self::CHAR_BOTTOM => '═', self::CHAR_BOTTOM_MID => '╧', self::CHAR_BOTTOM_LEFT => '╚', self::CHAR_BOTTOM_RIGHT => '╝', self::CHAR_LEFT => '║', self::CHAR_LEFT_MID => '╟', self::CHAR_MID => '─', self::CHAR_MID_MID => '┼', self::CHAR_RIGHT => '║', self::CHAR_RIGHT_MID => '╢', self::CHAR_MIDDLE => '│']","description":"Table chars","visibility":"protected","since":"2.0.19"},"columnWidths":{"type":"array","default":"[]","description":"Table column widths","visibility":"protected","since":"2.0.19"},"headers":{"type":"array","default":"[]","description":"Table headers","visibility":"protected","since":"2.0.19"},"listPrefix":{"type":"string","default":"'• '","description":"List prefix","visibility":"protected","since":"2.0.19"},"rows":{"type":"array","default":"[]","description":"Table rows","visibility":"protected","since":"2.0.19"},"screenWidth":{"type":"int","default":"null","description":"Screen width","visibility":"protected","since":"2.0.19"}},"methods":{"calculateRowHeight":{"signature":"protected function calculateRowHeight(array $row): int","summary":"Calculate the height of a row.","params":[{"name":"$row","type":"array"}],"return":{"type":"int","description":"Maximum row per cell"},"visibility":"protected"},"calculateRowsSize":{"signature":"protected function calculateRowsSize(): mixed","summary":"Calculate the size of rows to draw anchor of columns in console.","return":{"type":"mixed"},"visibility":"protected"},"getScreenWidth":{"signature":"protected function getScreenWidth(): int","summary":"Getting screen width.","return":{"type":"int","description":"Screen width"},"visibility":"protected"},"renderRow":{"signature":"protected function renderRow(array $row, string $spanLeft, string $spanMiddle, string $spanRight): string","summary":"Renders a row of data into a string.","params":[{"name":"$row","type":"array","description":"Row of data"},{"name":"$spanLeft","type":"string","description":"Character for left border"},{"name":"$spanMiddle","type":"string","description":"Character for middle border"},{"name":"$spanRight","type":"string","description":"Character for right border"}],"return":{"type":"string"},"visibility":"protected"},"renderSeparator":{"signature":"protected function renderSeparator(string $spanLeft, string $spanMid, string $spanMidMid, string $spanRight): string","summary":"Renders separator.","params":[{"name":"$spanLeft","type":"string","description":"Character for left border"},{"name":"$spanMid","type":"string","description":"Character for middle border"},{"name":"$spanMidMid","type":"string","description":"Character for middle-middle border"},{"name":"$spanRight","type":"string","description":"Character for right border"}],"return":{"type":"string","description":"The generated separator row"},"visibility":"protected"},"run":{"signature":"public function run(): string","return":{"type":"string","description":"The rendered table"}},"setChars":{"signature":"public function setChars(array $chars): $this","summary":"Set table chars.","params":[{"name":"$chars","type":"array","description":"Table chars"}],"return":{"type":"$this"}},"setHeaders":{"signature":"public function setHeaders(array $headers): $this","summary":"Set table headers.","params":[{"name":"$headers","type":"array","description":"Table headers"}],"return":{"type":"$this"}},"setListPrefix":{"signature":"public function setListPrefix(string $listPrefix): $this","summary":"Set list prefix.","params":[{"name":"$listPrefix","type":"string","description":"List prefix"}],"return":{"type":"$this"}},"setRows":{"signature":"public function setRows(array $rows): $this","summary":"Set table rows.","params":[{"name":"$rows","type":"array","description":"Table rows"}],"return":{"type":"$this"}},"setScreenWidth":{"signature":"public function setScreenWidth(int $width): $this","summary":"Set screen width.","params":[{"name":"$width","type":"int","description":"Screen width"}],"return":{"type":"$this"}}},"constants":{"DEFAULT_CONSOLE_SCREEN_WIDTH":{"value":"120"},"CONSOLE_SCROLLBAR_OFFSET":{"value":"3"},"CHAR_TOP":{"value":"'top'"},"CHAR_TOP_MID":{"value":"'top-mid'"},"CHAR_TOP_LEFT":{"value":"'top-left'"},"CHAR_TOP_RIGHT":{"value":"'top-right'"},"CHAR_BOTTOM":{"value":"'bottom'"},"CHAR_BOTTOM_MID":{"value":"'bottom-mid'"},"CHAR_BOTTOM_LEFT":{"value":"'bottom-left'"},"CHAR_BOTTOM_RIGHT":{"value":"'bottom-right'"},"CHAR_LEFT":{"value":"'left'"},"CHAR_LEFT_MID":{"value":"'left-mid'"},"CHAR_MID":{"value":"'mid'"},"CHAR_MID_MID":{"value":"'mid-mid'"},"CHAR_RIGHT":{"value":"'right'"},"CHAR_RIGHT_MID":{"value":"'right-mid'"},"CHAR_MIDDLE":{"value":"'middle'"}},"inherited":{"properties":{"autoIdPrefix":"yii\\base\\Widget","behaviors":"yii\\base\\Component","id":"yii\\base\\Widget","view":"yii\\base\\Widget","viewPath":"yii\\base\\Widget"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","afterRun":"yii\\base\\Widget","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeRun":"yii\\base\\Widget","begin":"yii\\base\\Widget","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","end":"yii\\base\\Widget","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getId":"yii\\base\\Widget","getView":"yii\\base\\Widget","getViewPath":"yii\\base\\Widget","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\Widget","off":"yii\\base\\Component","on":"yii\\base\\Component","render":"yii\\base\\Widget","renderFile":"yii\\base\\Widget","setId":"yii\\base\\Widget","setView":"yii\\base\\Widget","trigger":"yii\\base\\Component","widget":"yii\\base\\Widget"},"events":{"EVENT_INIT":"yii\\base\\Widget","EVENT_BEFORE_RUN":"yii\\base\\Widget","EVENT_AFTER_RUN":"yii\\base\\Widget"}}},"yii\\data\\ActiveDataFilter":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/data/activedatafilter/","summary":"ActiveDataFilter allows composing a filtering condition in a format suitable for `yii\\db\\QueryInterface::where()`.","since":"2.0.13","extends":"yii\\data\\DataFilter","implements":["yii\\base\\StaticInstanceInterface","IteratorAggregate","ArrayAccess","yii\\base\\Arrayable","yii\\base\\Configurable"],"traits":["yii\\base\\ArrayableTrait","yii\\base\\StaticInstanceTrait"],"properties":{"conditionBuilders":{"type":"array","default":"['AND' => 'buildConjunctionCondition', 'OR' => 'buildConjunctionCondition', 'NOT' => 'buildBlockCondition', '<' => 'buildOperatorCondition', '>' => 'buildOperatorCondition', '<=' => 'buildOperatorCondition', '>=' => 'buildOperatorCondition', '=' => 'buildOperatorCondition', '!=' => 'buildOperatorCondition', 'IN' => 'buildOperatorCondition', 'NOT IN' => 'buildOperatorCondition', 'LIKE' => 'buildOperatorCondition']","description":"Maps filtering condition keywords to build methods."},"queryOperatorMap":{"type":"array","default":"[]","description":"Map filtering operators to operators used in `yii\\db\\QueryInterface::where()`."}},"methods":{"buildAttributeCondition":{"signature":"protected function buildAttributeCondition(string $attribute, mixed $condition): array","summary":"Builds search condition for a particular attribute.","params":[{"name":"$attribute","type":"string","description":"Search attribute name."},{"name":"$condition","type":"mixed","description":"Search condition."}],"return":{"type":"array","description":"Actual condition."},"visibility":"protected"},"buildBlockCondition":{"signature":"protected function buildBlockCondition(string $operator, mixed $condition): array","summary":"Builds block condition, which consists of a single condition.","params":[{"name":"$operator","type":"string","description":"Operator keyword."},{"name":"$condition","type":"mixed","description":"Raw condition."}],"return":{"type":"array","description":"Actual condition."},"visibility":"protected"},"buildCondition":{"signature":"protected function buildCondition(array $condition): array","params":[{"name":"$condition","type":"array"}],"return":{"type":"array","description":"Built condition."},"visibility":"protected"},"buildConjunctionCondition":{"signature":"protected function buildConjunctionCondition(string $operator, mixed $condition): array","summary":"Builds conjunction condition, which consists of multiple independent ones.","params":[{"name":"$operator","type":"string","description":"Operator keyword."},{"name":"$condition","type":"mixed","description":"Raw condition."}],"return":{"type":"array","description":"Actual condition."},"visibility":"protected"},"buildInternal":{"signature":"protected function buildInternal(): mixed","summary":"Performs actual filter build.","return":{"type":"mixed","description":"Built actual filter value."},"visibility":"protected"},"buildOperatorCondition":{"signature":"protected function buildOperatorCondition(string $operator, mixed $condition, string $attribute): array","summary":"Builds an operator condition.","params":[{"name":"$operator","type":"string","description":"Operator keyword."},{"name":"$condition","type":"mixed","description":"Attribute condition."},{"name":"$attribute","type":"string","description":"Attribute name."}],"return":{"type":"array","description":"Actual condition."},"visibility":"protected"}},"inherited":{"properties":{"activeValidators":"yii\\base\\Model","attributeMap":"yii\\data\\DataFilter","attributes":"yii\\base\\Model","behaviors":"yii\\base\\Component","conditionValidators":"yii\\data\\DataFilter","errorMessages":"yii\\data\\DataFilter","errors":"yii\\base\\Model","filter":"yii\\data\\DataFilter","filterAttributeLabel":"yii\\data\\DataFilter","filterAttributeName":"yii\\data\\DataFilter","filterControls":"yii\\data\\DataFilter","firstErrors":"yii\\base\\Model","iterator":"yii\\base\\Model","multiValueOperators":"yii\\data\\DataFilter","nullValue":"yii\\data\\DataFilter","operatorTypes":"yii\\data\\DataFilter","scenario":"yii\\base\\Model","searchAttributeTypes":"yii\\data\\DataFilter","searchModel":"yii\\data\\DataFilter","validators":"yii\\base\\Model"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Model","__construct":"yii\\base\\BaseObject","__get":"yii\\data\\DataFilter","__isset":"yii\\data\\DataFilter","__set":"yii\\data\\DataFilter","__unset":"yii\\data\\DataFilter","activeAttributes":"yii\\base\\Model","addError":"yii\\base\\Model","addErrors":"yii\\base\\Model","afterValidate":"yii\\base\\Model","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","attributeHints":"yii\\base\\Model","attributeLabels":"yii\\data\\DataFilter","attributes":"yii\\data\\DataFilter","beforeValidate":"yii\\base\\Model","behaviors":"yii\\base\\Component","build":"yii\\data\\DataFilter","canGetProperty":"yii\\data\\DataFilter","canSetProperty":"yii\\data\\DataFilter","className":"yii\\base\\BaseObject","clearErrors":"yii\\base\\Model","createValidators":"yii\\base\\Model","defaultErrorMessages":"yii\\data\\DataFilter","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","detectSearchAttributeType":"yii\\data\\DataFilter","detectSearchAttributeTypes":"yii\\data\\DataFilter","ensureBehaviors":"yii\\base\\Component","extractFieldsFor":"yii\\base\\ArrayableTrait","extractRootFields":"yii\\base\\ArrayableTrait","extraFields":"yii\\base\\ArrayableTrait","fields":"yii\\base\\Model","filterAttributeValue":"yii\\data\\DataFilter","formName":"yii\\data\\DataFilter","generateAttributeLabel":"yii\\base\\Model","getActiveValidators":"yii\\base\\Model","getAttributeHint":"yii\\base\\Model","getAttributeLabel":"yii\\base\\Model","getAttributes":"yii\\base\\Model","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getErrorMessages":"yii\\data\\DataFilter","getErrors":"yii\\base\\Model","getErrorSummary":"yii\\base\\Model","getFilter":"yii\\data\\DataFilter","getFirstError":"yii\\base\\Model","getFirstErrors":"yii\\base\\Model","getIterator":"yii\\base\\Model","getScenario":"yii\\base\\Model","getSearchAttributeTypes":"yii\\data\\DataFilter","getSearchModel":"yii\\data\\DataFilter","getValidators":"yii\\base\\Model","hasErrors":"yii\\base\\Model","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","instance":"yii\\base\\StaticInstanceTrait","isAttributeActive":"yii\\base\\Model","isAttributeRequired":"yii\\base\\Model","isAttributeSafe":"yii\\base\\Model","load":"yii\\base\\Model","loadMultiple":"yii\\base\\Model","normalize":"yii\\data\\DataFilter","off":"yii\\base\\Component","offsetExists":"yii\\base\\Model","offsetGet":"yii\\base\\Model","offsetSet":"yii\\base\\Model","offsetUnset":"yii\\base\\Model","on":"yii\\base\\Component","onUnsafeAttribute":"yii\\base\\Model","parseErrorMessage":"yii\\data\\DataFilter","resolveFields":"yii\\base\\ArrayableTrait","rules":"yii\\data\\DataFilter","safeAttributes":"yii\\base\\Model","scenarios":"yii\\base\\Model","setAttributes":"yii\\base\\Model","setErrorMessages":"yii\\data\\DataFilter","setFilter":"yii\\data\\DataFilter","setScenario":"yii\\base\\Model","setSearchAttributeTypes":"yii\\data\\DataFilter","setSearchModel":"yii\\data\\DataFilter","toArray":"yii\\base\\ArrayableTrait","trigger":"yii\\base\\Component","validate":"yii\\base\\Model","validateAttributeCondition":"yii\\data\\DataFilter","validateAttributeValue":"yii\\data\\DataFilter","validateBlockCondition":"yii\\data\\DataFilter","validateCondition":"yii\\data\\DataFilter","validateConjunctionCondition":"yii\\data\\DataFilter","validateFilter":"yii\\data\\DataFilter","validateMultiple":"yii\\base\\Model","validateOperatorCondition":"yii\\data\\DataFilter"},"constants":{"TYPE_INTEGER":"yii\\data\\DataFilter","TYPE_FLOAT":"yii\\data\\DataFilter","TYPE_BOOLEAN":"yii\\data\\DataFilter","TYPE_STRING":"yii\\data\\DataFilter","TYPE_ARRAY":"yii\\data\\DataFilter","TYPE_DATETIME":"yii\\data\\DataFilter","TYPE_DATE":"yii\\data\\DataFilter","TYPE_TIME":"yii\\data\\DataFilter","SCENARIO_DEFAULT":"yii\\base\\Model"},"events":{"EVENT_BEFORE_VALIDATE":"yii\\base\\Model","EVENT_AFTER_VALIDATE":"yii\\base\\Model"}}},"yii\\data\\ActiveDataProvider":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/data/activedataprovider/","summary":"ActiveDataProvider implements a data provider based on `yii\\db\\Query` and `yii\\db\\ActiveQuery`.","since":"2.0","extends":"yii\\data\\BaseDataProvider","implements":["yii\\base\\Configurable","yii\\data\\DataProviderInterface"],"properties":{"db":{"type":"yii\\db\\Connection|array|string|null","default":"null","description":"The DB connection object or the application component ID of the DB connection."},"key":{"type":"string|callable|null","default":"null","description":"The column that is used as the key of the data models."},"query":{"type":"yii\\db\\QueryInterface|null","default":"null","description":"The query that is used to fetch data models and `$totalCount` if it is not explicitly set."}},"methods":{"__clone":{"signature":"public function __clone(): mixed","return":{"type":"mixed"}},"init":{"signature":"public function init(): mixed","summary":"Initializes the DB connection component.","return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$db` is invalid."}]},"prepareKeys":{"signature":"protected function prepareKeys(mixed $models): array","summary":"Prepares the keys associated with the currently available data models.","params":[{"name":"$models","type":"mixed","description":"The available data models"}],"return":{"type":"array","description":"The keys"},"visibility":"protected"},"prepareModels":{"signature":"protected function prepareModels(): array","summary":"Prepares the data models that will be made available in the current page.","return":{"type":"array","description":"The available data models"},"visibility":"protected"},"prepareTotalCount":{"signature":"protected function prepareTotalCount(): int","summary":"Returns a value indicating the total number of data models in this data provider.","return":{"type":"int","description":"Total number of data models in this data provider."},"visibility":"protected"},"setSort":{"signature":"public function setSort(mixed $value): mixed","summary":"Sets the sort definition for this data provider.","params":[{"name":"$value","type":"mixed","description":"The sort definition to be used by this data provider. This can be one of the following: - a configuration array for creating the sort definition object. The \"class\" element defaults to 'yii\\data\\Sort' - an instance of `yii\\data\\Sort` or its subclass - false, if sorting needs to be disabled."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException"}]}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","count":"yii\\data\\BaseDataProvider","id":"yii\\data\\BaseDataProvider","keys":"yii\\data\\BaseDataProvider","models":"yii\\data\\BaseDataProvider","pagination":"yii\\data\\BaseDataProvider","sort":"yii\\data\\BaseDataProvider","totalCount":"yii\\data\\BaseDataProvider"},"methods":{"__call":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getCount":"yii\\data\\BaseDataProvider","getKeys":"yii\\data\\BaseDataProvider","getModels":"yii\\data\\BaseDataProvider","getPagination":"yii\\data\\BaseDataProvider","getSort":"yii\\data\\BaseDataProvider","getTotalCount":"yii\\data\\BaseDataProvider","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","prepare":"yii\\data\\BaseDataProvider","refresh":"yii\\data\\BaseDataProvider","setKeys":"yii\\data\\BaseDataProvider","setModels":"yii\\data\\BaseDataProvider","setPagination":"yii\\data\\BaseDataProvider","setTotalCount":"yii\\data\\BaseDataProvider","trigger":"yii\\base\\Component"}}},"yii\\data\\ArrayDataProvider":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/data/arraydataprovider/","summary":"ArrayDataProvider implements a data provider based on a data array.","since":"2.0","extends":"yii\\data\\BaseDataProvider","implements":["yii\\base\\Configurable","yii\\data\\DataProviderInterface"],"properties":{"allModels":{"type":"array","default":"null","description":"The data that is not paginated or sorted."},"key":{"type":"string|array|callable|null","default":"null","description":"The column that is used as the key of the data models."},"modelClass":{"type":"string","default":"null","description":"The name of the Model (`yii\\base\\Model`) class that will be represented.","since":"2.0.9"}},"methods":{"prepareKeys":{"signature":"protected function prepareKeys(mixed $models): array","summary":"Prepares the keys associated with the currently available data models.","params":[{"name":"$models","type":"mixed","description":"The available data models"}],"return":{"type":"array","description":"The keys"},"visibility":"protected"},"prepareModels":{"signature":"protected function prepareModels(): array","summary":"Prepares the data models that will be made available in the current page.","return":{"type":"array","description":"The available data models"},"visibility":"protected"},"prepareTotalCount":{"signature":"protected function prepareTotalCount(): int","summary":"Returns a value indicating the total number of data models in this data provider.","return":{"type":"int","description":"Total number of data models in this data provider."},"visibility":"protected"},"sortModels":{"signature":"protected function sortModels(array $models, yii\\data\\Sort $sort): array","summary":"Sorts the data models according to the given sort definition.","params":[{"name":"$models","type":"array","description":"The models to be sorted"},{"name":"$sort","type":"yii\\data\\Sort","description":"The sort definition"}],"return":{"type":"array","description":"The sorted data models"},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","count":"yii\\data\\BaseDataProvider","id":"yii\\data\\BaseDataProvider","keys":"yii\\data\\BaseDataProvider","models":"yii\\data\\BaseDataProvider","pagination":"yii\\data\\BaseDataProvider","sort":"yii\\data\\BaseDataProvider","totalCount":"yii\\data\\BaseDataProvider"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getCount":"yii\\data\\BaseDataProvider","getKeys":"yii\\data\\BaseDataProvider","getModels":"yii\\data\\BaseDataProvider","getPagination":"yii\\data\\BaseDataProvider","getSort":"yii\\data\\BaseDataProvider","getTotalCount":"yii\\data\\BaseDataProvider","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\data\\BaseDataProvider","off":"yii\\base\\Component","on":"yii\\base\\Component","prepare":"yii\\data\\BaseDataProvider","refresh":"yii\\data\\BaseDataProvider","setKeys":"yii\\data\\BaseDataProvider","setModels":"yii\\data\\BaseDataProvider","setPagination":"yii\\data\\BaseDataProvider","setSort":"yii\\data\\BaseDataProvider","setTotalCount":"yii\\data\\BaseDataProvider","trigger":"yii\\base\\Component"}}},"yii\\data\\BaseDataProvider":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/data/basedataprovider/","summary":"BaseDataProvider provides a base class that implements the `yii\\data\\DataProviderInterface`.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\data\\DataProviderInterface","yii\\base\\Configurable"],"properties":{"count":{"type":"int","description":"The number of data models in the current page.","access":"read-only","virtual":true},"id":{"type":"string|null","default":"null","description":"An ID that uniquely identifies the data provider among all data providers."},"keys":{"type":"array","description":"The list of key values corresponding to `$models`.","virtual":true},"models":{"type":"array","description":"The list of data models in the current page.","virtual":true},"pagination":{"type":"array|yii\\data\\Pagination|false","description":"The pagination to be used by this data provider.","virtual":true},"sort":{"type":"array|yii\\data\\Sort|bool","description":"The sort definition to be used by this data provider.","virtual":true},"totalCount":{"type":"int","description":"Total number of possible data models.","virtual":true}},"methods":{"getCount":{"signature":"public function getCount(): int","summary":"Returns the number of data models in the current page.","return":{"type":"int","description":"The number of data models in the current page."}},"getKeys":{"signature":"public function getKeys(): array","summary":"Returns the key values associated with the data models.","return":{"type":"array","description":"The list of key values corresponding to `$models`. Each data model in `$models` is uniquely identified by the corresponding key value in this array."}},"getModels":{"signature":"public function getModels(): array","summary":"Returns the data models in the current page.","return":{"type":"array","description":"The list of data models in the current page."}},"getPagination":{"signature":"public function getPagination(): yii\\data\\Pagination|false","summary":"Returns the pagination object used by this data provider.","return":{"type":"yii\\data\\Pagination|false","description":"The pagination object. If this is false, it means the pagination is disabled."}},"getSort":{"signature":"public function getSort(): yii\\data\\Sort|bool","summary":"Returns the sorting object used by this data provider.","return":{"type":"yii\\data\\Sort|bool","description":"The sorting object. If this is false, it means the sorting is disabled."}},"getTotalCount":{"signature":"public function getTotalCount(): int","summary":"Returns the total number of data models.","return":{"type":"int","description":"Total number of possible data models."}},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"prepare":{"signature":"public function prepare(bool $forcePrepare = false): mixed","summary":"Prepares the data models and keys.","params":[{"name":"$forcePrepare","type":"bool","default":"false","optional":true,"description":"Whether to force data preparation even if it has been done before."}],"return":{"type":"mixed"}},"prepareKeys":{"signature":"abstract protected function prepareKeys(array $models): array","summary":"Prepares the keys associated with the currently available data models.","params":[{"name":"$models","type":"array","description":"The available data models"}],"return":{"type":"array","description":"The keys"},"visibility":"protected","abstract":true},"prepareModels":{"signature":"abstract protected function prepareModels(): array","summary":"Prepares the data models that will be made available in the current page.","return":{"type":"array","description":"The available data models"},"visibility":"protected","abstract":true},"prepareTotalCount":{"signature":"abstract protected function prepareTotalCount(): int","summary":"Returns a value indicating the total number of data models in this data provider.","return":{"type":"int","description":"Total number of data models in this data provider."},"visibility":"protected","abstract":true},"refresh":{"signature":"public function refresh(): mixed","summary":"Refreshes the data provider.","return":{"type":"mixed"}},"setKeys":{"signature":"public function setKeys(array $keys): mixed","summary":"Sets the key values associated with the data models.","params":[{"name":"$keys","type":"array","description":"The list of key values corresponding to `$models`."}],"return":{"type":"mixed"}},"setModels":{"signature":"public function setModels(array $models): mixed","summary":"Sets the data models in the current page.","params":[{"name":"$models","type":"array","description":"The models in the current page"}],"return":{"type":"mixed"}},"setPagination":{"signature":"public function setPagination(array|yii\\data\\Pagination|false $value): mixed","summary":"Sets the pagination for this data provider.","params":[{"name":"$value","type":"array|yii\\data\\Pagination|false","description":"The pagination to be used by this data provider. This can be one of the following: - a configuration array for creating the pagination object. The \"class\" element defaults to 'yii\\data\\Pagination' - an instance of `yii\\data\\Pagination` or its subclass - false, if pagination needs to be disabled."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException"}]},"setSort":{"signature":"public function setSort(array|yii\\data\\Sort|bool $value): mixed","summary":"Sets the sort definition for this data provider.","params":[{"name":"$value","type":"array|yii\\data\\Sort|bool","description":"The sort definition to be used by this data provider. This can be one of the following: - a configuration array for creating the sort definition object. The \"class\" element defaults to 'yii\\data\\Sort' - an instance of `yii\\data\\Sort` or its subclass - false, if sorting needs to be disabled."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException"}]},"setTotalCount":{"signature":"public function setTotalCount(int $value): mixed","summary":"Sets the total number of data models.","params":[{"name":"$value","type":"int","description":"The total number of data models."}],"return":{"type":"mixed"}}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\data\\DataFilter":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/data/datafilter/","summary":"DataFilter is a special `yii\\base\\Model` for processing query filtering specification.","since":"2.0.13","extends":"yii\\base\\Model","implements":["yii\\base\\StaticInstanceInterface","IteratorAggregate","ArrayAccess","yii\\base\\Arrayable","yii\\base\\Configurable"],"traits":["yii\\base\\ArrayableTrait","yii\\base\\StaticInstanceTrait"],"properties":{"attributeMap":{"type":"array","default":"[]","description":"Actual attribute names to be used in searched condition, in format: [filterAttribute => actualAttribute]."},"conditionValidators":{"type":"array","default":"['AND' => 'validateConjunctionCondition', 'OR' => 'validateConjunctionCondition', 'NOT' => 'validateBlockCondition', '<' => 'validateOperatorCondition', '>' => 'validateOperatorCondition', '<=' => 'validateOperatorCondition', '>=' => 'validateOperatorCondition', '=' => 'validateOperatorCondition', '!=' => 'validateOperatorCondition', 'IN' => 'validateOperatorCondition', 'NOT IN' => 'validateOperatorCondition', 'LIKE' => 'validateOperatorCondition']","description":"Maps filter condition keywords to validation methods."},"errorMessages":{"type":"array|Closure","description":"Error messages in `[errorKey => message]` format, or a PHP callback returning them.","virtual":true},"filter":{"type":"mixed","description":"Raw filter value.","virtual":true},"filterAttributeLabel":{"type":"string","default":"null","description":"Label for the filter attribute specified via `$filterAttributeName`."},"filterAttributeName":{"type":"string","default":"'filter'","description":"Name of the attribute that handles filter value."},"filterControls":{"type":"array","default":"['and' => 'AND', 'or' => 'OR', 'not' => 'NOT', 'lt' => '<', 'gt' => '>', 'lte' => '<=', 'gte' => '>=', 'eq' => '=', 'neq' => '!=', 'in' => 'IN', 'nin' => 'NOT IN', 'like' => 'LIKE']","description":"Keywords or expressions that could be used in a filter."},"multiValueOperators":{"type":"array","default":"['IN', 'NOT IN']","description":"List of operators keywords, which should accept multiple values."},"nullValue":{"type":"string","default":"'NULL'","description":"Representation of `null` instead of literal `null` in case the latter cannot be used.","since":"2.0.40"},"operatorTypes":{"type":"array","default":"['<' => [self::TYPE_INTEGER, self::TYPE_FLOAT, self::TYPE_DATETIME, self::TYPE_DATE, self::TYPE_TIME], '>' => [self::TYPE_INTEGER, self::TYPE_FLOAT, self::TYPE_DATETIME, self::TYPE_DATE, self::TYPE_TIME], '<=' => [self::TYPE_INTEGER, self::TYPE_FLOAT, self::TYPE_DATETIME, self::TYPE_DATE, self::TYPE_TIME], '>=' => [self::TYPE_INTEGER, self::TYPE_FLOAT, self::TYPE_DATETIME, self::TYPE_DATE, self::TYPE_TIME], '=' => '*', '!=' => '*', 'IN' => '*', 'NOT IN' => '*', 'LIKE' => [self::TYPE_STRING]]","description":"Specifies the list of supported search attribute types per each operator."},"searchAttributeTypes":{"type":"array|null","description":"Search attribute type map.","virtual":true},"searchModel":{"type":"yii\\base\\Model|array|string|callable","description":"Model instance or its DI compatible configuration.","virtual":true}},"methods":{"__get":{"signature":"public function __get(mixed $name): mixed","summary":"Returns the value of a component property.","params":[{"name":"$name","type":"mixed","description":"The property name"}],"return":{"type":"mixed","description":"The property value or the value of a behavior's property"},"throws":[{"type":"yii\\base\\UnknownPropertyException","description":"if the property is not defined"},{"type":"yii\\base\\InvalidCallException","description":"if the property is write-only."}]},"__isset":{"signature":"public function __isset(mixed $name): bool","summary":"Checks if a property is set, i.e. defined and not null.","params":[{"name":"$name","type":"mixed","description":"The property name or the event name"}],"return":{"type":"bool","description":"Whether the named property is set"}},"__set":{"signature":"public function __set(mixed $name, mixed $value): mixed","summary":"Sets the value of a component property.","params":[{"name":"$name","type":"mixed","description":"The property name or the event name"},{"name":"$value","type":"mixed","description":"The property value"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\UnknownPropertyException","description":"if the property is not defined"},{"type":"yii\\base\\InvalidCallException","description":"if the property is read-only."}]},"__unset":{"signature":"public function __unset(mixed $name): mixed","summary":"Sets a component property to be null.","params":[{"name":"$name","type":"mixed","description":"The property name"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if the property is read only."}]},"attributeLabels":{"signature":"public function attributeLabels(): array","summary":"Returns the attribute labels.","return":{"type":"array","description":"Attribute labels (name => label)"}},"attributes":{"signature":"public function attributes(): string[]","summary":"Returns the list of attribute names.","return":{"type":"string[]","description":"List of attribute names."}},"build":{"signature":"public function build(bool $runValidation = true): mixed|false","summary":"Builds actual filter specification form `$filter` value.","params":[{"name":"$runValidation","type":"bool","default":"true","optional":true,"description":"Whether to perform validation (calling `validate()`) before building the filter. Defaults to `true`. If the validation fails, no filter will be built and this method will return `false`."}],"return":{"type":"mixed|false","description":"Built actual filter value, or `false` if validation fails."}},"buildInternal":{"signature":"protected function buildInternal(): mixed","summary":"Performs actual filter build.","return":{"type":"mixed","description":"Built actual filter value."},"visibility":"protected"},"canGetProperty":{"signature":"public function canGetProperty(mixed $name, mixed $checkVars = true, mixed $checkBehaviors = true): bool","summary":"Returns a value indicating whether a property can be read.","params":[{"name":"$name","type":"mixed","description":"The property name"},{"name":"$checkVars","type":"mixed","default":"true","optional":true,"description":"Whether to treat member variables as properties"},{"name":"$checkBehaviors","type":"mixed","default":"true","optional":true,"description":"Whether to treat behaviors' properties as properties of this component"}],"return":{"type":"bool","description":"Whether the property can be read"}},"canSetProperty":{"signature":"public function canSetProperty(mixed $name, mixed $checkVars = true, mixed $checkBehaviors = true): bool","summary":"Returns a value indicating whether a property can be set.","params":[{"name":"$name","type":"mixed","description":"The property name"},{"name":"$checkVars","type":"mixed","default":"true","optional":true,"description":"Whether to treat member variables as properties"},{"name":"$checkBehaviors","type":"mixed","default":"true","optional":true,"description":"Whether to treat behaviors' properties as properties of this component"}],"return":{"type":"bool","description":"Whether the property can be written"}},"defaultErrorMessages":{"signature":"protected function defaultErrorMessages(): array","summary":"Returns default values for `$errorMessages`.","return":{"type":"array","description":"Default error messages in `[errorKey => message]` format."},"visibility":"protected"},"detectSearchAttributeType":{"signature":"protected function detectSearchAttributeType(yii\\validators\\Validator $validator): string|null","summary":"Detect attribute type from given validator.","params":[{"name":"$validator","type":"yii\\validators\\Validator","description":"Validator from which to detect attribute type."}],"return":{"type":"string|null","description":"Detected attribute type."},"visibility":"protected","since":"2.0.14"},"detectSearchAttributeTypes":{"signature":"protected function detectSearchAttributeTypes(): array","summary":"Composes default value for `$searchAttributeTypes` from the `$searchModel` validation rules.","return":{"type":"array","description":"Attribute type map."},"visibility":"protected"},"filterAttributeValue":{"signature":"protected function filterAttributeValue(string $attribute, mixed $value): mixed","summary":"Validates attribute value in the scope of `$searchModel`, applying attribute value filters if any.","params":[{"name":"$attribute","type":"string","description":"Attribute name."},{"name":"$value","type":"mixed","description":"Attribute value."}],"return":{"type":"mixed","description":"Filtered attribute value."},"visibility":"protected"},"formName":{"signature":"public function formName(): string","summary":"Returns the form name that this model class should use.","return":{"type":"string","description":"The form name of this model class."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"when form is defined with anonymous class and `formName()` method is not overridden."}]},"getErrorMessages":{"signature":"public function getErrorMessages(): array","return":{"type":"array","description":"Error messages in format `[errorKey => message]`."}},"getFilter":{"signature":"public function getFilter(): mixed","return":{"type":"mixed","description":"Raw filter value."}},"getSearchAttributeTypes":{"signature":"public function getSearchAttributeTypes(): array","return":{"type":"array","description":"Search attribute type map."}},"getSearchModel":{"signature":"public function getSearchModel(): yii\\base\\Model","return":{"type":"yii\\base\\Model","description":"Model instance."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"on invalid configuration."}]},"normalize":{"signature":"public function normalize(bool $runValidation = true): array|bool","summary":"Normalizes filter value, replacing raw keys according to `$filterControls` and `$attributeMap`.","params":[{"name":"$runValidation","type":"bool","default":"true","optional":true,"description":"Whether to perform validation (calling `validate()`) before normalizing the filter. Defaults to `true`. If the validation fails, no filter will be processed and this method will return `false`."}],"return":{"type":"array|bool","description":"Normalized filter value, or `false` if validation fails."}},"parseErrorMessage":{"signature":"protected function parseErrorMessage(string $messageKey, array $params = []): string","summary":"Parses content of the message from `$errorMessages`, specified by message key.","params":[{"name":"$messageKey","type":"string","description":"Message key."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"Params to be parsed into the message."}],"return":{"type":"string","description":"Composed message string."},"visibility":"protected"},"rules":{"signature":"public function rules(): array|yii\\validators\\Validator>","summary":"Returns the validation rules for attributes.","return":{"type":"array|yii\\validators\\Validator>","description":"Validation rules"}},"setErrorMessages":{"signature":"public function setErrorMessages(array|Closure $errorMessages): mixed","summary":"Sets the list of error messages responding to invalid filter structure, in format: `[errorKey => message]`.","params":[{"name":"$errorMessages","type":"array|Closure","description":"Error messages in `[errorKey => message]` format, or a PHP callback returning them."}],"return":{"type":"mixed"}},"setFilter":{"signature":"public function setFilter(mixed $filter): mixed","params":[{"name":"$filter","type":"mixed","description":"Raw filter value."}],"return":{"type":"mixed"}},"setSearchAttributeTypes":{"signature":"public function setSearchAttributeTypes(array|null $searchAttributeTypes): mixed","params":[{"name":"$searchAttributeTypes","type":"array|null","description":"Search attribute type map."}],"return":{"type":"mixed"}},"setSearchModel":{"signature":"public function setSearchModel(yii\\base\\Model|array|string|callable $model): mixed","params":[{"name":"$model","type":"yii\\base\\Model|array|string|callable","description":"Model instance or its DI compatible configuration."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"on invalid configuration."}]},"validateAttributeCondition":{"signature":"protected function validateAttributeCondition(string $attribute, mixed $condition): mixed","summary":"Validates search condition for a particular attribute.","params":[{"name":"$attribute","type":"string","description":"Search attribute name."},{"name":"$condition","type":"mixed","description":"Search condition."}],"return":{"type":"mixed"},"visibility":"protected"},"validateAttributeValue":{"signature":"protected function validateAttributeValue(string $attribute, mixed $value): mixed","summary":"Validates attribute value in the scope of `yii\\base\\Model`.","params":[{"name":"$attribute","type":"string","description":"Attribute name."},{"name":"$value","type":"mixed","description":"Attribute value."}],"return":{"type":"mixed"},"visibility":"protected"},"validateBlockCondition":{"signature":"protected function validateBlockCondition(string $operator, mixed $condition): mixed","summary":"Validates block condition that consists of a single condition.","params":[{"name":"$operator","type":"string","description":"Raw operator control keyword."},{"name":"$condition","type":"mixed","description":"Raw condition."}],"return":{"type":"mixed"},"visibility":"protected"},"validateCondition":{"signature":"protected function validateCondition(mixed $condition): mixed","summary":"Validates filter condition.","params":[{"name":"$condition","type":"mixed","description":"Raw filter condition."}],"return":{"type":"mixed"},"visibility":"protected"},"validateConjunctionCondition":{"signature":"protected function validateConjunctionCondition(string $operator, mixed $condition): mixed","summary":"Validates conjunction condition that consists of multiple independent ones.","params":[{"name":"$operator","type":"string","description":"Raw operator control keyword."},{"name":"$condition","type":"mixed","description":"Raw condition."}],"return":{"type":"mixed"},"visibility":"protected"},"validateFilter":{"signature":"public function validateFilter(): mixed","summary":"Validates filter attribute value to match filer condition specification.","return":{"type":"mixed"}},"validateOperatorCondition":{"signature":"protected function validateOperatorCondition(string $operator, mixed $condition, string|null $attribute = null): mixed","summary":"Validates operator condition.","params":[{"name":"$operator","type":"string","description":"Raw operator control keyword."},{"name":"$condition","type":"mixed","description":"Attribute condition."},{"name":"$attribute","type":"string|null","default":"null","optional":true,"description":"Attribute name."}],"return":{"type":"mixed"},"visibility":"protected"}},"constants":{"TYPE_INTEGER":{"value":"'integer'"},"TYPE_FLOAT":{"value":"'float'"},"TYPE_BOOLEAN":{"value":"'boolean'"},"TYPE_STRING":{"value":"'string'"},"TYPE_ARRAY":{"value":"'array'"},"TYPE_DATETIME":{"value":"'datetime'"},"TYPE_DATE":{"value":"'date'"},"TYPE_TIME":{"value":"'time'"}},"inherited":{"properties":{"activeValidators":"yii\\base\\Model","attributes":"yii\\base\\Model","behaviors":"yii\\base\\Component","errors":"yii\\base\\Model","firstErrors":"yii\\base\\Model","iterator":"yii\\base\\Model","scenario":"yii\\base\\Model","validators":"yii\\base\\Model"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Model","__construct":"yii\\base\\BaseObject","activeAttributes":"yii\\base\\Model","addError":"yii\\base\\Model","addErrors":"yii\\base\\Model","afterValidate":"yii\\base\\Model","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","attributeHints":"yii\\base\\Model","beforeValidate":"yii\\base\\Model","behaviors":"yii\\base\\Component","className":"yii\\base\\BaseObject","clearErrors":"yii\\base\\Model","createValidators":"yii\\base\\Model","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","extractFieldsFor":"yii\\base\\ArrayableTrait","extractRootFields":"yii\\base\\ArrayableTrait","extraFields":"yii\\base\\ArrayableTrait","fields":"yii\\base\\Model","generateAttributeLabel":"yii\\base\\Model","getActiveValidators":"yii\\base\\Model","getAttributeHint":"yii\\base\\Model","getAttributeLabel":"yii\\base\\Model","getAttributes":"yii\\base\\Model","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getErrors":"yii\\base\\Model","getErrorSummary":"yii\\base\\Model","getFirstError":"yii\\base\\Model","getFirstErrors":"yii\\base\\Model","getIterator":"yii\\base\\Model","getScenario":"yii\\base\\Model","getValidators":"yii\\base\\Model","hasErrors":"yii\\base\\Model","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","instance":"yii\\base\\StaticInstanceTrait","isAttributeActive":"yii\\base\\Model","isAttributeRequired":"yii\\base\\Model","isAttributeSafe":"yii\\base\\Model","load":"yii\\base\\Model","loadMultiple":"yii\\base\\Model","off":"yii\\base\\Component","offsetExists":"yii\\base\\Model","offsetGet":"yii\\base\\Model","offsetSet":"yii\\base\\Model","offsetUnset":"yii\\base\\Model","on":"yii\\base\\Component","onUnsafeAttribute":"yii\\base\\Model","resolveFields":"yii\\base\\ArrayableTrait","safeAttributes":"yii\\base\\Model","scenarios":"yii\\base\\Model","setAttributes":"yii\\base\\Model","setScenario":"yii\\base\\Model","toArray":"yii\\base\\ArrayableTrait","trigger":"yii\\base\\Component","validate":"yii\\base\\Model","validateMultiple":"yii\\base\\Model"},"constants":{"SCENARIO_DEFAULT":"yii\\base\\Model"},"events":{"EVENT_BEFORE_VALIDATE":"yii\\base\\Model","EVENT_AFTER_VALIDATE":"yii\\base\\Model"}}},"yii\\data\\DataProviderInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/data/dataproviderinterface/","summary":"DataProviderInterface is the interface that must be implemented by data provider classes.","since":"2.0","methods":{"getCount":{"signature":"abstract public function getCount(): int","summary":"Returns the number of data models in the current page.","return":{"type":"int","description":"The number of data models in the current page."},"abstract":true},"getKeys":{"signature":"abstract public function getKeys(): array","summary":"Returns the key values associated with the data models.","return":{"type":"array","description":"The list of key values corresponding to models (`getModels()`). Each data model in models (`getModels()`) is uniquely identified by the corresponding key value in this array."},"abstract":true},"getModels":{"signature":"abstract public function getModels(): array","summary":"Returns the data models in the current page.","return":{"type":"array","description":"The list of data models in the current page."},"abstract":true},"getPagination":{"signature":"abstract public function getPagination(): yii\\data\\Pagination|false","return":{"type":"yii\\data\\Pagination|false","description":"The pagination object. If this is false, it means the pagination is disabled."},"abstract":true},"getSort":{"signature":"abstract public function getSort(): yii\\data\\Sort|false","return":{"type":"yii\\data\\Sort|false","description":"The sorting object. If this is false, it means the sorting is disabled."},"abstract":true},"getTotalCount":{"signature":"abstract public function getTotalCount(): int","summary":"Returns the total number of data models.","return":{"type":"int","description":"Total number of possible data models."},"abstract":true},"prepare":{"signature":"abstract public function prepare(bool $forcePrepare = false): mixed","summary":"Prepares the data models and keys.","params":[{"name":"$forcePrepare","type":"bool","default":"false","optional":true,"description":"Whether to force data preparation even if it has been done before."}],"return":{"type":"mixed"},"abstract":true}}},"yii\\data\\Pagination":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/data/pagination/","summary":"Pagination represents information relevant to pagination of data items.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\web\\Linkable","yii\\base\\Configurable"],"properties":{"defaultPageSize":{"type":"int","default":"20","description":"The default page size."},"forcePageParam":{"type":"bool","default":"true","description":"Whether to always have the page parameter in the URL created by `createUrl()`."},"limit":{"type":"int","description":"The limit of the data.","access":"read-only","virtual":true},"links":{"type":"array","description":"The links for navigational purpose.","access":"read-only","virtual":true},"offset":{"type":"int","description":"The offset of the data.","access":"read-only","virtual":true},"page":{"type":"int","description":"The zero-based current page number.","virtual":true},"pageCount":{"type":"int","description":"Number of pages.","access":"read-only","virtual":true},"pageParam":{"type":"string","default":"'page'","description":"Name of the parameter storing the current page index."},"pageSize":{"type":"int","description":"The number of items per page.","virtual":true},"pageSizeLimit":{"type":"array|false","default":"[1, 50]","description":"The page size limits."},"pageSizeParam":{"type":"string","default":"'per-page'","description":"Name of the parameter storing the page size."},"params":{"type":"array|null","default":"null","description":"Parameters (name => value) that should be used to obtain the current page number and to create new pagination URLs."},"route":{"type":"string|null","default":"null","description":"The route of the controller action for displaying the paged contents."},"totalCount":{"type":"int","default":"0","description":"Total number of items."},"urlManager":{"type":"yii\\web\\UrlManager|null","default":"null","description":"The URL manager used for creating pagination URLs."},"validatePage":{"type":"bool","default":"true","description":"Whether to check if `$page` is within valid range."}},"methods":{"createUrl":{"signature":"public function createUrl(int $page, int|null $pageSize = null, bool $absolute = false): string","summary":"Creates the URL suitable for pagination with the specified page number.","params":[{"name":"$page","type":"int","description":"The zero-based page number that the URL should point to."},{"name":"$pageSize","type":"int|null","default":"null","optional":true,"description":"The number of items on each page. If not set, the value of `$pageSize` will be used."},{"name":"$absolute","type":"bool","default":"false","optional":true,"description":"Whether to create an absolute URL. Defaults to `false`."}],"return":{"type":"string","description":"The created URL"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `resolveRoute()` cannot determine a route."}]},"getLimit":{"signature":"public function getLimit(): int","return":{"type":"int","description":"The limit of the data. This may be used to set the LIMIT value for a SQL statement for fetching the current page of data. Note that if the page size is infinite, a value -1 will be returned."}},"getLinks":{"signature":"public function getLinks(bool $absolute = false): array","summary":"Returns a whole set of links for navigating to the first, last, next and previous pages.","params":[{"name":"$absolute","type":"bool","default":"false","optional":true,"description":"Whether the generated URLs should be absolute."}],"return":{"type":"array","description":"The links for navigational purpose. The array keys specify the purpose of the links (e.g. `LINK_FIRST`), and the array values are the corresponding URLs."}},"getOffset":{"signature":"public function getOffset(): int","return":{"type":"int","description":"The offset of the data. This may be used to set the OFFSET value for a SQL statement for fetching the current page of data."}},"getPage":{"signature":"public function getPage(bool $recalculate = false): int","summary":"Returns the zero-based current page number.","params":[{"name":"$recalculate","type":"bool","default":"false","optional":true,"description":"Whether to recalculate the current page based on the page size and item count."}],"return":{"type":"int","description":"The zero-based current page number."}},"getPageCount":{"signature":"public function getPageCount(): int","return":{"type":"int","description":"Number of pages"}},"getPageSize":{"signature":"public function getPageSize(): int","summary":"Returns the number of items per page.","return":{"type":"int","description":"The number of items per page. If it is less than 1, it means the page size is infinite, and thus a single page contains all items."}},"getQueryParam":{"signature":"protected function getQueryParam(string $name, string|null $defaultValue = null): string|null","summary":"Returns the value of the specified query parameter.","params":[{"name":"$name","type":"string","description":"The parameter name"},{"name":"$defaultValue","type":"string|null","default":"null","optional":true,"description":"The value to be returned when the specified parameter does not exist in `$params`."}],"return":{"type":"string|null","description":"The parameter value"},"visibility":"protected"},"resolveRoute":{"signature":"protected function resolveRoute(): string","summary":"Resolves the target route from `$route`, the active controller, or `yii\\base\\Application::$requestedRoute`.","return":{"type":"string","description":"The resolved route."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if no route can be resolved."}],"visibility":"protected"},"setPage":{"signature":"public function setPage(int $value, bool $validatePage = false): mixed","summary":"Sets the current page number.","params":[{"name":"$value","type":"int","description":"The zero-based index of the current page."},{"name":"$validatePage","type":"bool","default":"false","optional":true,"description":"Whether to validate the page number. Note that in order to validate the page number, both `$validatePage` and this parameter must be true."}],"return":{"type":"mixed"}},"setPageSize":{"signature":"public function setPageSize(int $value, bool $validatePageSize = false): mixed","params":[{"name":"$value","type":"int","description":"The number of items per page."},{"name":"$validatePageSize","type":"bool","default":"false","optional":true,"description":"Whether to validate page size."}],"return":{"type":"mixed"}}},"constants":{"LINK_NEXT":{"value":"'next'"},"LINK_PREV":{"value":"'prev'"},"LINK_FIRST":{"value":"'first'"},"LINK_LAST":{"value":"'last'"}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\data\\Sort":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/data/sort/","summary":"Sort represents information relevant to sorting.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"attributeOrders":{"type":"array|null","description":"Sort directions indexed by attribute names.","virtual":true},"attributes":{"type":"array","default":"[]","description":"List of attributes that are allowed to be sorted."},"defaultOrder":{"type":"array|null","default":"null","description":"The order that should be used when the current request does not specify any order."},"enableMultiSort":{"type":"bool","default":"false","description":"Whether the sorting can be applied to multiple attributes simultaneously."},"modelClass":{"type":"string|null","default":"null","description":"The name of the `yii\\base\\Model`-based class used by the `link()` method to retrieve attributes' labels.","since":"2.0.49"},"orders":{"type":"array","description":"The columns (keys) and their corresponding sort directions (values).","access":"read-only","virtual":true},"params":{"type":"array|null","default":"null","description":"Parameters (name => value) that should be used to obtain the current sort directions and to create new sort URLs."},"route":{"type":"string|null","default":"null","description":"The route of the controller action for displaying the sorted contents."},"separator":{"type":"string","default":"','","description":"The character used to separate different attributes that need to be sorted by."},"sortFlags":{"type":"int","default":"SORT_REGULAR","description":"Allow to control a value of the fourth parameter which will be passed to `ArrayHelper::multisort()`","since":"2.0.33"},"sortParam":{"type":"string","default":"'sort'","description":"The name of the parameter that specifies which attributes to be sorted in which direction."},"urlManager":{"type":"yii\\web\\UrlManager|null","default":"null","description":"The URL manager used for creating sort URLs."}},"methods":{"createSortParam":{"signature":"public function createSortParam(string $attribute): string","summary":"Creates the sort variable for the specified attribute.","params":[{"name":"$attribute","type":"string","description":"The attribute name"}],"return":{"type":"string","description":"The value of the sort variable"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the specified attribute is not defined in `$attributes`"}]},"createUrl":{"signature":"public function createUrl(string $attribute, bool $absolute = false): string","summary":"Creates a URL for sorting the data by the specified attribute.","params":[{"name":"$attribute","type":"string","description":"The attribute name"},{"name":"$absolute","type":"bool","default":"false","optional":true,"description":"Whether to create an absolute URL. Defaults to `false`."}],"return":{"type":"string","description":"The URL for sorting. False if the attribute is invalid."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the attribute is unknown, or if `resolveRoute()` cannot determine a route."}]},"getAttributeOrder":{"signature":"public function getAttributeOrder(string $attribute): int|null","summary":"Returns the sort direction of the specified attribute in the current request.","params":[{"name":"$attribute","type":"string","description":"The attribute name"}],"return":{"type":"int|null","description":"Sort direction of the attribute. Can be either `SORT_ASC` for ascending order or `SORT_DESC` for descending order. Null is returned if the attribute is invalid or does not need to be sorted."}},"getAttributeOrders":{"signature":"public function getAttributeOrders(bool $recalculate = false): array","summary":"Returns the currently requested sort information.","params":[{"name":"$recalculate","type":"bool","default":"false","optional":true,"description":"Whether to recalculate the sort directions"}],"return":{"type":"array","description":"Sort directions indexed by attribute names. Sort direction can be either `SORT_ASC` for ascending order or `SORT_DESC` for descending order."}},"getOrders":{"signature":"public function getOrders(bool $recalculate = false): array","summary":"Returns the columns and their corresponding sort directions.","params":[{"name":"$recalculate","type":"bool","default":"false","optional":true,"description":"Whether to recalculate the sort directions"}],"return":{"type":"array","description":"The columns (keys) and their corresponding sort directions (values). This can be passed to `yii\\db\\Query::orderBy()` to construct a DB query."}},"hasAttribute":{"signature":"public function hasAttribute(string $name): bool","summary":"Returns a value indicating whether the sort definition supports sorting by the named attribute.","params":[{"name":"$name","type":"string","description":"The attribute name"}],"return":{"type":"bool","description":"Whether the sort definition supports sorting by the named attribute."}},"init":{"signature":"public function init(): mixed","summary":"Normalizes the `$attributes` property.","return":{"type":"mixed"}},"link":{"signature":"public function link(string $attribute, array $options = []): string","summary":"Generates a hyperlink that links to the sort action to sort by the specified attribute.","params":[{"name":"$attribute","type":"string","description":"The attribute name by which the data should be sorted by."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"Additional HTML attributes for the hyperlink tag. There is one special attribute `label` which will be used as the label of the hyperlink. If this is not set, the label defined in `$attributes` will be used. If no label is defined, it will be retrieved from the instance of `$modelClass` (if `$modelClass` is not null) or generated from attribute name using `yii\\helpers\\Inflector::camel2words()`. Note that it will not be HTML-encoded."}],"return":{"type":"string","description":"The generated hyperlink"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the attribute is unknown"}]},"parseSortParam":{"signature":"protected function parseSortParam(mixed $param): array","summary":"Parses the value of `$sortParam` into an array of sort attributes.","params":[{"name":"$param","type":"mixed","description":"The value of the `$sortParam`."}],"return":{"type":"array","description":"The valid sort attributes."},"visibility":"protected","since":"2.0.12"},"resolveRoute":{"signature":"protected function resolveRoute(): string","summary":"Resolves the target route from `$route`, the active controller, or `yii\\base\\Application::$requestedRoute`.","return":{"type":"string","description":"The resolved route."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if no route can be resolved."}],"visibility":"protected"},"setAttributeOrders":{"signature":"public function setAttributeOrders(array|null $attributeOrders, bool $validate = true): mixed","summary":"Sets up the currently sort information.","params":[{"name":"$attributeOrders","type":"array|null","description":"Sort directions indexed by attribute names. Sort direction can be either `SORT_ASC` for ascending order or `SORT_DESC` for descending order."},{"name":"$validate","type":"bool","default":"true","optional":true,"description":"Whether to validate given attribute orders against `$attributes` and `$enableMultiSort`. If validation is enabled incorrect entries will be removed."}],"return":{"type":"mixed"},"since":"2.0.10"}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject"}}},"yii\\data\\SqlDataProvider":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/data/sqldataprovider/","summary":"SqlDataProvider implements a data provider based on a plain SQL statement.","since":"2.0","extends":"yii\\data\\BaseDataProvider","implements":["yii\\data\\DataProviderInterface","yii\\base\\Configurable"],"properties":{"db":{"type":"yii\\db\\Connection|array|string","default":"'db'","description":"The DB connection object or the application component ID of the DB connection."},"key":{"type":"string|callable|null","default":"null","description":"The column that is used as the key of the data models."},"params":{"type":"array","default":"[]","description":"Parameters (name=>value) to be bound to the SQL statement."},"sql":{"type":"string","default":"null","description":"The SQL statement to be used for fetching data rows."}},"methods":{"init":{"signature":"public function init(): mixed","summary":"Initializes the DB connection component.","return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$db` is invalid."}]},"prepareKeys":{"signature":"protected function prepareKeys(mixed $models): array","summary":"Prepares the keys associated with the currently available data models.","params":[{"name":"$models","type":"mixed","description":"The available data models"}],"return":{"type":"array","description":"The keys"},"visibility":"protected"},"prepareModels":{"signature":"protected function prepareModels(): array","summary":"Prepares the data models that will be made available in the current page.","return":{"type":"array","description":"The available data models"},"visibility":"protected"},"prepareTotalCount":{"signature":"protected function prepareTotalCount(): int","summary":"Returns a value indicating the total number of data models in this data provider.","return":{"type":"int","description":"Total number of data models in this data provider."},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","count":"yii\\data\\BaseDataProvider","id":"yii\\data\\BaseDataProvider","keys":"yii\\data\\BaseDataProvider","models":"yii\\data\\BaseDataProvider","pagination":"yii\\data\\BaseDataProvider","sort":"yii\\data\\BaseDataProvider","totalCount":"yii\\data\\BaseDataProvider"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getCount":"yii\\data\\BaseDataProvider","getKeys":"yii\\data\\BaseDataProvider","getModels":"yii\\data\\BaseDataProvider","getPagination":"yii\\data\\BaseDataProvider","getSort":"yii\\data\\BaseDataProvider","getTotalCount":"yii\\data\\BaseDataProvider","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","prepare":"yii\\data\\BaseDataProvider","refresh":"yii\\data\\BaseDataProvider","setKeys":"yii\\data\\BaseDataProvider","setModels":"yii\\data\\BaseDataProvider","setPagination":"yii\\data\\BaseDataProvider","setSort":"yii\\data\\BaseDataProvider","setTotalCount":"yii\\data\\BaseDataProvider","trigger":"yii\\base\\Component"}}},"yii\\db\\ActiveQuery":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/activequery/","summary":"ActiveQuery represents a DB query associated with an Active Record class.","since":"2.0","extends":"yii\\db\\Query","implements":["yii\\db\\ActiveQueryInterface","yii\\base\\Configurable","yii\\db\\QueryInterface","yii\\db\\ExpressionInterface"],"traits":["yii\\db\\ActiveQueryTrait","yii\\db\\ActiveRelationTrait","yii\\db\\QueryTrait"],"properties":{"joinWith":{"type":"array|null","default":"null","description":"A list of relations that this query should be joined with"},"on":{"type":"string|array|null","default":"null","description":"The join condition to be used when this query is used in a relational context."},"sql":{"type":"string|null","default":"null","description":"The SQL statement to be executed for retrieving AR records."}},"methods":{"__construct":{"signature":"public function __construct(class-string $modelClass, array $config = [])","summary":"Constructor.","params":[{"name":"$modelClass","type":"class-string","description":"The model class associated with this query"},{"name":"$config","type":"array","default":"[]","optional":true,"description":"Configurations to be applied to the newly created query object"}]},"alias":{"signature":"public function alias(string $alias): $this","summary":"Define an alias for the table defined in `$modelClass`.","params":[{"name":"$alias","type":"string","description":"The table alias."}],"return":{"type":"$this","description":"The query object itself"},"since":"2.0.7"},"all":{"signature":"public function all(yii\\db\\Connection|null $db = null): yii\\db\\T[]","summary":"Executes query and returns all results as an array.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The DB connection used to create the DB command. If null, the DB connection returned by `$modelClass` will be used."}],"return":{"type":"yii\\db\\T[]","description":"The query results. If the query results in nothing, an empty array will be returned."}},"andOnCondition":{"signature":"public function andOnCondition(string|array $condition, array $params = []): $this","summary":"Adds an additional ON condition to the existing one.","params":[{"name":"$condition","type":"string|array","description":"The new ON condition. Please refer to `where()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"$this","description":"The query object itself"}},"asArray":{"signature":"public function asArray(mixed $value): ($value is true ? (yii\\db\\T is array ? static : static>) : static)","summary":"Sets the `asArray()` property.","params":[{"name":"$value","type":"mixed"}],"return":{"type":"($value is true ? (yii\\db\\T is array ? static : static>) : static)"},"virtual":true},"batch":{"signature":"public function batch(mixed $batchSize, mixed $db): yii\\db\\BatchQueryResult","summary":"The batch query result.","params":[{"name":"$batchSize","type":"mixed"},{"name":"$db","type":"mixed"}],"return":{"type":"yii\\db\\BatchQueryResult"},"virtual":true},"createCommand":{"signature":"public function createCommand(yii\\db\\Connection|null $db = null): yii\\db\\Command","summary":"Creates a DB command that can be used to execute this query.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The DB connection used to create the DB command. If `null`, the DB connection returned by `$modelClass` will be used."}],"return":{"type":"yii\\db\\Command","description":"The created DB command instance."}},"each":{"signature":"public function each(mixed $batchSize, mixed $db): yii\\db\\BatchQueryResult","summary":"The batch query result.","params":[{"name":"$batchSize","type":"mixed"},{"name":"$db","type":"mixed"}],"return":{"type":"yii\\db\\BatchQueryResult"},"virtual":true},"getPrimaryTableName":{"signature":"protected function getPrimaryTableName(): string","return":{"type":"string","description":"Primary table name"},"visibility":"protected","since":"2.0.12"},"getTableNameAndAlias":{"signature":"protected function getTableNameAndAlias(): array","summary":"Returns the table name and the table alias for `$modelClass`.","return":{"type":"array","description":"The table name and the table alias."},"visibility":"protected","since":"2.0.16"},"getTablesUsedInFrom":{"signature":"public function getTablesUsedInFrom(): string[]","summary":"Returns table names used in `from()` indexed by aliases.","return":{"type":"string[]","description":"Table names indexed by aliases"},"throws":[{"type":"yii\\base\\InvalidConfigException"}],"since":"2.0.12"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"innerJoinWith":{"signature":"public function innerJoinWith(string|array $with, bool|array $eagerLoading = true): $this","summary":"Inner joins with the specified relations.","params":[{"name":"$with","type":"string|array","description":"The relations to be joined with."},{"name":"$eagerLoading","type":"bool|array","default":"true","optional":true,"description":"Whether to eager load the relations. Note, that this does not mean, that the relations are populated from the query result. An extra query will still be performed to bring in the related data."}],"return":{"type":"$this","description":"The query object itself"}},"joinWith":{"signature":"public function joinWith(string|array $with, bool|array $eagerLoading = true, string|array $joinType = 'LEFT JOIN'): $this","summary":"Joins with the specified relations.","params":[{"name":"$with","type":"string|array","description":"The relations to be joined. This can either be a string, representing a relation name or an array with the following semantics: - Each array element represents a single relation. - You may specify the relation name as the array key and provide an anonymous functions that can be used to modify the relation queries on-the-fly as the array value. - If a relation query does not need modification, you may use the relation name as the array value. The relation name may optionally contain an alias for the relation table (e.g. `books b`). Sub-relations can also be specified, see `with()` for the syntax. In the following you find some examples: ``` // find all orders that contain books, and eager loading \"books\" Order::find()->joinWith('books', true, 'INNER JOIN')->all(); // find all orders, eager loading \"books\", and sort the orders and books by the book names. Order::find()->joinWith([ 'books' => function (\\yii\\db\\ActiveQuery $query) { $query->orderBy('item.name'); } ])->all(); // find all orders that contain books of the category 'Science fiction', using the alias \"b\" for the books table Order::find()->joinWith(['books b'], true, 'INNER JOIN')->where(['b.category' => 'Science fiction'])->all(); ``` The alias syntax is available since version 2.0.7."},{"name":"$eagerLoading","type":"bool|array","default":"true","optional":true,"description":"Whether to eager load the relations specified in `$with`. When this is a boolean, it applies to all relations specified in `$with`. Use an array to explicitly list which relations in `$with` need to be eagerly loaded. Note, that this does not mean, that the relations are populated from the query result. An extra query will still be performed to bring in the related data. Defaults to `true`."},{"name":"$joinType","type":"string|array","default":"'LEFT JOIN'","optional":true,"description":"The join type of the relations specified in `$with`. When this is a string, it applies to all relations specified in `$with`. Use an array in the format of `relationName => joinType` to specify different join types for different relations."}],"return":{"type":"$this","description":"The query object itself"}},"onCondition":{"signature":"public function onCondition(string|array $condition, array $params = []): $this","summary":"Sets the ON condition for a relational query.","params":[{"name":"$condition","type":"string|array","description":"The ON condition. Please refer to `yii\\db\\Query::where()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"$this","description":"The query object itself"}},"one":{"signature":"public function one(yii\\db\\Connection|null $db = null): yii\\db\\T|null","summary":"Executes query and returns a single row of result.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The DB connection used to create the DB command. If `null`, the DB connection returned by `$modelClass` will be used."}],"return":{"type":"yii\\db\\T|null","description":"A single row of query result. Depending on the setting of `asArray()`, the query result may be either an array or an ActiveRecord object. `null` will be returned if the query results in nothing."}},"orOnCondition":{"signature":"public function orOnCondition(string|array $condition, array $params = []): $this","summary":"Adds an additional ON condition to the existing one.","params":[{"name":"$condition","type":"string|array","description":"The new ON condition. Please refer to `where()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"$this","description":"The query object itself"}},"populate":{"signature":"public function populate(mixed $rows, mixed $db = null): array","summary":"Converts the raw query results into the format as specified by this query.","params":[{"name":"$rows","type":"mixed","description":"The raw query result from database."},{"name":"$db","type":"mixed","default":"null","optional":true,"description":"The database connection used to retrieve the rows."}],"return":{"type":"array","description":"The converted query result."}},"prepare":{"signature":"public function prepare(mixed $builder): self","summary":"Prepares for building SQL.","params":[{"name":"$builder","type":"mixed"}],"return":{"type":"self","description":"A prepared query instance which will be used by `yii\\db\\QueryBuilder` to build the SQL"}},"queryScalar":{"signature":"protected function queryScalar(mixed $selectExpression, mixed $db): bool|string|null","summary":"Queries a scalar value by setting `select()` first.","params":[{"name":"$selectExpression","type":"mixed"},{"name":"$db","type":"mixed","description":"The database connection used to execute the query."}],"return":{"type":"bool|string|null"},"throws":[{"type":"Throwable","description":"if can't create command"}],"visibility":"protected"},"viaTable":{"signature":"public function viaTable(string $tableName, array $link, callable|null $callable = null): $this","summary":"Specifies the junction table for a relational query.","params":[{"name":"$tableName","type":"string","description":"The name of the junction table."},{"name":"$link","type":"array","description":"The link between the junction table and the table associated with `$primaryModel`. The keys of the array represent the columns in the junction table, and the values represent the columns in the `$primaryModel` table."},{"name":"$callable","type":"callable|null","default":"null","optional":true,"description":"A PHP callback for customizing the relation associated with the junction table. Its signature should be `function($query)`, where `$query` is the query to be customized."}],"return":{"type":"$this","description":"The query object itself"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"when query is not initialized properly"}]}},"events":{"EVENT_INIT":{"value":"'init'","type":"yii\\db\\Event","description":"An event that is triggered when the query is initialized via `init()`."}},"inherited":{"properties":{"asArray":"yii\\db\\ActiveQueryTrait","behaviors":"yii\\base\\Component","distinct":"yii\\db\\Query","emulateExecution":"yii\\db\\QueryTrait","from":"yii\\db\\Query","groupBy":"yii\\db\\Query","having":"yii\\db\\Query","indexBy":"yii\\db\\QueryTrait","inverseOf":"yii\\db\\ActiveRelationTrait","join":"yii\\db\\Query","limit":"yii\\db\\QueryTrait","link":"yii\\db\\ActiveRelationTrait","modelClass":"yii\\db\\ActiveQueryTrait","multiple":"yii\\db\\ActiveRelationTrait","offset":"yii\\db\\QueryTrait","orderBy":"yii\\db\\QueryTrait","params":"yii\\db\\Query","primaryModel":"yii\\db\\ActiveRelationTrait","queryCacheDependency":"yii\\db\\Query","queryCacheDuration":"yii\\db\\Query","select":"yii\\db\\Query","selectOption":"yii\\db\\Query","tablesUsedInFrom":"yii\\db\\Query","union":"yii\\db\\Query","unionLimit":"yii\\db\\Query","unionOffset":"yii\\db\\Query","unionOrderBy":"yii\\db\\Query","via":"yii\\db\\ActiveRelationTrait","where":"yii\\db\\QueryTrait","with":"yii\\db\\ActiveQueryTrait","withQueries":"yii\\db\\Query"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__toString":"yii\\db\\Query","__unset":"yii\\base\\Component","addGroupBy":"yii\\db\\Query","addOrderBy":"yii\\db\\QueryTrait","addParams":"yii\\db\\Query","addSelect":"yii\\db\\Query","addUnionOrderBy":"yii\\db\\Query","andFilterCompare":"yii\\db\\Query","andFilterHaving":"yii\\db\\Query","andFilterWhere":"yii\\db\\QueryTrait","andHaving":"yii\\db\\Query","andWhere":"yii\\db\\Query","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","average":"yii\\db\\Query","behaviors":"yii\\base\\Component","cache":"yii\\db\\Query","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","cleanUpTableNames":"yii\\db\\Query","column":"yii\\db\\Query","count":"yii\\db\\Query","create":"yii\\db\\Query","createModels":"yii\\db\\ActiveQueryTrait","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","distinct":"yii\\db\\Query","emulateExecution":"yii\\db\\QueryTrait","ensureBehaviors":"yii\\base\\Component","exists":"yii\\db\\Query","filterCondition":"yii\\db\\QueryTrait","filterHaving":"yii\\db\\Query","filterWhere":"yii\\db\\QueryTrait","findFor":"yii\\db\\ActiveRelationTrait","findWith":"yii\\db\\ActiveQueryTrait","from":"yii\\db\\Query","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","groupBy":"yii\\db\\Query","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","having":"yii\\db\\Query","indexBy":"yii\\db\\QueryTrait","innerJoin":"yii\\db\\Query","inverseOf":"yii\\db\\ActiveRelationTrait","isEmpty":"yii\\db\\QueryTrait","join":"yii\\db\\Query","leftJoin":"yii\\db\\Query","limit":"yii\\db\\QueryTrait","max":"yii\\db\\Query","min":"yii\\db\\Query","noCache":"yii\\db\\Query","normalizeOrderBy":"yii\\db\\QueryTrait","normalizeSelect":"yii\\db\\Query","off":"yii\\base\\Component","offset":"yii\\db\\QueryTrait","on":"yii\\base\\Component","orderBy":"yii\\db\\QueryTrait","orFilterHaving":"yii\\db\\Query","orFilterWhere":"yii\\db\\QueryTrait","orHaving":"yii\\db\\Query","orWhere":"yii\\db\\Query","params":"yii\\db\\Query","populateRelation":"yii\\db\\ActiveRelationTrait","rightJoin":"yii\\db\\Query","scalar":"yii\\db\\Query","select":"yii\\db\\Query","setCommandCache":"yii\\db\\Query","sum":"yii\\db\\Query","trigger":"yii\\base\\Component","union":"yii\\db\\Query","unionLimit":"yii\\db\\Query","unionOffset":"yii\\db\\Query","unionOrderBy":"yii\\db\\Query","via":"yii\\db\\ActiveRelationTrait","where":"yii\\db\\Query","with":"yii\\db\\ActiveQueryTrait","withQuery":"yii\\db\\Query"}}},"yii\\db\\ActiveQueryInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/db/activequeryinterface/","summary":"ActiveQueryInterface defines the common interface to be implemented by active record query classes.","since":"2.0","implements":["yii\\db\\QueryInterface"],"methods":{"asArray":{"signature":"abstract public function asArray(bool $value = true): $this","summary":"Sets the `asArray()` property.","params":[{"name":"$value","type":"bool","default":"true","optional":true,"description":"Whether to return the query results in terms of arrays instead of Active Records."}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"findFor":{"signature":"abstract public function findFor(string $name, yii\\db\\ActiveRecordInterface $model): mixed","summary":"Finds the related records for the specified primary record.","params":[{"name":"$name","type":"string","description":"The relation name"},{"name":"$model","type":"yii\\db\\ActiveRecordInterface","description":"The primary model"}],"return":{"type":"mixed","description":"The related record(s)"},"abstract":true},"indexBy":{"signature":"abstract public function indexBy(string|callable $column): $this","summary":"Sets the `indexBy()` property.","params":[{"name":"$column","type":"string|callable","description":"The name of the column by which the query results should be indexed by. This can also be a callable (e.g. anonymous function) that returns the index value based on the given row or model data. The signature of the callable should be: ``` // $model is an AR instance when `asArray` is false, // or an array of column values when `asArray` is true. function ($model) { // return the index value corresponding to $model } ```"}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"one":{"signature":"abstract public function one(yii\\db\\Connection|null $db = null): yii\\db\\ActiveRecordInterface|array|null","summary":"Executes query and returns a single row of result.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The DB connection used to create the DB command. If `null`, the DB connection returned by modelClass (`yii\\db\\ActiveQueryTrait::$modelClass`) will be used."}],"return":{"type":"yii\\db\\ActiveRecordInterface|array|null","description":"A single row of query result. Depending on the setting of `asArray()`, the query result may be either an array or an ActiveRecord object. `null` will be returned if the query results in nothing."},"abstract":true},"via":{"signature":"abstract public function via(string $relationName, callable|null $callable = null): $this","summary":"Specifies the relation associated with the junction table for use in relational query.","params":[{"name":"$relationName","type":"string","description":"The relation name. This refers to a relation declared in the primaryModel (`yii\\db\\ActiveRelationTrait::$primaryModel`) of the relation."},{"name":"$callable","type":"callable|null","default":"null","optional":true,"description":"A PHP callback for customizing the relation associated with the junction table. Its signature should be `function($query)`, where `$query` is the query to be customized."}],"return":{"type":"$this","description":"The relation object itself."},"abstract":true},"with":{"signature":"abstract public function with(): $this","summary":"Specifies the relations with which this query should be performed.","return":{"type":"$this","description":"The query object itself"},"abstract":true}},"inherited":{"methods":{"addOrderBy":"yii\\db\\QueryInterface","all":"yii\\db\\QueryInterface","andFilterWhere":"yii\\db\\QueryInterface","andWhere":"yii\\db\\QueryInterface","count":"yii\\db\\QueryInterface","emulateExecution":"yii\\db\\QueryInterface","exists":"yii\\db\\QueryInterface","filterWhere":"yii\\db\\QueryInterface","limit":"yii\\db\\QueryInterface","offset":"yii\\db\\QueryInterface","orderBy":"yii\\db\\QueryInterface","orFilterWhere":"yii\\db\\QueryInterface","orWhere":"yii\\db\\QueryInterface","where":"yii\\db\\QueryInterface"}}},"yii\\db\\ActiveQueryTrait":{"kind":"trait","url":"https://yii2-framework.github.io/docs/api/yii/db/activequerytrait/","summary":"ActiveQueryTrait implements the common methods and properties for active record query classes.","since":"2.0","properties":{"asArray":{"type":"bool","default":"null","description":"Whether to return each record as an array."},"modelClass":{"type":"class-string","default":"null","description":"The name of the ActiveRecord class."},"with":{"type":"array|null","default":"null","description":"A list of relations that this query should be performed with"}},"methods":{"asArray":{"signature":"public function asArray(bool $value = true): $this","summary":"Sets the `asArray()` property.","params":[{"name":"$value","type":"bool","default":"true","optional":true,"description":"Whether to return the query results in terms of arrays instead of Active Records."}],"return":{"type":"$this","description":"The query object itself"}},"createModels":{"signature":"protected function createModels(array $rows, yii\\db\\Connection|null $db = null): array|yii\\db\\BaseActiveRecord[]","summary":"Converts found rows into model instances.","params":[{"name":"$rows","type":"array","description":"The rows to be converted into model instances. Each array element represents a row of data."},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to retrieve the rows."}],"return":{"type":"array|yii\\db\\BaseActiveRecord[]","description":"The model instances created from the rows. If `asArray()` is true, the rows will be returned as is."},"visibility":"protected","since":"2.0.11"},"findWith":{"signature":"public function findWith(array $with, array &$models): mixed","summary":"Finds records corresponding to one or multiple relations and populates them into the primary models.","params":[{"name":"$with","type":"array","description":"A list of relations that this query should be performed with. Please refer to `with()` for details about specifying this parameter."},{"name":"$models","type":"array","byReference":true,"description":"The primary models (can be either AR instances or arrays)"}],"return":{"type":"mixed"}},"with":{"signature":"public function with(): $this","summary":"Specifies the relations with which this query should be performed.","return":{"type":"$this","description":"The query object itself"}}}},"yii\\db\\ActiveRecord":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/activerecord/","summary":"ActiveRecord is the base class for classes representing relational data in terms of objects.","since":"2.0","extends":"yii\\db\\BaseActiveRecord","implements":["yii\\base\\StaticInstanceInterface","IteratorAggregate","ArrayAccess","yii\\base\\Arrayable","yii\\base\\Configurable","yii\\db\\ActiveRecordInterface"],"traits":["yii\\base\\ArrayableTrait","yii\\base\\StaticInstanceTrait"],"methods":{"attributes":{"signature":"public function attributes(): array","summary":"Returns the list of all attribute names of the model.","return":{"type":"array","description":"List of attribute names."}},"delete":{"signature":"public function delete(): int|false","summary":"Deletes the table row corresponding to this active record.","return":{"type":"int|false","description":"The number of rows deleted, or `false` if the deletion is unsuccessful for some reason. Note that it is possible the number of rows deleted is 0, even though the deletion execution is successful."},"throws":[{"type":"yii\\db\\StaleObjectException","description":"if optimistic locking (`optimisticLock()`) is enabled and the data being deleted is outdated."},{"type":"Throwable","description":"in case delete failed."}]},"deleteAll":{"signature":"public static function deleteAll(string|array|null $condition = null, array $params = []): int","summary":"Deletes rows in the table using the provided conditions.","params":[{"name":"$condition","type":"string|array|null","default":"null","optional":true,"description":"The conditions that will be put in the WHERE part of the DELETE SQL. Please refer to `yii\\db\\Query::where()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"int","description":"The number of rows deleted"},"static":true},"deleteInternal":{"signature":"protected function deleteInternal(): int|false","summary":"Deletes an ActiveRecord without considering transaction.","return":{"type":"int|false","description":"The number of rows deleted, or `false` if the deletion is unsuccessful for some reason. Note that it is possible the number of rows deleted is 0, even though the deletion execution is successful."},"throws":[{"type":"yii\\db\\StaleObjectException"}],"visibility":"protected"},"equals":{"signature":"public function equals(yii\\db\\ActiveRecord $record): bool","summary":"Returns a value indicating whether the given active record is the same as the current one.","params":[{"name":"$record","type":"yii\\db\\ActiveRecord","description":"Record to compare to"}],"return":{"type":"bool","description":"Whether the two active records refer to the same row in the same database table."}},"find":{"signature":"public static function find(): yii\\db\\ActiveQuery","summary":"Creates an `yii\\db\\ActiveQueryInterface` instance for query purpose.","return":{"type":"yii\\db\\ActiveQuery","description":"The newly created `yii\\db\\ActiveQuery` instance."},"static":true},"findBySql":{"signature":"public static function findBySql(string $sql, array $params = []): yii\\db\\ActiveQuery","summary":"Creates an `yii\\db\\ActiveQuery` instance with a given SQL statement.","params":[{"name":"$sql","type":"string","description":"The SQL statement to be executed"},{"name":"$params","type":"array","default":"[]","optional":true,"description":"Parameters to be bound to the SQL statement during execution."}],"return":{"type":"yii\\db\\ActiveQuery","description":"The newly created `yii\\db\\ActiveQuery` instance"},"static":true},"getDb":{"signature":"public static function getDb(): yii\\db\\Connection","summary":"Returns the database connection used by this AR class.","return":{"type":"yii\\db\\Connection","description":"The database connection used by this AR class."},"static":true},"getTableSchema":{"signature":"public static function getTableSchema(yii\\db\\Connection|null $db = null): yii\\db\\TableSchema","summary":"Returns the schema information of the DB table associated with this AR class.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to retrieve the schema. If `null`, the connection returned by `getDb()` will be used."}],"return":{"type":"yii\\db\\TableSchema","description":"The schema information of the DB table associated with this AR class."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the table for the AR class does not exist."}],"static":true},"hasMany":{"signature":"public function hasMany(class-string $class, mixed $link): yii\\db\\ActiveQuery","summary":"Declares a `has-many` relation.","params":[{"name":"$class","type":"class-string","description":"The class name of the related record."},{"name":"$link","type":"mixed","description":"The primary-foreign key constraint. The keys of the array refer to the attributes of the record associated with the `$class` model, while the values of the array refer to the corresponding attributes in **this** AR class."}],"return":{"type":"yii\\db\\ActiveQuery","description":"The relational query object."}},"hasOne":{"signature":"public function hasOne(class-string $class, mixed $link): yii\\db\\ActiveQuery","summary":"Declares a `has-one` relation.","params":[{"name":"$class","type":"class-string","description":"The class name of the related record."},{"name":"$link","type":"mixed","description":"The primary-foreign key constraint. The keys of the array refer to the attributes of the record associated with the `$class` model, while the values of the array refer to the corresponding attributes in **this** AR class."}],"return":{"type":"yii\\db\\ActiveQuery","description":"The relational query object."}},"insert":{"signature":"public function insert(bool $runValidation = true, array|null $attributes = null): bool","summary":"Inserts a row into the associated database table using the attribute values of this record.","params":[{"name":"$runValidation","type":"bool","default":"true","optional":true,"description":"Whether to perform validation (calling `validate()`) before saving the record. Defaults to `true`. If the validation fails, the record will not be saved to the database and this method will return `false`."},{"name":"$attributes","type":"array|null","default":"null","optional":true,"description":"List of attributes that need to be saved. Defaults to `null`, meaning all attributes that are loaded from DB will be saved."}],"return":{"type":"bool","description":"Whether the attributes are valid and the record is inserted successfully."},"throws":[{"type":"Throwable","description":"in case insert failed."}]},"insertInternal":{"signature":"protected function insertInternal(array|null $attributes = null): bool","summary":"Inserts an ActiveRecord into DB without considering transaction.","params":[{"name":"$attributes","type":"array|null","default":"null","optional":true,"description":"List of attributes that need to be saved. Defaults to `null`, meaning all attributes that are loaded from DB will be saved."}],"return":{"type":"bool","description":"Whether the record is inserted successfully."},"visibility":"protected"},"isTransactional":{"signature":"public function isTransactional(int $operation): bool","summary":"Returns a value indicating whether the specified operation is transactional in the current `$scenario`.","params":[{"name":"$operation","type":"int","description":"The operation to check. Possible values are `OP_INSERT`, `OP_UPDATE` and `OP_DELETE`."}],"return":{"type":"bool","description":"Whether the specified operation is transactional in the current `$scenario`."}},"loadDefaultValues":{"signature":"public function loadDefaultValues(bool $skipIfSet = true): $this","summary":"Loads default values from database table schema.","params":[{"name":"$skipIfSet","type":"bool","default":"true","optional":true,"description":"Whether existing value should be preserved. This will only set defaults for attributes that are `null`."}],"return":{"type":"$this","description":"The model instance itself."}},"populateRecord":{"signature":"public static function populateRecord(mixed $record, mixed $row, yii\\db\\Connection|null $db = null): mixed","summary":"Populates an active record object using a row of data from the database/storage.","params":[{"name":"$record","type":"mixed","description":"The record to be populated. In most cases this will be an instance created by `instantiate()` beforehand."},{"name":"$row","type":"mixed","description":"Attribute values (name => value)"},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to retrieve the row and its schema."}],"return":{"type":"mixed"},"static":true},"primaryKey":{"signature":"public static function primaryKey(): string[]","summary":"Returns the primary key name(s) for this AR class.","return":{"type":"string[]","description":"The primary keys of the associated database table."},"static":true},"refresh":{"signature":"public function refresh(): bool","summary":"Repopulates this active record with the latest data.","return":{"type":"bool","description":"Whether the row still exists in the database. If `true`, the latest data will be populated to this active record. Otherwise, this record will remain unchanged."}},"tableName":{"signature":"public static function tableName(): string","summary":"Declares the name of the database table associated with this AR class.","return":{"type":"string","description":"The table name"},"static":true},"transactions":{"signature":"public function transactions(): array","summary":"Declares which DB operations should be performed within a transaction in different scenarios.","return":{"type":"array","description":"The declarations of transactional operations. The array keys are scenarios names, and the array values are the corresponding transaction operations."}},"update":{"signature":"public function update(bool $runValidation = true, array|null $attributeNames = null): int|false","summary":"Saves the changes to this active record into the associated database table.","params":[{"name":"$runValidation","type":"bool","default":"true","optional":true,"description":"Whether to perform validation (calling `validate()`) before saving the record. Defaults to `true`. If the validation fails, the record will not be saved to the database and this method will return `false`."},{"name":"$attributeNames","type":"array|null","default":"null","optional":true,"description":"List of attributes that need to be saved. Defaults to `null`, meaning all attributes that are loaded from DB will be saved."}],"return":{"type":"int|false","description":"The number of rows affected, or false if validation fails or `beforeSave()` stops the updating process."},"throws":[{"type":"yii\\db\\StaleObjectException","description":"if optimistic locking (`optimisticLock()`) is enabled and the data being updated is outdated."},{"type":"Throwable","description":"in case update failed."}]},"updateAll":{"signature":"public static function updateAll(array $attributes, string|array $condition = '', array $params = []): int","summary":"Updates the whole table using the provided attribute values and conditions.","params":[{"name":"$attributes","type":"array","description":"Attribute values (name-value pairs) to be saved into the table"},{"name":"$condition","type":"string|array","default":"''","optional":true,"description":"The conditions that will be put in the WHERE part of the UPDATE SQL. Please refer to `yii\\db\\Query::where()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"int","description":"The number of rows updated"},"static":true},"updateAllCounters":{"signature":"public static function updateAllCounters(array $counters, string|array $condition = '', array $params = []): int","summary":"Updates the whole table using the provided counter changes and conditions.","params":[{"name":"$counters","type":"array","description":"The counters to be updated (attribute name => increment value). Use negative values if you want to decrement the counters."},{"name":"$condition","type":"string|array","default":"''","optional":true,"description":"The conditions that will be put in the WHERE part of the UPDATE SQL. Please refer to `yii\\db\\Query::where()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query. Do not name the parameters as `:bp0`, `:bp1`, etc., because they are used internally by this method."}],"return":{"type":"int","description":"The number of rows updated"},"static":true}},"constants":{"OP_INSERT":{"value":"0x1","description":"The insert operation. This is mainly used when overriding `transactions()` to specify which operations are transactional."},"OP_UPDATE":{"value":"0x2","description":"The update operation. This is mainly used when overriding `transactions()` to specify which operations are transactional."},"OP_DELETE":{"value":"0x4","description":"The delete operation. This is mainly used when overriding `transactions()` to specify which operations are transactional."},"OP_ALL":{"value":"0x7","description":"All three operations: insert, update, delete."}},"inherited":{"properties":{"activeValidators":"yii\\base\\Model","attributes":"yii\\base\\Model","behaviors":"yii\\base\\Component","dirtyAttributes":"yii\\db\\BaseActiveRecord","errors":"yii\\base\\Model","firstErrors":"yii\\base\\Model","isNewRecord":"yii\\db\\BaseActiveRecord","iterator":"yii\\base\\Model","oldAttributes":"yii\\db\\BaseActiveRecord","oldPrimaryKey":"yii\\db\\BaseActiveRecord","primaryKey":"yii\\db\\BaseActiveRecord","relatedRecords":"yii\\db\\BaseActiveRecord","scenario":"yii\\base\\Model","validators":"yii\\base\\Model"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Model","__construct":"yii\\base\\BaseObject","__get":"yii\\db\\BaseActiveRecord","__isset":"yii\\db\\BaseActiveRecord","__set":"yii\\db\\BaseActiveRecord","__unset":"yii\\db\\BaseActiveRecord","activeAttributes":"yii\\base\\Model","addError":"yii\\base\\Model","addErrors":"yii\\base\\Model","afterDelete":"yii\\db\\BaseActiveRecord","afterFind":"yii\\db\\BaseActiveRecord","afterRefresh":"yii\\db\\BaseActiveRecord","afterSave":"yii\\db\\BaseActiveRecord","afterValidate":"yii\\base\\Model","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","attributeHints":"yii\\base\\Model","attributeLabels":"yii\\base\\Model","beforeDelete":"yii\\db\\BaseActiveRecord","beforeSave":"yii\\db\\BaseActiveRecord","beforeValidate":"yii\\base\\Model","behaviors":"yii\\base\\Component","canGetProperty":"yii\\db\\BaseActiveRecord","canSetOldAttribute":"yii\\db\\BaseActiveRecord","canSetProperty":"yii\\db\\BaseActiveRecord","className":"yii\\base\\BaseObject","clearErrors":"yii\\base\\Model","createRelationQuery":"yii\\db\\BaseActiveRecord","createValidators":"yii\\base\\Model","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","extractFieldsFor":"yii\\base\\ArrayableTrait","extractRootFields":"yii\\base\\ArrayableTrait","extraFields":"yii\\db\\BaseActiveRecord","fields":"yii\\db\\BaseActiveRecord","findAll":"yii\\db\\BaseActiveRecord","findOne":"yii\\db\\BaseActiveRecord","formName":"yii\\base\\Model","generateAttributeLabel":"yii\\base\\Model","getActiveValidators":"yii\\base\\Model","getAttribute":"yii\\db\\BaseActiveRecord","getAttributeHint":"yii\\db\\BaseActiveRecord","getAttributeLabel":"yii\\db\\BaseActiveRecord","getAttributes":"yii\\base\\Model","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getDirtyAttributes":"yii\\db\\BaseActiveRecord","getErrors":"yii\\base\\Model","getErrorSummary":"yii\\base\\Model","getFirstError":"yii\\base\\Model","getFirstErrors":"yii\\base\\Model","getIsNewRecord":"yii\\db\\BaseActiveRecord","getIterator":"yii\\base\\Model","getOldAttribute":"yii\\db\\BaseActiveRecord","getOldAttributes":"yii\\db\\BaseActiveRecord","getOldPrimaryKey":"yii\\db\\BaseActiveRecord","getPrimaryKey":"yii\\db\\BaseActiveRecord","getRelatedRecords":"yii\\db\\BaseActiveRecord","getRelation":"yii\\db\\BaseActiveRecord","getScenario":"yii\\base\\Model","getValidators":"yii\\base\\Model","hasAttribute":"yii\\db\\BaseActiveRecord","hasErrors":"yii\\base\\Model","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\db\\BaseActiveRecord","instance":"yii\\base\\StaticInstanceTrait","instantiate":"yii\\db\\BaseActiveRecord","isAttributeActive":"yii\\base\\Model","isAttributeChanged":"yii\\db\\BaseActiveRecord","isAttributeRequired":"yii\\base\\Model","isAttributeSafe":"yii\\base\\Model","isPrimaryKey":"yii\\db\\BaseActiveRecord","isRelationPopulated":"yii\\db\\BaseActiveRecord","link":"yii\\db\\BaseActiveRecord","load":"yii\\base\\Model","loadMultiple":"yii\\base\\Model","loadRelations":"yii\\db\\BaseActiveRecord","loadRelationsFor":"yii\\db\\BaseActiveRecord","markAttributeDirty":"yii\\db\\BaseActiveRecord","off":"yii\\base\\Component","offsetExists":"yii\\db\\BaseActiveRecord","offsetGet":"yii\\base\\Model","offsetSet":"yii\\base\\Model","offsetUnset":"yii\\db\\BaseActiveRecord","on":"yii\\base\\Component","onUnsafeAttribute":"yii\\base\\Model","optimisticLock":"yii\\db\\BaseActiveRecord","populateRelation":"yii\\db\\BaseActiveRecord","refreshInternal":"yii\\db\\BaseActiveRecord","resolveFields":"yii\\base\\ArrayableTrait","rules":"yii\\base\\Model","safeAttributes":"yii\\base\\Model","save":"yii\\db\\BaseActiveRecord","scenarios":"yii\\base\\Model","setAttribute":"yii\\db\\BaseActiveRecord","setAttributes":"yii\\base\\Model","setIsNewRecord":"yii\\db\\BaseActiveRecord","setOldAttribute":"yii\\db\\BaseActiveRecord","setOldAttributes":"yii\\db\\BaseActiveRecord","setScenario":"yii\\base\\Model","toArray":"yii\\base\\ArrayableTrait","trigger":"yii\\base\\Component","unlink":"yii\\db\\BaseActiveRecord","unlinkAll":"yii\\db\\BaseActiveRecord","updateAttributes":"yii\\db\\BaseActiveRecord","updateCounters":"yii\\db\\BaseActiveRecord","updateInternal":"yii\\db\\BaseActiveRecord","validate":"yii\\base\\Model","validateMultiple":"yii\\base\\Model"},"constants":{"SCENARIO_DEFAULT":"yii\\base\\Model"},"events":{"EVENT_INIT":"yii\\db\\BaseActiveRecord","EVENT_AFTER_FIND":"yii\\db\\BaseActiveRecord","EVENT_BEFORE_INSERT":"yii\\db\\BaseActiveRecord","EVENT_AFTER_INSERT":"yii\\db\\BaseActiveRecord","EVENT_BEFORE_UPDATE":"yii\\db\\BaseActiveRecord","EVENT_AFTER_UPDATE":"yii\\db\\BaseActiveRecord","EVENT_BEFORE_DELETE":"yii\\db\\BaseActiveRecord","EVENT_AFTER_DELETE":"yii\\db\\BaseActiveRecord","EVENT_AFTER_REFRESH":"yii\\db\\BaseActiveRecord","EVENT_BEFORE_VALIDATE":"yii\\base\\Model","EVENT_AFTER_VALIDATE":"yii\\base\\Model"}}},"yii\\db\\ActiveRecordInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/db/activerecordinterface/","summary":"ActiveRecordInterface.","since":"2.0","implements":["yii\\base\\StaticInstanceInterface"],"methods":{"attributes":{"signature":"abstract public function attributes(): array","summary":"Returns the list of all attribute names of the record.","return":{"type":"array","description":"List of attribute names."},"abstract":true},"delete":{"signature":"abstract public function delete(): int|bool","summary":"Deletes the record from the database.","return":{"type":"int|bool","description":"The number of rows deleted, or `false` if the deletion is unsuccessful for some reason. Note that it is possible that the number of rows deleted is 0, even though the deletion execution is successful."},"abstract":true},"deleteAll":{"signature":"abstract public static function deleteAll(array|null $condition = null): int","summary":"Deletes records using the provided conditions.","params":[{"name":"$condition","type":"array|null","default":"null","optional":true,"description":"The condition that matches the records that should get deleted. Please refer to `yii\\db\\QueryInterface::where()` on how to specify this parameter. An empty condition will match all records."}],"return":{"type":"int","description":"The number of rows deleted"},"static":true,"abstract":true},"equals":{"signature":"abstract public function equals(static $record): bool","summary":"Returns a value indicating whether the given active record is the same as the current one.","params":[{"name":"$record","type":"static","description":"Record to compare to"}],"return":{"type":"bool","description":"Whether the two active records refer to the same row in the same database table."},"abstract":true},"find":{"signature":"abstract public static function find(): yii\\db\\ActiveQueryInterface","summary":"Creates an `yii\\db\\ActiveQueryInterface` instance for query purpose.","return":{"type":"yii\\db\\ActiveQueryInterface","description":"The newly created `yii\\db\\ActiveQueryInterface` instance."},"static":true,"abstract":true},"findAll":{"signature":"abstract public static function findAll(mixed $condition): array","summary":"Returns a list of active record models that match the specified primary key value(s) or a set of column values.","params":[{"name":"$condition","type":"mixed","description":"Primary key value or a set of column values"}],"return":{"type":"array","description":"An array of ActiveRecord instance, or an empty array if nothing matches."},"static":true,"abstract":true},"findOne":{"signature":"abstract public static function findOne(mixed $condition): static|null","summary":"Returns a single active record model instance by a primary key or an array of column values.","params":[{"name":"$condition","type":"mixed","description":"Primary key value or a set of column values"}],"return":{"type":"static|null","description":"ActiveRecord instance matching the condition, or `null` if nothing matches."},"static":true,"abstract":true},"getAttribute":{"signature":"abstract public function getAttribute(string $name): mixed","summary":"Returns the named attribute value.","params":[{"name":"$name","type":"string","description":"The attribute name"}],"return":{"type":"mixed","description":"The attribute value. `null` if the attribute is not set or does not exist."},"abstract":true},"getDb":{"signature":"abstract public static function getDb(): mixed","summary":"Returns the connection used by this AR class.","return":{"type":"mixed","description":"The database connection used by this AR class."},"static":true,"abstract":true},"getIsNewRecord":{"signature":"abstract public function getIsNewRecord(): bool","summary":"Returns a value indicating whether the current record is new (not saved in the database).","return":{"type":"bool","description":"Whether the record is new and should be inserted when calling `save()`."},"abstract":true},"getOldPrimaryKey":{"signature":"abstract public function getOldPrimaryKey(bool $asArray = false): mixed","summary":"Returns the old primary key value(s).","params":[{"name":"$asArray","type":"bool","default":"false","optional":true,"description":"Whether to return the primary key value as an array. If true, the return value will be an array with column name as key and column value as value. If this is `false` (default), a scalar value will be returned for non-composite primary key."}],"return":{"type":"mixed","description":"The old primary key value. An array (column name => column value) is returned if the primary key is composite or `$asArray` is true. A string is returned otherwise (`null` will be returned if the key value is `null`)."},"abstract":true},"getPrimaryKey":{"signature":"abstract public function getPrimaryKey(bool $asArray = false): mixed","summary":"Returns the primary key value(s).","params":[{"name":"$asArray","type":"bool","default":"false","optional":true,"description":"Whether to return the primary key value as an array. If true, the return value will be an array with attribute names as keys and attribute values as values. Note that for composite primary keys, an array will always be returned regardless of this parameter value."}],"return":{"type":"mixed","description":"The primary key value. An array (attribute name => attribute value) is returned if the primary key is composite or `$asArray` is true. A string is returned otherwise (`null` will be returned if the key value is `null`)."},"abstract":true},"getRelation":{"signature":"abstract public function getRelation(string $name, bool $throwException = true): yii\\db\\ActiveQueryInterface","summary":"Returns the relation object with the specified name.","params":[{"name":"$name","type":"string","description":"The relation name, e.g. `orders` for a relation defined via `getOrders()` method (case-sensitive)."},{"name":"$throwException","type":"bool","default":"true","optional":true,"description":"Whether to throw exception if the relation does not exist."}],"return":{"type":"yii\\db\\ActiveQueryInterface","description":"The relational query object"},"abstract":true},"hasAttribute":{"signature":"abstract public function hasAttribute(string $name): bool","summary":"Returns a value indicating whether the record has an attribute with the specified name.","params":[{"name":"$name","type":"string","description":"The name of the attribute"}],"return":{"type":"bool","description":"Whether the record has an attribute with the specified name."},"abstract":true},"insert":{"signature":"abstract public function insert(bool $runValidation = true, array|null $attributes = null): bool","summary":"Inserts the record into the database using the attribute values of this record.","params":[{"name":"$runValidation","type":"bool","default":"true","optional":true,"description":"Whether to perform validation (calling validate() (`yii\\base\\Model::validate()`)) before saving the record. Defaults to `true`. If the validation fails, the record will not be saved to the database and this method will return `false`."},{"name":"$attributes","type":"array|null","default":"null","optional":true,"description":"List of attributes that need to be saved. Defaults to `null`, meaning all attributes that are loaded from DB will be saved."}],"return":{"type":"bool","description":"Whether the attributes are valid and the record is inserted successfully."},"abstract":true},"isPrimaryKey":{"signature":"abstract public static function isPrimaryKey(array $keys): bool","summary":"Returns a value indicating whether the given set of attributes represents the primary key for this model.","params":[{"name":"$keys","type":"array","description":"The set of attributes to check"}],"return":{"type":"bool","description":"Whether the given set of attributes represents the primary key for this model"},"static":true,"abstract":true},"link":{"signature":"abstract public function link(string $name, static $model, array $extraColumns = []): mixed","summary":"Establishes the relationship between two records.","params":[{"name":"$name","type":"string","description":"The case sensitive name of the relationship, e.g. `orders` for a relation defined via `getOrders()` method."},{"name":"$model","type":"static","description":"The record to be linked with the current one."},{"name":"$extraColumns","type":"array","default":"[]","optional":true,"description":"Additional column values to be saved into the junction table. This parameter is only meaningful for a relationship involving a junction table (i.e., a relation set with `yii\\db\\ActiveQueryInterface::via()`)."}],"return":{"type":"mixed"},"abstract":true},"populateRelation":{"signature":"abstract public function populateRelation(string $name, yii\\db\\ActiveRecordInterface|array|null $records): mixed","summary":"Populates the named relation with the related records.","params":[{"name":"$name","type":"string","description":"The relation name, e.g. `orders` for a relation defined via `getOrders()` method (case-sensitive)."},{"name":"$records","type":"yii\\db\\ActiveRecordInterface|array|null","description":"The related records to be populated into the relation."}],"return":{"type":"mixed"},"abstract":true,"since":"2.0.8"},"primaryKey":{"signature":"abstract public static function primaryKey(): string[]","summary":"Returns the primary key **name(s)** for this AR class.","return":{"type":"string[]","description":"The primary key name(s) for this AR class."},"static":true,"abstract":true},"save":{"signature":"abstract public function save(bool $runValidation = true, array|null $attributeNames = null): bool","summary":"Saves the current record.","params":[{"name":"$runValidation","type":"bool","default":"true","optional":true,"description":"Whether to perform validation (calling validate() (`yii\\base\\Model::validate()`)) before saving the record. Defaults to `true`. If the validation fails, the record will not be saved to the database and this method will return `false`."},{"name":"$attributeNames","type":"array|null","default":"null","optional":true,"description":"List of attribute names that need to be saved. Defaults to `null`, meaning all attributes that are loaded from DB will be saved."}],"return":{"type":"bool","description":"Whether the saving succeeded (i.e. no validation errors occurred)."},"abstract":true},"setAttribute":{"signature":"abstract public function setAttribute(string $name, mixed $value): mixed","summary":"Sets the named attribute value.","params":[{"name":"$name","type":"string","description":"The attribute name."},{"name":"$value","type":"mixed","description":"The attribute value."}],"return":{"type":"mixed"},"abstract":true},"unlink":{"signature":"abstract public function unlink(string $name, static $model, bool $delete = false): mixed","summary":"Destroys the relationship between two records.","params":[{"name":"$name","type":"string","description":"The case sensitive name of the relationship, e.g. `orders` for a relation defined via `getOrders()` method."},{"name":"$model","type":"static","description":"The model to be unlinked from the current one."},{"name":"$delete","type":"bool","default":"false","optional":true,"description":"Whether to delete the model that contains the foreign key. If false, the model's foreign key will be set `null` and saved. If true, the model containing the foreign key will be deleted."}],"return":{"type":"mixed"},"abstract":true},"update":{"signature":"abstract public function update(bool $runValidation = true, array|null $attributeNames = null): int|bool","summary":"Saves the changes to this active record into the database.","params":[{"name":"$runValidation","type":"bool","default":"true","optional":true,"description":"Whether to perform validation (calling validate() (`yii\\base\\Model::validate()`)) before saving the record. Defaults to `true`. If the validation fails, the record will not be saved to the database and this method will return `false`."},{"name":"$attributeNames","type":"array|null","default":"null","optional":true,"description":"List of attributes that need to be saved. Defaults to `null`, meaning all attributes that are loaded from DB will be saved."}],"return":{"type":"int|bool","description":"The number of rows affected, or `false` if validation fails or updating process is stopped for other reasons. Note that it is possible that the number of rows affected is 0, even though the update execution is successful."},"abstract":true},"updateAll":{"signature":"abstract public static function updateAll(array $attributes, mixed $condition = null): int","summary":"Updates records using the provided attribute values and conditions.","params":[{"name":"$attributes","type":"array","description":"Attribute values (name-value pairs) to be saved for the record. Unlike `update()` these are not going to be validated."},{"name":"$condition","type":"mixed","default":"null","optional":true,"description":"The condition that matches the records that should get updated. Please refer to `yii\\db\\QueryInterface::where()` on how to specify this parameter. An empty condition will match all records."}],"return":{"type":"int","description":"The number of rows updated"},"static":true,"abstract":true}},"inherited":{"methods":{"instance":"yii\\base\\StaticInstanceInterface"}}},"yii\\db\\ActiveRelationTrait":{"kind":"trait","url":"https://yii2-framework.github.io/docs/api/yii/db/activerelationtrait/","summary":"ActiveRelationTrait implements the common methods and properties for active record relational queries.","since":"2.0","properties":{"inverseOf":{"type":"string","default":"null","description":"The name of the relation that is the inverse of this relation."},"link":{"type":"array","default":"null","description":"The columns of the primary and foreign tables that establish a relation."},"modelClass":{"type":"class-string","virtual":true},"multiple":{"type":"bool","default":"null","description":"Whether this query represents a relation to more than one record."},"primaryModel":{"type":"yii\\db\\ActiveRecord","default":"null","description":"The primary model of a relational query."},"via":{"type":"array|object|null","default":"null","description":"The query associated with the junction table."}},"methods":{"__clone":{"signature":"public function __clone(): mixed","summary":"Clones internal objects.","return":{"type":"mixed"}},"all":{"signature":"public function all(mixed $db): yii\\db\\ActiveRecordInterface[]","summary":"See `yii\\db\\ActiveQueryInterface::all()` for more info.","params":[{"name":"$db","type":"mixed"}],"return":{"type":"yii\\db\\ActiveRecordInterface[]"},"virtual":true},"findFor":{"signature":"public function findFor(string $name, yii\\db\\ActiveRecordInterface|yii\\db\\BaseActiveRecord $model): mixed","summary":"Finds the related records for the specified primary record.","params":[{"name":"$name","type":"string","description":"The relation name"},{"name":"$model","type":"yii\\db\\ActiveRecordInterface|yii\\db\\BaseActiveRecord","description":"The primary model"}],"return":{"type":"mixed","description":"The related record(s)"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the relation is invalid"}]},"inverseOf":{"signature":"public function inverseOf(string $relationName): $this","summary":"Sets the name of the relation that is the inverse of this relation.","params":[{"name":"$relationName","type":"string","description":"The name of the relation that is the inverse of this relation."}],"return":{"type":"$this","description":"The relation object itself."}},"one":{"signature":"public function one(mixed $db): yii\\db\\ActiveRecordInterface|array|null","summary":"See `yii\\db\\ActiveQueryInterface::one()` for more info.","params":[{"name":"$db","type":"mixed"}],"return":{"type":"yii\\db\\ActiveRecordInterface|array|null"},"virtual":true},"populateRelation":{"signature":"public function populateRelation(string $name, array &$primaryModels): array","summary":"Finds the related records and populates them into the primary models.","params":[{"name":"$name","type":"string","description":"The relation name"},{"name":"$primaryModels","type":"array","byReference":true,"description":"Primary models"}],"return":{"type":"array","description":"The related models"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$link` is invalid"}]},"via":{"signature":"public function via(string $relationName, callable|null $callable = null): $this","summary":"Specifies the relation associated with the junction table.","params":[{"name":"$relationName","type":"string","description":"The relation name. This refers to a relation declared in `$primaryModel`."},{"name":"$callable","type":"callable|null","default":"null","optional":true,"description":"A PHP callback for customizing the relation associated with the junction table. Its signature should be `function($query)`, where `$query` is the query to be customized."}],"return":{"type":"$this","description":"The relation object itself."}}}},"yii\\db\\AfterSaveEvent":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/aftersaveevent/","summary":"AfterSaveEvent represents the information available in `yii\\db\\ActiveRecord::EVENT_AFTER_INSERT` and `yii\\db\\ActiveRecord::EVENT_AFTER_UPDATE`.","since":"2.0","extends":"yii\\base\\Event","implements":["yii\\base\\Configurable"],"properties":{"changedAttributes":{"type":"array","default":"null","description":"The attribute values that had changed and were saved."}},"inherited":{"properties":{"data":"yii\\base\\Event","handled":"yii\\base\\Event","name":"yii\\base\\Event","sender":"yii\\base\\Event"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasHandlers":"yii\\base\\Event","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","off":"yii\\base\\Event","offAll":"yii\\base\\Event","on":"yii\\base\\Event","trigger":"yii\\base\\Event"}}},"yii\\db\\ArrayExpression":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/arrayexpression/","summary":"Class ArrayExpression represents an array SQL expression.","since":"2.0.14","implements":["yii\\db\\ExpressionInterface","ArrayAccess","Countable","IteratorAggregate"],"methods":{"__construct":{"signature":"public function __construct(array|yii\\db\\QueryInterface|mixed $value, string|null $type = null, int $dimension = 1)","summary":"ArrayExpression constructor.","params":[{"name":"$value","type":"array|yii\\db\\QueryInterface|mixed","description":"The array content. Either represented as an array of values or a Query that returns these values. A single value will be considered as an array containing one element."},{"name":"$type","type":"string|null","default":"null","optional":true,"description":"The type of the array elements. Defaults to `null` which means the type is not explicitly specified. In case when type is not specified explicitly and DBMS can not guess it from the context, SQL error will be raised."},{"name":"$dimension","type":"int","default":"1","optional":true,"description":"The number of indices needed to select an element"}]},"count":{"signature":"public function count(): int","summary":"Count elements of an object","return":{"type":"int","description":"The custom count as an integer.

The return value is cast to an integer."},"since":"2.0.14"},"getDimension":{"signature":"public function getDimension(): int","return":{"type":"int","description":"The number of indices needed to select an element"}},"getIterator":{"signature":"public function getIterator(): Traversable","summary":"Retrieve an external iterator","return":{"type":"Traversable","description":"An instance of an object implementing Iterator or Traversable"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"when ArrayExpression contains QueryInterface object"}],"since":"2.0.14.1"},"getType":{"signature":"public function getType(): string|null","return":{"type":"string|null"}},"getValue":{"signature":"public function getValue(): array|mixed|yii\\db\\QueryInterface","return":{"type":"array|mixed|yii\\db\\QueryInterface"}},"offsetExists":{"signature":"public function offsetExists(int|string $offset): bool","summary":"Whether a offset exists","params":[{"name":"$offset","type":"int|string","description":"

An offset to check for.

"}],"return":{"type":"bool","description":"True on success or false on failure.

The return value will be casted to boolean if non-boolean was returned."},"since":"2.0.14"},"offsetGet":{"signature":"public function offsetGet(int|string $offset): mixed","summary":"Offset to retrieve","params":[{"name":"$offset","type":"int|string","description":"

The offset to retrieve.

"}],"return":{"type":"mixed","description":"Can return all value types."},"since":"2.0.14"},"offsetSet":{"signature":"public function offsetSet(int|string $offset, mixed $value): void","summary":"Offset to set","params":[{"name":"$offset","type":"int|string","description":"

The offset to assign the value to.

"},{"name":"$value","type":"mixed","description":"

The value to set.

"}],"return":{"type":"void"},"since":"2.0.14"},"offsetUnset":{"signature":"public function offsetUnset(int|string $offset): void","summary":"Offset to unset","params":[{"name":"$offset","type":"int|string","description":"

The offset to unset.

"}],"return":{"type":"void"},"since":"2.0.14"}}},"yii\\db\\BaseActiveRecord":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/db/baseactiverecord/","summary":"ActiveRecord is the base class for classes representing relational data in terms of objects.","since":"2.0","extends":"yii\\base\\Model","implements":["yii\\db\\ActiveRecordInterface","yii\\base\\StaticInstanceInterface","IteratorAggregate","ArrayAccess","yii\\base\\Arrayable","yii\\base\\Configurable"],"traits":["yii\\base\\ArrayableTrait","yii\\base\\StaticInstanceTrait"],"properties":{"dirtyAttributes":{"type":"array","description":"The changed attribute values (name-value pairs).","access":"read-only","virtual":true},"isNewRecord":{"type":"bool","description":"Whether the record is new and should be inserted when calling `save()`.","virtual":true},"oldAttributes":{"type":"array|null","description":"Old attribute values to be set.","virtual":true},"oldPrimaryKey":{"type":"mixed","description":"The old primary key value.","access":"read-only","virtual":true},"primaryKey":{"type":"mixed","description":"The primary key value.","access":"read-only","virtual":true},"relatedRecords":{"type":"array","description":"An array of related records indexed by relation names.","access":"read-only","virtual":true}},"methods":{"__get":{"signature":"public function __get(string $name): mixed","summary":"PHP getter magic method.","params":[{"name":"$name","type":"string","description":"Property name"}],"return":{"type":"mixed","description":"Property value"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if relation name is wrong"}]},"__isset":{"signature":"public function __isset(string $name): bool","summary":"Checks if a property value is null.","params":[{"name":"$name","type":"string","description":"The property name or the event name"}],"return":{"type":"bool","description":"Whether the property value is null"}},"__set":{"signature":"public function __set(string $name, mixed $value): mixed","summary":"PHP setter magic method.","params":[{"name":"$name","type":"string","description":"Property name"},{"name":"$value","type":"mixed","description":"Property value"}],"return":{"type":"mixed"}},"__unset":{"signature":"public function __unset(string $name): mixed","summary":"Sets a component property to be null.","params":[{"name":"$name","type":"string","description":"The property name or the event name"}],"return":{"type":"mixed"}},"afterDelete":{"signature":"public function afterDelete(): mixed","summary":"This method is invoked after deleting a record.","return":{"type":"mixed"}},"afterFind":{"signature":"public function afterFind(): mixed","summary":"This method is called when the AR object is created and populated with the query result.","return":{"type":"mixed"}},"afterRefresh":{"signature":"public function afterRefresh(): mixed","summary":"This method is called when the AR object is refreshed.","return":{"type":"mixed"},"since":"2.0.8"},"afterSave":{"signature":"public function afterSave(bool $insert, array $changedAttributes): mixed","summary":"This method is called at the end of inserting or updating a record.","params":[{"name":"$insert","type":"bool","description":"Whether this method called while inserting a record. If `false`, it means the method is called while updating a record."},{"name":"$changedAttributes","type":"array","description":"The old values of attributes that had changed and were saved. You can use this parameter to take action based on the changes made for example send an email when the password had changed or implement audit trail that tracks all the changes. `$changedAttributes` gives you the old attribute values while the active record (`$this`) has already the new, updated values. Note that no automatic type conversion performed by default. You may use `yii\\behaviors\\AttributeTypecastBehavior` to facilitate attribute typecasting. See https://www.yiiframework.com/doc-2.0/guide-db-active-record.html#attributes-typecasting."}],"return":{"type":"mixed"}},"beforeDelete":{"signature":"public function beforeDelete(): bool","summary":"This method is invoked before deleting a record.","return":{"type":"bool","description":"Whether the record should be deleted. Defaults to `true`."}},"beforeSave":{"signature":"public function beforeSave(bool $insert): bool","summary":"This method is called at the beginning of inserting or updating a record.","params":[{"name":"$insert","type":"bool","description":"Whether this method called while inserting a record. If `false`, it means the method is called while updating a record."}],"return":{"type":"bool","description":"Whether the insertion or updating should continue. If `false`, the insertion or updating will be cancelled."}},"canGetProperty":{"signature":"public function canGetProperty(mixed $name, mixed $checkVars = true, mixed $checkBehaviors = true): bool","summary":"Returns a value indicating whether a property can be read.","params":[{"name":"$name","type":"mixed","description":"The property name"},{"name":"$checkVars","type":"mixed","default":"true","optional":true,"description":"Whether to treat member variables as properties"},{"name":"$checkBehaviors","type":"mixed","default":"true","optional":true,"description":"Whether to treat behaviors' properties as properties of this component"}],"return":{"type":"bool","description":"Whether the property can be read"}},"canSetOldAttribute":{"signature":"public function canSetOldAttribute(string $name): bool","summary":"Returns if the old named attribute can be set.","params":[{"name":"$name","type":"string","description":"The attribute name"}],"return":{"type":"bool","description":"Whether the old attribute can be set"}},"canSetProperty":{"signature":"public function canSetProperty(mixed $name, mixed $checkVars = true, mixed $checkBehaviors = true): bool","summary":"Returns a value indicating whether a property can be set.","params":[{"name":"$name","type":"mixed","description":"The property name"},{"name":"$checkVars","type":"mixed","default":"true","optional":true,"description":"Whether to treat member variables as properties"},{"name":"$checkBehaviors","type":"mixed","default":"true","optional":true,"description":"Whether to treat behaviors' properties as properties of this component"}],"return":{"type":"bool","description":"Whether the property can be written"}},"createRelationQuery":{"signature":"protected function createRelationQuery(string $class, array $link, bool $multiple): yii\\db\\ActiveQueryInterface","summary":"Creates a query instance for `has-one` or `has-many` relation.","params":[{"name":"$class","type":"string","description":"The class name of the related record."},{"name":"$link","type":"array","description":"The primary-foreign key constraint."},{"name":"$multiple","type":"bool","description":"Whether this query represents a relation to more than one record."}],"return":{"type":"yii\\db\\ActiveQueryInterface","description":"The relational query object."},"visibility":"protected","since":"2.0.12"},"delete":{"signature":"public function delete(): int|false","summary":"Deletes the table row corresponding to this active record.","return":{"type":"int|false","description":"The number of rows deleted, or `false` if the deletion is unsuccessful for some reason. Note that it is possible the number of rows deleted is 0, even though the deletion execution is successful."},"throws":[{"type":"yii\\db\\StaleObjectException","description":"if optimistic locking (`optimisticLock()`) is enabled and the data being deleted is outdated."},{"type":"yii\\db\\Exception","description":"in case delete failed."}]},"deleteAll":{"signature":"public static function deleteAll(string|array|null $condition = null): int","summary":"Deletes rows in the table using the provided conditions.","params":[{"name":"$condition","type":"string|array|null","default":"null","optional":true,"description":"The conditions that will be put in the WHERE part of the DELETE SQL. Please refer to `yii\\db\\Query::where()` on how to specify this parameter."}],"return":{"type":"int","description":"The number of rows deleted"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if not overridden."}],"static":true},"equals":{"signature":"public function equals(yii\\db\\ActiveRecordInterface $record): bool","summary":"Returns a value indicating whether the given active record is the same as the current one.","params":[{"name":"$record","type":"yii\\db\\ActiveRecordInterface","description":"Record to compare to"}],"return":{"type":"bool","description":"Whether the two active records refer to the same row in the same database table."}},"extraFields":{"signature":"public function extraFields(): array","summary":"Returns the list of fields that can be expanded further and returned by `toArray()`.","return":{"type":"array","description":"The list of expandable field names or field definitions. Please refer to `fields()` on the format of the return value."}},"fields":{"signature":"public function fields(): array","summary":"Returns the list of fields that should be returned by default by `toArray()` when no specific fields are specified.","return":{"type":"array","description":"The list of field names or field definitions."}},"findAll":{"signature":"public static function findAll(mixed $condition): static[]","summary":"Returns a list of active record models that match the specified primary key value(s) or a set of column values.","params":[{"name":"$condition","type":"mixed","description":"Primary key value or a set of column values"}],"return":{"type":"static[]","description":"An array of ActiveRecord instances, or an empty array if nothing matches."},"static":true},"findOne":{"signature":"public static function findOne(mixed $condition): static|null","summary":"Returns a single active record model instance by a primary key or an array of column values.","params":[{"name":"$condition","type":"mixed","description":"Primary key value or a set of column values"}],"return":{"type":"static|null","description":"ActiveRecord instance matching the condition, or `null` if nothing matches."},"static":true},"getAttribute":{"signature":"public function getAttribute(string $name): mixed","summary":"Returns the named attribute value.","params":[{"name":"$name","type":"string","description":"The attribute name"}],"return":{"type":"mixed","description":"The attribute value. `null` if the attribute is not set or does not exist."}},"getAttributeHint":{"signature":"public function getAttributeHint(string $attribute): string","summary":"Returns the text hint for the specified attribute.","params":[{"name":"$attribute","type":"string","description":"The attribute name"}],"return":{"type":"string","description":"The attribute hint"},"since":"2.0.4"},"getAttributeLabel":{"signature":"public function getAttributeLabel(string $attribute): string","summary":"Returns the text label for the specified attribute.","params":[{"name":"$attribute","type":"string","description":"The attribute name"}],"return":{"type":"string","description":"The attribute label"}},"getDirtyAttributes":{"signature":"public function getDirtyAttributes(string[]|null $names = null): array","summary":"Returns the attribute values that have been modified since they are loaded or saved most recently.","params":[{"name":"$names","type":"string[]|null","default":"null","optional":true,"description":"The names of the attributes whose values may be returned if they are changed recently. If null, `attributes()` will be used."}],"return":{"type":"array","description":"The changed attribute values (name-value pairs)"}},"getIsNewRecord":{"signature":"public function getIsNewRecord(): bool","summary":"Returns a value indicating whether the current record is new.","return":{"type":"bool","description":"Whether the record is new and should be inserted when calling `save()`."}},"getOldAttribute":{"signature":"public function getOldAttribute(string $name): mixed","summary":"Returns the old value of the named attribute.","params":[{"name":"$name","type":"string","description":"The attribute name"}],"return":{"type":"mixed","description":"The old attribute value. `null` if the attribute is not loaded before or does not exist."}},"getOldAttributes":{"signature":"public function getOldAttributes(): array","summary":"Returns the old attribute values.","return":{"type":"array","description":"The old attribute values (name-value pairs)"}},"getOldPrimaryKey":{"signature":"public function getOldPrimaryKey(bool $asArray = false): mixed","summary":"Returns the old primary key value(s).","params":[{"name":"$asArray","type":"bool","default":"false","optional":true,"description":"Whether to return the primary key value as an array. If `true`, the return value will be an array with column name as key and column value as value. If this is `false` (default), a scalar value will be returned for non-composite primary key."}],"return":{"type":"mixed","description":"The old primary key value. An array (column name => column value) is returned if the primary key is composite or `$asArray` is `true`. A string is returned otherwise (null will be returned if the key value is null)."},"throws":[{"type":"yii\\db\\Exception","description":"if the AR model does not have a primary key"}]},"getPrimaryKey":{"signature":"public function getPrimaryKey(bool $asArray = false): mixed","summary":"Returns the primary key value(s).","params":[{"name":"$asArray","type":"bool","default":"false","optional":true,"description":"Whether to return the primary key value as an array. If `true`, the return value will be an array with column names as keys and column values as values. Note that for composite primary keys, an array will always be returned regardless of this parameter value."}],"return":{"type":"mixed","description":"The primary key value. An array (column name => column value) is returned if the primary key is composite or `$asArray` is `true`. A string is returned otherwise (null will be returned if the key value is null)."}},"getRelatedRecords":{"signature":"public function getRelatedRecords(): array","summary":"Returns all populated related records.","return":{"type":"array","description":"An array of related records indexed by relation names."}},"getRelation":{"signature":"public function getRelation(string $name, bool $throwException = true): yii\\db\\ActiveQueryInterface|yii\\db\\ActiveQuery|null","summary":"Returns the relation object with the specified name.","params":[{"name":"$name","type":"string","description":"The relation name, e.g. `orders` for a relation defined via `getOrders()` method (case-sensitive)."},{"name":"$throwException","type":"bool","default":"true","optional":true,"description":"Whether to throw exception if the relation does not exist."}],"return":{"type":"yii\\db\\ActiveQueryInterface|yii\\db\\ActiveQuery|null","description":"The relational query object. If the relation does not exist and `$throwException` is `false`, `null` will be returned."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the named relation does not exist."}]},"hasAttribute":{"signature":"public function hasAttribute(string $name): bool","summary":"Returns a value indicating whether the model has an attribute with the specified name.","params":[{"name":"$name","type":"string","description":"The name of the attribute"}],"return":{"type":"bool","description":"Whether the model has an attribute with the specified name."}},"hasMany":{"signature":"public function hasMany(class-string $class, array $link): yii\\db\\ActiveQueryInterface","summary":"Declares a `has-many` relation.","params":[{"name":"$class","type":"class-string","description":"The class name of the related record"},{"name":"$link","type":"array","description":"The primary-foreign key constraint. The keys of the array refer to the attributes of the record associated with the `$class` model, while the values of the array refer to the corresponding attributes in **this** AR class."}],"return":{"type":"yii\\db\\ActiveQueryInterface","description":"The relational query object."}},"hasOne":{"signature":"public function hasOne(class-string $class, array $link): yii\\db\\ActiveQueryInterface","summary":"Declares a `has-one` relation.","params":[{"name":"$class","type":"class-string","description":"The class name of the related record"},{"name":"$link","type":"array","description":"The primary-foreign key constraint. The keys of the array refer to the attributes of the record associated with the `$class` model, while the values of the array refer to the corresponding attributes in **this** AR class."}],"return":{"type":"yii\\db\\ActiveQueryInterface","description":"The relational query object."}},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"instantiate":{"signature":"public static function instantiate(array $row): static","summary":"Creates an active record instance.","params":[{"name":"$row","type":"array","description":"Row data to be populated into the record."}],"return":{"type":"static","description":"The newly created active record"},"static":true},"isAttributeChanged":{"signature":"public function isAttributeChanged(string $name, bool $identical = true): bool","summary":"Returns a value indicating whether the named attribute has been changed.","params":[{"name":"$name","type":"string","description":"The name of the attribute."},{"name":"$identical","type":"bool","default":"true","optional":true,"description":"Whether the comparison of new and old value is made for identical values using `===`, defaults to `true`. Otherwise `==` is used for comparison. This parameter is available since version 2.0.4."}],"return":{"type":"bool","description":"Whether the attribute has been changed"}},"isPrimaryKey":{"signature":"public static function isPrimaryKey(array $keys): bool","summary":"Returns a value indicating whether the given set of attributes represents the primary key for this model.","params":[{"name":"$keys","type":"array","description":"The set of attributes to check"}],"return":{"type":"bool","description":"Whether the given set of attributes represents the primary key for this model"},"static":true},"isRelationPopulated":{"signature":"public function isRelationPopulated(string $name): bool","summary":"Check whether the named relation has been populated with records.","params":[{"name":"$name","type":"string","description":"The relation name, e.g. `orders` for a relation defined via `getOrders()` method (case-sensitive)."}],"return":{"type":"bool","description":"Whether relation has been populated with records."}},"link":{"signature":"public function link(string $name, yii\\db\\ActiveRecordInterface $model, array $extraColumns = []): mixed","summary":"Establishes the relationship between two models.","params":[{"name":"$name","type":"string","description":"The case sensitive name of the relationship, e.g. `orders` for a relation defined via `getOrders()` method."},{"name":"$model","type":"yii\\db\\ActiveRecordInterface","description":"The model to be linked with the current one."},{"name":"$extraColumns","type":"array","default":"[]","optional":true,"description":"Additional column values to be saved into the junction table. This parameter is only meaningful for a relationship involving a junction table (i.e., a relation set with `yii\\db\\ActiveRelationTrait::via()` or `yii\\db\\ActiveQuery::viaTable()`.)"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if the method is unable to link two models."}]},"loadRelations":{"signature":"public function loadRelations(string|array $relationNames, bool $asArray = false): mixed","summary":"Eager loads related models for the already loaded primary model.","params":[{"name":"$relationNames","type":"string|array","description":"The names of the relations of this model to be loaded from database. See `yii\\db\\ActiveQueryInterface::with()` on how to specify this argument."},{"name":"$asArray","type":"bool","default":"false","optional":true,"description":"Whether to load each relation as an array or an object (if the relation itself does not specify that)."}],"return":{"type":"mixed"},"since":"2.0.50"},"loadRelationsFor":{"signature":"public static function loadRelationsFor(yii\\db\\TModels &$models, string|array $relationNames, bool $asArray = false): mixed","summary":"Eager loads related models for the already loaded primary models.","params":[{"name":"$models","type":"yii\\db\\TModels","byReference":true,"description":"Array of primary models. Each model should have the same type and can be: - an active record instance; - active record instance represented by array (i.e. active record was loaded using `yii\\db\\ActiveQuery::asArray()`)."},{"name":"$relationNames","type":"string|array","description":"The names of the relations of primary models to be loaded from database. See `yii\\db\\ActiveQueryInterface::with()` on how to specify this argument."},{"name":"$asArray","type":"bool","default":"false","optional":true,"description":"Whether to load each related model as an array or an object (if the relation itself does not specify that)."}],"return":{"type":"mixed"},"static":true,"since":"2.0.50"},"markAttributeDirty":{"signature":"public function markAttributeDirty(string $name): mixed","summary":"Marks an attribute dirty.","params":[{"name":"$name","type":"string","description":"The attribute name"}],"return":{"type":"mixed"}},"offsetExists":{"signature":"public function offsetExists(mixed $offset): bool","summary":"Returns whether there is an element at the specified offset.","params":[{"name":"$offset","type":"mixed","description":"The offset to check on"}],"return":{"type":"bool","description":"Whether there is an element at the specified offset."}},"offsetUnset":{"signature":"public function offsetUnset(mixed $offset): mixed","summary":"Sets the element value at the specified offset to null.","params":[{"name":"$offset","type":"mixed","description":"The offset to unset element"}],"return":{"type":"mixed"}},"optimisticLock":{"signature":"public function optimisticLock(): string|null","summary":"Returns the name of the column that stores the lock version for implementing optimistic locking.","return":{"type":"string|null","description":"The column name that stores the lock version of a table row. If `null` is returned (default implemented), optimistic locking will not be supported."}},"populateRecord":{"signature":"public static function populateRecord(yii\\db\\BaseActiveRecord $record, array $row): mixed","summary":"Populates an active record object using a row of data from the database/storage.","params":[{"name":"$record","type":"yii\\db\\BaseActiveRecord","description":"The record to be populated. In most cases this will be an instance created by `instantiate()` beforehand."},{"name":"$row","type":"array","description":"Attribute values (name => value)"}],"return":{"type":"mixed"},"static":true},"populateRelation":{"signature":"public function populateRelation(string $name, yii\\db\\ActiveRecordInterface|array|null $records): mixed","summary":"Populates the named relation with the related records.","params":[{"name":"$name","type":"string","description":"The relation name, e.g. `orders` for a relation defined via `getOrders()` method (case-sensitive)."},{"name":"$records","type":"yii\\db\\ActiveRecordInterface|array|null","description":"The related records to be populated into the relation."}],"return":{"type":"mixed"}},"refresh":{"signature":"public function refresh(): bool","summary":"Repopulates this active record with the latest data.","return":{"type":"bool","description":"Whether the row still exists in the database. If `true`, the latest data will be populated to this active record. Otherwise, this record will remain unchanged."}},"refreshInternal":{"signature":"protected function refreshInternal(yii\\db\\BaseActiveRecord $record): bool","summary":"Repopulates this active record with the latest data from a newly fetched instance.","params":[{"name":"$record","type":"yii\\db\\BaseActiveRecord","description":"The record to take attributes from."}],"return":{"type":"bool","description":"Whether refresh was successful."},"visibility":"protected","since":"2.0.13"},"save":{"signature":"public function save(bool $runValidation = true, array|null $attributeNames = null): bool","summary":"Saves the current record.","params":[{"name":"$runValidation","type":"bool","default":"true","optional":true,"description":"Whether to perform validation (calling `validate()`) before saving the record. Defaults to `true`. If the validation fails, the record will not be saved to the database and this method will return `false`."},{"name":"$attributeNames","type":"array|null","default":"null","optional":true,"description":"List of attribute names that need to be saved. Defaults to null, meaning all attributes that are loaded from DB will be saved."}],"return":{"type":"bool","description":"Whether the saving succeeded (i.e. no validation errors occurred)."},"throws":[{"type":"yii\\db\\Exception","description":"in case update or insert failed."}]},"setAttribute":{"signature":"public function setAttribute(string $name, mixed $value): mixed","summary":"Sets the named attribute value.","params":[{"name":"$name","type":"string","description":"The attribute name"},{"name":"$value","type":"mixed","description":"The attribute value."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the named attribute does not exist."}]},"setIsNewRecord":{"signature":"public function setIsNewRecord(bool $value): mixed","summary":"Sets the value indicating whether the record is new.","params":[{"name":"$value","type":"bool","description":"Whether the record is new and should be inserted when calling `save()`."}],"return":{"type":"mixed"}},"setOldAttribute":{"signature":"public function setOldAttribute(string $name, mixed $value): mixed","summary":"Sets the old value of the named attribute.","params":[{"name":"$name","type":"string","description":"The attribute name"},{"name":"$value","type":"mixed","description":"The old attribute value."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the named attribute does not exist."}]},"setOldAttributes":{"signature":"public function setOldAttributes(array|null $values): mixed","summary":"Sets the old attribute values.","params":[{"name":"$values","type":"array|null","description":"Old attribute values to be set. If set to `null` this record is considered to be new (`$isNewRecord`)."}],"return":{"type":"mixed"}},"unlink":{"signature":"public function unlink(string $name, yii\\db\\ActiveRecordInterface $model, bool $delete = false): mixed","summary":"Destroys the relationship between two models.","params":[{"name":"$name","type":"string","description":"The case sensitive name of the relationship, e.g. `orders` for a relation defined via `getOrders()` method."},{"name":"$model","type":"yii\\db\\ActiveRecordInterface","description":"The model to be unlinked from the current one. You have to make sure that the model is really related with the current model as this method does not check this."},{"name":"$delete","type":"bool","default":"false","optional":true,"description":"Whether to delete the model that contains the foreign key. If `false`, the model's foreign key will be set `null` and saved. If `true`, the model containing the foreign key will be deleted."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if the models cannot be unlinked"},{"type":"yii\\db\\Exception"},{"type":"yii\\db\\StaleObjectException"}]},"unlinkAll":{"signature":"public function unlinkAll(string $name, bool $delete = false): mixed","summary":"Destroys the relationship in current model.","params":[{"name":"$name","type":"string","description":"The case sensitive name of the relationship, e.g. `orders` for a relation defined via `getOrders()` method."},{"name":"$delete","type":"bool","default":"false","optional":true,"description":"Whether to delete the model that contains the foreign key. Note that the deletion will be performed using `deleteAll()`, which will not trigger any events on the related models. If you need `EVENT_BEFORE_DELETE` or `EVENT_AFTER_DELETE` to be triggered, you need to find (`find()`) the models first and then call `delete()` on each of them."}],"return":{"type":"mixed"}},"update":{"signature":"public function update(bool $runValidation = true, array|null $attributeNames = null): int|false","summary":"Saves the changes to this active record into the associated database table.","params":[{"name":"$runValidation","type":"bool","default":"true","optional":true,"description":"Whether to perform validation (calling `validate()`) before saving the record. Defaults to `true`. If the validation fails, the record will not be saved to the database and this method will return `false`."},{"name":"$attributeNames","type":"array|null","default":"null","optional":true,"description":"List of attribute names that need to be saved. Defaults to null, meaning all attributes that are loaded from DB will be saved."}],"return":{"type":"int|false","description":"The number of rows affected, or `false` if validation fails or `beforeSave()` stops the updating process."},"throws":[{"type":"yii\\db\\StaleObjectException","description":"if optimistic locking (`optimisticLock()`) is enabled and the data being updated is outdated."},{"type":"yii\\db\\Exception","description":"in case update failed."}]},"updateAll":{"signature":"public static function updateAll(array $attributes, string|array $condition = ''): int","summary":"Updates the whole table using the provided attribute values and conditions.","params":[{"name":"$attributes","type":"array","description":"Attribute values (name-value pairs) to be saved into the table"},{"name":"$condition","type":"string|array","default":"''","optional":true,"description":"The conditions that will be put in the WHERE part of the UPDATE SQL. Please refer to `yii\\db\\Query::where()` on how to specify this parameter."}],"return":{"type":"int","description":"The number of rows updated"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if not overridden"}],"static":true},"updateAllCounters":{"signature":"public static function updateAllCounters(array $counters, string|array $condition = ''): int","summary":"Updates the whole table using the provided counter changes and conditions.","params":[{"name":"$counters","type":"array","description":"The counters to be updated (attribute name => increment value). Use negative values if you want to decrement the counters."},{"name":"$condition","type":"string|array","default":"''","optional":true,"description":"The conditions that will be put in the WHERE part of the UPDATE SQL. Please refer to `yii\\db\\Query::where()` on how to specify this parameter."}],"return":{"type":"int","description":"The number of rows updated"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if not overrided"}],"static":true},"updateAttributes":{"signature":"public function updateAttributes(array $attributes): int","summary":"Updates the specified attributes.","params":[{"name":"$attributes","type":"array","description":"The attributes (names or name-value pairs) to be updated"}],"return":{"type":"int","description":"The number of rows affected."}},"updateCounters":{"signature":"public function updateCounters(array $counters): bool","summary":"Updates one or several counter columns for the current AR object.","params":[{"name":"$counters","type":"array","description":"The counters to be updated (attribute name => increment value) Use negative values if you want to decrement the counters."}],"return":{"type":"bool","description":"Whether the saving is successful"}},"updateInternal":{"signature":"protected function updateInternal(array|null $attributes = null): int|false","params":[{"name":"$attributes","type":"array|null","default":"null","optional":true,"description":"Attributes to update"}],"return":{"type":"int|false","description":"The number of rows affected, or false if `beforeSave()` stops the updating process."},"throws":[{"type":"yii\\db\\StaleObjectException"}],"visibility":"protected"}},"events":{"EVENT_INIT":{"value":"'init'","type":"yii\\db\\Event","description":"An event that is triggered when the record is initialized via `init()`."},"EVENT_AFTER_FIND":{"value":"'afterFind'","type":"yii\\db\\Event","description":"An event that is triggered after the record is created and populated with query result."},"EVENT_BEFORE_INSERT":{"value":"'beforeInsert'","type":"yii\\base\\ModelEvent","description":"An event that is triggered before inserting a record."},"EVENT_AFTER_INSERT":{"value":"'afterInsert'","type":"yii\\db\\AfterSaveEvent","description":"An event that is triggered after a record is inserted."},"EVENT_BEFORE_UPDATE":{"value":"'beforeUpdate'","type":"yii\\base\\ModelEvent","description":"An event that is triggered before updating a record."},"EVENT_AFTER_UPDATE":{"value":"'afterUpdate'","type":"yii\\db\\AfterSaveEvent","description":"An event that is triggered after a record is updated."},"EVENT_BEFORE_DELETE":{"value":"'beforeDelete'","type":"yii\\base\\ModelEvent","description":"An event that is triggered before deleting a record."},"EVENT_AFTER_DELETE":{"value":"'afterDelete'","type":"yii\\db\\Event","description":"An event that is triggered after a record is deleted."},"EVENT_AFTER_REFRESH":{"value":"'afterRefresh'","type":"yii\\db\\Event","description":"An event that is triggered after a record is refreshed.","since":"2.0.8"}},"inherited":{"properties":{"activeValidators":"yii\\base\\Model","attributes":"yii\\base\\Model","behaviors":"yii\\base\\Component","errors":"yii\\base\\Model","firstErrors":"yii\\base\\Model","iterator":"yii\\base\\Model","scenario":"yii\\base\\Model","validators":"yii\\base\\Model"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Model","__construct":"yii\\base\\BaseObject","activeAttributes":"yii\\base\\Model","addError":"yii\\base\\Model","addErrors":"yii\\base\\Model","afterValidate":"yii\\base\\Model","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","attributeHints":"yii\\base\\Model","attributeLabels":"yii\\base\\Model","attributes":"yii\\base\\Model","beforeValidate":"yii\\base\\Model","behaviors":"yii\\base\\Component","className":"yii\\base\\BaseObject","clearErrors":"yii\\base\\Model","createValidators":"yii\\base\\Model","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","extractFieldsFor":"yii\\base\\ArrayableTrait","extractRootFields":"yii\\base\\ArrayableTrait","find":"yii\\db\\ActiveRecordInterface","formName":"yii\\base\\Model","generateAttributeLabel":"yii\\base\\Model","getActiveValidators":"yii\\base\\Model","getAttributes":"yii\\base\\Model","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getDb":"yii\\db\\ActiveRecordInterface","getErrors":"yii\\base\\Model","getErrorSummary":"yii\\base\\Model","getFirstError":"yii\\base\\Model","getFirstErrors":"yii\\base\\Model","getIterator":"yii\\base\\Model","getScenario":"yii\\base\\Model","getValidators":"yii\\base\\Model","hasErrors":"yii\\base\\Model","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","insert":"yii\\db\\ActiveRecordInterface","instance":"yii\\base\\StaticInstanceTrait","isAttributeActive":"yii\\base\\Model","isAttributeRequired":"yii\\base\\Model","isAttributeSafe":"yii\\base\\Model","load":"yii\\base\\Model","loadMultiple":"yii\\base\\Model","off":"yii\\base\\Component","offsetGet":"yii\\base\\Model","offsetSet":"yii\\base\\Model","on":"yii\\base\\Component","onUnsafeAttribute":"yii\\base\\Model","primaryKey":"yii\\db\\ActiveRecordInterface","resolveFields":"yii\\base\\ArrayableTrait","rules":"yii\\base\\Model","safeAttributes":"yii\\base\\Model","scenarios":"yii\\base\\Model","setAttributes":"yii\\base\\Model","setScenario":"yii\\base\\Model","toArray":"yii\\base\\ArrayableTrait","trigger":"yii\\base\\Component","validate":"yii\\base\\Model","validateMultiple":"yii\\base\\Model"},"constants":{"SCENARIO_DEFAULT":"yii\\base\\Model"},"events":{"EVENT_BEFORE_VALIDATE":"yii\\base\\Model","EVENT_AFTER_VALIDATE":"yii\\base\\Model"}}},"yii\\db\\BatchQueryResult":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/batchqueryresult/","summary":"BatchQueryResult represents a batch query from which you can retrieve data in batches.","since":"2.0","extends":"yii\\base\\Component","implements":["Iterator","yii\\base\\Configurable"],"properties":{"batchSize":{"type":"int","default":"100","description":"The number of rows to be returned in each batch."},"db":{"type":"yii\\db\\Connection|null","default":"null","description":"The DB connection to be used when performing batch query."},"each":{"type":"bool","default":"false","description":"Whether to return a single row during each iteration."},"query":{"type":"yii\\db\\Query","default":"null","description":"The query object associated with this batch query."}},"methods":{"__destruct":{"signature":"public function __destruct(): mixed","summary":"Destructor.","return":{"type":"mixed"}},"__wakeup":{"signature":"public function __wakeup(): mixed","summary":"Unserialization is disabled to prevent remote code execution in case application calls unserialize() on user input containing specially crafted string.","return":{"type":"mixed"},"since":"2.0.38"},"current":{"signature":"public function current(): yii\\db\\TValue","summary":"Returns the current dataset.","return":{"type":"yii\\db\\TValue","description":"The current dataset."}},"fetchData":{"signature":"protected function fetchData(): array","summary":"Fetches the next batch of data.","return":{"type":"array","description":"The data fetched"},"throws":[{"type":"yii\\db\\Exception"}],"visibility":"protected"},"getRows":{"signature":"protected function getRows(): array","summary":"Reads and collects rows for batch","return":{"type":"array"},"visibility":"protected","since":"2.0.23"},"key":{"signature":"public function key(): yii\\db\\TKey|null","summary":"Returns the index of the current dataset.","return":{"type":"yii\\db\\TKey|null","description":"The index of the current row."}},"next":{"signature":"public function next(): mixed","summary":"Moves the internal pointer to the next dataset.","return":{"type":"mixed"}},"reset":{"signature":"public function reset(): mixed","summary":"Resets the batch query.","return":{"type":"mixed"}},"rewind":{"signature":"public function rewind(): mixed","summary":"Resets the iterator to the initial state.","return":{"type":"mixed"}},"valid":{"signature":"public function valid(): bool","summary":"Returns whether there is a valid dataset at the current position.","return":{"type":"bool","description":"Whether there is a valid dataset at the current position."}}},"constants":{"MSSQL_NO_MORE_ROWS_ERROR_CODE":{"value":"-13","description":"MSSQL error code for exception that is thrown when last batch is size less than specified batch size"}},"events":{"EVENT_RESET":{"value":"'reset'","type":"yii\\db\\Event","description":"An event that is triggered when the batch query is reset.","since":"2.0.41"},"EVENT_FINISH":{"value":"'finish'","type":"yii\\db\\Event","description":"An event that is triggered when the last batch has been fetched.","since":"2.0.41"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\db\\CheckConstraint":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/checkconstraint/","summary":"CheckConstraint represents the metadata of a table `CHECK` constraint.","since":"2.0.13","extends":"yii\\db\\Constraint","implements":["yii\\base\\Configurable"],"properties":{"expression":{"type":"string","default":"null","description":"The SQL of the `CHECK` constraint."}},"inherited":{"properties":{"columnNames":"yii\\db\\Constraint","name":"yii\\db\\Constraint"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\ColumnSchema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/columnschema/","summary":"ColumnSchema class describes the metadata of a column in a database table.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"allowNull":{"type":"bool","default":"false","description":"Whether this column can be null."},"autoIncrement":{"type":"bool","default":"false","description":"Whether this column is auto-incremental"},"comment":{"type":"string|null","default":"null","description":"Comment of this column."},"dbType":{"type":"string","default":"''","description":"The DB type of this column."},"defaultValue":{"type":"mixed","default":"null","description":"Default value of this column"},"enumValues":{"type":"array|null","default":"null","description":"Enumerable values."},"isPrimaryKey":{"type":"bool|null","default":"null","description":"Whether this column is a primary key"},"name":{"type":"string","default":"''","description":"Name of this column (without quotes)."},"phpType":{"type":"string","default":"''","description":"The PHP type of this column."},"precision":{"type":"int|null","default":"null","description":"Precision of the column data, if it is numeric."},"scale":{"type":"int|null","default":"null","description":"Scale of the column data, if it is numeric."},"size":{"type":"int|null","default":"null","description":"Display size of the column."},"type":{"type":"string","default":"''","description":"Abstract type of this column."},"unsigned":{"type":"bool","default":"false","description":"Whether this column is unsigned."}},"methods":{"dbTypecast":{"signature":"public function dbTypecast(mixed $value): mixed","summary":"Converts the input value according to `$type` and `$dbType` for use in a db query.","params":[{"name":"$value","type":"mixed","description":"Input value"}],"return":{"type":"mixed","description":"Converted value. This may also be an array containing the value as the first element and the PDO type as the second element."}},"defaultPhpTypecast":{"signature":"public function defaultPhpTypecast(mixed $value): mixed","summary":"Converts a raw column default value from the database metadata to its PHP representation.","params":[{"name":"$value","type":"mixed","description":"Raw default value from the database schema metadata."}],"return":{"type":"mixed","description":"Converted PHP value."},"since":"22.0"},"isType":{"signature":"public function isType(string $type): bool","summary":"Returns whether this column uses the given abstract type.","params":[{"name":"$type","type":"string","description":"Abstract column type."}],"return":{"type":"bool","description":"Whether this column uses the given abstract type."},"since":"22.0"},"phpTypecast":{"signature":"public function phpTypecast(mixed $value): mixed","summary":"Converts the input value according to `$phpType` after retrieval from the database.","params":[{"name":"$value","type":"mixed","description":"Input value"}],"return":{"type":"mixed","description":"Converted value"}},"typecast":{"signature":"protected function typecast(mixed $value): mixed","summary":"Converts the input value according to `$phpType` after retrieval from the database.","params":[{"name":"$value","type":"mixed","description":"Input value"}],"return":{"type":"mixed","description":"Converted value"},"visibility":"protected","since":"2.0.3"}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\ColumnSchemaBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/columnschemabuilder/","summary":"ColumnSchemaBuilder helps to define database schema types using a PHP interface.","since":"2.0.6","extends":"yii\\base\\BaseObject","implements":["Stringable","yii\\base\\Configurable"],"properties":{"after":{"type":"string","default":"null","description":"The column after which this column will be added.","visibility":"protected","since":"2.0.8"},"append":{"type":"mixed","default":"null","description":"SQL string to be appended to column schema definition.","visibility":"protected","since":"2.0.9"},"categoryMap":{"type":"array","description":"Mapping of abstract column types (keys) to type categories (values).","virtual":true},"check":{"type":"string","default":"null","description":"The `CHECK` constraint for the column.","visibility":"protected"},"comment":{"type":"string","default":"null","description":"Comment value of the column.","since":"2.0.8"},"db":{"type":"yii\\db\\Connection","default":"null","description":"The current database connection.","since":"2.0.8"},"default":{"type":"mixed","default":"null","description":"Default value of the column.","visibility":"protected"},"isFirst":{"type":"bool","default":"null","description":"Whether this column is to be inserted at the beginning of the table.","visibility":"protected","since":"2.0.8"},"isNotNull":{"type":"bool|null","default":"null","description":"Whether the column is or not nullable.","visibility":"protected"},"isUnique":{"type":"bool","default":"false","description":"Whether the column values should be unique.","visibility":"protected"},"isUnsigned":{"type":"bool","default":"false","description":"Whether the column values should be unsigned.","visibility":"protected","since":"2.0.7"},"length":{"type":"int|string|array","default":"null","description":"Column size or precision definition.","visibility":"protected"},"type":{"type":"string","default":"null","description":"The column type definition such as INTEGER, VARCHAR, DATETIME, etc.","visibility":"protected"},"typeCategoryMap":{"type":"array","default":"[\\yii\\db\\Schema::TYPE_PK => self::CATEGORY_PK, \\yii\\db\\Schema::TYPE_UPK => self::CATEGORY_PK, \\yii\\db\\Schema::TYPE_BIGPK => self::CATEGORY_PK, \\yii\\db\\Schema::TYPE_UBIGPK => self::CATEGORY_PK, \\yii\\db\\Schema::TYPE_CHAR => self::CATEGORY_STRING, \\yii\\db\\Schema::TYPE_STRING => self::CATEGORY_STRING, \\yii\\db\\Schema::TYPE_TEXT => self::CATEGORY_STRING, \\yii\\db\\Schema::TYPE_TINYINT => self::CATEGORY_NUMERIC, \\yii\\db\\Schema::TYPE_SMALLINT => self::CATEGORY_NUMERIC, \\yii\\db\\Schema::TYPE_INTEGER => self::CATEGORY_NUMERIC, \\yii\\db\\Schema::TYPE_BIGINT => self::CATEGORY_NUMERIC, \\yii\\db\\Schema::TYPE_FLOAT => self::CATEGORY_NUMERIC, \\yii\\db\\Schema::TYPE_DOUBLE => self::CATEGORY_NUMERIC, \\yii\\db\\Schema::TYPE_DECIMAL => self::CATEGORY_NUMERIC, \\yii\\db\\Schema::TYPE_DATETIME => self::CATEGORY_TIME, \\yii\\db\\Schema::TYPE_TIMESTAMP => self::CATEGORY_TIME, \\yii\\db\\Schema::TYPE_TIME => self::CATEGORY_TIME, \\yii\\db\\Schema::TYPE_DATE => self::CATEGORY_TIME, \\yii\\db\\Schema::TYPE_BINARY => self::CATEGORY_OTHER, \\yii\\db\\Schema::TYPE_BOOLEAN => self::CATEGORY_NUMERIC, \\yii\\db\\Schema::TYPE_MONEY => self::CATEGORY_NUMERIC]","description":"Mapping of abstract column types (keys) to type categories (values).","static":true,"since":"2.0.43"},"typeDefinition":{"type":"string","description":"Abstract type plus optional length, for example `string(255)`.","access":"read-only","virtual":true,"since":"22.0"}},"methods":{"__construct":{"signature":"public function __construct(string $type, int|string|array|null $length = null, yii\\db\\Connection|null $db = null, array $config = [])","summary":"Create a column schema builder instance giving the type and value precision.","params":[{"name":"$type","type":"string","description":"Type of the column. See `$type`."},{"name":"$length","type":"int|string|array|null","default":"null","optional":true,"description":"Length or precision of the column. See `$length`."},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The current database connection. See `$db`."},{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties"}]},"__toString":{"signature":"public function __toString(): string","summary":"Builds the full string for the column's schema.","return":{"type":"string"}},"after":{"signature":"public function after(string $after): $this","summary":"Adds an `AFTER` constraint to the column.","params":[{"name":"$after","type":"string","description":"The column after which $this column will be added."}],"return":{"type":"$this"},"since":"2.0.8"},"append":{"signature":"public function append(string $sql): $this","summary":"Specify additional SQL to be appended to column definition.","params":[{"name":"$sql","type":"string","description":"The SQL string to be appended."}],"return":{"type":"$this"},"since":"2.0.9"},"buildAfterString":{"signature":"protected function buildAfterString(): string","summary":"Builds the after constraint for the column. Defaults to unsupported.","return":{"type":"string","description":"A string containing the AFTER constraint."},"visibility":"protected","since":"2.0.8"},"buildAppendString":{"signature":"protected function buildAppendString(): string","summary":"Builds the custom string that's appended to column definition.","return":{"type":"string","description":"Custom string to append."},"visibility":"protected","since":"2.0.9"},"buildCheckString":{"signature":"protected function buildCheckString(): string","summary":"Builds the check constraint for the column.","return":{"type":"string","description":"A string containing the CHECK constraint."},"visibility":"protected"},"buildCommentString":{"signature":"protected function buildCommentString(): string","summary":"Builds the comment specification for the column.","return":{"type":"string","description":"A string containing the COMMENT keyword and the comment itself"},"visibility":"protected","since":"2.0.8"},"buildCompleteString":{"signature":"protected function buildCompleteString(string $format): string","summary":"Returns the complete column definition from input format.","params":[{"name":"$format","type":"string","description":"The format of the definition."}],"return":{"type":"string","description":"A string containing the complete column definition."},"visibility":"protected","since":"2.0.8"},"buildDefaultString":{"signature":"protected function buildDefaultString(): string","summary":"Builds the default value specification for the column.","return":{"type":"string","description":"String with default value of column."},"visibility":"protected"},"buildDefaultValue":{"signature":"protected function buildDefaultValue(): string|null","summary":"Return the default value for the column.","return":{"type":"string|null","description":"String with default value of column."},"visibility":"protected"},"buildFirstString":{"signature":"protected function buildFirstString(): string","summary":"Builds the first constraint for the column. Defaults to unsupported.","return":{"type":"string","description":"A string containing the FIRST constraint."},"visibility":"protected","since":"2.0.8"},"buildLengthString":{"signature":"protected function buildLengthString(): string","summary":"Builds the length/precision part of the column.","return":{"type":"string"},"visibility":"protected"},"buildNotNullString":{"signature":"protected function buildNotNullString(): string","summary":"Builds the not null constraint for the column.","return":{"type":"string","description":"Returns 'NOT NULL' if `isNotNull()` is true, 'NULL' if `isNotNull()` is false or an empty string otherwise."},"visibility":"protected"},"buildUniqueString":{"signature":"protected function buildUniqueString(): string","summary":"Builds the unique constraint for the column.","return":{"type":"string","description":"Returns string 'UNIQUE' if `isUnique()` is true, otherwise it returns an empty string."},"visibility":"protected"},"buildUnsignedString":{"signature":"protected function buildUnsignedString(): string","summary":"Builds the unsigned string for column. Defaults to unsupported.","return":{"type":"string","description":"A string containing UNSIGNED keyword."},"visibility":"protected","since":"2.0.7"},"check":{"signature":"public function check(string $check): $this","summary":"Sets a `CHECK` constraint for the column.","params":[{"name":"$check","type":"string","description":"The SQL of the `CHECK` constraint to be added."}],"return":{"type":"$this"}},"comment":{"signature":"public function comment(string $comment): $this","summary":"Specifies the comment for column.","params":[{"name":"$comment","type":"string","description":"The comment"}],"return":{"type":"$this"},"since":"2.0.8"},"defaultExpression":{"signature":"public function defaultExpression(string $default): $this","summary":"Specify the default SQL expression for the column.","params":[{"name":"$default","type":"string","description":"The default value expression."}],"return":{"type":"$this"},"since":"2.0.7"},"defaultValue":{"signature":"public function defaultValue(mixed $default): $this","summary":"Specify the default value for the column.","params":[{"name":"$default","type":"mixed","description":"The default value."}],"return":{"type":"$this"}},"first":{"signature":"public function first(): $this","summary":"Adds an `FIRST` constraint to the column.","return":{"type":"$this"},"since":"2.0.8"},"getAppend":{"signature":"public function getAppend(): string|null","summary":"Returns the raw SQL fragment appended to the column definition.","return":{"type":"string|null","description":"Appended SQL fragment, or `null` when none is set."},"since":"22.0"},"getCategoryMap":{"signature":"public function getCategoryMap(): array","return":{"type":"array","description":"Mapping of abstract column types (keys) to type categories (values)."},"since":"2.0.43"},"getCheck":{"signature":"public function getCheck(): string|null","summary":"Returns the raw `CHECK` constraint expression of the column.","return":{"type":"string|null","description":"`CHECK` expression, or `null` when no constraint is set."},"since":"22.0"},"getDefault":{"signature":"public function getDefault(): mixed","summary":"Returns the raw default value of the column.","return":{"type":"mixed","description":"Scalar value, an `yii\\db\\Expression` when `defaultExpression()` was used, or `null` when unset."},"since":"22.0"},"getTypeCategory":{"signature":"protected function getTypeCategory(): string","summary":"Returns the category of the column type.","return":{"type":"string","description":"A string containing the column type category name."},"visibility":"protected","since":"2.0.8"},"getTypeDefinition":{"signature":"public function getTypeDefinition(): string","summary":"Returns the abstract type together with its length or precision, without any constraint keywords.","return":{"type":"string","description":"Abstract type plus optional length, for example `string(255)`."},"since":"22.0"},"isNotNull":{"signature":"public function isNotNull(): bool|null","summary":"Returns the nullability state of the column as a tri-state value.","return":{"type":"bool|null","description":"`true` for `NOT NULL`, `false` for `NULL`, or `null` when the nullability is unspecified."},"since":"22.0"},"isUnique":{"signature":"public function isUnique(): bool","summary":"Returns whether the column carries a `UNIQUE` constraint.","return":{"type":"bool","description":"`true` when a `UNIQUE` constraint is set; `false` otherwise."},"since":"22.0"},"notNull":{"signature":"public function notNull(): $this","summary":"Adds a `NOT NULL` constraint to the column.","return":{"type":"$this"}},"null":{"signature":"public function null(): $this","summary":"Adds a `NULL` constraint to the column.","return":{"type":"$this"},"since":"2.0.9"},"setCategoryMap":{"signature":"public function setCategoryMap(array $categoryMap): mixed","params":[{"name":"$categoryMap","type":"array","description":"Mapping of abstract column types (keys) to type categories (values)."}],"return":{"type":"mixed"},"since":"2.0.43"},"unique":{"signature":"public function unique(): $this","summary":"Adds a `UNIQUE` constraint to the column.","return":{"type":"$this"}},"unsigned":{"signature":"public function unsigned(): $this","summary":"Marks column as unsigned.","return":{"type":"$this"},"since":"2.0.7"}},"constants":{"CATEGORY_PK":{"value":"'pk'"},"CATEGORY_STRING":{"value":"'string'"},"CATEGORY_NUMERIC":{"value":"'numeric'"},"CATEGORY_TIME":{"value":"'time'"},"CATEGORY_OTHER":{"value":"'other'"}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\Command":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/command/","summary":"Command represents a SQL statement to be executed against a database.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"db":{"type":"yii\\db\\Connection","default":"null","description":"The DB connection that this command is associated with"},"fetchMode":{"type":"int","default":"\\PDO::FETCH_ASSOC","description":"The default fetch mode for this command."},"params":{"type":"array","default":"[]","description":"The parameters (name => value) that are bound to the current PDO statement."},"pdoStatement":{"type":"PDOStatement|null","default":"null","description":"The PDOStatement object that this command is associated with"},"pendingParams":{"type":"array","default":"[]","description":"Pending parameters to be bound to the current PDO statement.","visibility":"protected","since":"2.0.33"},"queryCacheDependency":{"type":"yii\\caching\\Dependency","default":"null","description":"The dependency to be associated with the cached query result for this command"},"queryCacheDuration":{"type":"int","default":"null","description":"The default number of seconds that query results can remain valid in cache."},"rawSql":{"type":"string","description":"The raw SQL with parameter values inserted into the corresponding placeholders in `$sql`.","virtual":true},"sql":{"type":"string","description":"The SQL statement to be executed.","virtual":true}},"methods":{"addCheck":{"signature":"public function addCheck(string $name, string $table, string $expression): $this","summary":"Creates a SQL command for adding a check constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the check constraint. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the check constraint will be added to. The name will be properly quoted by the method."},{"name":"$expression","type":"string","description":"The SQL of the `CHECK` constraint."}],"return":{"type":"$this","description":"The command object itself."},"since":"2.0.13"},"addColumn":{"signature":"public function addColumn(string $table, string $column, string $type): $this","summary":"Creates a SQL command for adding a new DB column.","params":[{"name":"$table","type":"string","description":"The table that the new column will be added to. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the new column. The name will be properly quoted by the method."},{"name":"$type","type":"string","description":"The column type. `yii\\db\\QueryBuilder::getColumnType()` will be called to convert the given column type to the physical one. For example, `string` will be converted as `varchar(255)`, and `string not null` becomes `varchar(255) not null`."}],"return":{"type":"$this","description":"The command object itself"}},"addCommentOnColumn":{"signature":"public function addCommentOnColumn(string $table, string $column, string $comment): $this","summary":"Builds a SQL command for adding comment to column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be commented. The column name will be properly quoted by the method."},{"name":"$comment","type":"string","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself"},"since":"2.0.8"},"addCommentOnTable":{"signature":"public function addCommentOnTable(string $table, string $comment): $this","summary":"Builds a SQL command for adding comment to table.","params":[{"name":"$table","type":"string","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$comment","type":"string","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself"},"since":"2.0.8"},"addDefaultValue":{"signature":"public function addDefaultValue(string $name, string $table, string $column, mixed $value): $this","summary":"Creates a SQL command for adding a default value constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the default value constraint. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the default value constraint will be added to. The name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to that the constraint will be added on. The name will be properly quoted by the method."},{"name":"$value","type":"mixed","description":"Default value."}],"return":{"type":"$this","description":"The command object itself."},"since":"2.0.13"},"addForeignKey":{"signature":"public function addForeignKey(string $name, string $table, string|array $columns, string $refTable, string|array $refColumns, string|null $delete = null, string|null $update = null): $this","summary":"Creates a SQL command for adding a foreign key constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the foreign key constraint."},{"name":"$table","type":"string","description":"The table that the foreign key constraint will be added to."},{"name":"$columns","type":"string|array","description":"The name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas."},{"name":"$refTable","type":"string","description":"The table that the foreign key references to."},{"name":"$refColumns","type":"string|array","description":"The name of the column that the foreign key references to. If there are multiple columns, separate them with commas."},{"name":"$delete","type":"string|null","default":"null","optional":true,"description":"The ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL"},{"name":"$update","type":"string|null","default":"null","optional":true,"description":"The ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL"}],"return":{"type":"$this","description":"The command object itself"}},"addPrimaryKey":{"signature":"public function addPrimaryKey(string $name, string $table, string|array $columns): $this","summary":"Creates a SQL command for adding a primary key constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the primary key constraint."},{"name":"$table","type":"string","description":"The table that the primary key constraint will be added to."},{"name":"$columns","type":"string|array","description":"Comma separated string or array of columns that the primary key will consist of."}],"return":{"type":"$this","description":"The command object itself."}},"addUnique":{"signature":"public function addUnique(string $name, string $table, string|array $columns): $this","summary":"Creates a SQL command for adding an unique constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the unique constraint. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the unique constraint will be added to. The name will be properly quoted by the method."},{"name":"$columns","type":"string|array","description":"The name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas. The name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself."},"since":"2.0.13"},"alterColumn":{"signature":"public function alterColumn(string $table, string $column, string $type): $this","summary":"Creates a SQL command for changing the definition of a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be changed. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be changed. The name will be properly quoted by the method."},{"name":"$type","type":"string","description":"The column type. `yii\\db\\QueryBuilder::getColumnType()` will be called to convert the give column type to the physical one. For example, `string` will be converted as `varchar(255)`, and `string not null` becomes `varchar(255) not null`."}],"return":{"type":"$this","description":"The command object itself"}},"batchInsert":{"signature":"public function batchInsert(string $table, array $columns, array|Generator $rows): $this","summary":"Creates a batch INSERT command.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"array","description":"The column names"},{"name":"$rows","type":"array|Generator","description":"The rows to be batch inserted into the table"}],"return":{"type":"$this","description":"The command object itself"}},"bindParam":{"signature":"public function bindParam(string|int $name, mixed &$value, int|null $dataType = null, int|null $length = null, mixed $driverOptions = null): $this","summary":"Binds a parameter to the SQL statement to be executed.","params":[{"name":"$name","type":"string|int","description":"Parameter identifier. For a prepared statement using named placeholders, this will be a parameter name of the form `:name`. For a prepared statement using question mark placeholders, this will be the 1-indexed position of the parameter."},{"name":"$value","type":"mixed","byReference":true,"description":"The PHP variable to bind to the SQL statement parameter (passed by reference)"},{"name":"$dataType","type":"int|null","default":"null","optional":true,"description":"SQL data type of the parameter. If null, the type is determined by the PHP type of the value."},{"name":"$length","type":"int|null","default":"null","optional":true,"description":"Length of the data type"},{"name":"$driverOptions","type":"mixed","default":"null","optional":true,"description":"The driver-specific options"}],"return":{"type":"$this","description":"The current command being executed"}},"bindPendingParams":{"signature":"protected function bindPendingParams(): mixed","summary":"Binds pending parameters that were registered via `bindValue()` and `bindValues()`.","return":{"type":"mixed"},"visibility":"protected"},"bindValue":{"signature":"public function bindValue(string|int $name, mixed $value, int|null $dataType = null): $this","summary":"Binds a value to a parameter.","params":[{"name":"$name","type":"string|int","description":"Parameter identifier. For a prepared statement using named placeholders, this will be a parameter name of the form `:name`. For a prepared statement using question mark placeholders, this will be the 1-indexed position of the parameter."},{"name":"$value","type":"mixed","description":"The value to bind to the parameter"},{"name":"$dataType","type":"int|null","default":"null","optional":true,"description":"SQL data type of the parameter. If null, the type is determined by the PHP type of the value."}],"return":{"type":"$this","description":"The current command being executed"}},"bindValues":{"signature":"public function bindValues(array $values): $this","summary":"Binds a list of values to the corresponding parameters.","params":[{"name":"$values","type":"array","description":"The values to be bound. This must be given in terms of an associative array with array keys being the parameter names, and array values the corresponding parameter values, e.g. `[':name' => 'John', ':age' => 25]`. By default, the PDO type of each value is determined by its PHP type. You may explicitly specify the PDO type by using a `yii\\db\\PdoValue` class: `new PdoValue(value, type)`, e.g. `[':name' => 'John', ':profile' => new PdoValue($profile, \\PDO::PARAM_LOB)]`."}],"return":{"type":"$this","description":"The current command being executed"}},"cache":{"signature":"public function cache(int|null $duration = null, yii\\caching\\Dependency|null $dependency = null): $this","summary":"Enables query cache for this command.","params":[{"name":"$duration","type":"int|null","default":"null","optional":true,"description":"The number of seconds that query result of this command can remain valid in the cache. If this is not set, the value of `yii\\db\\Connection::$queryCacheDuration` will be used instead. Use 0 to indicate that the cached data will never expire."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"The cache dependency associated with the cached query result."}],"return":{"type":"$this","description":"The command object itself"}},"cancel":{"signature":"public function cancel(): mixed","summary":"Cancels the execution of the SQL statement.","return":{"type":"mixed"}},"checkIntegrity":{"signature":"public function checkIntegrity(bool $check = true, string $schema = '', string $table = ''): $this","summary":"Builds a SQL command for enabling or disabling integrity check.","params":[{"name":"$check","type":"bool","default":"true","optional":true,"description":"Whether to turn on or off the integrity check."},{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema name of the tables. Defaults to empty string, meaning the current or default schema."},{"name":"$table","type":"string","default":"''","optional":true,"description":"The table name."}],"return":{"type":"$this","description":"The command object itself"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS"}]},"createIndex":{"signature":"public function createIndex(string $name, string $table, string|array $columns, bool $unique = false): $this","summary":"Creates a SQL command for creating a new index.","params":[{"name":"$name","type":"string","description":"The name of the index. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the new index will be created for. The table name will be properly quoted by the method."},{"name":"$columns","type":"string|array","description":"The column(s) that should be included in the index. If there are multiple columns, please separate them by commas. The column names will be properly quoted by the method."},{"name":"$unique","type":"bool","default":"false","optional":true,"description":"Whether to add UNIQUE constraint on the created index."}],"return":{"type":"$this","description":"The command object itself"}},"createTable":{"signature":"public function createTable(string $table, array $columns, string|null $options = null): $this","summary":"Creates a SQL command for creating a new DB table.","params":[{"name":"$table","type":"string","description":"The name of the table to be created. The name will be properly quoted by the method."},{"name":"$columns","type":"array","description":"The columns (name => definition) in the new table."},{"name":"$options","type":"string|null","default":"null","optional":true,"description":"Additional SQL fragment that will be appended to the generated SQL."}],"return":{"type":"$this","description":"The command object itself"}},"createView":{"signature":"public function createView(string $viewName, string|yii\\db\\Query $subquery): $this","summary":"Creates a SQL View.","params":[{"name":"$viewName","type":"string","description":"The name of the view to be created."},{"name":"$subquery","type":"string|yii\\db\\Query","description":"The select statement which defines the view. This can be either a string or a `yii\\db\\Query` object."}],"return":{"type":"$this","description":"The command object itself."},"since":"2.0.14"},"delete":{"signature":"public function delete(string $table, string|array $condition = '', array $params = []): $this","summary":"Creates a DELETE command.","params":[{"name":"$table","type":"string","description":"The table where the data will be deleted from."},{"name":"$condition","type":"string|array","default":"''","optional":true,"description":"The condition that will be put in the WHERE part. Please refer to `yii\\db\\Query::where()` on how to specify condition."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be bound to the command"}],"return":{"type":"$this","description":"The command object itself"}},"dropCheck":{"signature":"public function dropCheck(string $name, string $table): $this","summary":"Creates a SQL command for dropping a check constraint.","params":[{"name":"$name","type":"string","description":"The name of the check constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose check constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself."},"since":"2.0.13"},"dropColumn":{"signature":"public function dropColumn(string $table, string $column): $this","summary":"Creates a SQL command for dropping a DB column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be dropped. The name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be dropped. The name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself"}},"dropCommentFromColumn":{"signature":"public function dropCommentFromColumn(string $table, string $column): $this","summary":"Builds a SQL command for dropping comment from column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be commented. The column name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself"},"since":"2.0.8"},"dropCommentFromTable":{"signature":"public function dropCommentFromTable(string $table): $this","summary":"Builds a SQL command for dropping comment from table.","params":[{"name":"$table","type":"string","description":"The table whose column is to be commented. The table name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself"},"since":"2.0.8"},"dropDefaultValue":{"signature":"public function dropDefaultValue(string $name, string $table): $this","summary":"Creates a SQL command for dropping a default value constraint.","params":[{"name":"$name","type":"string","description":"The name of the default value constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose default value constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself."},"since":"2.0.13"},"dropForeignKey":{"signature":"public function dropForeignKey(string $name, string $table): $this","summary":"Creates a SQL command for dropping a foreign key constraint.","params":[{"name":"$name","type":"string","description":"The name of the foreign key constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose foreign is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself"}},"dropIndex":{"signature":"public function dropIndex(string $name, string $table): $this","summary":"Creates a SQL command for dropping an index.","params":[{"name":"$name","type":"string","description":"The name of the index to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose index is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself"}},"dropPrimaryKey":{"signature":"public function dropPrimaryKey(string $name, string $table): $this","summary":"Creates a SQL command for removing a primary key constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the primary key constraint to be removed."},{"name":"$table","type":"string","description":"The table that the primary key constraint will be removed from."}],"return":{"type":"$this","description":"The command object itself"}},"dropTable":{"signature":"public function dropTable(string $table): $this","summary":"Creates a SQL command for dropping a DB table.","params":[{"name":"$table","type":"string","description":"The table to be dropped. The name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself"}},"dropUnique":{"signature":"public function dropUnique(string $name, string $table): $this","summary":"Creates a SQL command for dropping an unique constraint.","params":[{"name":"$name","type":"string","description":"The name of the unique constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose unique constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself."},"since":"2.0.13"},"dropView":{"signature":"public function dropView(string $viewName): $this","summary":"Drops a SQL View.","params":[{"name":"$viewName","type":"string","description":"The name of the view to be dropped."}],"return":{"type":"$this","description":"The command object itself."},"since":"2.0.14"},"execute":{"signature":"public function execute(): int","summary":"Executes the SQL statement.","return":{"type":"int","description":"Number of rows affected by the execution."},"throws":[{"type":"yii\\db\\Exception","description":"execution failed"}]},"executeResetSequence":{"signature":"public function executeResetSequence(string $table, int|null $value = null): mixed","summary":"Executes a db command resetting the sequence value of a table's primary key.","params":[{"name":"$table","type":"string","description":"The name of the table whose primary key sequence is reset."},{"name":"$value","type":"int|null","default":"null","optional":true,"description":"The integer value for the primary key of the next new row inserted. If this is not set, the next new row's primary key will have the maximum existing value `+1`."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}],"since":"2.0.16"},"getCacheKey":{"signature":"protected function getCacheKey(string $method, int $fetchMode, mixed $rawSql): array","summary":"Returns the cache key for the query.","params":[{"name":"$method","type":"string","description":"Method of PDOStatement to be called"},{"name":"$fetchMode","type":"int","description":"The result fetch mode. Please refer to [PHP manual](https://www.php.net/manual/en/function.PDOStatement-setFetchMode.php) for valid fetch modes."},{"name":"$rawSql","type":"mixed"}],"return":{"type":"array","description":"The cache key"},"visibility":"protected","since":"2.0.16"},"getRawSql":{"signature":"public function getRawSql(): string","summary":"Returns the raw SQL by inserting parameter values into the corresponding placeholders in `$sql`.","return":{"type":"string","description":"The raw SQL with parameter values inserted into the corresponding placeholders in `$sql`."}},"getSql":{"signature":"public function getSql(): string","summary":"Returns the SQL statement for this command.","return":{"type":"string","description":"The SQL statement to be executed"}},"insert":{"signature":"public function insert(string $table, array|yii\\db\\Query $columns): $this","summary":"Creates an INSERT command.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"array|yii\\db\\Query","description":"The column data (name => value) to be inserted into the table or instance of Query (`yii\\db\\Query`) to perform INSERT INTO ... SELECT SQL statement. Passing of Query (`yii\\db\\Query`) is available since version 2.0.11."}],"return":{"type":"$this","description":"The command object itself"}},"internalExecute":{"signature":"protected function internalExecute(string|null $rawSql): mixed","summary":"Executes a prepared statement.","params":[{"name":"$rawSql","type":"string|null","description":"The rawSql if it has been created."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\db\\Exception","description":"if execution failed."}],"visibility":"protected","since":"2.0.14"},"logQuery":{"signature":"protected function logQuery(string $category): array","summary":"Logs the current database query if query logging is enabled and returns the profiling token if profiling is enabled.","params":[{"name":"$category","type":"string","description":"The log category."}],"return":{"type":"array","description":"Array of two elements, the first is boolean of whether profiling is enabled or not. The second is the rawSql if it has been created."},"visibility":"protected"},"noCache":{"signature":"public function noCache(): $this","summary":"Disables query cache for this command.","return":{"type":"$this","description":"The command object itself"}},"prepare":{"signature":"public function prepare(bool|null $forRead = null): mixed","summary":"Prepares the SQL statement to be executed.","params":[{"name":"$forRead","type":"bool|null","default":"null","optional":true,"description":"Whether this method is called for a read query. If null, it means the SQL statement should be used to determine whether it is for read or write."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\db\\Exception","description":"if there is any DB error"}]},"query":{"signature":"public function query(): yii\\db\\DataReader","summary":"Executes the SQL statement and returns query result.","return":{"type":"yii\\db\\DataReader","description":"The reader object for fetching the query result"},"throws":[{"type":"yii\\db\\Exception","description":"execution failed"}]},"queryAll":{"signature":"public function queryAll(int|null $fetchMode = null): array","summary":"Executes the SQL statement and returns ALL rows at once.","params":[{"name":"$fetchMode","type":"int|null","default":"null","optional":true,"description":"The result fetch mode. Please refer to [PHP manual](https://www.php.net/manual/en/function.PDOStatement-setFetchMode.php) for valid fetch modes. If this parameter is null, the value set in `$fetchMode` will be used."}],"return":{"type":"array","description":"All rows of the query result. Each array element is an array representing a row of data. An empty array is returned if the query results in nothing."},"throws":[{"type":"yii\\db\\Exception","description":"execution failed"}]},"queryColumn":{"signature":"public function queryColumn(): array","summary":"Executes the SQL statement and returns the first column of the result.","return":{"type":"array","description":"The first column of the query result. Empty array is returned if the query results in nothing."},"throws":[{"type":"yii\\db\\Exception","description":"execution failed"}]},"queryInternal":{"signature":"protected function queryInternal(string $method, int|null $fetchMode = null): mixed","summary":"Performs the actual DB query of a SQL statement.","params":[{"name":"$method","type":"string","description":"Method of PDOStatement to be called"},{"name":"$fetchMode","type":"int|null","default":"null","optional":true,"description":"The result fetch mode. Please refer to [PHP manual](https://www.php.net/manual/en/function.PDOStatement-setFetchMode.php) for valid fetch modes. If this parameter is null, the value set in `$fetchMode` will be used."}],"return":{"type":"mixed","description":"The method execution result"},"throws":[{"type":"yii\\db\\Exception","description":"if the query causes any problem"}],"visibility":"protected"},"queryOne":{"signature":"public function queryOne(int|null $fetchMode = null): array|false","summary":"Executes the SQL statement and returns the first row of the result.","params":[{"name":"$fetchMode","type":"int|null","default":"null","optional":true,"description":"The result fetch mode. Please refer to [PHP manual](https://www.php.net/manual/en/pdostatement.setfetchmode.php) for valid fetch modes. If this parameter is null, the value set in `$fetchMode` will be used."}],"return":{"type":"array|false","description":"The first row (in terms of an array) of the query result. False is returned if the query results in nothing."},"throws":[{"type":"yii\\db\\Exception","description":"execution failed"}]},"queryScalar":{"signature":"public function queryScalar(): string|int|null|false","summary":"Executes the SQL statement and returns the value of the first column in the first row of data.","return":{"type":"string|int|null|false","description":"The value of the first column in the first row of the query result. False is returned if there is no value."},"throws":[{"type":"yii\\db\\Exception","description":"execution failed"}]},"refreshTableSchema":{"signature":"protected function refreshTableSchema(): mixed","summary":"Refreshes table schema, which was marked by `requireTableSchemaRefresh()`.","return":{"type":"mixed"},"visibility":"protected","since":"2.0.6"},"renameColumn":{"signature":"public function renameColumn(string $table, string $oldName, string $newName): $this","summary":"Creates a SQL command for renaming a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be renamed. The name will be properly quoted by the method."},{"name":"$oldName","type":"string","description":"The old name of the column. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new name of the column. The name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself"}},"renameTable":{"signature":"public function renameTable(string $table, string $newName): $this","summary":"Creates a SQL command for renaming a DB table.","params":[{"name":"$table","type":"string","description":"The table to be renamed. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new table name. The name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself"}},"requireTableSchemaRefresh":{"signature":"protected function requireTableSchemaRefresh(string $name): $this","summary":"Marks a specified table schema to be refreshed after command execution.","params":[{"name":"$name","type":"string","description":"Name of the table, which schema should be refreshed."}],"return":{"type":"$this","description":"This command instance"},"visibility":"protected","since":"2.0.6"},"requireTransaction":{"signature":"protected function requireTransaction(string|null $isolationLevel = null): $this","summary":"Marks the command to be executed in transaction.","params":[{"name":"$isolationLevel","type":"string|null","default":"null","optional":true,"description":"The isolation level to use for this transaction. See `yii\\db\\Transaction::begin()` for details."}],"return":{"type":"$this","description":"This command instance."},"visibility":"protected","since":"2.0.14"},"reset":{"signature":"protected function reset(): mixed","summary":"Resets command properties to their initial state.","return":{"type":"mixed"},"visibility":"protected","since":"2.0.13"},"resetSequence":{"signature":"public function resetSequence(string $table, int|null $value = null): $this","summary":"Creates a SQL command for resetting the sequence value of a table's primary key.","params":[{"name":"$table","type":"string","description":"The name of the table whose primary key sequence will be reset."},{"name":"$value","type":"int|null","default":"null","optional":true,"description":"The integer value for the primary key of the next new row inserted. If this is not set, the next new row's primary key will have the maximum existing value `+1`."}],"return":{"type":"$this","description":"The command object itself."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}]},"setRawSql":{"signature":"public function setRawSql(string $sql): $this","summary":"Specifies the SQL statement to be executed. The SQL statement will not be modified in any way.","params":[{"name":"$sql","type":"string","description":"The SQL statement to be set."}],"return":{"type":"$this","description":"This command instance"},"since":"2.0.13"},"setRetryHandler":{"signature":"protected function setRetryHandler(callable $handler): $this","summary":"Sets a callable (e.g. anonymous function) that is called when `yii\\db\\Exception` is thrown when executing the command. The signature of the callable should be:","params":[{"name":"$handler","type":"callable","description":"A PHP callback to handle database exceptions."}],"return":{"type":"$this","description":"This command instance."},"visibility":"protected","since":"2.0.14"},"setSql":{"signature":"public function setSql(string $sql): $this","summary":"Specifies the SQL statement to be executed. The SQL statement will be quoted using `yii\\db\\Connection::quoteSql()`.","params":[{"name":"$sql","type":"string","description":"The SQL statement to be set."}],"return":{"type":"$this","description":"This command instance"}},"truncateTable":{"signature":"public function truncateTable(string $table): $this","summary":"Creates a SQL command for truncating a DB table.","params":[{"name":"$table","type":"string","description":"The table to be truncated. The name will be properly quoted by the method."}],"return":{"type":"$this","description":"The command object itself"}},"update":{"signature":"public function update(string $table, array $columns, string|array $condition = '', array $params = []): $this","summary":"Creates an UPDATE command.","params":[{"name":"$table","type":"string","description":"The table to be updated."},{"name":"$columns","type":"array","description":"The column data (name => value) to be updated."},{"name":"$condition","type":"string|array","default":"''","optional":true,"description":"The condition that will be put in the WHERE part. Please refer to `yii\\db\\Query::where()` on how to specify condition."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be bound to the command"}],"return":{"type":"$this","description":"The command object itself"}},"upsert":{"signature":"public function upsert(string $table, array|yii\\db\\Query $insertColumns, array|bool $updateColumns = true, array $params = []): $this","summary":"Creates a command to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into/updated in."},{"name":"$insertColumns","type":"array|yii\\db\\Query","description":"The column data (name => value) to be inserted into the table or instance of `yii\\db\\Query` to perform `INSERT INTO ... SELECT` SQL statement."},{"name":"$updateColumns","type":"array|bool","default":"true","optional":true,"description":"The column data (name => value) to be updated if they already exist. If `true` is passed, the column data will be updated to match the insert column data. If `false` is passed, no update will be performed if the column data already exists."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be bound to the command."}],"return":{"type":"$this","description":"The command object itself."},"since":"2.0.14"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\db\\Connection":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/connection/","summary":"Connection represents a connection to a database via [PDO](https://www.php.net/manual/en/book.pdo.php).","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"attributes":{"type":"array","default":"null","description":"PDO attributes (name => value) that should be set when calling `open()` to establish a DB connection."},"charset":{"type":"string|null","default":"null","description":"The charset used for database connection."},"commandMap":{"type":"array","default":"['pgsql' => 'yii\\db\\Command', 'mysqli' => 'yii\\db\\Command', 'mysql' => 'yii\\db\\Command', 'sqlite' => 'yii\\db\\sqlite\\Command', 'sqlite2' => 'yii\\db\\sqlite\\Command', 'sqlsrv' => 'yii\\db\\mssql\\Command', 'oci' => 'yii\\db\\oci\\Command', 'mssql' => 'yii\\db\\mssql\\Command', 'dblib' => 'yii\\db\\mssql\\Command']","description":"Mapping between PDO driver names and `yii\\db\\Command` classes.","since":"2.0.14"},"driverName":{"type":"string","description":"Name of the DB driver.","virtual":true},"dsn":{"type":"string","default":"null","description":"The Data Source Name, or DSN, contains the information required to connect to the database."},"effectiveCharset":{"type":"string|null","description":"The effective connection charset, or `null` when the connection relies on the database server defaults.","access":"read-only","virtual":true},"emulatePrepare":{"type":"bool|null","default":"null","description":"Whether to turn on prepare emulation."},"enableLogging":{"type":"bool","default":"true","description":"Whether to enable logging of database queries.","since":"2.0.12"},"enableProfiling":{"type":"bool","default":"true","description":"Whether to enable profiling of opening database connection and database queries.","since":"2.0.12"},"enableQueryCache":{"type":"bool","default":"true","description":"Whether to enable query caching."},"enableSavepoint":{"type":"bool","default":"true","description":"Whether to enable [savepoint](https://en.wikipedia.org/wiki/Savepoint)."},"enableSchemaCache":{"type":"bool","default":"false","description":"Whether to enable schema caching."},"enableSlaves":{"type":"bool","default":"true","description":"Whether to enable read/write splitting by using `$slaves` to read data."},"isActive":{"type":"bool","description":"Whether the DB connection is established.","access":"read-only","virtual":true},"isSybase":{"type":"bool","default":"false","description":"If the database connected via pdo_dblib is SyBase.","since":"2.0.38"},"lastInsertID":{"type":"string","description":"The row ID of the last row inserted, or the last value retrieved from the sequence object.","access":"read-only","virtual":true},"master":{"type":"yii\\db\\Connection|null","description":"The currently active master connection. `null` is returned if there is no master available.","access":"read-only","virtual":true},"masterConfig":{"type":"array","default":"[]","description":"The configuration that should be merged with every master configuration listed in `$masters`."},"masterPdo":{"type":"PDO","description":"The PDO instance for the currently active master connection.","access":"read-only","virtual":true},"masters":{"type":"array","default":"[]","description":"List of master connection configurations."},"password":{"type":"string|null","default":"null","description":"The password for establishing DB connection."},"pdo":{"type":"PDO|null","default":"null","description":"The PHP PDO instance associated with this DB connection."},"pdoClass":{"type":"string|null","default":"null","description":"Custom PDO wrapper class."},"queryBuilder":{"type":"array","description":"The `yii\\db\\QueryBuilder` properties to be configured.","virtual":true},"queryCache":{"type":"yii\\caching\\CacheInterface|string","default":"'cache'","description":"The cache object or the ID of the cache application component that is used for query caching."},"queryCacheDuration":{"type":"int","default":"3600","description":"The default number of seconds that query results can remain valid in cache."},"schema":{"type":"yii\\db\\TSchema","description":"The schema information for the database opened by this connection.","access":"read-only","virtual":true},"schemaCache":{"type":"yii\\caching\\CacheInterface|string","default":"'cache'","description":"The cache object or the ID of the cache application component that is used to cache the table metadata."},"schemaCacheDuration":{"type":"int","default":"3600","description":"Number of seconds that table metadata can remain valid in cache."},"schemaCacheExclude":{"type":"array","default":"[]","description":"List of tables whose metadata should NOT be cached."},"schemaMap":{"type":"array","default":"['pgsql' => 'yii\\db\\pgsql\\Schema', 'mysqli' => 'yii\\db\\mysql\\Schema', 'mysql' => 'yii\\db\\mysql\\Schema', 'sqlite' => 'yii\\db\\sqlite\\Schema', 'sqlite2' => 'yii\\db\\sqlite\\Schema', 'sqlsrv' => 'yii\\db\\mssql\\Schema', 'oci' => 'yii\\db\\oci\\Schema', 'mssql' => 'yii\\db\\mssql\\Schema', 'dblib' => 'yii\\db\\mssql\\Schema']","description":"Mapping between PDO driver names and `yii\\db\\Schema` classes."},"serverRetryInterval":{"type":"int","default":"600","description":"The retry interval in seconds for dead servers listed in `$masters` and `$slaves`."},"serverStatusCache":{"type":"yii\\caching\\CacheInterface|string|false","default":"'cache'","description":"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`."},"serverVersion":{"type":"string","description":"Server version as a string.","access":"read-only","virtual":true},"shuffleMasters":{"type":"bool","default":"true","description":"Whether to shuffle `$masters` before getting one.","since":"2.0.11"},"slave":{"type":"yii\\db\\Connection|null","description":"The currently active slave connection. `null` is returned if there is no slave available and `$fallbackToMaster` is false.","access":"read-only","virtual":true},"slaveConfig":{"type":"array","default":"[]","description":"The configuration that should be merged with every slave configuration listed in `$slaves`."},"slavePdo":{"type":"PDO|null","description":"The PDO instance for the currently active slave connection. `null` is returned if no slave connection is available and `$fallbackToMaster` is false.","access":"read-only","virtual":true},"slaves":{"type":"array","default":"[]","description":"List of slave connection configurations."},"tablePrefix":{"type":"string","default":"''","description":"The common prefix or suffix for table names."},"transaction":{"type":"yii\\db\\Transaction|null","description":"The currently active transaction.","access":"read-only","virtual":true},"transactionMap":{"type":"array|array>","default":"['pgsql' => \\yii\\db\\pgsql\\Transaction::class, 'mysqli' => \\yii\\db\\Transaction::class, 'mysql' => \\yii\\db\\Transaction::class, 'sqlite' => \\yii\\db\\Transaction::class, 'sqlite2' => \\yii\\db\\Transaction::class, 'sqlsrv' => \\yii\\db\\Transaction::class, 'oci' => \\yii\\db\\Transaction::class, 'mssql' => \\yii\\db\\Transaction::class, 'dblib' => \\yii\\db\\Transaction::class]","description":"Mapping between PDO driver names and `yii\\db\\Transaction` classes or configurations.","since":"22.0"},"username":{"type":"string|null","default":"null","description":"The username for establishing DB connection."}},"methods":{"__clone":{"signature":"public function __clone(): mixed","summary":"Reset the connection after cloning.","return":{"type":"mixed"}},"__sleep":{"signature":"public function __sleep(): array","summary":"Close the connection before serializing.","return":{"type":"array"}},"beginTransaction":{"signature":"public function beginTransaction(string|null $isolationLevel = null): yii\\db\\Transaction","summary":"Starts a transaction.","params":[{"name":"$isolationLevel","type":"string|null","default":"null","optional":true,"description":"The isolation level to use for this transaction. See `yii\\db\\Transaction::begin()` for details."}],"return":{"type":"yii\\db\\Transaction","description":"The transaction initiated"}},"cache":{"signature":"public function cache(callable $callable, int|null $duration = null, yii\\caching\\Dependency|null $dependency = null): mixed","summary":"Uses query cache for the queries performed with the callable.","params":[{"name":"$callable","type":"callable","description":"A PHP callable that contains DB queries which will make use of query cache. The signature of the callable is `function (Connection $db)`."},{"name":"$duration","type":"int|null","default":"null","optional":true,"description":"The number of seconds that query results can remain valid in the cache. If this is not set, the value of `$queryCacheDuration` will be used instead. Use 0 to indicate that the cached data will never expire."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"The cache dependency associated with the cached query results."}],"return":{"type":"mixed","description":"The return result of the callable"},"throws":[{"type":"Throwable","description":"if there is any exception during query"}]},"close":{"signature":"public function close(): mixed","summary":"Closes the currently active DB connection.","return":{"type":"mixed"}},"createCommand":{"signature":"public function createCommand(string|null $sql = null, array $params = []): yii\\db\\Command","summary":"Creates a command for execution.","params":[{"name":"$sql","type":"string|null","default":"null","optional":true,"description":"The SQL statement to be executed"},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be bound to the SQL statement"}],"return":{"type":"yii\\db\\Command","description":"The DB command"}},"createPdoInstance":{"signature":"protected function createPdoInstance(): PDO","summary":"Creates the PDO instance.","return":{"type":"PDO","description":"The pdo instance"},"visibility":"protected"},"getDriverName":{"signature":"public function getDriverName(): string|null","summary":"Returns the name of the DB driver. Based on the the current `$dsn`, in case it was not set explicitly by an end user.","return":{"type":"string|null","description":"Name of the DB driver"}},"getEffectiveCharset":{"signature":"public function getEffectiveCharset(): string|null","summary":"Returns the charset the connection effectively uses.","return":{"type":"string|null","description":"The effective connection charset, or `null` when the connection relies on the database server defaults."},"since":"22.0"},"getIsActive":{"signature":"public function getIsActive(): bool","summary":"Returns a value indicating whether the DB connection is established.","return":{"type":"bool","description":"Whether the DB connection is established"}},"getLastInsertID":{"signature":"public function getLastInsertID(string $sequenceName = ''): string","summary":"Returns the ID of the last inserted row or sequence value.","params":[{"name":"$sequenceName","type":"string","default":"''","optional":true,"description":"Name of the sequence object (required by some DBMS)"}],"return":{"type":"string","description":"The row ID of the last row inserted, or the last value retrieved from the sequence object"}},"getMaster":{"signature":"public function getMaster(): yii\\db\\Connection|null","summary":"Returns the currently active master connection.","return":{"type":"yii\\db\\Connection|null","description":"The currently active master connection. `null` is returned if there is no master available."},"since":"2.0.11"},"getMasterPdo":{"signature":"public function getMasterPdo(): PDO","summary":"Returns the PDO instance for the currently active master connection.","return":{"type":"PDO","description":"The PDO instance for the currently active master connection."}},"getQueryBuilder":{"signature":"public function getQueryBuilder(): yii\\db\\TQueryBuilder","summary":"Returns the query builder for the current DB connection.","return":{"type":"yii\\db\\TQueryBuilder","description":"The query builder for the current DB connection."}},"getSchema":{"signature":"public function getSchema(): yii\\db\\TSchema","summary":"Returns the schema information for the database opened by this connection.","return":{"type":"yii\\db\\TSchema","description":"The schema information for the database opened by this connection."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if there is no support for the current driver type"}]},"getServerVersion":{"signature":"public function getServerVersion(): string","summary":"Returns a server version as a string comparable by `version_compare()`.","return":{"type":"string","description":"Server version as a string."},"since":"2.0.14"},"getSlave":{"signature":"public function getSlave(bool $fallbackToMaster = true): yii\\db\\Connection|null","summary":"Returns the currently active slave connection.","params":[{"name":"$fallbackToMaster","type":"bool","default":"true","optional":true,"description":"Whether to return a master connection in case there is no slave connection available."}],"return":{"type":"yii\\db\\Connection|null","description":"The currently active slave connection. `null` is returned if there is no slave available and `$fallbackToMaster` is false."}},"getSlavePdo":{"signature":"public function getSlavePdo(bool $fallbackToMaster = true): PDO|null","summary":"Returns the PDO instance for the currently active slave connection.","params":[{"name":"$fallbackToMaster","type":"bool","default":"true","optional":true,"description":"Whether to return a master PDO in case none of the slave connections is available."}],"return":{"type":"PDO|null","description":"The PDO instance for the currently active slave connection. `null` is returned if no slave connection is available and `$fallbackToMaster` is false."}},"getTableSchema":{"signature":"public function getTableSchema(string $name, bool $refresh = false): yii\\db\\TableSchema|null","summary":"Obtains the schema information for the named table.","params":[{"name":"$name","type":"string","description":"Table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the table schema even if it is found in the cache."}],"return":{"type":"yii\\db\\TableSchema|null","description":"Table schema information. Null if the named table does not exist."}},"getTransaction":{"signature":"public function getTransaction(): yii\\db\\Transaction|null","summary":"Returns the currently active transaction.","return":{"type":"yii\\db\\Transaction|null","description":"The currently active transaction. Null if no active transaction."}},"initConnection":{"signature":"protected function initConnection(): mixed","summary":"Initializes the DB connection.","return":{"type":"mixed"},"visibility":"protected"},"noCache":{"signature":"public function noCache(callable $callable): mixed","summary":"Disables query cache temporarily.","params":[{"name":"$callable","type":"callable","description":"A PHP callable that contains DB queries which should not use query cache. The signature of the callable is `function (Connection $db)`."}],"return":{"type":"mixed","description":"The return result of the callable"},"throws":[{"type":"Throwable","description":"if there is any exception during query"}]},"open":{"signature":"public function open(): mixed","summary":"Establishes a DB connection.","return":{"type":"mixed"},"throws":[{"type":"yii\\db\\Exception","description":"if connection fails"}]},"openFromPool":{"signature":"protected function openFromPool(array $pool, array $sharedConfig): yii\\db\\Connection|null","summary":"Opens the connection to a server in the pool.","params":[{"name":"$pool","type":"array","description":"The list of connection configurations in the server pool"},{"name":"$sharedConfig","type":"array","description":"The configuration common to those given in `$pool`."}],"return":{"type":"yii\\db\\Connection|null","description":"The opened DB connection, or `null` if no server is available"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if a configuration does not specify \"dsn\""}],"visibility":"protected"},"openFromPoolSequentially":{"signature":"protected function openFromPoolSequentially(array $pool, array $sharedConfig): yii\\db\\Connection|null","summary":"Opens the connection to a server in the pool.","params":[{"name":"$pool","type":"array","description":"The list of connection configurations in the server pool"},{"name":"$sharedConfig","type":"array","description":"The configuration common to those given in `$pool`."}],"return":{"type":"yii\\db\\Connection|null","description":"The opened DB connection, or `null` if no server is available"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if a configuration does not specify \"dsn\""}],"visibility":"protected","since":"2.0.11"},"quoteColumnName":{"signature":"public function quoteColumnName(string $name): string","summary":"Quotes a column name for use in a query.","params":[{"name":"$name","type":"string","description":"Column name"}],"return":{"type":"string","description":"The properly quoted column name"}},"quoteSql":{"signature":"public function quoteSql(string $sql): string","summary":"Processes a SQL statement by quoting table and column names that are enclosed within double brackets.","params":[{"name":"$sql","type":"string","description":"The SQL to be quoted"}],"return":{"type":"string","description":"The quoted SQL"}},"quoteTableName":{"signature":"public function quoteTableName(string $name): string","summary":"Quotes a table name for use in a query.","params":[{"name":"$name","type":"string","description":"Table name"}],"return":{"type":"string","description":"The properly quoted table name"}},"quoteValue":{"signature":"public function quoteValue(string $value): string","summary":"Quotes a string value for use in a query.","params":[{"name":"$value","type":"string","description":"String to be quoted"}],"return":{"type":"string","description":"The properly quoted string"}},"setDriverName":{"signature":"public function setDriverName(string $driverName): mixed","summary":"Changes the current driver name.","params":[{"name":"$driverName","type":"string","description":"Name of the DB driver"}],"return":{"type":"mixed"}},"setQueryBuilder":{"signature":"public function setQueryBuilder(array $value): mixed","summary":"Can be used to set `yii\\db\\QueryBuilder` configuration via Connection configuration array.","params":[{"name":"$value","type":"array","description":"The `yii\\db\\QueryBuilder` properties to be configured."}],"return":{"type":"mixed"},"since":"2.0.14"},"transaction":{"signature":"public function transaction(callable $callback, string|null $isolationLevel = null): mixed","summary":"Executes callback provided in a transaction.","params":[{"name":"$callback","type":"callable","description":"A valid PHP callback that performs the job. Accepts connection instance as parameter."},{"name":"$isolationLevel","type":"string|null","default":"null","optional":true,"description":"The isolation level to use for this transaction. See `yii\\db\\Transaction::begin()` for details."}],"return":{"type":"mixed","description":"Result of callback function"},"throws":[{"type":"Throwable","description":"if there is any exception during query. In this case the transaction will be rolled back."}]},"useMaster":{"signature":"public function useMaster(callable $callback): mixed","summary":"Executes the provided callback by using the master connection.","params":[{"name":"$callback","type":"callable","description":"A PHP callable to be executed by this method. Its signature is `function (Connection $db)`. Its return value will be returned by this method."}],"return":{"type":"mixed","description":"The return value of the callback"},"throws":[{"type":"Throwable","description":"if there is any exception thrown from the callback"}]}},"events":{"EVENT_AFTER_OPEN":{"value":"'afterOpen'","type":"yii\\base\\Event","description":"An event that is triggered after a DB connection is established"},"EVENT_BEGIN_TRANSACTION":{"value":"'beginTransaction'","type":"yii\\base\\Event","description":"An event that is triggered right before a top-level transaction is started"},"EVENT_COMMIT_TRANSACTION":{"value":"'commitTransaction'","type":"yii\\base\\Event","description":"An event that is triggered right after a top-level transaction is committed"},"EVENT_ROLLBACK_TRANSACTION":{"value":"'rollbackTransaction'","type":"yii\\base\\Event","description":"An event that is triggered right after a top-level transaction is rolled back"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\db\\Constraint":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/constraint/","summary":"Constraint represents the metadata of a table constraint.","since":"2.0.13","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"columnNames":{"type":"string[]|null","default":"null","description":"List of column names the constraint belongs to."},"name":{"type":"string|null","default":"null","description":"The constraint name."}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\ConstraintFinderInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/db/constraintfinderinterface/","summary":"ConstraintFinderInterface defines methods for getting a table constraint information.","since":"2.0.14","methods":{"getSchemaChecks":{"signature":"abstract public function getSchemaChecks(string $schema = '', bool $refresh = false): yii\\db\\CheckConstraint[][]","summary":"Returns check constraints for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available."}],"return":{"type":"yii\\db\\CheckConstraint[][]","description":"Check constraints for all tables in the database. Each array element is an array of `yii\\db\\CheckConstraint` or its child classes."},"abstract":true},"getSchemaDefaultValues":{"signature":"abstract public function getSchemaDefaultValues(string $schema = '', bool $refresh = false): yii\\db\\DefaultValueConstraint[]","summary":"Returns default value constraints for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available."}],"return":{"type":"yii\\db\\DefaultValueConstraint[]","description":"Default value constraints for all tables in the database. Each array element is an array of `yii\\db\\DefaultValueConstraint` or its child classes."},"abstract":true},"getSchemaForeignKeys":{"signature":"abstract public function getSchemaForeignKeys(string $schema = '', bool $refresh = false): yii\\db\\ForeignKeyConstraint[][]","summary":"Returns foreign keys for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available."}],"return":{"type":"yii\\db\\ForeignKeyConstraint[][]","description":"Foreign keys for all tables in the database. Each array element is an array of `yii\\db\\ForeignKeyConstraint` or its child classes."},"abstract":true},"getSchemaIndexes":{"signature":"abstract public function getSchemaIndexes(string $schema = '', bool $refresh = false): yii\\db\\IndexConstraint[][]","summary":"Returns indexes for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available."}],"return":{"type":"yii\\db\\IndexConstraint[][]","description":"Indexes for all tables in the database. Each array element is an array of `yii\\db\\IndexConstraint` or its child classes."},"abstract":true},"getSchemaPrimaryKeys":{"signature":"abstract public function getSchemaPrimaryKeys(string $schema = '', bool $refresh = false): yii\\db\\Constraint[]","summary":"Returns primary keys for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is `false`, cached data may be returned if available."}],"return":{"type":"yii\\db\\Constraint[]","description":"Primary keys for all tables in the database. Each array element is an instance of `yii\\db\\Constraint` or its child class."},"abstract":true},"getSchemaUniques":{"signature":"abstract public function getSchemaUniques(string $schema = '', bool $refresh = false): yii\\db\\Constraint[][]","summary":"Returns unique constraints for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available."}],"return":{"type":"yii\\db\\Constraint[][]","description":"Unique constraints for all tables in the database. Each array element is an array of `yii\\db\\Constraint` or its child classes."},"abstract":true},"getTableChecks":{"signature":"abstract public function getTableChecks(string $name, bool $refresh = false): yii\\db\\CheckConstraint[]","summary":"Obtains the check constraints information for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\CheckConstraint[]","description":"Table check constraints."},"abstract":true},"getTableDefaultValues":{"signature":"abstract public function getTableDefaultValues(string $name, bool $refresh = false): yii\\db\\DefaultValueConstraint[]","summary":"Obtains the default value constraints information for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\DefaultValueConstraint[]","description":"Table default value constraints."},"abstract":true},"getTableForeignKeys":{"signature":"abstract public function getTableForeignKeys(string $name, bool $refresh = false): yii\\db\\ForeignKeyConstraint[]","summary":"Obtains the foreign keys information for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\ForeignKeyConstraint[]","description":"Table foreign keys."},"abstract":true},"getTableIndexes":{"signature":"abstract public function getTableIndexes(string $name, bool $refresh = false): yii\\db\\IndexConstraint[]","summary":"Obtains the indexes information for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\IndexConstraint[]","description":"Table indexes."},"abstract":true},"getTablePrimaryKey":{"signature":"abstract public function getTablePrimaryKey(string $name, bool $refresh = false): yii\\db\\Constraint|null","summary":"Obtains the primary key for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\Constraint|null","description":"Table primary key, `null` if the table has no primary key."},"abstract":true},"getTableUniques":{"signature":"abstract public function getTableUniques(string $name, bool $refresh = false): yii\\db\\Constraint[]","summary":"Obtains the unique constraints information for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\Constraint[]","description":"Table unique constraints."},"abstract":true}}},"yii\\db\\ConstraintFinderTrait":{"kind":"trait","url":"https://yii2-framework.github.io/docs/api/yii/db/constraintfindertrait/","summary":"ConstraintFinderTrait provides methods for getting a table constraint information.","since":"2.0.13","properties":{"schemaChecks":{"type":"yii\\db\\CheckConstraint[][]","description":"Check constraints for all tables in the database.","virtual":true},"schemaDefaultValues":{"type":"yii\\db\\DefaultValueConstraint[]","description":"Default value constraints for all tables in the database.","virtual":true},"schemaForeignKeys":{"type":"yii\\db\\ForeignKeyConstraint[][]","description":"Foreign keys for all tables in the database.","virtual":true},"schemaIndexes":{"type":"yii\\db\\IndexConstraint[][]","description":"Indexes for all tables in the database.","virtual":true},"schemaPrimaryKeys":{"type":"yii\\db\\Constraint[]","description":"Primary keys for all tables in the database.","virtual":true},"schemaUniques":{"type":"yii\\db\\IndexConstraint[][]","description":"Unique constraints for all tables in the database.","virtual":true}},"methods":{"getSchemaChecks":{"signature":"public function getSchemaChecks(string $schema = '', bool $refresh = false): yii\\db\\CheckConstraint[][]","summary":"Returns check constraints for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available."}],"return":{"type":"yii\\db\\CheckConstraint[][]","description":"Check constraints for all tables in the database. Each array element is an array of `yii\\db\\CheckConstraint` or its child classes."}},"getSchemaDefaultValues":{"signature":"public function getSchemaDefaultValues(string $schema = '', bool $refresh = false): yii\\db\\DefaultValueConstraint[]","summary":"Returns default value constraints for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available."}],"return":{"type":"yii\\db\\DefaultValueConstraint[]","description":"Default value constraints for all tables in the database. Each array element is an array of `yii\\db\\DefaultValueConstraint` or its child classes."}},"getSchemaForeignKeys":{"signature":"public function getSchemaForeignKeys(string $schema = '', bool $refresh = false): yii\\db\\ForeignKeyConstraint[][]","summary":"Returns foreign keys for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available."}],"return":{"type":"yii\\db\\ForeignKeyConstraint[][]","description":"Foreign keys for all tables in the database. Each array element is an array of `yii\\db\\ForeignKeyConstraint` or its child classes."}},"getSchemaIndexes":{"signature":"public function getSchemaIndexes(string $schema = '', bool $refresh = false): yii\\db\\IndexConstraint[][]","summary":"Returns indexes for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available."}],"return":{"type":"yii\\db\\IndexConstraint[][]","description":"Indexes for all tables in the database. Each array element is an array of `yii\\db\\IndexConstraint` or its child classes."}},"getSchemaMetadata":{"signature":"abstract protected function getSchemaMetadata(string $schema, string $type, bool $refresh): array","summary":"Returns the metadata of the given type for all tables in the given schema.","params":[{"name":"$schema","type":"string","description":"The schema of the metadata. Defaults to empty string, meaning the current or default schema name."},{"name":"$type","type":"string","description":"Metadata type."},{"name":"$refresh","type":"bool","description":"Whether to fetch the latest available table metadata. If this is `false`, cached data may be returned if available."}],"return":{"type":"array","description":"Array of metadata."},"visibility":"protected","abstract":true},"getSchemaPrimaryKeys":{"signature":"public function getSchemaPrimaryKeys(string $schema = '', bool $refresh = false): yii\\db\\Constraint[]","summary":"Returns primary keys for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is `false`, cached data may be returned if available."}],"return":{"type":"yii\\db\\Constraint[]","description":"Primary keys for all tables in the database. Each array element is an instance of `yii\\db\\Constraint` or its child class."}},"getSchemaUniques":{"signature":"public function getSchemaUniques(string $schema = '', bool $refresh = false): yii\\db\\Constraint[][]","summary":"Returns unique constraints for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available."}],"return":{"type":"yii\\db\\Constraint[][]","description":"Unique constraints for all tables in the database. Each array element is an array of `yii\\db\\Constraint` or its child classes."}},"getTableChecks":{"signature":"public function getTableChecks(string $name, bool $refresh = false): yii\\db\\CheckConstraint[]","summary":"Obtains the check constraints information for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\CheckConstraint[]","description":"Table check constraints."}},"getTableDefaultValues":{"signature":"public function getTableDefaultValues(string $name, bool $refresh = false): yii\\db\\DefaultValueConstraint[]","summary":"Obtains the default value constraints information for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\DefaultValueConstraint[]","description":"Table default value constraints."}},"getTableForeignKeys":{"signature":"public function getTableForeignKeys(string $name, bool $refresh = false): yii\\db\\ForeignKeyConstraint[]","summary":"Obtains the foreign keys information for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\ForeignKeyConstraint[]","description":"Table foreign keys."}},"getTableIndexes":{"signature":"public function getTableIndexes(string $name, bool $refresh = false): yii\\db\\IndexConstraint[]","summary":"Obtains the indexes information for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\IndexConstraint[]","description":"Table indexes."}},"getTableMetadata":{"signature":"abstract protected function getTableMetadata(string $name, string $type, bool $refresh): mixed","summary":"Returns the metadata of the given type for the given table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$type","type":"string","description":"Metadata type."},{"name":"$refresh","type":"bool","description":"Whether to reload the table metadata even if it is found in the cache."}],"return":{"type":"mixed","description":"Metadata."},"visibility":"protected","abstract":true},"getTablePrimaryKey":{"signature":"public function getTablePrimaryKey(string $name, bool $refresh = false): yii\\db\\Constraint|null","summary":"Obtains the primary key for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\Constraint|null","description":"Table primary key, `null` if the table has no primary key."}},"getTableUniques":{"signature":"public function getTableUniques(string $name, bool $refresh = false): yii\\db\\Constraint[]","summary":"Obtains the unique constraints information for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the information even if it is found in the cache."}],"return":{"type":"yii\\db\\Constraint[]","description":"Table unique constraints."}},"loadTableChecks":{"signature":"abstract protected function loadTableChecks(string $tableName): yii\\db\\CheckConstraint[]","summary":"Loads all check constraints for the given table.","params":[{"name":"$tableName","type":"string","description":"Table name."}],"return":{"type":"yii\\db\\CheckConstraint[]","description":"Check constraints for the given table."},"visibility":"protected","abstract":true},"loadTableDefaultValues":{"signature":"abstract protected function loadTableDefaultValues(string $tableName): yii\\db\\DefaultValueConstraint[]","summary":"Loads all default value constraints for the given table.","params":[{"name":"$tableName","type":"string","description":"Table name."}],"return":{"type":"yii\\db\\DefaultValueConstraint[]","description":"Default value constraints for the given table."},"visibility":"protected","abstract":true},"loadTableForeignKeys":{"signature":"abstract protected function loadTableForeignKeys(string $tableName): yii\\db\\ForeignKeyConstraint[]","summary":"Loads all foreign keys for the given table.","params":[{"name":"$tableName","type":"string","description":"Table name."}],"return":{"type":"yii\\db\\ForeignKeyConstraint[]","description":"Foreign keys for the given table."},"visibility":"protected","abstract":true},"loadTableIndexes":{"signature":"abstract protected function loadTableIndexes(string $tableName): yii\\db\\IndexConstraint[]","summary":"Loads all indexes for the given table.","params":[{"name":"$tableName","type":"string","description":"Table name."}],"return":{"type":"yii\\db\\IndexConstraint[]","description":"Indexes for the given table."},"visibility":"protected","abstract":true},"loadTablePrimaryKey":{"signature":"abstract protected function loadTablePrimaryKey(string $tableName): yii\\db\\Constraint|null","summary":"Loads a primary key for the given table.","params":[{"name":"$tableName","type":"string","description":"Table name."}],"return":{"type":"yii\\db\\Constraint|null","description":"Primary key for the given table, `null` if the table has no primary key."},"visibility":"protected","abstract":true},"loadTableUniques":{"signature":"abstract protected function loadTableUniques(string $tableName): yii\\db\\Constraint[]","summary":"Loads all unique constraints for the given table.","params":[{"name":"$tableName","type":"string","description":"Table name."}],"return":{"type":"yii\\db\\Constraint[]","description":"Unique constraints for the given table."},"visibility":"protected","abstract":true}}},"yii\\db\\DataReader":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/datareader/","summary":"DataReader represents a forward-only stream of rows from a query result set.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["Iterator","Countable","yii\\base\\Configurable"],"properties":{"columnCount":{"type":"int","description":"The number of columns in the result set.","access":"read-only","virtual":true},"fetchMode":{"type":"int","description":"Fetch mode.","access":"write-only","virtual":true},"isClosed":{"type":"bool","description":"Whether the reader is closed or not.","access":"read-only","virtual":true},"rowCount":{"type":"int","description":"Number of rows contained in the result.","access":"read-only","virtual":true}},"methods":{"__construct":{"signature":"public function __construct(yii\\db\\Command $command, array $config = [])","summary":"Constructor.","params":[{"name":"$command","type":"yii\\db\\Command","description":"The command generating the query result"},{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties"}]},"bindColumn":{"signature":"public function bindColumn(int|string $column, mixed &$value, int|null $dataType = null): mixed","summary":"Binds a column to a PHP variable.","params":[{"name":"$column","type":"int|string","description":"Number of the column (1-indexed) or name of the column in the result set. If using the column name, be aware that the name should match the case of the column, as returned by the driver."},{"name":"$value","type":"mixed","byReference":true,"description":"Name of the PHP variable to which the column will be bound."},{"name":"$dataType","type":"int|null","default":"null","optional":true,"description":"Data type of the parameter"}],"return":{"type":"mixed"}},"close":{"signature":"public function close(): mixed","summary":"Closes the reader.","return":{"type":"mixed"}},"count":{"signature":"public function count(): int","summary":"Returns the number of rows in the result set.","return":{"type":"int","description":"Number of rows contained in the result."}},"current":{"signature":"public function current(): mixed","summary":"Returns the current row.","return":{"type":"mixed","description":"The current row."}},"getColumnCount":{"signature":"public function getColumnCount(): int","summary":"Returns the number of columns in the result set.","return":{"type":"int","description":"The number of columns in the result set."}},"getIsClosed":{"signature":"public function getIsClosed(): bool","summary":"Whether the reader is closed or not.","return":{"type":"bool","description":"Whether the reader is closed or not."}},"getRowCount":{"signature":"public function getRowCount(): int","summary":"Returns the number of rows in the result set.","return":{"type":"int","description":"Number of rows contained in the result."}},"key":{"signature":"public function key(): int","summary":"Returns the index of the current row.","return":{"type":"int","description":"The index of the current row."}},"next":{"signature":"public function next(): mixed","summary":"Moves the internal pointer to the next row.","return":{"type":"mixed"}},"nextResult":{"signature":"public function nextResult(): bool","summary":"Advances the reader to the next result when reading the results of a batch of statements.","return":{"type":"bool","description":"Returns true on success or false on failure."}},"read":{"signature":"public function read(): array|false","summary":"Advances the reader to the next row in a result set.","return":{"type":"array|false","description":"The current row, false if no more row available"}},"readAll":{"signature":"public function readAll(): array","summary":"Reads the whole result set into an array.","return":{"type":"array","description":"The result set (each array element represents a row of data). An empty array will be returned if the result contains no row."}},"readColumn":{"signature":"public function readColumn(int $columnIndex): mixed","summary":"Returns a single column from the next row of a result set.","params":[{"name":"$columnIndex","type":"int","description":"Zero-based column index"}],"return":{"type":"mixed","description":"The column of the current row, false if no more rows available"}},"readObject":{"signature":"public function readObject(string $className, array $fields): mixed","summary":"Returns an object populated with the next row of data.","params":[{"name":"$className","type":"string","description":"Class name of the object to be created and populated"},{"name":"$fields","type":"array","description":"Elements of this array are passed to the constructor"}],"return":{"type":"mixed","description":"The populated object, false if no more row of data available"}},"rewind":{"signature":"public function rewind(): mixed","summary":"Resets the iterator to the initial state.","return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if this method is invoked twice"}]},"setFetchMode":{"signature":"public function setFetchMode(int $mode): mixed","summary":"Set the default fetch mode for this statement.","params":[{"name":"$mode","type":"int","description":"Fetch mode"}],"return":{"type":"mixed"}},"valid":{"signature":"public function valid(): bool","summary":"Returns whether there is a row of data at current position.","return":{"type":"bool","description":"Whether there is a row of data at current position."}}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\DefaultValueConstraint":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/defaultvalueconstraint/","summary":"DefaultValueConstraint represents the metadata of a table `DEFAULT` constraint.","since":"2.0.13","extends":"yii\\db\\Constraint","implements":["yii\\base\\Configurable"],"properties":{"value":{"type":"mixed","default":"null","description":"Default value as returned by the DBMS."}},"inherited":{"properties":{"columnNames":"yii\\db\\Constraint","name":"yii\\db\\Constraint"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\Exception":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/exception/","summary":"Exception represents an exception that is caused by some DB-related operations.","since":"2.0","extends":"yii\\base\\Exception","properties":{"errorInfo":{"type":"array","default":"[]","description":"The error info provided by a PDO exception."}},"methods":{"__construct":{"signature":"public function __construct(string $message, array $errorInfo = [], string $code = '', Throwable|null $previous = null)","summary":"Constructor.","params":[{"name":"$message","type":"string","description":"PDO error message"},{"name":"$errorInfo","type":"array","default":"[]","optional":true,"description":"PDO error info"},{"name":"$code","type":"string","default":"''","optional":true,"description":"PDO error code"},{"name":"$previous","type":"Throwable|null","default":"null","optional":true,"description":"The previous exception used for the exception chaining."}]},"__toString":{"signature":"public function __toString(): string","return":{"type":"string","description":"Readable representation of exception"}},"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\db\\Expression":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/expression/","summary":"Expression represents a DB expression that does not need escaping or quoting.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\db\\ExpressionInterface","yii\\base\\Configurable"],"properties":{"expression":{"type":"string","default":"null","description":"The DB expression"},"params":{"type":"array","default":"[]","description":"List of parameters that should be bound for this expression."}},"methods":{"__construct":{"signature":"public function __construct(string $expression, array $params = [], array $config = [])","summary":"Constructor.","params":[{"name":"$expression","type":"string","description":"The DB expression"},{"name":"$params","type":"array","default":"[]","optional":true,"description":"Parameters"},{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties"}]},"__toString":{"signature":"public function __toString(): string","summary":"String magic method.","return":{"type":"string","description":"The DB expression."}}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\ExpressionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/expressionbuilder/","summary":"Class ExpressionBuilder builds objects of `yii\\db\\Expression` class.","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\Expression|yii\\db\\ExpressionInterface $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\Expression|yii\\db\\ExpressionInterface","description":"The expression to be built"},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\ExpressionBuilderInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/db/expressionbuilderinterface/","summary":"Interface ExpressionBuilderInterface is designed to build raw SQL from specific expression objects that implement `yii\\db\\ExpressionInterface`.","since":"2.0.14","methods":{"build":{"signature":"abstract public function build(yii\\db\\ExpressionInterface $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."},"abstract":true}}},"yii\\db\\ExpressionBuilderTrait":{"kind":"trait","url":"https://yii2-framework.github.io/docs/api/yii/db/expressionbuildertrait/","summary":"Trait ExpressionBuilderTrait provides common constructor for classes that should implement `yii\\db\\ExpressionBuilderInterface`","since":"2.0.14","properties":{"queryBuilder":{"type":"yii\\db\\QueryBuilder","default":"null","visibility":"protected"}},"methods":{"__construct":{"signature":"public function __construct(yii\\db\\QueryBuilder $queryBuilder)","summary":"ExpressionBuilderTrait constructor.","params":[{"name":"$queryBuilder","type":"yii\\db\\QueryBuilder"}]}}},"yii\\db\\ExpressionInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/db/expressioninterface/","summary":"Interface ExpressionInterface should be used to mark classes, that should be built in a special way.","since":"2.0.14"},"yii\\db\\ForeignKeyConstraint":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/foreignkeyconstraint/","summary":"ForeignKeyConstraint represents the metadata of a table `FOREIGN KEY` constraint.","since":"2.0.13","extends":"yii\\db\\Constraint","implements":["yii\\base\\Configurable"],"properties":{"foreignColumnNames":{"type":"string[]","default":"null","description":"List of referenced table column names."},"foreignSchemaName":{"type":"string|null","default":"null","description":"Referenced table schema name."},"foreignTableName":{"type":"string","default":"null","description":"Referenced table name."},"onDelete":{"type":"string|null","default":"null","description":"Referential action if rows in a referenced table are to be deleted."},"onUpdate":{"type":"string|null","default":"null","description":"Referential action if rows in a referenced table are to be updated."}},"inherited":{"properties":{"columnNames":"yii\\db\\Constraint","name":"yii\\db\\Constraint"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\IndexConstraint":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/indexconstraint/","summary":"IndexConstraint represents the metadata of a table `INDEX` constraint.","since":"2.0.13","extends":"yii\\db\\Constraint","implements":["yii\\base\\Configurable"],"properties":{"isPrimary":{"type":"bool","default":"null","description":"Whether the index was created for a primary key."},"isUnique":{"type":"bool","default":"null","description":"Whether the index is unique."}},"inherited":{"properties":{"columnNames":"yii\\db\\Constraint","name":"yii\\db\\Constraint"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\IntegrityException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/integrityexception/","summary":"Exception represents an exception that is caused by violation of DB constraints.","since":"2.0","extends":"yii\\db\\Exception","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}},"inherited":{"properties":{"errorInfo":"yii\\db\\Exception"},"methods":{"__construct":"yii\\db\\Exception","__toString":"yii\\db\\Exception"}}},"yii\\db\\JsonExpression":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/jsonexpression/","summary":"Class JsonExpression represents data that should be encoded to JSON.","since":"2.0.14","implements":["yii\\db\\ExpressionInterface","JsonSerializable"],"properties":{"type":{"type":"string|null","default":"null","description":"Type of JSON, expression should be casted to.","visibility":"protected"},"value":{"type":"mixed","default":"null","description":"The value to be encoded to JSON.","visibility":"protected"}},"methods":{"__construct":{"signature":"public function __construct(mixed $value, string|null $type = null)","summary":"JsonExpression constructor.","params":[{"name":"$value","type":"mixed","description":"The value to be encoded to JSON. The value must be compatible with [\\yii\\helpers\\Json::encode()|Json::encode()]] requirements."},{"name":"$type","type":"string|null","default":"null","optional":true,"description":"The type of the JSON. See `yii\\db\\JsonExpression::$type`"}]},"getType":{"signature":"public function getType(): string|null","return":{"type":"string|null","description":"The type of JSON"}},"getValue":{"signature":"public function getValue(): mixed","return":{"type":"mixed"}},"jsonSerialize":{"signature":"public function jsonSerialize(): mixed","summary":"Specify data which should be serialized to JSON","return":{"type":"mixed","description":"Data which can be serialized by json_encode, which is a value of any type other than a resource."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"when JsonExpression contains QueryInterface object"}],"since":"2.0.14.2"}},"constants":{"TYPE_JSON":{"value":"'json'"},"TYPE_JSONB":{"value":"'jsonb'"}}},"yii\\db\\Migration":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/migration/","summary":"Migration is the base class for representing a database migration.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\db\\MigrationInterface","yii\\base\\Configurable"],"traits":["yii\\db\\SchemaBuilderTrait"],"properties":{"compact":{"type":"bool","default":"false","description":"Indicates whether the console output should be compacted.","since":"2.0.13"},"db":{"type":"yii\\db\\Connection|array|string","default":"'db'","description":"The DB connection object or the application component ID of the DB connection that this migration should work with."},"maxSqlOutputLength":{"type":"int","default":"null","description":"Max number of characters of the SQL outputted.","since":"2.0.13"}},"methods":{"addCheck":{"signature":"public function addCheck(string $name, string $table, string $expression): mixed","summary":"Creates a SQL command for adding a check constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the check constraint. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the check constraint will be added to. The name will be properly quoted by the method."},{"name":"$expression","type":"string","description":"The SQL of the `CHECK` constraint."}],"return":{"type":"mixed"}},"addColumn":{"signature":"public function addColumn(string $table, string $column, string $type): mixed","summary":"Builds and executes a SQL statement for adding a new DB column.","params":[{"name":"$table","type":"string","description":"The table that the new column will be added to. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the new column. The name will be properly quoted by the method."},{"name":"$type","type":"string","description":"The column type. The `yii\\db\\QueryBuilder::getColumnType()` method will be invoked to convert abstract column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'."}],"return":{"type":"mixed"}},"addCommentOnColumn":{"signature":"public function addCommentOnColumn(string $table, string $column, string $comment): mixed","summary":"Builds and execute a SQL statement for adding comment to column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be commented. The column name will be properly quoted by the method."},{"name":"$comment","type":"string","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"mixed"},"since":"2.0.8"},"addCommentOnTable":{"signature":"public function addCommentOnTable(string $table, string $comment): mixed","summary":"Builds a SQL statement for adding comment to table.","params":[{"name":"$table","type":"string","description":"The table to be commented. The table name will be properly quoted by the method."},{"name":"$comment","type":"string","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"mixed"},"since":"2.0.8"},"addForeignKey":{"signature":"public function addForeignKey(string $name, string $table, string|array $columns, string $refTable, string|array $refColumns, string|null $delete = null, string|null $update = null): mixed","summary":"Builds a SQL statement for adding a foreign key constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the foreign key constraint."},{"name":"$table","type":"string","description":"The table that the foreign key constraint will be added to."},{"name":"$columns","type":"string|array","description":"The name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array."},{"name":"$refTable","type":"string","description":"The table that the foreign key references to."},{"name":"$refColumns","type":"string|array","description":"The name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array."},{"name":"$delete","type":"string|null","default":"null","optional":true,"description":"The ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL"},{"name":"$update","type":"string|null","default":"null","optional":true,"description":"The ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL"}],"return":{"type":"mixed"}},"addPrimaryKey":{"signature":"public function addPrimaryKey(string $name, string $table, string|array $columns): mixed","summary":"Builds and executes a SQL statement for creating a primary key.","params":[{"name":"$name","type":"string","description":"The name of the primary key constraint."},{"name":"$table","type":"string","description":"The table that the primary key constraint will be added to."},{"name":"$columns","type":"string|array","description":"Comma separated string or array of columns that the primary key will consist of."}],"return":{"type":"mixed"}},"alterColumn":{"signature":"public function alterColumn(string $table, string $column, string $type): mixed","summary":"Builds and executes a SQL statement for changing the definition of a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be changed. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be changed. The name will be properly quoted by the method."},{"name":"$type","type":"string","description":"The new column type. The `yii\\db\\QueryBuilder::getColumnType()` method will be invoked to convert abstract column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'."}],"return":{"type":"mixed"}},"batchInsert":{"signature":"public function batchInsert(string $table, array $columns, array $rows): mixed","summary":"Creates and executes a batch INSERT SQL statement.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"array","description":"The column names."},{"name":"$rows","type":"array","description":"The rows to be batch inserted into the table"}],"return":{"type":"mixed"}},"beginCommand":{"signature":"protected function beginCommand(string $description): float","summary":"Prepares for a command to be executed, and outputs to the console.","params":[{"name":"$description","type":"string","description":"The description for the command, to be output to the console."}],"return":{"type":"float","description":"The time before the command is executed, for the time elapsed to be calculated."},"visibility":"protected","since":"2.0.13"},"createIndex":{"signature":"public function createIndex(string $name, string $table, string|array $columns, bool $unique = false): mixed","summary":"Builds and executes a SQL statement for creating a new index.","params":[{"name":"$name","type":"string","description":"The name of the index. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the new index will be created for. The table name will be properly quoted by the method."},{"name":"$columns","type":"string|array","description":"The column(s) that should be included in the index. If there are multiple columns, please separate them by commas or use an array. Each column name will be properly quoted by the method. Quoting will be skipped for column names that include a left parenthesis \"(\"."},{"name":"$unique","type":"bool","default":"false","optional":true,"description":"Whether to add UNIQUE constraint on the created index."}],"return":{"type":"mixed"}},"createTable":{"signature":"public function createTable(string $table, array $columns, string|null $options = null): mixed","summary":"Builds and executes a SQL statement for creating a new DB table.","params":[{"name":"$table","type":"string","description":"The name of the table to be created. The name will be properly quoted by the method."},{"name":"$columns","type":"array","description":"The columns (name => definition) in the new table."},{"name":"$options","type":"string|null","default":"null","optional":true,"description":"Additional SQL fragment that will be appended to the generated SQL."}],"return":{"type":"mixed"}},"delete":{"signature":"public function delete(string $table, array|string $condition = '', array $params = []): mixed","summary":"Creates and executes a DELETE SQL statement.","params":[{"name":"$table","type":"string","description":"The table where the data will be deleted from."},{"name":"$condition","type":"array|string","default":"''","optional":true,"description":"The conditions that will be put in the WHERE part. Please refer to `yii\\db\\Query::where()` on how to specify conditions."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be bound to the query."}],"return":{"type":"mixed"}},"down":{"signature":"public function down(): false|void|mixed","summary":"This method contains the logic to be executed when removing this migration.","return":{"type":"false|void|mixed","description":"Return a false value to indicate the migration fails and should not proceed further. All other return values mean the migration succeeds."}},"dropCheck":{"signature":"public function dropCheck(string $name, string $table): mixed","summary":"Creates a SQL command for dropping a check constraint.","params":[{"name":"$name","type":"string","description":"The name of the check constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose check constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"mixed"}},"dropColumn":{"signature":"public function dropColumn(string $table, string $column): mixed","summary":"Builds and executes a SQL statement for dropping a DB column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be dropped. The name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be dropped. The name will be properly quoted by the method."}],"return":{"type":"mixed"}},"dropCommentFromColumn":{"signature":"public function dropCommentFromColumn(string $table, string $column): mixed","summary":"Builds and execute a SQL statement for dropping comment from column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be commented. The column name will be properly quoted by the method."}],"return":{"type":"mixed"},"since":"2.0.8"},"dropCommentFromTable":{"signature":"public function dropCommentFromTable(string $table): mixed","summary":"Builds a SQL statement for dropping comment from table.","params":[{"name":"$table","type":"string","description":"The table whose column is to be commented. The table name will be properly quoted by the method."}],"return":{"type":"mixed"},"since":"2.0.8"},"dropForeignKey":{"signature":"public function dropForeignKey(string $name, string $table): mixed","summary":"Builds a SQL statement for dropping a foreign key constraint.","params":[{"name":"$name","type":"string","description":"The name of the foreign key constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose foreign is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"mixed"}},"dropIndex":{"signature":"public function dropIndex(string $name, string $table): mixed","summary":"Builds and executes a SQL statement for dropping an index.","params":[{"name":"$name","type":"string","description":"The name of the index to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose index is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"mixed"}},"dropPrimaryKey":{"signature":"public function dropPrimaryKey(string $name, string $table): mixed","summary":"Builds and executes a SQL statement for dropping a primary key.","params":[{"name":"$name","type":"string","description":"The name of the primary key constraint to be removed."},{"name":"$table","type":"string","description":"The table that the primary key constraint will be removed from."}],"return":{"type":"mixed"}},"dropTable":{"signature":"public function dropTable(string $table): mixed","summary":"Builds and executes a SQL statement for dropping a DB table.","params":[{"name":"$table","type":"string","description":"The table to be dropped. The name will be properly quoted by the method."}],"return":{"type":"mixed"}},"endCommand":{"signature":"protected function endCommand(float $time): mixed","summary":"Finalizes after the command has been executed, and outputs to the console the time elapsed.","params":[{"name":"$time","type":"float","description":"The time before the command was executed."}],"return":{"type":"mixed"},"visibility":"protected","since":"2.0.13"},"execute":{"signature":"public function execute(string $sql, array $params = []): mixed","summary":"Executes a SQL statement.","params":[{"name":"$sql","type":"string","description":"The SQL statement to be executed"},{"name":"$params","type":"array","default":"[]","optional":true,"description":"Input parameters (name => value) for the SQL execution. See `yii\\db\\Command::execute()` for more details."}],"return":{"type":"mixed"}},"getDb":{"signature":"protected function getDb()","visibility":"protected","since":"2.0.6"},"init":{"signature":"public function init(): mixed","summary":"Initializes the migration.","return":{"type":"mixed"}},"insert":{"signature":"public function insert(string $table, array $columns): mixed","summary":"Creates and executes an INSERT SQL statement.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"array","description":"The column data (name => value) to be inserted into the table."}],"return":{"type":"mixed"}},"renameColumn":{"signature":"public function renameColumn(string $table, string $name, string $newName): mixed","summary":"Builds and executes a SQL statement for renaming a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be renamed. The name will be properly quoted by the method."},{"name":"$name","type":"string","description":"The old name of the column. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new name of the column. The name will be properly quoted by the method."}],"return":{"type":"mixed"}},"renameTable":{"signature":"public function renameTable(string $table, string $newName): mixed","summary":"Builds and executes a SQL statement for renaming a DB table.","params":[{"name":"$table","type":"string","description":"The table to be renamed. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new table name. The name will be properly quoted by the method."}],"return":{"type":"mixed"}},"safeDown":{"signature":"public function safeDown(): false|void|mixed","summary":"This method contains the logic to be executed when removing this migration.","return":{"type":"false|void|mixed","description":"Return a false value to indicate the migration fails and should not proceed further. All other return values mean the migration succeeds."}},"safeUp":{"signature":"public function safeUp(): false|void|mixed","summary":"This method contains the logic to be executed when applying this migration.","return":{"type":"false|void|mixed","description":"Return a false value to indicate the migration fails and should not proceed further. All other return values mean the migration succeeds."}},"truncateTable":{"signature":"public function truncateTable(string $table): mixed","summary":"Builds and executes a SQL statement for truncating a DB table.","params":[{"name":"$table","type":"string","description":"The table to be truncated. The name will be properly quoted by the method."}],"return":{"type":"mixed"}},"up":{"signature":"public function up(): false|void|mixed","summary":"This method contains the logic to be executed when applying this migration.","return":{"type":"false|void|mixed","description":"Return a false value to indicate the migration fails and should not proceed further. All other return values mean the migration succeeds."}},"update":{"signature":"public function update(string $table, array $columns, array|string $condition = '', array $params = []): mixed","summary":"Creates and executes an UPDATE SQL statement.","params":[{"name":"$table","type":"string","description":"The table to be updated."},{"name":"$columns","type":"array","description":"The column data (name => value) to be updated."},{"name":"$condition","type":"array|string","default":"''","optional":true,"description":"The conditions that will be put in the WHERE part. Please refer to `yii\\db\\Query::where()` on how to specify conditions."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be bound to the query."}],"return":{"type":"mixed"}},"upsert":{"signature":"public function upsert(string $table, array|yii\\db\\Query $insertColumns, array|bool $updateColumns = true, array $params = []): mixed","summary":"Creates and executes a command to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into/updated in."},{"name":"$insertColumns","type":"array|yii\\db\\Query","description":"The column data (name => value) to be inserted into the table or instance of `yii\\db\\Query` to perform `INSERT INTO ... SELECT` SQL statement."},{"name":"$updateColumns","type":"array|bool","default":"true","optional":true,"description":"The column data (name => value) to be updated if they already exist. If `true` is passed, the column data will be updated to match the insert column data. If `false` is passed, no update will be performed if the column data already exists."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be bound to the command."}],"return":{"type":"mixed"},"since":"2.0.14"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","bigInteger":"yii\\db\\SchemaBuilderTrait","bigPrimaryKey":"yii\\db\\SchemaBuilderTrait","binary":"yii\\db\\SchemaBuilderTrait","boolean":"yii\\db\\SchemaBuilderTrait","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","char":"yii\\db\\SchemaBuilderTrait","className":"yii\\base\\BaseObject","date":"yii\\db\\SchemaBuilderTrait","dateTime":"yii\\db\\SchemaBuilderTrait","decimal":"yii\\db\\SchemaBuilderTrait","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","double":"yii\\db\\SchemaBuilderTrait","ensureBehaviors":"yii\\base\\Component","float":"yii\\db\\SchemaBuilderTrait","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","integer":"yii\\db\\SchemaBuilderTrait","json":"yii\\db\\SchemaBuilderTrait","money":"yii\\db\\SchemaBuilderTrait","off":"yii\\base\\Component","on":"yii\\base\\Component","primaryKey":"yii\\db\\SchemaBuilderTrait","smallInteger":"yii\\db\\SchemaBuilderTrait","string":"yii\\db\\SchemaBuilderTrait","text":"yii\\db\\SchemaBuilderTrait","time":"yii\\db\\SchemaBuilderTrait","timestamp":"yii\\db\\SchemaBuilderTrait","tinyInteger":"yii\\db\\SchemaBuilderTrait","trigger":"yii\\base\\Component"}}},"yii\\db\\MigrationInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/db/migrationinterface/","summary":"The MigrationInterface defines the minimum set of methods to be implemented by a database migration.","since":"2.0","methods":{"down":{"signature":"abstract public function down(): bool","summary":"This method contains the logic to be executed when removing this migration.","return":{"type":"bool","description":"Return a false value to indicate the migration fails and should not proceed further. All other return values mean the migration succeeds."},"abstract":true},"up":{"signature":"abstract public function up(): bool","summary":"This method contains the logic to be executed when applying this migration.","return":{"type":"bool","description":"Return a false value to indicate the migration fails and should not proceed further. All other return values mean the migration succeeds."},"abstract":true}}},"yii\\db\\PdoValue":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/api/yii/db/pdovalue/","summary":"Class PdoValue represents a $value that should be bound to PDO with exact $type.","since":"2.0.14","implements":["yii\\db\\ExpressionInterface"],"methods":{"__construct":{"signature":"public function __construct(mixed $value, mixed $type)","summary":"PdoValue constructor.","params":[{"name":"$value","type":"mixed"},{"name":"$type","type":"mixed"}]},"getType":{"signature":"public function getType(): int","return":{"type":"int"}},"getValue":{"signature":"public function getValue(): mixed","return":{"type":"mixed"}}}},"yii\\db\\PdoValueBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/pdovaluebuilder/","summary":"Class PdoValueBuilder builds object of the `yii\\db\\PdoValue` expression class.","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}}},"constants":{"PARAM_PREFIX":{"value":"':pv'"}}},"yii\\db\\Query":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/query/","summary":"Query represents a SELECT SQL statement in a way that is independent of DBMS.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\db\\QueryInterface","yii\\db\\ExpressionInterface","yii\\base\\Configurable"],"traits":["yii\\db\\QueryTrait"],"properties":{"distinct":{"type":"bool","default":"false","description":"Whether to select distinct rows of data only."},"from":{"type":"array|string|null","default":"null","description":"The table(s) to be selected from."},"groupBy":{"type":"array|null","default":"null","description":"How to group the query results."},"having":{"type":"string|array|yii\\db\\ExpressionInterface|null","default":"null","description":"The condition to be applied in the GROUP BY clause."},"join":{"type":"array|null","default":"null","description":"How to join with other tables."},"params":{"type":"array|null","default":"[]","description":"List of query parameter values indexed by parameter placeholders."},"queryCacheDependency":{"type":"yii\\caching\\Dependency|null","default":"null","description":"The dependency to be associated with the cached query result for this query","since":"2.0.14"},"queryCacheDuration":{"type":"int|bool|null","default":"null","description":"The default number of seconds that query results can remain valid in cache.","since":"2.0.14"},"select":{"type":"array|null","default":"null","description":"The columns being selected."},"selectOption":{"type":"string|null","default":"null","description":"Additional option that should be appended to the 'SELECT' keyword."},"tablesUsedInFrom":{"type":"string[]","description":"Table names indexed by aliases.","access":"read-only","virtual":true},"union":{"type":"array|null","default":"null","description":"This is used to construct the UNION clause(s) in a SQL statement."},"unionLimit":{"type":"int|yii\\db\\ExpressionInterface|null","default":"null","description":"Number of records to return from the complete UNION result.","since":"22.0"},"unionOffset":{"type":"int|yii\\db\\ExpressionInterface|null","default":"null","description":"Zero-based offset for the complete UNION result.","since":"22.0"},"unionOrderBy":{"type":"array|null","default":"null","description":"How to sort the complete UNION result.","since":"22.0"},"withQueries":{"type":"array|null","default":"null","description":"This is used to construct the WITH section in a SQL query.","since":"2.0.35"}},"methods":{"__toString":{"signature":"public function __toString(): string","summary":"Returns the SQL representation of Query","return":{"type":"string"}},"addGroupBy":{"signature":"public function addGroupBy(string|array|yii\\db\\ExpressionInterface $columns): $this","summary":"Adds additional group-by columns to the existing ones.","params":[{"name":"$columns","type":"string|array|yii\\db\\ExpressionInterface","description":"Additional columns to be grouped by. Columns can be specified in either a string (e.g. \"id, name\") or an array (e.g. ['id', 'name']). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression). Note that if your group-by is an expression containing commas, you should always use an array to represent the group-by information. Otherwise, the method will not be able to correctly determine the group-by columns. Since version 2.0.7, an `yii\\db\\Expression` object can be passed to specify the GROUP BY part explicitly in plain SQL. Since version 2.0.14, an `yii\\db\\ExpressionInterface` object can be passed as well."}],"return":{"type":"$this","description":"The query object itself"}},"addParams":{"signature":"public function addParams(array $params): $this","summary":"Adds additional parameters to be bound to the query.","params":[{"name":"$params","type":"array","description":"List of query parameter values indexed by parameter placeholders. For example, `[':name' => 'Dan', ':age' => 31]`."}],"return":{"type":"$this","description":"The query object itself"}},"addSelect":{"signature":"public function addSelect(string|array|yii\\db\\ExpressionInterface $columns): $this","summary":"Add more columns to the SELECT part of the query.","params":[{"name":"$columns","type":"string|array|yii\\db\\ExpressionInterface","description":"The columns to add to the select. See `select()` for more details about the format of this parameter."}],"return":{"type":"$this","description":"The query object itself"}},"addUnionOrderBy":{"signature":"public function addUnionOrderBy(array|string|yii\\db\\ExpressionInterface|null $columns): static","summary":"Adds ORDER BY columns to the complete UNION result.","params":[{"name":"$columns","type":"array|string|yii\\db\\ExpressionInterface|null","description":"The columns (and the directions) to be ordered by."}],"return":{"type":"static","description":"The query object itself."},"since":"22.0"},"all":{"signature":"public function all(yii\\db\\Connection|null $db = null): array","summary":"Executes the query and returns all results as an array.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"array","description":"The query results. If the query results in nothing, an empty array will be returned."}},"andFilterCompare":{"signature":"public function andFilterCompare(string $name, string $value, string $defaultOperator = '='): $this","summary":"Adds a filtering condition for a specific column and allow the user to choose a filter operator.","params":[{"name":"$name","type":"string","description":"The column name."},{"name":"$value","type":"string","description":"The column value optionally prepended with the comparison operator."},{"name":"$defaultOperator","type":"string","default":"'='","optional":true,"description":"The operator to use, when no operator is given in `$value`. Defaults to `=`, performing an exact match."}],"return":{"type":"$this","description":"The query object itself"},"since":"2.0.8"},"andFilterHaving":{"signature":"public function andFilterHaving(array $condition): $this","summary":"Adds an additional HAVING condition to the existing one but ignores empty operands (`isEmpty()`).","params":[{"name":"$condition","type":"array","description":"The new HAVING condition. Please refer to `having()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"},"since":"2.0.11"},"andHaving":{"signature":"public function andHaving(string|array|yii\\db\\ExpressionInterface $condition, array $params = []): $this","summary":"Adds an additional HAVING condition to the existing one.","params":[{"name":"$condition","type":"string|array|yii\\db\\ExpressionInterface","description":"The new HAVING condition. Please refer to `where()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"$this","description":"The query object itself"}},"andWhere":{"signature":"public function andWhere(string|array|yii\\db\\ExpressionInterface $condition, array $params = []): $this","summary":"Adds an additional WHERE condition to the existing one.","params":[{"name":"$condition","type":"string|array|yii\\db\\ExpressionInterface","description":"The new WHERE condition. Please refer to `where()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"$this","description":"The query object itself"}},"average":{"signature":"public function average(string $q, yii\\db\\Connection|null $db = null): mixed","summary":"Returns the average of the specified column values.","params":[{"name":"$q","type":"string","description":"The column name or expression. Make sure you properly [quote](https://yii2-framework.github.io/docs/guide/db-dao/#quoting-table-and-column-names) column names in the expression."},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"mixed","description":"The average of the specified column values."}},"batch":{"signature":"public function batch(int $batchSize = 100, yii\\db\\Connection|null $db = null): yii\\db\\BatchQueryResult","summary":"Starts a batch query.","params":[{"name":"$batchSize","type":"int","default":"100","optional":true,"description":"The number of records to be fetched in each batch."},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection. If not set, the \"db\" application component will be used."}],"return":{"type":"yii\\db\\BatchQueryResult","description":"The batch query result. It implements the `Iterator` interface and can be traversed to retrieve the data in batches."}},"cache":{"signature":"public function cache(int|true $duration = true, yii\\caching\\Dependency|null $dependency = null): $this","summary":"Enables query cache for this Query.","params":[{"name":"$duration","type":"int|true","default":"true","optional":true,"description":"The number of seconds that query results can remain valid in cache. Use 0 to indicate that the cached data will never expire. Use a negative number to indicate that query cache should not be used. Use boolean `true` to indicate that `yii\\db\\Connection::$queryCacheDuration` should be used. Defaults to `true`."},{"name":"$dependency","type":"yii\\caching\\Dependency|null","default":"null","optional":true,"description":"The cache dependency associated with the cached result."}],"return":{"type":"$this","description":"The Query object itself"},"since":"2.0.14"},"cleanUpTableNames":{"signature":"protected function cleanUpTableNames(array $tableNames): string[]","summary":"Clean up table names and aliases Both aliases and names are enclosed into {{ and }}.","params":[{"name":"$tableNames","type":"array","description":"Non-empty array"}],"return":{"type":"string[]","description":"Table names indexed by aliases"},"visibility":"protected","since":"2.0.14"},"column":{"signature":"public function column(yii\\db\\Connection|null $db = null): array","summary":"Executes the query and returns the first column of the result.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"array","description":"The first column of the query result. An empty array is returned if the query results in nothing."}},"count":{"signature":"public function count(string $q = '*', yii\\db\\Connection|null $db = null): int|string|null","summary":"Returns the number of records.","params":[{"name":"$q","type":"string","default":"'*'","optional":true,"description":"The COUNT expression. Defaults to '*'. Make sure you properly [quote](https://yii2-framework.github.io/docs/guide/db-dao/#quoting-table-and-column-names) column names in the expression."},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to generate the SQL statement. If this parameter is not given (or null), the `db` application component will be used."}],"return":{"type":"int|string|null","description":"Number of records. The result may be a string depending on the underlying database engine and to support integer values higher than a 32bit PHP integer can handle."}},"create":{"signature":"public static function create(yii\\db\\Query $from): yii\\db\\Query","summary":"Creates a new Query object and copies its property values from an existing one.","params":[{"name":"$from","type":"yii\\db\\Query","description":"The source query object"}],"return":{"type":"yii\\db\\Query","description":"The new Query object"},"static":true},"createCommand":{"signature":"public function createCommand(yii\\db\\Connection|null $db = null): yii\\db\\Command","summary":"Creates a DB command that can be used to execute this query.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"yii\\db\\Command","description":"The created DB command instance."}},"distinct":{"signature":"public function distinct(bool $value = true): $this","summary":"Sets the value indicating whether to SELECT DISTINCT or not.","params":[{"name":"$value","type":"bool","default":"true","optional":true,"description":"Whether to SELECT DISTINCT or not."}],"return":{"type":"$this","description":"The query object itself"}},"each":{"signature":"public function each(int $batchSize = 100, yii\\db\\Connection|null $db = null): yii\\db\\BatchQueryResult","summary":"Starts a batch query and retrieves data row by row.","params":[{"name":"$batchSize","type":"int","default":"100","optional":true,"description":"The number of records to be fetched in each batch."},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection. If not set, the \"db\" application component will be used."}],"return":{"type":"yii\\db\\BatchQueryResult","description":"The batch query result. It implements the `Iterator` interface and can be traversed to retrieve the data in batches."}},"exists":{"signature":"public function exists(yii\\db\\Connection|null $db = null): bool","summary":"Returns a value indicating whether the query result contains any row of data.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"bool","description":"Whether the query result contains any row of data."}},"filterHaving":{"signature":"public function filterHaving(array $condition): $this","summary":"Sets the HAVING part of the query but ignores empty operands (`isEmpty()`).","params":[{"name":"$condition","type":"array","description":"The conditions that should be put in the HAVING part. See `having()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"},"since":"2.0.11"},"from":{"signature":"public function from(string|array|yii\\db\\ExpressionInterface $tables): $this","summary":"Sets the FROM part of the query.","params":[{"name":"$tables","type":"string|array|yii\\db\\ExpressionInterface","description":"The table(s) to be selected from. This can be either a string (e.g. `'user'`) or an array (e.g. `['user', 'profile']`) specifying one or several table names. Table names can contain schema prefixes (e.g. `'public.user'`) and/or table aliases (e.g. `'user u'`). The method will automatically quote the table names unless it contains some parenthesis (which means the table is given as a sub-query or DB expression). When the tables are specified as an array, you may also use the array keys as the table aliases (if a table does not need alias, do not use a string key). Use a Query object to represent a sub-query. In this case, the corresponding array key will be used as the alias for the sub-query. To specify the `FROM` part in plain SQL, you may pass an instance of `yii\\db\\ExpressionInterface`. Here are some examples: ``` // SELECT * FROM `user` `u`, `profile`; $query = (new \\yii\\db\\Query)->from(['u' => 'user', 'profile']); // SELECT * FROM (SELECT * FROM `user` WHERE `active` = 1) `activeusers`; $subquery = (new \\yii\\db\\Query)->from('user')->where(['active' => true]) $query = (new \\yii\\db\\Query)->from(['activeusers' => $subquery]); // subquery can also be a string with plain SQL wrapped in parenthesis // SELECT * FROM (SELECT * FROM `user` WHERE `active` = 1) `activeusers`; $subquery = \"(SELECT * FROM `user` WHERE `active` = 1)\"; $query = (new \\yii\\db\\Query)->from(['activeusers' => $subquery]); ```"}],"return":{"type":"$this","description":"The query object itself"}},"getTablesUsedInFrom":{"signature":"public function getTablesUsedInFrom(): string[]","summary":"Returns table names used in `from()` indexed by aliases.","return":{"type":"string[]","description":"Table names indexed by aliases"},"throws":[{"type":"yii\\base\\InvalidConfigException"}],"since":"2.0.12"},"groupBy":{"signature":"public function groupBy(string|array|yii\\db\\ExpressionInterface|null $columns): $this","summary":"Sets the GROUP BY part of the query.","params":[{"name":"$columns","type":"string|array|yii\\db\\ExpressionInterface|null","description":"The columns to be grouped by. Columns can be specified in either a string (e.g. \"id, name\") or an array (e.g. ['id', 'name']). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression). Note that if your group-by is an expression containing commas, you should always use an array to represent the group-by information. Otherwise, the method will not be able to correctly determine the group-by columns. Since version 2.0.7, an `yii\\db\\ExpressionInterface` object can be passed to specify the GROUP BY part explicitly in plain SQL. Since version 2.0.14, an `yii\\db\\ExpressionInterface` object can be passed as well."}],"return":{"type":"$this","description":"The query object itself"}},"having":{"signature":"public function having(string|array|yii\\db\\ExpressionInterface $condition, array $params = []): $this","summary":"Sets the HAVING part of the query.","params":[{"name":"$condition","type":"string|array|yii\\db\\ExpressionInterface","description":"The conditions to be put after HAVING. Please refer to `where()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"$this","description":"The query object itself"}},"innerJoin":{"signature":"public function innerJoin(string|array $table, string|array $on = '', array $params = []): $this","summary":"Appends an INNER JOIN part to the query.","params":[{"name":"$table","type":"string|array","description":"The table or sub-query to be joined. Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression). You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']). To join a sub-query, use an array with one element, with the value set to a `yii\\db\\Query` object representing the sub-query, and the corresponding key representing the alias."},{"name":"$on","type":"string|array","default":"''","optional":true,"description":"The join condition that should appear in the ON part. Please refer to `join()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"$this","description":"The query object itself"}},"join":{"signature":"public function join(string $type, string|array $table, string|array $on = '', array $params = []): $this","summary":"Appends a JOIN part to the query.","params":[{"name":"$type","type":"string","description":"The type of join, such as INNER JOIN, LEFT JOIN."},{"name":"$table","type":"string|array","description":"The table or sub-query to be joined. Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression). You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']). To join a sub-query, use an array with one element, with the value set to a `yii\\db\\Query` object representing the sub-query, and the corresponding key representing the alias."},{"name":"$on","type":"string|array","default":"''","optional":true,"description":"The join condition that should appear in the ON part. Please refer to `where()` on how to specify this parameter. Note that the array format of `where()` is designed to match columns to values instead of columns to columns, so the following would **not** work as expected: `['post.author_id' => 'user.id']`, it would match the `post.author_id` column value against the string `'user.id'`. It is recommended to use the string syntax here which is more suited for a join: ``` 'post.author_id = user.id' ```"},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"$this","description":"The query object itself"}},"leftJoin":{"signature":"public function leftJoin(string|array $table, string|array $on = '', array $params = []): $this","summary":"Appends a LEFT OUTER JOIN part to the query.","params":[{"name":"$table","type":"string|array","description":"The table or sub-query to be joined. Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression). You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']). To join a sub-query, use an array with one element, with the value set to a `yii\\db\\Query` object representing the sub-query, and the corresponding key representing the alias."},{"name":"$on","type":"string|array","default":"''","optional":true,"description":"The join condition that should appear in the ON part. Please refer to `join()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query"}],"return":{"type":"$this","description":"The query object itself"}},"max":{"signature":"public function max(string $q, yii\\db\\Connection|null $db = null): mixed","summary":"Returns the maximum of the specified column values.","params":[{"name":"$q","type":"string","description":"The column name or expression. Make sure you properly [quote](https://yii2-framework.github.io/docs/guide/db-dao/#quoting-table-and-column-names) column names in the expression."},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"mixed","description":"The maximum of the specified column values."}},"min":{"signature":"public function min(string $q, yii\\db\\Connection|null $db = null): mixed","summary":"Returns the minimum of the specified column values.","params":[{"name":"$q","type":"string","description":"The column name or expression. Make sure you properly [quote](https://yii2-framework.github.io/docs/guide/db-dao/#quoting-table-and-column-names) column names in the expression."},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"mixed","description":"The minimum of the specified column values."}},"noCache":{"signature":"public function noCache(): $this","summary":"Disables query cache for this Query.","return":{"type":"$this","description":"The Query object itself"},"since":"2.0.14"},"normalizeSelect":{"signature":"protected function normalizeSelect(string|array|yii\\db\\ExpressionInterface $columns): array","summary":"Normalizes the SELECT columns passed to `select()` or `addSelect()`.","params":[{"name":"$columns","type":"string|array|yii\\db\\ExpressionInterface"}],"return":{"type":"array"},"visibility":"protected","since":"2.0.21"},"one":{"signature":"public function one(yii\\db\\Connection|null $db = null): array|bool","summary":"Executes the query and returns a single row of result.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"array|bool","description":"The first row (in terms of an array) of the query result. False is returned if the query results in nothing."}},"orFilterHaving":{"signature":"public function orFilterHaving(array $condition): $this","summary":"Adds an additional HAVING condition to the existing one but ignores empty operands (`isEmpty()`).","params":[{"name":"$condition","type":"array","description":"The new HAVING condition. Please refer to `having()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"},"since":"2.0.11"},"orHaving":{"signature":"public function orHaving(string|array|yii\\db\\ExpressionInterface $condition, array $params = []): $this","summary":"Adds an additional HAVING condition to the existing one.","params":[{"name":"$condition","type":"string|array|yii\\db\\ExpressionInterface","description":"The new HAVING condition. Please refer to `where()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"$this","description":"The query object itself"}},"orWhere":{"signature":"public function orWhere(string|array|yii\\db\\ExpressionInterface $condition, array $params = []): $this","summary":"Adds an additional WHERE condition to the existing one.","params":[{"name":"$condition","type":"string|array|yii\\db\\ExpressionInterface","description":"The new WHERE condition. Please refer to `where()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"$this","description":"The query object itself"}},"params":{"signature":"public function params(array $params): $this","summary":"Sets the parameters to be bound to the query.","params":[{"name":"$params","type":"array","description":"List of query parameter values indexed by parameter placeholders. For example, `[':name' => 'Dan', ':age' => 31]`."}],"return":{"type":"$this","description":"The query object itself"}},"populate":{"signature":"public function populate(array $rows, yii\\db\\Connection|null $db = null): array","summary":"Converts the raw query results into the format as specified by this query.","params":[{"name":"$rows","type":"array","description":"The raw query result from database."},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to retrieve the rows."}],"return":{"type":"array","description":"The converted query result."}},"prepare":{"signature":"public function prepare(yii\\db\\QueryBuilder $builder): self","summary":"Prepares for building SQL.","params":[{"name":"$builder","type":"yii\\db\\QueryBuilder"}],"return":{"type":"self","description":"A prepared query instance which will be used by `yii\\db\\QueryBuilder` to build the SQL"}},"queryScalar":{"signature":"protected function queryScalar(string|yii\\db\\ExpressionInterface $selectExpression, yii\\db\\Connection|null $db): bool|string|null","summary":"Queries a scalar value by setting `select()` first.","params":[{"name":"$selectExpression","type":"string|yii\\db\\ExpressionInterface"},{"name":"$db","type":"yii\\db\\Connection|null","description":"The database connection used to execute the query."}],"return":{"type":"bool|string|null"},"throws":[{"type":"Throwable","description":"if can't create command"}],"visibility":"protected"},"rightJoin":{"signature":"public function rightJoin(string|array $table, string|array $on = '', array $params = []): $this","summary":"Appends a RIGHT OUTER JOIN part to the query.","params":[{"name":"$table","type":"string|array","description":"The table or sub-query to be joined. Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression). You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']). To join a sub-query, use an array with one element, with the value set to a `yii\\db\\Query` object representing the sub-query, and the corresponding key representing the alias."},{"name":"$on","type":"string|array","default":"''","optional":true,"description":"The join condition that should appear in the ON part. Please refer to `join()` on how to specify this parameter."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query"}],"return":{"type":"$this","description":"The query object itself"}},"scalar":{"signature":"public function scalar(yii\\db\\Connection|null $db = null): string|int|null|false","summary":"Returns the query result as a scalar value.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"string|int|null|false","description":"The value of the first column in the first row of the query result. False is returned if the query result is empty."}},"select":{"signature":"public function select(string|array|yii\\db\\ExpressionInterface $columns, string|null $option = null): $this","summary":"Sets the SELECT part of the query.","params":[{"name":"$columns","type":"string|array|yii\\db\\ExpressionInterface","description":"The columns to be selected. Columns can be specified in either a string (e.g. \"id, name\") or an array (e.g. ['id', 'name']). Columns can be prefixed with table names (e.g. \"user.id\") and/or contain column aliases (e.g. \"user.id AS user_id\"). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression). A DB expression may also be passed in form of an `yii\\db\\ExpressionInterface` object. Note that if you are selecting an expression like `CONCAT(first_name, ' ', last_name)`, you should use an array to specify the columns. Otherwise, the expression may be incorrectly split into several parts. When the columns are specified as an array, you may also use array keys as the column aliases (if a column does not need alias, do not use a string key). Starting from version 2.0.1, you may also select sub-queries as columns by specifying each such column as a `Query` instance representing the sub-query."},{"name":"$option","type":"string|null","default":"null","optional":true,"description":"Additional option that should be appended to the 'SELECT' keyword. For example, in MySQL, the option 'SQL_CALC_FOUND_ROWS' can be used."}],"return":{"type":"$this","description":"The query object itself"}},"setCommandCache":{"signature":"protected function setCommandCache(yii\\db\\Command $command): yii\\db\\Command","summary":"Sets $command cache, if this query has enabled caching.","params":[{"name":"$command","type":"yii\\db\\Command"}],"return":{"type":"yii\\db\\Command"},"visibility":"protected","since":"2.0.14"},"sum":{"signature":"public function sum(string $q, yii\\db\\Connection|null $db = null): mixed","summary":"Returns the sum of the specified column values.","params":[{"name":"$q","type":"string","description":"The column name or expression. Make sure you properly [quote](https://yii2-framework.github.io/docs/guide/db-dao/#quoting-table-and-column-names) column names in the expression."},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"mixed","description":"The sum of the specified column values."}},"union":{"signature":"public function union(string|yii\\db\\Query $sql, bool $all = false): $this","summary":"Appends a SQL statement using UNION operator.","params":[{"name":"$sql","type":"string|yii\\db\\Query","description":"The SQL statement to be appended using UNION"},{"name":"$all","type":"bool","default":"false","optional":true,"description":"TRUE if using UNION ALL and FALSE if using UNION"}],"return":{"type":"$this","description":"The query object itself"}},"unionLimit":{"signature":"public function unionLimit(int|yii\\db\\ExpressionInterface|null $limit): static","summary":"Sets the LIMIT part of the complete UNION result.","params":[{"name":"$limit","type":"int|yii\\db\\ExpressionInterface|null","description":"The limit. Use `null` or a negative value to disable it."}],"return":{"type":"static","description":"The query object itself."},"since":"22.0"},"unionOffset":{"signature":"public function unionOffset(int|yii\\db\\ExpressionInterface|null $offset): static","summary":"Sets the OFFSET part of the complete UNION result.","params":[{"name":"$offset","type":"int|yii\\db\\ExpressionInterface|null","description":"The offset. Use null or a negative value to disable it."}],"return":{"type":"static","description":"The query object itself."},"since":"22.0"},"unionOrderBy":{"signature":"public function unionOrderBy(array|string|yii\\db\\ExpressionInterface|null $columns): static","summary":"Sets the ORDER BY part of the complete UNION result.","params":[{"name":"$columns","type":"array|string|yii\\db\\ExpressionInterface|null","description":"The columns (and the directions) to be ordered by."}],"return":{"type":"static","description":"The query object itself."},"since":"22.0"},"where":{"signature":"public function where(string|array|yii\\db\\ExpressionInterface $condition, array $params = []): $this","summary":"Sets the WHERE part of the query.","params":[{"name":"$condition","type":"string|array|yii\\db\\ExpressionInterface","description":"The conditions that should be put in the WHERE part."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters (name => value) to be bound to the query."}],"return":{"type":"$this","description":"The query object itself"}},"withQuery":{"signature":"public function withQuery(string|yii\\db\\Query $query, string $alias, bool $recursive = false): $this","summary":"Prepends a SQL statement using WITH syntax.","params":[{"name":"$query","type":"string|yii\\db\\Query","description":"The SQL statement to be prepended using WITH"},{"name":"$alias","type":"string","description":"Query alias in WITH construction"},{"name":"$recursive","type":"bool","default":"false","optional":true,"description":"TRUE if using WITH RECURSIVE and FALSE if using WITH"}],"return":{"type":"$this","description":"The query object itself"},"since":"2.0.35"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","emulateExecution":"yii\\db\\QueryTrait","indexBy":"yii\\db\\QueryTrait","limit":"yii\\db\\QueryTrait","offset":"yii\\db\\QueryTrait","orderBy":"yii\\db\\QueryTrait","where":"yii\\db\\QueryTrait"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","addOrderBy":"yii\\db\\QueryTrait","andFilterWhere":"yii\\db\\QueryTrait","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","emulateExecution":"yii\\db\\QueryTrait","ensureBehaviors":"yii\\base\\Component","filterCondition":"yii\\db\\QueryTrait","filterWhere":"yii\\db\\QueryTrait","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","indexBy":"yii\\db\\QueryTrait","init":"yii\\base\\BaseObject","isEmpty":"yii\\db\\QueryTrait","limit":"yii\\db\\QueryTrait","normalizeOrderBy":"yii\\db\\QueryTrait","off":"yii\\base\\Component","offset":"yii\\db\\QueryTrait","on":"yii\\base\\Component","orderBy":"yii\\db\\QueryTrait","orFilterWhere":"yii\\db\\QueryTrait","trigger":"yii\\base\\Component"}}},"yii\\db\\QueryBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/querybuilder/","summary":"QueryBuilder builds a SELECT SQL statement based on the specification given as a `yii\\db\\Query` object.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"conditionClasses":{"type":"array","default":"[]","description":"Map of condition aliases to condition classes.","visibility":"protected","since":"2.0.14"},"db":{"type":"yii\\db\\Connection","default":"null","description":"The database connection."},"expressionBuilders":{"type":"string[]|yii\\db\\ExpressionBuilderInterface[]","default":"[]","description":"Maps expression class to expression builder class.","visibility":"protected","since":"2.0.14"},"separator":{"type":"string","default":"' '","description":"The separator between different fragments of a SQL statement."},"typeMap":{"type":"array","default":"[]","description":"The abstract column types mapped to physical column types."}},"methods":{"__construct":{"signature":"public function __construct(yii\\db\\Connection $connection, array $config = [])","summary":"Constructor.","params":[{"name":"$connection","type":"yii\\db\\Connection","description":"The database connection."},{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties"}]},"addCheck":{"signature":"public function addCheck(string $name, string $table, string $expression): string","summary":"Creates a SQL command for adding a check constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the check constraint. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the check constraint will be added to. The name will be properly quoted by the method."},{"name":"$expression","type":"string","description":"The SQL of the `CHECK` constraint."}],"return":{"type":"string","description":"The SQL statement for adding a check constraint to an existing table."},"since":"2.0.13"},"addColumn":{"signature":"public function addColumn(string $table, string $column, string $type): string","summary":"Builds a SQL statement for adding a new DB column.","params":[{"name":"$table","type":"string","description":"The table that the new column will be added to. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the new column. The name will be properly quoted by the method."},{"name":"$type","type":"string","description":"The column type. The `getColumnType()` method will be invoked to convert abstract column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'."}],"return":{"type":"string","description":"The SQL statement for adding a new column."}},"addCommentOnColumn":{"signature":"public function addCommentOnColumn(string $table, string $column, string $comment): string","summary":"Builds a SQL command for adding comment to column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be commented. The column name will be properly quoted by the method."},{"name":"$comment","type":"string","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"since":"2.0.8"},"addCommentOnTable":{"signature":"public function addCommentOnTable(string $table, string $comment): string","summary":"Builds a SQL command for adding comment to table.","params":[{"name":"$table","type":"string","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$comment","type":"string","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on table"},"since":"2.0.8"},"addDefaultValue":{"signature":"public function addDefaultValue(string $name, string $table, string $column, mixed $value): string","summary":"Creates a SQL command for adding a default value constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the default value constraint. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the default value constraint will be added to. The name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to that the constraint will be added on. The name will be properly quoted by the method."},{"name":"$value","type":"mixed","description":"Default value."}],"return":{"type":"string","description":"The SQL statement for adding a default value constraint to an existing table."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}],"since":"2.0.13"},"addForeignKey":{"signature":"public function addForeignKey(string $name, string $table, string|array $columns, string $refTable, string|array $refColumns, string|null $delete = null, string|null $update = null): string","summary":"Builds a SQL statement for adding a foreign key constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the foreign key constraint."},{"name":"$table","type":"string","description":"The table that the foreign key constraint will be added to."},{"name":"$columns","type":"string|array","description":"The name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array to represent them."},{"name":"$refTable","type":"string","description":"The table that the foreign key references to."},{"name":"$refColumns","type":"string|array","description":"The name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array to represent them."},{"name":"$delete","type":"string|null","default":"null","optional":true,"description":"The ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL"},{"name":"$update","type":"string|null","default":"null","optional":true,"description":"The ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL"}],"return":{"type":"string","description":"The SQL statement for adding a foreign key constraint to an existing table."}},"addPrimaryKey":{"signature":"public function addPrimaryKey(string $name, string $table, string|array $columns): string","summary":"Builds a SQL statement for adding a primary key constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the primary key constraint."},{"name":"$table","type":"string","description":"The table that the primary key constraint will be added to."},{"name":"$columns","type":"string|array","description":"Comma separated string or array of columns that the primary key will consist of."}],"return":{"type":"string","description":"The SQL statement for adding a primary key constraint to an existing table."}},"addUnique":{"signature":"public function addUnique(string $name, string $table, string|array $columns): string","summary":"Creates a SQL command for adding an unique constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the unique constraint. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the unique constraint will be added to. The name will be properly quoted by the method."},{"name":"$columns","type":"string|array","description":"The name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding an unique constraint to an existing table."},"since":"2.0.13"},"alterColumn":{"signature":"public function alterColumn(string $table, string $column, string $type): string","summary":"Builds a SQL statement for changing the definition of a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be changed. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be changed. The name will be properly quoted by the method."},{"name":"$type","type":"string","description":"The new column type. The `getColumnType()` method will be invoked to convert abstract column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'."}],"return":{"type":"string","description":"The SQL statement for changing the definition of a column."}},"batchInsert":{"signature":"public function batchInsert(string $table, array $columns, array|Generator $rows, array &$params = []): string","summary":"Generates a batch INSERT SQL statement.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"array","description":"The column names"},{"name":"$rows","type":"array|Generator","description":"The rows to be batch inserted into the table"},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters. This parameter exists since 2.0.14"}],"return":{"type":"string","description":"The batch INSERT SQL statement"}},"bindParam":{"signature":"public function bindParam(string|null $value, array &$params): string","summary":"Helper method to add $value to $params array using `PARAM_PREFIX`.","params":[{"name":"$value","type":"string|null"},{"name":"$params","type":"array","byReference":true,"description":"Passed by reference"}],"return":{"type":"string","description":"The placeholder name in $params array"},"since":"2.0.14"},"build":{"signature":"public function build(yii\\db\\Query $query, array $params = []): array","summary":"Generates a SELECT SQL statement from a `yii\\db\\Query` object.","params":[{"name":"$query","type":"yii\\db\\Query","description":"The `yii\\db\\Query` object from which the SQL statement will be generated."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be bound to the generated SQL statement. These parameters will be included in the result with the additional parameters generated during the query building process."}],"return":{"type":"array","description":"The generated SQL statement (the first array element) and the corresponding parameters to be bound to the SQL statement (the second array element). The parameters returned include those provided in `$params`."}},"buildColumns":{"signature":"public function buildColumns(string|array $columns): string","summary":"Processes columns and properly quotes them if necessary.","params":[{"name":"$columns","type":"string|array","description":"The columns to be processed"}],"return":{"type":"string","description":"The processing result"}},"buildCondition":{"signature":"public function buildCondition(string|array|yii\\db\\ExpressionInterface $condition, array &$params): string","summary":"Parses the condition specification and generates the corresponding SQL expression.","params":[{"name":"$condition","type":"string|array|yii\\db\\ExpressionInterface","description":"The condition specification. Please refer to `yii\\db\\Query::where()` on how to specify a condition."},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters to be populated"}],"return":{"type":"string","description":"The generated SQL expression"}},"buildExpression":{"signature":"public function buildExpression(yii\\db\\ExpressionInterface $expression, array &$params = []): string","summary":"Builds given $expression","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface","description":"The expression to be built"},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The parameters to be bound to the generated SQL statement. These parameters will be included in the result with the additional parameters generated during the expression building process."}],"return":{"type":"string","description":"The SQL statement that will not be neither quoted nor encoded before passing to DBMS"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"when $expression building is not supported by this QueryBuilder."}],"since":"2.0.14"},"buildFrom":{"signature":"public function buildFrom(array $tables, array &$params): string","params":[{"name":"$tables","type":"array"},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters to be populated"}],"return":{"type":"string","description":"The FROM clause built from `yii\\db\\Query::$from`."}},"buildGroupBy":{"signature":"public function buildGroupBy(array $columns): string","params":[{"name":"$columns","type":"array"}],"return":{"type":"string","description":"The GROUP BY clause"}},"buildHaving":{"signature":"public function buildHaving(string|array $condition, array &$params): string","params":[{"name":"$condition","type":"string|array"},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters to be populated"}],"return":{"type":"string","description":"The HAVING clause built from `yii\\db\\Query::$having`."}},"buildJoin":{"signature":"public function buildJoin(array $joins, array &$params): string","params":[{"name":"$joins","type":"array"},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters to be populated"}],"return":{"type":"string","description":"The JOIN clause built from `yii\\db\\Query::$join`."},"throws":[{"type":"yii\\db\\Exception","description":"if the $joins parameter is not in proper format"}]},"buildLimit":{"signature":"public function buildLimit(int $limit, int $offset): string","params":[{"name":"$limit","type":"int"},{"name":"$offset","type":"int"}],"return":{"type":"string","description":"The LIMIT and OFFSET clauses"}},"buildOrderBy":{"signature":"public function buildOrderBy(array $columns): string","params":[{"name":"$columns","type":"array"}],"return":{"type":"string","description":"The ORDER BY clause built from `yii\\db\\Query::$orderBy`."}},"buildOrderByAndLimit":{"signature":"public function buildOrderByAndLimit(string $sql, array $orderBy, int $limit, int $offset): string","summary":"Builds the ORDER BY and LIMIT/OFFSET clauses and appends them to the given SQL.","params":[{"name":"$sql","type":"string","description":"The existing SQL (without ORDER BY/LIMIT/OFFSET)"},{"name":"$orderBy","type":"array","description":"The order by columns. See `yii\\db\\Query::orderBy()` for more details on how to specify this parameter."},{"name":"$limit","type":"int","description":"The limit number. See `yii\\db\\Query::limit()` for more details."},{"name":"$offset","type":"int","description":"The offset number. See `yii\\db\\Query::offset()` for more details."}],"return":{"type":"string","description":"The SQL completed with ORDER BY/LIMIT/OFFSET (if any)"}},"buildSelect":{"signature":"public function buildSelect(array $columns, array &$params, bool $distinct = false, string|null $selectOption = null): string","params":[{"name":"$columns","type":"array"},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters to be populated"},{"name":"$distinct","type":"bool","default":"false","optional":true},{"name":"$selectOption","type":"string|null","default":"null","optional":true}],"return":{"type":"string","description":"The SELECT clause built from `yii\\db\\Query::$select`."}},"buildUnion":{"signature":"public function buildUnion(array $unions, array &$params): string","params":[{"name":"$unions","type":"array"},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters to be populated"}],"return":{"type":"string","description":"The UNION clause built from `yii\\db\\Query::$union`."}},"buildUnionOrderByAndLimit":{"signature":"public function buildUnionOrderByAndLimit(string $sql, array|null $orderBy, int|yii\\db\\ExpressionInterface|null $limit, int|yii\\db\\ExpressionInterface|null $offset): string","summary":"Builds the global ORDER BY and LIMIT/OFFSET clauses for a UNION query.","params":[{"name":"$sql","type":"string","description":"The complete UNION SQL without global ORDER BY/LIMIT/OFFSET clauses."},{"name":"$orderBy","type":"array|null","description":"The global order by columns."},{"name":"$limit","type":"int|yii\\db\\ExpressionInterface|null","description":"The global limit."},{"name":"$offset","type":"int|yii\\db\\ExpressionInterface|null","description":"The global offset."}],"return":{"type":"string","description":"The completed UNION SQL."},"since":"22.0"},"buildWhere":{"signature":"public function buildWhere(string|array $condition, array &$params): string","params":[{"name":"$condition","type":"string|array"},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters to be populated"}],"return":{"type":"string","description":"The WHERE clause built from `yii\\db\\Query::$where`."}},"buildWithQueries":{"signature":"public function buildWithQueries(array $withs, array &$params): string","params":[{"name":"$withs","type":"array","description":"Of configurations for each WITH query"},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters to be populated"}],"return":{"type":"string","description":"Compiled WITH prefix of query including nested queries"},"since":"2.0.35"},"checkIntegrity":{"signature":"public function checkIntegrity(bool $check = true, string $schema = '', string $table = ''): string","summary":"Builds a SQL statement for enabling or disabling integrity check.","params":[{"name":"$check","type":"bool","default":"true","optional":true,"description":"Whether to turn on or off the integrity check."},{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema."},{"name":"$table","type":"string","default":"''","optional":true,"description":"The table name. Defaults to empty string, meaning that no table will be changed."}],"return":{"type":"string","description":"The SQL statement for checking integrity"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS"}]},"concatUnionSql":{"signature":"protected function concatUnionSql(string $sql, string $union): string","summary":"Concatenates the first `SELECT` statement with the UNION clauses built by `buildUnion()`.","params":[{"name":"$sql","type":"string","description":"The SQL of the first `SELECT` statement."},{"name":"$union","type":"string","description":"The UNION clauses."}],"return":{"type":"string","description":"The compound SQL with the first statement parenthesized."},"visibility":"protected","since":"22.0"},"createConditionFromArray":{"signature":"public function createConditionFromArray(string|array $condition): yii\\db\\conditions\\ConditionInterface","summary":"Transforms $condition defined in array format (as described in `yii\\db\\Query::where()` to instance of ConditionInterface according to `$conditionClasses` map.","params":[{"name":"$condition","type":"string|array"}],"return":{"type":"yii\\db\\conditions\\ConditionInterface"},"since":"2.0.14"},"createIndex":{"signature":"public function createIndex(string $name, string $table, string|array $columns, bool $unique = false): string","summary":"Builds a SQL statement for creating a new index.","params":[{"name":"$name","type":"string","description":"The name of the index. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the new index will be created for. The table name will be properly quoted by the method."},{"name":"$columns","type":"string|array","description":"The column(s) that should be included in the index. If there are multiple columns, separate them with commas or use an array to represent them. Each column name will be properly quoted by the method, unless a parenthesis is found in the name."},{"name":"$unique","type":"bool","default":"false","optional":true,"description":"Whether to add UNIQUE constraint on the created index."}],"return":{"type":"string","description":"The SQL statement for creating a new index."}},"createTable":{"signature":"public function createTable(string $table, array $columns, string|null $options = null): string","summary":"Builds a SQL statement for creating a new DB table.","params":[{"name":"$table","type":"string","description":"The name of the table to be created. The name will be properly quoted by the method."},{"name":"$columns","type":"array","description":"The columns (name => definition) in the new table."},{"name":"$options","type":"string|null","default":"null","optional":true,"description":"Additional SQL fragment that will be appended to the generated SQL."}],"return":{"type":"string","description":"The SQL statement for creating a new DB table."}},"createView":{"signature":"public function createView(string $viewName, string|yii\\db\\Query $subQuery): string","summary":"Creates a SQL View.","params":[{"name":"$viewName","type":"string","description":"The name of the view to be created."},{"name":"$subQuery","type":"string|yii\\db\\Query","description":"The select statement which defines the view. This can be either a string or a `yii\\db\\Query` object."}],"return":{"type":"string","description":"The `CREATE VIEW` SQL statement."},"since":"2.0.14"},"defaultConditionClasses":{"signature":"protected function defaultConditionClasses(): array","summary":"Contains array of default condition classes. Extend this method, if you want to change default condition classes for the query builder. See `$conditionClasses` docs for details.","return":{"type":"array"},"visibility":"protected","since":"2.0.14"},"defaultExpressionBuilders":{"signature":"protected function defaultExpressionBuilders(): array","summary":"Contains array of default expression builders. Extend this method and override it, if you want to change default expression builders for this query builder. See `$expressionBuilders` docs for details.","return":{"type":"array"},"visibility":"protected","since":"2.0.14"},"delete":{"signature":"public function delete(string $table, array|string $condition, array &$params): string","summary":"Creates a DELETE SQL statement.","params":[{"name":"$table","type":"string","description":"The table where the data will be deleted from."},{"name":"$condition","type":"array|string","description":"The condition that will be put in the WHERE part. Please refer to `yii\\db\\Query::where()` on how to specify condition."},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters that will be modified by this method so that they can be bound to the DB command later."}],"return":{"type":"string","description":"The DELETE SQL"}},"dropCheck":{"signature":"public function dropCheck(string $name, string $table): string","summary":"Creates a SQL command for dropping a check constraint.","params":[{"name":"$name","type":"string","description":"The name of the check constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose check constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping a check constraint."},"since":"2.0.13"},"dropColumn":{"signature":"public function dropColumn(string $table, string $column): string","summary":"Builds a SQL statement for dropping a DB column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be dropped. The name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping a DB column."}},"dropCommentFromColumn":{"signature":"public function dropCommentFromColumn(string $table, string $column): string","summary":"Builds a SQL command for adding comment to column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be commented. The column name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"since":"2.0.8"},"dropCommentFromTable":{"signature":"public function dropCommentFromTable(string $table): string","summary":"Builds a SQL command for adding comment to table.","params":[{"name":"$table","type":"string","description":"The table whose column is to be commented. The table name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"since":"2.0.8"},"dropDefaultValue":{"signature":"public function dropDefaultValue(string $name, string $table): string","summary":"Creates a SQL command for dropping a default value constraint.","params":[{"name":"$name","type":"string","description":"The name of the default value constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose default value constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping a default value constraint."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}],"since":"2.0.13"},"dropForeignKey":{"signature":"public function dropForeignKey(string $name, string $table): string","summary":"Builds a SQL statement for dropping a foreign key constraint.","params":[{"name":"$name","type":"string","description":"The name of the foreign key constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose foreign is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping a foreign key constraint."}},"dropIndex":{"signature":"public function dropIndex(string $name, string $table): string","summary":"Builds a SQL statement for dropping an index.","params":[{"name":"$name","type":"string","description":"The name of the index to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose index is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping an index."}},"dropPrimaryKey":{"signature":"public function dropPrimaryKey(string $name, string $table): string","summary":"Builds a SQL statement for removing a primary key constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the primary key constraint to be removed."},{"name":"$table","type":"string","description":"The table that the primary key constraint will be removed from."}],"return":{"type":"string","description":"The SQL statement for removing a primary key constraint from an existing table."}},"dropTable":{"signature":"public function dropTable(string $table): string","summary":"Builds a SQL statement for dropping a DB table.","params":[{"name":"$table","type":"string","description":"The table to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping a DB table."}},"dropUnique":{"signature":"public function dropUnique(string $name, string $table): string","summary":"Creates a SQL command for dropping an unique constraint.","params":[{"name":"$name","type":"string","description":"The name of the unique constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose unique constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping an unique constraint."},"since":"2.0.13"},"dropView":{"signature":"public function dropView(string $viewName): string","summary":"Drops a SQL View.","params":[{"name":"$viewName","type":"string","description":"The name of the view to be dropped."}],"return":{"type":"string","description":"The `DROP VIEW` SQL statement."},"since":"2.0.14"},"executeResetSequence":{"signature":"public function executeResetSequence(string $table, int|null $value = null): mixed","summary":"Execute a SQL statement for resetting the sequence value of a table's primary key.","params":[{"name":"$table","type":"string","description":"The name of the table whose primary key sequence is reset."},{"name":"$value","type":"int|null","default":"null","optional":true,"description":"The integer value for the primary key of the next new row inserted. If this is not set, the next new row's primary key will have the maximum existing value `+1`."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS"}],"since":"2.0.16"},"extractAlias":{"signature":"protected function extractAlias(mixed $table): bool|array","summary":"Extracts table alias if there is one or returns false","params":[{"name":"$table","type":"mixed"}],"return":{"type":"bool|array"},"visibility":"protected","since":"2.0.24"},"getColumnType":{"signature":"public function getColumnType(string|yii\\db\\ColumnSchemaBuilder $type): string","summary":"Converts an abstract column type into a physical column type.","params":[{"name":"$type","type":"string|yii\\db\\ColumnSchemaBuilder","description":"Abstract column type"}],"return":{"type":"string","description":"Physical column type."}},"getExpressionBuilder":{"signature":"public function getExpressionBuilder(yii\\db\\ExpressionInterface $expression): yii\\db\\ExpressionBuilderInterface","summary":"Gets object of `yii\\db\\ExpressionBuilderInterface` that is suitable for $expression.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface"}],"return":{"type":"yii\\db\\ExpressionBuilderInterface"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"when $expression building is not supported by this QueryBuilder."}],"since":"2.0.14"},"hasLimit":{"signature":"protected function hasLimit(mixed $limit): bool","summary":"Checks to see if the given limit is effective.","params":[{"name":"$limit","type":"mixed","description":"The given limit"}],"return":{"type":"bool","description":"Whether the limit is effective"},"visibility":"protected"},"hasOffset":{"signature":"protected function hasOffset(mixed $offset): bool","summary":"Checks to see if the given offset is effective.","params":[{"name":"$offset","type":"mixed","description":"The given offset"}],"return":{"type":"bool","description":"Whether the offset is effective"},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"insert":{"signature":"public function insert(string $table, array|yii\\db\\Query $columns, array &$params): string","summary":"Creates an INSERT SQL statement.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"array|yii\\db\\Query","description":"The column data (name => value) to be inserted into the table or instance of Query (`yii\\db\\Query`) to perform INSERT INTO ... SELECT SQL statement. Passing of Query (`yii\\db\\Query`) is available since version 2.0.11."},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"string","description":"The INSERT SQL"}},"prepareInsertSelectSubQuery":{"signature":"protected function prepareInsertSelectSubQuery(yii\\db\\Query $columns, yii\\db\\Schema $schema, array $params = []): array","summary":"Prepare select-subquery and field names for INSERT INTO ... SELECT SQL statement.","params":[{"name":"$columns","type":"yii\\db\\Query","description":"Object, which represents select query."},{"name":"$schema","type":"yii\\db\\Schema","description":"Schema object to quote column name."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The parameters to be bound to the generated SQL statement. These parameters will be included in the result with the additional parameters generated during the query building process."}],"return":{"type":"array","description":"Array of column names, values and params."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if query's select does not contain named parameters only."}],"visibility":"protected","since":"2.0.11"},"prepareInsertValues":{"signature":"protected function prepareInsertValues(string $table, array|yii\\db\\Query $columns, array $params = []): array","summary":"Prepares a `VALUES` part for an `INSERT` SQL statement.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"array|yii\\db\\Query","description":"The column data (name => value) to be inserted into the table or instance of Query (`yii\\db\\Query`) to perform INSERT INTO ... SELECT SQL statement."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"array","description":"Array of column names, placeholders, values and params."},"visibility":"protected","since":"2.0.14"},"prepareSelectQuery":{"signature":"protected function prepareSelectQuery(yii\\db\\Query $query): yii\\db\\Query","summary":"Performs driver-specific preparation after `yii\\db\\Query::prepare()`.","params":[{"name":"$query","type":"yii\\db\\Query","description":"The prepared query."}],"return":{"type":"yii\\db\\Query","description":"The query to build."},"visibility":"protected","since":"22.0"},"prepareUpdateSets":{"signature":"protected function prepareUpdateSets(string $table, array $columns, array $params = []): array","summary":"Prepares a `SET` parts for an `UPDATE` SQL statement.","params":[{"name":"$table","type":"string","description":"The table to be updated."},{"name":"$columns","type":"array","description":"The column data (name => value) to be updated."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The binding parameters that will be modified by this method so that they can be bound to the DB command later."}],"return":{"type":"array","description":"An array `SET` parts for an `UPDATE` SQL statement (the first array element) and params (the second array element)."},"visibility":"protected","since":"2.0.14"},"prepareUpsertColumns":{"signature":"protected function prepareUpsertColumns(string $table, array|yii\\db\\Query $insertColumns, array|bool $updateColumns, yii\\db\\Constraint[] &$constraints = []): array","params":[{"name":"$table","type":"string"},{"name":"$insertColumns","type":"array|yii\\db\\Query"},{"name":"$updateColumns","type":"array|bool"},{"name":"$constraints","type":"yii\\db\\Constraint[]","default":"[]","optional":true,"byReference":true,"description":"This parameter receives a matched constraint list. The constraints will be unique by their column names."}],"return":{"type":"array"},"visibility":"protected","since":"2.0.14"},"prepareUpsertSets":{"signature":"protected function prepareUpsertSets(string $table, array|bool $updateColumns, string[]|null $updateNames, array $params, Closure(string): string $sourceColumnRef): array{string[], array}","summary":"Prepares the `SET` assignments for the update branch of an upsert statement.","params":[{"name":"$table","type":"string","description":"The table that the upsert targets."},{"name":"$updateColumns","type":"array|bool","description":"`true` for every non-unique inserted column, or an explicit `name => value` map."},{"name":"$updateNames","type":"string[]|null","description":"Quoted column names eligible for update."},{"name":"$params","type":"array","description":"The binding parameters modified by this method."},{"name":"$sourceColumnRef","type":"Closure(string): string","description":"Maps a quoted column name to its source reference."}],"return":{"type":"array{string[], array}","description":"The `SET` assignments (first element) and params (second element)."},"visibility":"protected","since":"22.0"},"renameColumn":{"signature":"public function renameColumn(string $table, string $oldName, string $newName): string","summary":"Builds a SQL statement for renaming a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be renamed. The name will be properly quoted by the method."},{"name":"$oldName","type":"string","description":"The old name of the column. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new name of the column. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for renaming a DB column."}},"renameTable":{"signature":"public function renameTable(string $oldName, string $newName): string","summary":"Builds a SQL statement for renaming a DB table.","params":[{"name":"$oldName","type":"string","description":"The table to be renamed. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new table name. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for renaming a DB table."}},"resetSequence":{"signature":"public function resetSequence(string $tableName, int|null $value = null): string","summary":"Creates a SQL statement for resetting the sequence value of a table's primary key.","params":[{"name":"$tableName","type":"string","description":"The name of the table whose primary key sequence will be reset."},{"name":"$value","type":"int|null","default":"null","optional":true,"description":"The integer value for the primary key of the next new row inserted. If this is not set, the next new row's primary key will have the maximum existing value `+1`."}],"return":{"type":"string","description":"The SQL statement for resetting sequence."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}]},"selectExists":{"signature":"public function selectExists(string $rawSql): string","summary":"Creates a SELECT EXISTS() SQL statement.","params":[{"name":"$rawSql","type":"string","description":"The subquery in a raw form to select from."}],"return":{"type":"string","description":"The SELECT EXISTS() SQL statement."},"since":"2.0.8"},"setConditionClasses":{"signature":"public function setConditionClasses(string[] $classes): mixed","summary":"Setter for `$conditionClasses` property.","params":[{"name":"$classes","type":"string[]","description":"Map of condition aliases to condition classes. For example: ``` ['LIKE' => yii\\db\\condition\\LikeCondition::class] ```"}],"return":{"type":"mixed"},"since":"2.0.14.2"},"setExpressionBuilders":{"signature":"public function setExpressionBuilders(string[] $builders): mixed","summary":"Setter for `$expressionBuilders` property.","params":[{"name":"$builders","type":"string[]","description":"Array of builders that should be merged with the pre-defined ones in `$expressionBuilders` property."}],"return":{"type":"mixed"},"since":"2.0.14"},"truncateTable":{"signature":"public function truncateTable(string $table): string","summary":"Builds a SQL statement for truncating a DB table.","params":[{"name":"$table","type":"string","description":"The table to be truncated. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for truncating a DB table."}},"update":{"signature":"public function update(string $table, array $columns, array|string $condition, array &$params): string","summary":"Creates an UPDATE SQL statement.","params":[{"name":"$table","type":"string","description":"The table to be updated."},{"name":"$columns","type":"array","description":"The column data (name => value) to be updated."},{"name":"$condition","type":"array|string","description":"The condition that will be put in the WHERE part. Please refer to `yii\\db\\Query::where()` on how to specify condition."},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters that will be modified by this method so that they can be bound to the DB command later."}],"return":{"type":"string","description":"The UPDATE SQL"}},"upsert":{"signature":"public function upsert(string $table, array|yii\\db\\Query $insertColumns, array|bool $updateColumns, array &$params): string","summary":"Creates an SQL statement to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into/updated in."},{"name":"$insertColumns","type":"array|yii\\db\\Query","description":"The column data (name => value) to be inserted into the table or instance of `yii\\db\\Query` to perform `INSERT INTO ... SELECT` SQL statement."},{"name":"$updateColumns","type":"array|bool","description":"The column data (name => value) to be updated if they already exist. If `true` is passed, the column data will be updated to match the insert column data. If `false` is passed, no update will be performed if the column data already exists."},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"string","description":"The resulting SQL."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}],"since":"2.0.14"}},"constants":{"PARAM_PREFIX":{"value":"':qp'","description":"The prefix for automatically generated query binding parameters."}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject"}}},"yii\\db\\QueryExpressionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/queryexpressionbuilder/","summary":"Class QueryExpressionBuilder is used internally to build `yii\\db\\Query` object using unified `yii\\db\\QueryBuilder` expression building interface.","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface|yii\\db\\Query $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface|yii\\db\\Query","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\QueryInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/db/queryinterface/","summary":"The QueryInterface defines the minimum set of methods to be implemented by a database query.","since":"2.0","methods":{"addOrderBy":{"signature":"abstract public function addOrderBy(string|array $columns): $this","summary":"Adds additional ORDER BY columns to the query.","params":[{"name":"$columns","type":"string|array","description":"The columns (and the directions) to be ordered by. Columns can be specified in either a string (e.g. \"id ASC, name DESC\") or an array (e.g. `['id' => SORT_ASC, 'name' => SORT_DESC]`). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression)."}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"all":{"signature":"abstract public function all(yii\\db\\Connection|null $db = null): array","summary":"Executes the query and returns all results as an array.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to execute the query. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"array","description":"The query results. If the query results in nothing, an empty array will be returned."},"abstract":true},"andFilterWhere":{"signature":"abstract public function andFilterWhere(array $condition): $this","summary":"Adds an additional WHERE condition to the existing one ignoring empty parameters.","params":[{"name":"$condition","type":"array","description":"The new WHERE condition. Please refer to `where()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"andWhere":{"signature":"abstract public function andWhere(array $condition): $this","summary":"Adds an additional WHERE condition to the existing one.","params":[{"name":"$condition","type":"array","description":"The new WHERE condition. Please refer to `where()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"count":{"signature":"abstract public function count(string $q = '*', yii\\db\\Connection|null $db = null): int|string|null","summary":"Returns the number of records.","params":[{"name":"$q","type":"string","default":"'*'","optional":true,"description":"The COUNT expression. Defaults to '*'."},{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to execute the query. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"int|string|null","description":"Number of records."},"abstract":true},"emulateExecution":{"signature":"abstract public function emulateExecution(bool $value = true): $this","summary":"Sets whether to emulate query execution, preventing any interaction with data storage.","params":[{"name":"$value","type":"bool","default":"true","optional":true,"description":"Whether to prevent query execution."}],"return":{"type":"$this","description":"The query object itself."},"abstract":true,"since":"2.0.11"},"exists":{"signature":"abstract public function exists(yii\\db\\Connection|null $db = null): bool","summary":"Returns a value indicating whether the query result contains any row of data.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to execute the query. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"bool","description":"Whether the query result contains any row of data."},"abstract":true},"filterWhere":{"signature":"abstract public function filterWhere(array $condition): $this","summary":"Sets the WHERE part of the query ignoring empty parameters.","params":[{"name":"$condition","type":"array","description":"The conditions that should be put in the WHERE part. Please refer to `where()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"indexBy":{"signature":"abstract public function indexBy(string|callable $column): $this","summary":"Sets the `indexBy()` property.","params":[{"name":"$column","type":"string|callable","description":"The name of the column by which the query results should be indexed by. This can also be a callable (e.g. anonymous function) that returns the index value based on the given row data. The signature of the callable should be: ``` function ($row) { // return the index value corresponding to $row } ```"}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"limit":{"signature":"abstract public function limit(int|null $limit): $this","summary":"Sets the LIMIT part of the query.","params":[{"name":"$limit","type":"int|null","description":"The limit. Use null or negative value to disable limit."}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"offset":{"signature":"abstract public function offset(int|null $offset): $this","summary":"Sets the OFFSET part of the query.","params":[{"name":"$offset","type":"int|null","description":"The offset. Use null or negative value to disable offset."}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"one":{"signature":"abstract public function one(yii\\db\\Connection|null $db = null): array|bool","summary":"Executes the query and returns a single row of result.","params":[{"name":"$db","type":"yii\\db\\Connection|null","default":"null","optional":true,"description":"The database connection used to execute the query. If this parameter is not given, the `db` application component will be used."}],"return":{"type":"array|bool","description":"The first row (in terms of an array) of the query result. False is returned if the query results in nothing."},"abstract":true},"orderBy":{"signature":"abstract public function orderBy(string|array $columns): $this","summary":"Sets the ORDER BY part of the query.","params":[{"name":"$columns","type":"string|array","description":"The columns (and the directions) to be ordered by. Columns can be specified in either a string (e.g. \"id ASC, name DESC\") or an array (e.g. `['id' => SORT_ASC, 'name' => SORT_DESC]`). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression)."}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"orFilterWhere":{"signature":"abstract public function orFilterWhere(array $condition): $this","summary":"Adds an additional WHERE condition to the existing one ignoring empty parameters.","params":[{"name":"$condition","type":"array","description":"The new WHERE condition. Please refer to `where()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"orWhere":{"signature":"abstract public function orWhere(array $condition): $this","summary":"Adds an additional WHERE condition to the existing one.","params":[{"name":"$condition","type":"array","description":"The new WHERE condition. Please refer to `where()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"},"abstract":true},"where":{"signature":"abstract public function where(array $condition): $this","summary":"Sets the WHERE part of the query.","params":[{"name":"$condition","type":"array","description":"The conditions that should be put in the WHERE part."}],"return":{"type":"$this","description":"The query object itself"},"abstract":true}}},"yii\\db\\QueryTrait":{"kind":"trait","url":"https://yii2-framework.github.io/docs/api/yii/db/querytrait/","summary":"The BaseQuery trait represents the minimum method set of a database Query.","since":"2.0","properties":{"emulateExecution":{"type":"bool","default":"false","description":"Whether to emulate the actual query execution, returning empty or false results.","since":"2.0.11"},"indexBy":{"type":"string|callable|null","default":"null","description":"The name of the column by which the query results should be indexed by."},"limit":{"type":"int|yii\\db\\ExpressionInterface|null","default":"null","description":"Maximum number of records to be returned."},"offset":{"type":"int|yii\\db\\ExpressionInterface|null","default":"null","description":"Zero-based offset from where the records are to be returned."},"orderBy":{"type":"array|null","default":"null","description":"How to sort the query results."},"where":{"type":"string|array|yii\\db\\ExpressionInterface|null","default":"null","description":"Query condition."}},"methods":{"addOrderBy":{"signature":"public function addOrderBy(string|array|yii\\db\\ExpressionInterface $columns): $this","summary":"Adds additional ORDER BY columns to the query.","params":[{"name":"$columns","type":"string|array|yii\\db\\ExpressionInterface","description":"The columns (and the directions) to be ordered by. Columns can be specified in either a string (e.g. \"id ASC, name DESC\") or an array (e.g. `['id' => SORT_ASC, 'name' => SORT_DESC]`). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression). Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns. Since version 2.0.7, an `yii\\db\\ExpressionInterface` object can be passed to specify the ORDER BY part explicitly in plain SQL."}],"return":{"type":"$this","description":"The query object itself"}},"andFilterWhere":{"signature":"public function andFilterWhere(array $condition): $this","summary":"Adds an additional WHERE condition to the existing one but ignores empty operands (`isEmpty()`).","params":[{"name":"$condition","type":"array","description":"The new WHERE condition. Please refer to `where()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"}},"andWhere":{"signature":"public function andWhere(string|array|yii\\db\\ExpressionInterface $condition): $this","summary":"Adds an additional WHERE condition to the existing one.","params":[{"name":"$condition","type":"string|array|yii\\db\\ExpressionInterface","description":"The new WHERE condition. Please refer to `where()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"}},"emulateExecution":{"signature":"public function emulateExecution(bool $value = true): $this","summary":"Sets whether to emulate query execution, preventing any interaction with data storage.","params":[{"name":"$value","type":"bool","default":"true","optional":true,"description":"Whether to prevent query execution."}],"return":{"type":"$this","description":"The query object itself."},"since":"2.0.11"},"filterCondition":{"signature":"protected function filterCondition(array $condition): array","summary":"Removes empty operands (`isEmpty()`) from the given query condition.","params":[{"name":"$condition","type":"array","description":"The original condition"}],"return":{"type":"array","description":"The condition with empty operands (`isEmpty()`) removed."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if the condition operator is not supported"}],"visibility":"protected"},"filterWhere":{"signature":"public function filterWhere(array $condition): $this","summary":"Sets the WHERE part of the query but ignores empty operands (`isEmpty()`).","params":[{"name":"$condition","type":"array","description":"The conditions that should be put in the WHERE part. See `where()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"}},"indexBy":{"signature":"public function indexBy(string|callable $column): $this","summary":"Sets the `indexBy()` property.","params":[{"name":"$column","type":"string|callable","description":"The name of the column by which the query results should be indexed by. This can also be a callable (e.g. anonymous function) that returns the index value based on the given row data. The signature of the callable should be: ``` function ($row) { // return the index value corresponding to $row } ```"}],"return":{"type":"$this","description":"The query object itself"}},"isEmpty":{"signature":"protected function isEmpty(mixed $value): bool","summary":"Returns a value indicating whether the give value is \"empty\".","params":[{"name":"$value","type":"mixed"}],"return":{"type":"bool","description":"If the value is empty"},"visibility":"protected"},"limit":{"signature":"public function limit(int|yii\\db\\ExpressionInterface|null $limit): $this","summary":"Sets the LIMIT part of the query.","params":[{"name":"$limit","type":"int|yii\\db\\ExpressionInterface|null","description":"The limit. Use null or negative value to disable limit."}],"return":{"type":"$this","description":"The query object itself"}},"normalizeOrderBy":{"signature":"protected function normalizeOrderBy(array|string|yii\\db\\ExpressionInterface|null $columns): array","summary":"Normalizes format of ORDER BY data.","params":[{"name":"$columns","type":"array|string|yii\\db\\ExpressionInterface|null","description":"The columns value to normalize. See `orderBy()` and `addOrderBy()`."}],"return":{"type":"array"},"visibility":"protected"},"offset":{"signature":"public function offset(int|yii\\db\\ExpressionInterface|null $offset): $this","summary":"Sets the OFFSET part of the query.","params":[{"name":"$offset","type":"int|yii\\db\\ExpressionInterface|null","description":"The offset. Use null or negative value to disable offset."}],"return":{"type":"$this","description":"The query object itself"}},"orderBy":{"signature":"public function orderBy(string|array|yii\\db\\ExpressionInterface|null $columns): $this","summary":"Sets the ORDER BY part of the query.","params":[{"name":"$columns","type":"string|array|yii\\db\\ExpressionInterface|null","description":"The columns (and the directions) to be ordered by. Columns can be specified in either a string (e.g. `\"id ASC, name DESC\"`) or an array (e.g. `['id' => SORT_ASC, 'name' => SORT_DESC]`). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression). Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns. Since version 2.0.7, an `yii\\db\\ExpressionInterface` object can be passed to specify the ORDER BY part explicitly in plain SQL."}],"return":{"type":"$this","description":"The query object itself"}},"orFilterWhere":{"signature":"public function orFilterWhere(array $condition): $this","summary":"Adds an additional WHERE condition to the existing one but ignores empty operands (`isEmpty()`).","params":[{"name":"$condition","type":"array","description":"The new WHERE condition. Please refer to `where()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"}},"orWhere":{"signature":"public function orWhere(string|array|yii\\db\\ExpressionInterface $condition): $this","summary":"Adds an additional WHERE condition to the existing one.","params":[{"name":"$condition","type":"string|array|yii\\db\\ExpressionInterface","description":"The new WHERE condition. Please refer to `where()` on how to specify this parameter."}],"return":{"type":"$this","description":"The query object itself"}},"where":{"signature":"public function where(string|array|yii\\db\\ExpressionInterface $condition): $this","summary":"Sets the WHERE part of the query.","params":[{"name":"$condition","type":"string|array|yii\\db\\ExpressionInterface","description":"The conditions that should be put in the WHERE part."}],"return":{"type":"$this","description":"The query object itself"}}}},"yii\\db\\Schema":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/db/schema/","summary":"Schema is the base class for concrete DBMS-specific schema classes.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"columnQuoteCharacter":{"type":"string|string[]","default":"'\"'","description":"Character used to quote column names.","visibility":"protected","since":"2.0.14"},"columnSchemaClass":{"type":"class-string|array{class?: class-string, __class?: class-string}","default":"'yii\\db\\ColumnSchema'","description":"Column schema class or class config","since":"2.0.11"},"db":{"type":"yii\\db\\Connection","default":"null","description":"The database connection"},"defaultSchema":{"type":"string","default":"null","description":"The default schema name used for the current session."},"exceptionMap":{"type":"array","default":"['SQLSTATE[23' => 'yii\\db\\IntegrityException']","description":"Map of DB errors and corresponding exceptions If left part is found in DB error message exception class from the right part is used."},"lastInsertID":{"type":"string","description":"The row ID of the last row inserted, or the last value retrieved from the sequence object.","access":"read-only","virtual":true},"queryBuilder":{"type":"yii\\db\\TQueryBuilder","description":"The query builder for this connection.","access":"read-only","virtual":true},"schemaNames":{"type":"string[]","description":"All schema names in the database, except system schemas.","access":"read-only","virtual":true},"serverVersion":{"type":"string","description":"Server version as a string.","access":"read-only","virtual":true},"systemSchemaNames":{"type":"list","default":"[]","description":"List of schema names that should be excluded from `getSchemaNames()`."},"tableNames":{"type":"string[]","description":"All table names in the database.","access":"read-only","virtual":true},"tableQuoteCharacter":{"type":"string|string[]","default":"\"'\"","description":"Character used to quote schema, table, etc. names.","visibility":"protected","since":"2.0.14"},"tableSchemas":{"type":"yii\\db\\TableSchema[]","description":"The metadata for all tables in the database.","access":"read-only","virtual":true},"transactionIsolationLevel":{"type":"string","description":"The transaction isolation level to use for this transaction.","access":"write-only","virtual":true}},"methods":{"convertException":{"signature":"public function convertException(Exception $e, string $rawSql): yii\\db\\Exception","summary":"Converts a DB exception to a more concrete one if possible.","params":[{"name":"$e","type":"Exception"},{"name":"$rawSql","type":"string","description":"SQL that produced exception"}],"return":{"type":"yii\\db\\Exception"}},"createColumnSchema":{"signature":"protected function createColumnSchema(): yii\\db\\T","summary":"Creates a column schema for the database.","return":{"type":"yii\\db\\T","description":"Column schema instance."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if a column schema class cannot be created."}],"visibility":"protected"},"createColumnSchemaBuilder":{"signature":"public function createColumnSchemaBuilder(string $type, int|string|array|null $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Create a column schema builder instance giving the type and value precision.","params":[{"name":"$type","type":"string","description":"Type of the column. See `yii\\db\\ColumnSchemaBuilder::$type`."},{"name":"$length","type":"int|string|array|null","default":"null","optional":true,"description":"Length or precision of the column. See `yii\\db\\ColumnSchemaBuilder::$length`."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"Column schema builder instance"},"since":"2.0.6"},"createQueryBuilder":{"signature":"public function createQueryBuilder(): yii\\db\\TQueryBuilder","summary":"Creates a query builder for the database.","return":{"type":"yii\\db\\TQueryBuilder","description":"Query builder instance"}},"createSavepoint":{"signature":"public function createSavepoint(string $name): mixed","summary":"Creates a new savepoint.","params":[{"name":"$name","type":"string","description":"The savepoint name"}],"return":{"type":"mixed"}},"findSchemaNames":{"signature":"protected function findSchemaNames(): array","summary":"Returns all schema names in the database, including the default one but not system schemas.","return":{"type":"array","description":"All schema names in the database, except system schemas."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected","since":"2.0.4"},"findTableNames":{"signature":"protected function findTableNames(string $schema = ''): array","summary":"Returns all table names in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema."}],"return":{"type":"array","description":"All table names in the database. The names have NO schema name prefix."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected"},"findUniqueIndexes":{"signature":"public function findUniqueIndexes(yii\\db\\TableSchema $table): array","summary":"Returns all unique indexes for the given table.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"array","description":"All unique indexes for the given table."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is called"}]},"getCacheKey":{"signature":"protected function getCacheKey(string $name): mixed","summary":"Returns the cache key for the specified table name.","params":[{"name":"$name","type":"string","description":"The table name."}],"return":{"type":"mixed","description":"The cache key."},"visibility":"protected"},"getCacheTag":{"signature":"protected function getCacheTag(): string","summary":"Returns the cache tag name.","return":{"type":"string","description":"The cache tag name"},"visibility":"protected"},"getColumnPhpType":{"signature":"protected function getColumnPhpType(yii\\db\\ColumnSchema $column): string","summary":"Extracts the PHP type from abstract DB type.","params":[{"name":"$column","type":"yii\\db\\ColumnSchema","description":"The column schema information"}],"return":{"type":"string","description":"PHP type name"},"visibility":"protected"},"getLastInsertID":{"signature":"public function getLastInsertID(string $sequenceName = ''): string","summary":"Returns the ID of the last inserted row or sequence value.","params":[{"name":"$sequenceName","type":"string","default":"''","optional":true,"description":"Name of the sequence object (required by some DBMS)"}],"return":{"type":"string","description":"The row ID of the last row inserted, or the last value retrieved from the sequence object"},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if the DB connection is not active"}]},"getPdoType":{"signature":"public function getPdoType(mixed $data): int","summary":"Determines the PDO type for the given PHP data value.","params":[{"name":"$data","type":"mixed","description":"The data whose PDO type is to be determined"}],"return":{"type":"int","description":"The PDO type"}},"getQueryBuilder":{"signature":"public function getQueryBuilder(): yii\\db\\TQueryBuilder","return":{"type":"yii\\db\\TQueryBuilder","description":"The query builder for this connection."}},"getRawTableName":{"signature":"public function getRawTableName(string $name): string","summary":"Returns the actual name of a given table name.","params":[{"name":"$name","type":"string","description":"The table name to be converted"}],"return":{"type":"string","description":"The real name of the given table name"}},"getSchemaMetadata":{"signature":"protected function getSchemaMetadata(string $schema, string $type, bool $refresh): array","summary":"Returns the metadata of the given type for all tables in the given schema.","params":[{"name":"$schema","type":"string","description":"The schema of the metadata. Defaults to empty string, meaning the current or default schema name."},{"name":"$type","type":"string","description":"Metadata type."},{"name":"$refresh","type":"bool","description":"Whether to fetch the latest available table metadata. If this is `false`, cached data may be returned if available."}],"return":{"type":"array","description":"Array of metadata."},"visibility":"protected","since":"2.0.13"},"getSchemaNames":{"signature":"public function getSchemaNames(bool $refresh = false): string[]","summary":"Returns all schema names in the database, except system schemas.","params":[{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available schema names. If this is false, schema names fetched previously (if available) will be returned."}],"return":{"type":"string[]","description":"All schema names in the database, except system schemas."},"since":"2.0.4"},"getServerVersion":{"signature":"public function getServerVersion(): string","summary":"Returns a server version as a string comparable by `version_compare()`.","return":{"type":"string","description":"Server version as a string."},"since":"2.0.14"},"getTableMetadata":{"signature":"protected function getTableMetadata(string $name, string $type, bool $refresh): mixed","summary":"Returns the metadata of the given type for the given table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$type","type":"string","description":"Metadata type."},{"name":"$refresh","type":"bool","description":"Whether to reload the table metadata even if it is found in the cache."}],"return":{"type":"mixed","description":"Metadata."},"visibility":"protected","since":"2.0.13"},"getTableNameParts":{"signature":"protected function getTableNameParts(string $name): array","summary":"Splits full table name into parts.","params":[{"name":"$name","type":"string","description":"Full table name."}],"return":{"type":"array","description":"Table name parts."},"visibility":"protected","since":"2.0.22"},"getTableNames":{"signature":"public function getTableNames(string $schema = '', bool $refresh = false): string[]","summary":"Returns all table names in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name. If not empty, the returned table names will be prefixed with the schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table names. If this is false, table names fetched previously (if available) will be returned."}],"return":{"type":"string[]","description":"All table names in the database."}},"getTableSchema":{"signature":"public function getTableSchema(string $name, bool $refresh = false): yii\\db\\TableSchema|null","summary":"Obtains the metadata for the named table.","params":[{"name":"$name","type":"string","description":"Table name. The table name may contain schema name if any. Do not quote the table name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to reload the table schema even if it is found in the cache."}],"return":{"type":"yii\\db\\TableSchema|null","description":"Table metadata. `null` if the named table does not exist."}},"getTableSchemas":{"signature":"public function getTableSchemas(string $schema = '', bool $refresh = false): yii\\db\\TableSchema[]","summary":"Returns the metadata for all tables in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available table schemas. If this is `false`, cached data may be returned if available."}],"return":{"type":"yii\\db\\TableSchema[]","description":"The metadata for all tables in the database. Each array element is an instance of `yii\\db\\TableSchema` or its child class."}},"insert":{"signature":"public function insert(string $table, array $columns): array|false","summary":"Executes the INSERT command, returning primary key values.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"array","description":"The column data (name => value) to be inserted into the table."}],"return":{"type":"array|false","description":"Primary key values or false if the command fails"},"since":"2.0.4"},"isReadQuery":{"signature":"public function isReadQuery(string $sql): bool","summary":"Returns a value indicating whether a SQL statement is for read purpose.","params":[{"name":"$sql","type":"string","description":"The SQL statement"}],"return":{"type":"bool","description":"Whether a SQL statement is for read purpose."}},"loadTableSchema":{"signature":"abstract protected function loadTableSchema(string $name): yii\\db\\TableSchema|null","summary":"Loads the metadata for the specified table.","params":[{"name":"$name","type":"string","description":"Table name"}],"return":{"type":"yii\\db\\TableSchema|null","description":"DBMS-dependent table metadata, `null` if the table does not exist."},"visibility":"protected","abstract":true},"normalizePdoRowKeyCase":{"signature":"protected function normalizePdoRowKeyCase(array $row, bool $multiple): array","summary":"Changes row's array key case to lower if PDO's one is set to uppercase.","params":[{"name":"$row","type":"array","description":"Row's array or an array of row's arrays."},{"name":"$multiple","type":"bool","description":"Whether multiple rows or a single row passed."}],"return":{"type":"array","description":"Normalized row or rows."},"visibility":"protected","since":"2.0.13"},"quoteColumnName":{"signature":"public function quoteColumnName(string $name): string","summary":"Quotes a column name for use in a query.","params":[{"name":"$name","type":"string","description":"Column name."}],"return":{"type":"string","description":"The properly quoted column name."}},"quoteSimpleColumnName":{"signature":"public function quoteSimpleColumnName(string $name): string","summary":"Quotes a simple column name for use in a query.","params":[{"name":"$name","type":"string","description":"Column name."}],"return":{"type":"string","description":"The properly quoted column name."}},"quoteSimpleTableName":{"signature":"public function quoteSimpleTableName(string $name): string","summary":"Quotes a simple table name for use in a query.","params":[{"name":"$name","type":"string","description":"Table name."}],"return":{"type":"string","description":"The properly quoted table name."}},"quoteTableName":{"signature":"public function quoteTableName(string $name): string","summary":"Quotes a table name for use in a query.","params":[{"name":"$name","type":"string","description":"Table name."}],"return":{"type":"string","description":"The properly quoted table name."}},"quoteValue":{"signature":"public function quoteValue(mixed $str): mixed","summary":"Quotes a string value for use in a query.","params":[{"name":"$str","type":"mixed","description":"String to be quoted. If the parameter is not a string, it will be returned without change."}],"return":{"type":"mixed","description":"The properly quoted string, or the original data if it is not a string."}},"refresh":{"signature":"public function refresh(): mixed","summary":"Refreshes the schema.","return":{"type":"mixed"}},"refreshTableSchema":{"signature":"public function refreshTableSchema(string $name): mixed","summary":"Refreshes the particular table schema.","params":[{"name":"$name","type":"string","description":"Table name."}],"return":{"type":"mixed"},"since":"2.0.6"},"releaseSavepoint":{"signature":"public function releaseSavepoint(string $name): mixed","summary":"Releases an existing savepoint.","params":[{"name":"$name","type":"string","description":"The savepoint name"}],"return":{"type":"mixed"}},"resolveRawTableName":{"signature":"public function resolveRawTableName(string $name): yii\\db\\TableSchema","summary":"Resolves the table name and schema name (if any) without loading database metadata.","params":[{"name":"$name","type":"string","description":"The table name."}],"return":{"type":"yii\\db\\TableSchema","description":"TableSchema with resolved table, schema, etc. names."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"since":"22.0"},"resolveTableName":{"signature":"protected function resolveTableName(string $name): yii\\db\\TableSchema","summary":"Resolves the table name and schema name (if any).","params":[{"name":"$name","type":"string","description":"The table name"}],"return":{"type":"yii\\db\\TableSchema","description":"`yii\\db\\TableSchema` with resolved table, schema, etc. names."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected","since":"2.0.13"},"rollBackSavepoint":{"signature":"public function rollBackSavepoint(string $name): mixed","summary":"Rolls back to a previously created savepoint.","params":[{"name":"$name","type":"string","description":"The savepoint name"}],"return":{"type":"mixed"}},"setTableMetadata":{"signature":"protected function setTableMetadata(string $name, string $type, mixed $data): mixed","summary":"Sets the metadata of the given type for the given table.","params":[{"name":"$name","type":"string","description":"Table name."},{"name":"$type","type":"string","description":"Metadata type."},{"name":"$data","type":"mixed","description":"Metadata."}],"return":{"type":"mixed"},"visibility":"protected","since":"2.0.13"},"setTransactionIsolationLevel":{"signature":"public function setTransactionIsolationLevel(string $level): mixed","summary":"Sets the isolation level of the current transaction.","params":[{"name":"$level","type":"string","description":"The transaction isolation level to use for this transaction. This can be one of `yii\\db\\Transaction::READ_UNCOMMITTED`, `yii\\db\\Transaction::READ_COMMITTED`, `yii\\db\\Transaction::REPEATABLE_READ` and `yii\\db\\Transaction::SERIALIZABLE` but also a string containing DBMS specific syntax to be used after `SET TRANSACTION ISOLATION LEVEL`."}],"return":{"type":"mixed"}},"supportsSavepoint":{"signature":"public function supportsSavepoint(): bool","return":{"type":"bool","description":"Whether this DBMS supports [savepoint](https://en.wikipedia.org/wiki/Savepoint)."}},"unquoteSimpleColumnName":{"signature":"public function unquoteSimpleColumnName(string $name): string","summary":"Unquotes a simple column name.","params":[{"name":"$name","type":"string","description":"Column name."}],"return":{"type":"string","description":"Unquoted column name."},"since":"2.0.14"},"unquoteSimpleTableName":{"signature":"public function unquoteSimpleTableName(string $name): string","summary":"Unquotes a simple table name.","params":[{"name":"$name","type":"string","description":"Table name."}],"return":{"type":"string","description":"Unquoted table name."},"since":"2.0.14"}},"constants":{"TYPE_PK":{"value":"'pk'"},"TYPE_UPK":{"value":"'upk'"},"TYPE_BIGPK":{"value":"'bigpk'"},"TYPE_UBIGPK":{"value":"'ubigpk'"},"TYPE_CHAR":{"value":"'char'"},"TYPE_STRING":{"value":"'string'"},"TYPE_TEXT":{"value":"'text'"},"TYPE_TINYINT":{"value":"'tinyint'"},"TYPE_SMALLINT":{"value":"'smallint'"},"TYPE_INTEGER":{"value":"'integer'"},"TYPE_BIGINT":{"value":"'bigint'"},"TYPE_FLOAT":{"value":"'float'"},"TYPE_DOUBLE":{"value":"'double'"},"TYPE_DECIMAL":{"value":"'decimal'"},"TYPE_DATETIME":{"value":"'datetime'"},"TYPE_TIMESTAMP":{"value":"'timestamp'"},"TYPE_TIME":{"value":"'time'"},"TYPE_DATE":{"value":"'date'"},"TYPE_BINARY":{"value":"'binary'"},"TYPE_BOOLEAN":{"value":"'boolean'"},"TYPE_MONEY":{"value":"'money'"},"TYPE_JSON":{"value":"'json'"},"SCHEMA_CACHE_VERSION":{"value":"1","description":"Schema cache version, to detect incompatibilities in cached values when the data format of the cache changes."}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\SchemaBuilderTrait":{"kind":"trait","url":"https://yii2-framework.github.io/docs/api/yii/db/schemabuildertrait/","summary":"SchemaBuilderTrait contains shortcut methods to create instances of `yii\\db\\ColumnSchemaBuilder`.","since":"2.0.6","methods":{"bigInteger":{"signature":"public function bigInteger(int|null $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a bigint column.","params":[{"name":"$length","type":"int|null","default":"null","optional":true,"description":"Column size or precision definition. This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"bigPrimaryKey":{"signature":"public function bigPrimaryKey(int|null $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a big primary key column.","params":[{"name":"$length","type":"int|null","default":"null","optional":true,"description":"Column size or precision definition. This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"binary":{"signature":"public function binary(int|null $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a binary column.","params":[{"name":"$length","type":"int|null","default":"null","optional":true,"description":"Column size or precision definition. This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"boolean":{"signature":"public function boolean(): yii\\db\\ColumnSchemaBuilder","summary":"Creates a boolean column.","return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"char":{"signature":"public function char(int|null $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a char column.","params":[{"name":"$length","type":"int|null","default":"null","optional":true,"description":"Column size definition i.e. the maximum string length. This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.8"},"date":{"signature":"public function date(): yii\\db\\ColumnSchemaBuilder","summary":"Creates a date column.","return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"dateTime":{"signature":"public function dateTime(int|null $precision = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a datetime column.","params":[{"name":"$precision","type":"int|null","default":"null","optional":true,"description":"Column value precision. First parameter passed to the column type, e.g. DATETIME(precision). This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"decimal":{"signature":"public function decimal(int|null $precision = null, int|null $scale = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a decimal column.","params":[{"name":"$precision","type":"int|null","default":"null","optional":true,"description":"Column value precision, which is usually the total number of digits. First parameter passed to the column type, e.g. DECIMAL(precision, scale). This parameter will be ignored if not supported by the DBMS."},{"name":"$scale","type":"int|null","default":"null","optional":true,"description":"Column value scale, which is usually the number of digits after the decimal point. Second parameter passed to the column type, e.g. DECIMAL(precision, scale). This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"double":{"signature":"public function double(int|null $precision = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a double column.","params":[{"name":"$precision","type":"int|null","default":"null","optional":true,"description":"Column value precision. First parameter passed to the column type, e.g. DOUBLE(precision). This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"float":{"signature":"public function float(int|null $precision = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a float column.","params":[{"name":"$precision","type":"int|null","default":"null","optional":true,"description":"Column value precision. First parameter passed to the column type, e.g. FLOAT(precision). This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"getDb":{"signature":"abstract protected function getDb(): yii\\db\\Connection","return":{"type":"yii\\db\\Connection","description":"The database connection to be used for schema building."},"visibility":"protected","abstract":true},"integer":{"signature":"public function integer(int|null $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates an integer column.","params":[{"name":"$length","type":"int|null","default":"null","optional":true,"description":"Column size or precision definition. This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"json":{"signature":"public function json(): yii\\db\\ColumnSchemaBuilder","summary":"Creates a JSON column.","return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.14"},"money":{"signature":"public function money(int|null $precision = null, int|null $scale = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a money column.","params":[{"name":"$precision","type":"int|null","default":"null","optional":true,"description":"Column value precision, which is usually the total number of digits. First parameter passed to the column type, e.g. DECIMAL(precision, scale). This parameter will be ignored if not supported by the DBMS."},{"name":"$scale","type":"int|null","default":"null","optional":true,"description":"Column value scale, which is usually the number of digits after the decimal point. Second parameter passed to the column type, e.g. DECIMAL(precision, scale). This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"primaryKey":{"signature":"public function primaryKey(int|null $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a primary key column.","params":[{"name":"$length","type":"int|null","default":"null","optional":true,"description":"Column size or precision definition. This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"smallInteger":{"signature":"public function smallInteger(int|null $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a smallint column.","params":[{"name":"$length","type":"int|null","default":"null","optional":true,"description":"Column size or precision definition. This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"string":{"signature":"public function string(int|null $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a string column.","params":[{"name":"$length","type":"int|null","default":"null","optional":true,"description":"Column size definition i.e. the maximum string length. This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"text":{"signature":"public function text(): yii\\db\\ColumnSchemaBuilder","summary":"Creates a text column.","return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"time":{"signature":"public function time(int|null $precision = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a time column.","params":[{"name":"$precision","type":"int|null","default":"null","optional":true,"description":"Column value precision. First parameter passed to the column type, e.g. TIME(precision). This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"timestamp":{"signature":"public function timestamp(int|null $precision = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a timestamp column.","params":[{"name":"$precision","type":"int|null","default":"null","optional":true,"description":"Column value precision. First parameter passed to the column type, e.g. TIMESTAMP(precision). This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.6"},"tinyInteger":{"signature":"public function tinyInteger(int|null $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Creates a tinyint column. If tinyint is not supported by the DBMS, smallint will be used.","params":[{"name":"$length","type":"int|null","default":"null","optional":true,"description":"Column size or precision definition. This parameter will be ignored if not supported by the DBMS."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"The column instance which can be further customized."},"since":"2.0.14"}}},"yii\\db\\SqlToken":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/sqltoken/","summary":"SqlToken represents SQL tokens produced by `yii\\db\\SqlTokenizer` or its child classes.","since":"2.0.13","extends":"yii\\base\\BaseObject","implements":["ArrayAccess","yii\\base\\Configurable"],"properties":{"children":{"type":"yii\\db\\SqlToken[]","description":"Child tokens.","virtual":true},"content":{"type":"string|null","default":"null","description":"Token content."},"endOffset":{"type":"int","default":"null","description":"Original SQL token end position."},"hasChildren":{"type":"bool","description":"Whether the token has children.","access":"read-only","virtual":true},"isCollection":{"type":"bool","description":"Whether the token represents a collection of tokens.","access":"read-only","virtual":true},"parent":{"type":"yii\\db\\SqlToken","default":"null","description":"Parent token."},"sql":{"type":"string","description":"SQL code.","access":"read-only","virtual":true},"startOffset":{"type":"int","default":"null","description":"Original SQL token start position."},"type":{"type":"int","default":"self::TYPE_TOKEN","description":"Token type."}},"methods":{"__toString":{"signature":"public function __toString(): string","summary":"Returns the SQL code representing the token.","return":{"type":"string","description":"SQL code."}},"getChildren":{"signature":"public function getChildren(): yii\\db\\SqlToken[]","summary":"Returns child tokens.","return":{"type":"yii\\db\\SqlToken[]","description":"Child tokens."}},"getHasChildren":{"signature":"public function getHasChildren(): bool","summary":"Returns whether the token represents a collection of tokens and has non-zero number of children.","return":{"type":"bool","description":"Whether the token has children."}},"getIsCollection":{"signature":"public function getIsCollection(): bool","summary":"Returns whether the token represents a collection of tokens.","return":{"type":"bool","description":"Whether the token represents a collection of tokens."}},"getSql":{"signature":"public function getSql(): string","summary":"Returns the SQL code representing the token.","return":{"type":"string","description":"SQL code."}},"matches":{"signature":"public function matches(yii\\db\\SqlToken $patternToken, int $offset = 0, int|null &$firstMatchIndex = null, int|null &$lastMatchIndex = null): bool","summary":"Returns whether this token (including its children) matches the specified \"pattern\" SQL code.","params":[{"name":"$patternToken","type":"yii\\db\\SqlToken","description":"Tokenized SQL code to match against. In addition to normal SQL, the `any` keyword is supported which will match any number of keywords, identifiers, whitespaces."},{"name":"$offset","type":"int","default":"0","optional":true,"description":"Token children offset to start lookup with."},{"name":"$firstMatchIndex","type":"int|null","default":"null","optional":true,"byReference":true,"description":"Token children offset where a successful match begins."},{"name":"$lastMatchIndex","type":"int|null","default":"null","optional":true,"byReference":true,"description":"Token children offset where a successful match ends."}],"return":{"type":"bool","description":"Whether this token matches the pattern SQL code."}},"offsetExists":{"signature":"public function offsetExists(int $offset): bool","summary":"Returns whether there is a child token at the specified offset.","params":[{"name":"$offset","type":"int","description":"Child token offset."}],"return":{"type":"bool","description":"Whether the token exists."}},"offsetGet":{"signature":"public function offsetGet(int $offset): yii\\db\\SqlToken|null","summary":"Returns a child token at the specified offset.","params":[{"name":"$offset","type":"int","description":"Child token offset."}],"return":{"type":"yii\\db\\SqlToken|null","description":"The child token at the specified offset, `null` if there's no token."}},"offsetSet":{"signature":"public function offsetSet(int|null $offset, yii\\db\\SqlToken $token): mixed","summary":"Adds a child token to the token.","params":[{"name":"$offset","type":"int|null","description":"Child token offset."},{"name":"$token","type":"yii\\db\\SqlToken","description":"Token to be added."}],"return":{"type":"mixed"}},"offsetUnset":{"signature":"public function offsetUnset(int $offset): mixed","summary":"Removes a child token at the specified offset.","params":[{"name":"$offset","type":"int","description":"Child token offset."}],"return":{"type":"mixed"}},"setChildren":{"signature":"public function setChildren(yii\\db\\SqlToken[] $children): mixed","summary":"Sets a list of child tokens.","params":[{"name":"$children","type":"yii\\db\\SqlToken[]","description":"Child tokens."}],"return":{"type":"mixed"}}},"constants":{"TYPE_CODE":{"value":"0"},"TYPE_STATEMENT":{"value":"1"},"TYPE_TOKEN":{"value":"2"},"TYPE_PARENTHESIS":{"value":"3"},"TYPE_KEYWORD":{"value":"4"},"TYPE_OPERATOR":{"value":"5"},"TYPE_IDENTIFIER":{"value":"6"},"TYPE_STRING_LITERAL":{"value":"7"}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\SqlTokenizer":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/db/sqltokenizer/","summary":"SqlTokenizer splits an SQL query into individual SQL tokens.","since":"2.0.13","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"length":{"type":"int","default":"null","description":"SQL code string length.","visibility":"protected"},"offset":{"type":"int","default":"null","description":"SQL code string current offset.","visibility":"protected"},"sql":{"type":"string","default":"null","description":"SQL code."}},"methods":{"__construct":{"signature":"public function __construct(string $sql, array $config = [])","summary":"Constructor.","params":[{"name":"$sql","type":"string","description":"SQL code to be tokenized."},{"name":"$config","type":"array","default":"[]","optional":true,"description":"Name-value pairs that will be used to initialize the object properties"}]},"indexAfter":{"signature":"protected function indexAfter(string $string, int|null $offset = null): int","summary":"Returns an index after the given string in the SQL code starting with the specified offset.","params":[{"name":"$string","type":"string","description":"String to be found."},{"name":"$offset","type":"int|null","default":"null","optional":true,"description":"SQL code offset, defaults to current if `null` is passed."}],"return":{"type":"int","description":"Index after the given string or end of string index."},"visibility":"protected"},"isComment":{"signature":"abstract protected function isComment(int &$length): bool","summary":"Returns whether there's a commentary at the current offset.","params":[{"name":"$length","type":"int","byReference":true,"description":"Length of the matched string."}],"return":{"type":"bool","description":"Whether there's a commentary at the current offset."},"visibility":"protected","abstract":true},"isIdentifier":{"signature":"abstract protected function isIdentifier(int &$length, string &$content): bool","summary":"Returns whether there's an identifier at the current offset.","params":[{"name":"$length","type":"int","byReference":true,"description":"Length of the matched string."},{"name":"$content","type":"string","byReference":true,"description":"Optional content instead of the matched string."}],"return":{"type":"bool","description":"Whether there's an identifier at the current offset."},"visibility":"protected","abstract":true},"isKeyword":{"signature":"abstract protected function isKeyword(string $string, string &$content): bool","summary":"Returns whether the given string is a keyword.","params":[{"name":"$string","type":"string","description":"String to be matched."},{"name":"$content","type":"string","byReference":true,"description":"Optional content instead of the matched string."}],"return":{"type":"bool","description":"Whether the given string is a keyword."},"visibility":"protected","abstract":true},"isOperator":{"signature":"abstract protected function isOperator(int &$length, string &$content): bool","summary":"Returns whether there's an operator at the current offset.","params":[{"name":"$length","type":"int","byReference":true,"description":"Length of the matched string."},{"name":"$content","type":"string","byReference":true,"description":"Optional content instead of the matched string."}],"return":{"type":"bool","description":"Whether there's an operator at the current offset."},"visibility":"protected","abstract":true},"isStringLiteral":{"signature":"abstract protected function isStringLiteral(int &$length, string &$content): bool","summary":"Returns whether there's a string literal at the current offset.","params":[{"name":"$length","type":"int","byReference":true,"description":"Length of the matched string."},{"name":"$content","type":"string","byReference":true,"description":"Optional content instead of the matched string."}],"return":{"type":"bool","description":"Whether there's a string literal at the current offset."},"visibility":"protected","abstract":true},"isWhitespace":{"signature":"abstract protected function isWhitespace(int &$length): bool","summary":"Returns whether there's a whitespace at the current offset.","params":[{"name":"$length","type":"int","byReference":true,"description":"Length of the matched string."}],"return":{"type":"bool","description":"Whether there's a whitespace at the current offset."},"visibility":"protected","abstract":true},"startsWithAnyLongest":{"signature":"protected function startsWithAnyLongest(array|array> &$with, bool $caseSensitive, int|null &$length = null, string|null &$content = null): bool","summary":"Returns whether the longest common prefix equals to the SQL code of the same length at the current offset.","params":[{"name":"$with","type":"array|array>","byReference":true,"description":"Strings to be tested. The method **will** modify this parameter to speed up lookups."},{"name":"$caseSensitive","type":"bool","description":"Whether to perform a case sensitive comparison."},{"name":"$length","type":"int|null","default":"null","optional":true,"byReference":true,"description":"Length of the matched string."},{"name":"$content","type":"string|null","default":"null","optional":true,"byReference":true,"description":"Matched string."}],"return":{"type":"bool","description":"Whether a match is found."},"visibility":"protected"},"substring":{"signature":"protected function substring(int $length, bool $caseSensitive = true, int|null $offset = null): string","summary":"Returns a string of the given length starting with the specified offset.","params":[{"name":"$length","type":"int","description":"String length to be returned."},{"name":"$caseSensitive","type":"bool","default":"true","optional":true,"description":"If it's `false`, the string will be uppercased."},{"name":"$offset","type":"int|null","default":"null","optional":true,"description":"SQL code offset, defaults to current if `null` is passed."}],"return":{"type":"string","description":"Result string, it may be empty if there's nothing to return."},"visibility":"protected"},"tokenize":{"signature":"public function tokenize(): yii\\db\\SqlToken","summary":"Tokenizes and returns a code type token.","return":{"type":"yii\\db\\SqlToken","description":"Code type token."}}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\db\\StaleObjectException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/staleobjectexception/","since":"2.0","extends":"yii\\db\\Exception","methods":{"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}},"inherited":{"properties":{"errorInfo":"yii\\db\\Exception"},"methods":{"__construct":"yii\\db\\Exception","__toString":"yii\\db\\Exception"}}},"yii\\db\\TableSchema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/tableschema/","summary":"TableSchema represents the metadata of a database table.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"columnNames":{"type":"array","description":"List of column names.","access":"read-only","virtual":true},"columns":{"type":"yii\\db\\ColumnSchema[]","default":"[]","description":"Column metadata of this table."},"foreignKeys":{"type":"array","default":"[]","description":"Foreign keys of this table."},"fullName":{"type":"string","default":"null","description":"The full name of this table, which includes the schema name prefix, if any."},"name":{"type":"string","default":"null","description":"The name of this table."},"primaryKey":{"type":"string[]","default":"[]","description":"Primary keys of this table."},"schemaName":{"type":"string","default":"null","description":"The name of the schema that this table belongs to."},"sequenceName":{"type":"string|null","default":"null","description":"Sequence name for the primary key."}},"methods":{"fixPrimaryKey":{"signature":"public function fixPrimaryKey(string|array $keys): mixed","summary":"Manually specifies the primary key for this table.","params":[{"name":"$keys","type":"string|array","description":"The primary key (can be composite)"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the specified key cannot be found in the table."}]},"getColumn":{"signature":"public function getColumn(string $name): yii\\db\\ColumnSchema|null","summary":"Gets the named column metadata.","params":[{"name":"$name","type":"string","description":"Column name"}],"return":{"type":"yii\\db\\ColumnSchema|null","description":"Metadata of the named column. Null if the named column does not exist."}},"getColumnNames":{"signature":"public function getColumnNames(): array","summary":"Returns the names of all columns in this table.","return":{"type":"array","description":"List of column names"}}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\Transaction":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/transaction/","summary":"Transaction represents a DB transaction.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"db":{"type":"yii\\db\\Connection","default":"null","description":"The database connection that this transaction is associated with."},"isActive":{"type":"bool","description":"Whether this transaction is active.","access":"read-only","virtual":true},"isolationLevel":{"type":"string","description":"The transaction isolation level to use for this transaction.","access":"write-only","virtual":true},"level":{"type":"int","description":"The current nesting level of the transaction.","access":"read-only","virtual":true}},"methods":{"begin":{"signature":"public function begin(string|null $isolationLevel = null): mixed","summary":"Begins a transaction.","params":[{"name":"$isolationLevel","type":"string|null","default":"null","optional":true,"description":"The [isolation level][] to use for this transaction. This can be one of `READ_UNCOMMITTED`, `READ_COMMITTED`, `REPEATABLE_READ` and `SERIALIZABLE` but also a string containing DBMS specific syntax to be used after `SET TRANSACTION ISOLATION LEVEL`. If not specified (`null`) the isolation level will not be set explicitly and the DBMS default will be used. > Note: Some DBMS allow setting of the isolation level only for the whole connection so subsequent transactions may get the same isolation level even if you did not specify any. When using this feature you may need to set the isolation level for all transactions explicitly to avoid conflicting settings. At the time of this writing affected DBMS are MSSQL and SQLite. > Note: The isolation level applies to the outermost transaction only. Nested transactions are implemented with savepoints and always run at the isolation level of the outer transaction, so an `$isolationLevel` passed to a nested `begin()` call is ignored and a warning is logged (since 2.0.56). [isolation level]: https://en.wikipedia.org/wiki/Isolation_%28database_systems%29#Isolation_levels Starting from version 2.0.16, this method throws exception when beginning nested transaction and underlying DBMS does not support savepoints."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$db` is `null`"},{"type":"yii\\base\\NotSupportedException","description":"if the DBMS does not support nested transactions"},{"type":"yii\\db\\Exception","description":"if DB connection fails"}]},"commit":{"signature":"public function commit(): mixed","summary":"Commits a transaction.","return":{"type":"mixed"},"throws":[{"type":"yii\\db\\Exception","description":"if the transaction is not active"}]},"getIsActive":{"signature":"public function getIsActive(): bool","summary":"Returns a value indicating whether this transaction is active.","return":{"type":"bool","description":"Whether this transaction is active. Only an active transaction can `commit()` or `rollBack()`."}},"getLevel":{"signature":"public function getLevel(): int","return":{"type":"int","description":"The current nesting level of the transaction."},"since":"2.0.8"},"rollBack":{"signature":"public function rollBack(): mixed","summary":"Rolls back a transaction.","return":{"type":"mixed"}},"setIsolationLevel":{"signature":"public function setIsolationLevel(string $level): mixed","summary":"Sets the transaction isolation level for this transaction.","params":[{"name":"$level","type":"string","description":"The transaction isolation level to use for this transaction. This can be one of `READ_UNCOMMITTED`, `READ_COMMITTED`, `REPEATABLE_READ` and `SERIALIZABLE` but also a string containing DBMS specific syntax to be used after `SET TRANSACTION ISOLATION LEVEL`."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\db\\Exception","description":"if the transaction is not active"}]}},"constants":{"READ_UNCOMMITTED":{"value":"'READ UNCOMMITTED'","description":"A constant representing the transaction isolation level `READ UNCOMMITTED`."},"READ_COMMITTED":{"value":"'READ COMMITTED'","description":"A constant representing the transaction isolation level `READ COMMITTED`."},"REPEATABLE_READ":{"value":"'REPEATABLE READ'","description":"A constant representing the transaction isolation level `REPEATABLE READ`."},"SERIALIZABLE":{"value":"'SERIALIZABLE'","description":"A constant representing the transaction isolation level `SERIALIZABLE`."}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\ViewFinderTrait":{"kind":"trait","url":"https://yii2-framework.github.io/docs/api/yii/db/viewfindertrait/","summary":"ViewFinderTrait implements the method getViewNames for finding views in a database.","since":"2.0.12","methods":{"findViewNames":{"signature":"abstract protected function findViewNames(string $schema = ''): array","summary":"Returns all views names in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the views. Defaults to empty string, meaning the current or default schema."}],"return":{"type":"array","description":"All views names in the database. The names have NO schema name prefix."},"visibility":"protected","abstract":true},"getViewNames":{"signature":"public function getViewNames(string $schema = '', bool $refresh = false): string[]","summary":"Returns all view names in the database.","params":[{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the views. Defaults to empty string, meaning the current or default schema name. If not empty, the returned view names will be prefixed with the schema name."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to fetch the latest available view names. If this is false, view names fetched previously (if available) will be returned."}],"return":{"type":"string[]","description":"All view names in the database."}}}},"yii\\db\\conditions\\AndCondition":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/andcondition/","summary":"Condition that connects two or more SQL expressions with the `AND` operator.","since":"2.0.14","extends":"yii\\db\\conditions\\ConjunctionCondition","implements":["yii\\db\\conditions\\ConditionInterface"],"methods":{"getOperator":{"signature":"public function getOperator(): string","summary":"Returns the operator that is represented by this condition class, e.g. `AND`, `OR`.","return":{"type":"string"}}},"inherited":{"properties":{"expressions":"yii\\db\\conditions\\ConjunctionCondition"},"methods":{"__construct":"yii\\db\\conditions\\ConjunctionCondition","fromArrayDefinition":"yii\\db\\conditions\\ConjunctionCondition","getExpressions":"yii\\db\\conditions\\ConjunctionCondition"}}},"yii\\db\\conditions\\BetweenColumnsCondition":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/betweencolumnscondition/","summary":"Class BetweenColumnCondition represents a `BETWEEN` condition where values is between two columns. For example:","since":"2.0.14","implements":["yii\\db\\conditions\\ConditionInterface"],"methods":{"__construct":{"signature":"public function __construct(mixed $value, string $operator, string|yii\\db\\ExpressionInterface $intervalStartColumn, string|yii\\db\\ExpressionInterface $intervalEndColumn)","summary":"Creates a condition with the `BETWEEN` operator.","params":[{"name":"$value","type":"mixed","description":"The value to compare against"},{"name":"$operator","type":"string","description":"The operator to use (e.g. `BETWEEN` or `NOT BETWEEN`)"},{"name":"$intervalStartColumn","type":"string|yii\\db\\ExpressionInterface","description":"The column name or expression that is a beginning of the interval"},{"name":"$intervalEndColumn","type":"string|yii\\db\\ExpressionInterface","description":"The column name or expression that is an end of the interval"}]},"fromArrayDefinition":{"signature":"public static function fromArrayDefinition(mixed $operator, mixed $operands): static","summary":"Creates object by array-definition as described in [Query Builder – Operator format](https://yii2-framework.github.io/docs/guide/db-query-builder/#operator-format) guide article.","params":[{"name":"$operator","type":"mixed","description":"Operator in uppercase."},{"name":"$operands","type":"mixed","description":"Array of corresponding operands"}],"return":{"type":"static"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if wrong number of operands have been given."}],"static":true},"getIntervalEndColumn":{"signature":"public function getIntervalEndColumn(): string|yii\\db\\ExpressionInterface|yii\\db\\Query","return":{"type":"string|yii\\db\\ExpressionInterface|yii\\db\\Query"}},"getIntervalStartColumn":{"signature":"public function getIntervalStartColumn(): string|yii\\db\\ExpressionInterface|yii\\db\\Query","return":{"type":"string|yii\\db\\ExpressionInterface|yii\\db\\Query"}},"getOperator":{"signature":"public function getOperator(): string","return":{"type":"string"}},"getValue":{"signature":"public function getValue(): mixed","return":{"type":"mixed"}}}},"yii\\db\\conditions\\BetweenColumnsConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/betweencolumnsconditionbuilder/","summary":"Class BetweenColumnsConditionBuilder builds objects of `yii\\db\\conditions\\BetweenColumnsCondition`","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface|yii\\db\\conditions\\BetweenColumnsCondition $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface|yii\\db\\conditions\\BetweenColumnsCondition","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}},"createPlaceholder":{"signature":"protected function createPlaceholder(mixed $value, array &$params): string","summary":"Attaches $value to $params array and returns placeholder.","params":[{"name":"$value","type":"mixed"},{"name":"$params","type":"array","byReference":true,"description":"Passed by reference"}],"return":{"type":"string"},"visibility":"protected"},"escapeColumnName":{"signature":"protected function escapeColumnName(yii\\db\\Query|yii\\db\\ExpressionInterface|string $columnName, array &$params = []): string","summary":"Prepares column name to be used in SQL statement.","params":[{"name":"$columnName","type":"yii\\db\\Query|yii\\db\\ExpressionInterface|string"},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string"},"visibility":"protected"}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\conditions\\BetweenCondition":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/betweencondition/","summary":"Class BetweenCondition represents a `BETWEEN` condition.","since":"2.0.14","implements":["yii\\db\\conditions\\ConditionInterface"],"methods":{"__construct":{"signature":"public function __construct(mixed $column, string $operator, mixed $intervalStart, mixed $intervalEnd)","summary":"Creates a condition with the `BETWEEN` operator.","params":[{"name":"$column","type":"mixed","description":"The literal to the left of $operator"},{"name":"$operator","type":"string","description":"The operator to use (e.g. `BETWEEN` or `NOT BETWEEN`)"},{"name":"$intervalStart","type":"mixed","description":"Beginning of the interval"},{"name":"$intervalEnd","type":"mixed","description":"End of the interval"}]},"fromArrayDefinition":{"signature":"public static function fromArrayDefinition(mixed $operator, mixed $operands): static","summary":"Creates object by array-definition as described in [Query Builder – Operator format](https://yii2-framework.github.io/docs/guide/db-query-builder/#operator-format) guide article.","params":[{"name":"$operator","type":"mixed","description":"Operator in uppercase."},{"name":"$operands","type":"mixed","description":"Array of corresponding operands"}],"return":{"type":"static"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if wrong number of operands have been given."}],"static":true},"getColumn":{"signature":"public function getColumn(): mixed","return":{"type":"mixed"}},"getIntervalEnd":{"signature":"public function getIntervalEnd(): mixed","return":{"type":"mixed"}},"getIntervalStart":{"signature":"public function getIntervalStart(): mixed","return":{"type":"mixed"}},"getOperator":{"signature":"public function getOperator(): string","return":{"type":"string"}}}},"yii\\db\\conditions\\BetweenConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/betweenconditionbuilder/","summary":"Class BetweenConditionBuilder builds objects of `yii\\db\\conditions\\BetweenCondition`","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface|yii\\db\\conditions\\BetweenCondition $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface|yii\\db\\conditions\\BetweenCondition","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}},"createPlaceholder":{"signature":"protected function createPlaceholder(mixed $value, array &$params): string","summary":"Attaches $value to $params array and returns placeholder.","params":[{"name":"$value","type":"mixed"},{"name":"$params","type":"array","byReference":true,"description":"Passed by reference"}],"return":{"type":"string"},"visibility":"protected"}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\conditions\\ConditionInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/conditioninterface/","summary":"Interface ConditionInterface should be implemented by classes that represent a condition in DBAL of framework.","since":"2.0.14","implements":["yii\\db\\ExpressionInterface"],"methods":{"fromArrayDefinition":{"signature":"abstract public static function fromArrayDefinition(string $operator, array $operands): static","summary":"Creates object by array-definition as described in [Query Builder – Operator format](https://yii2-framework.github.io/docs/guide/db-query-builder/#operator-format) guide article.","params":[{"name":"$operator","type":"string","description":"Operator in uppercase."},{"name":"$operands","type":"array","description":"Array of corresponding operands"}],"return":{"type":"static"},"throws":[{"type":"InvalidArgumentException","description":"if input parameters are not suitable for this condition"}],"static":true,"abstract":true}}},"yii\\db\\conditions\\ConjunctionCondition":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/conjunctioncondition/","summary":"Class ConjunctionCondition","since":"2.0.14","implements":["yii\\db\\conditions\\ConditionInterface"],"properties":{"expressions":{"type":"mixed[]","default":"null","visibility":"protected"}},"methods":{"__construct":{"signature":"public function __construct(mixed $expressions)","params":[{"name":"$expressions","type":"mixed"}]},"fromArrayDefinition":{"signature":"public static function fromArrayDefinition(mixed $operator, mixed $operands): static","summary":"Creates object by array-definition as described in [Query Builder – Operator format](https://yii2-framework.github.io/docs/guide/db-query-builder/#operator-format) guide article.","params":[{"name":"$operator","type":"mixed","description":"Operator in uppercase."},{"name":"$operands","type":"mixed","description":"Array of corresponding operands"}],"return":{"type":"static"},"throws":[{"type":"InvalidArgumentException","description":"if input parameters are not suitable for this condition"}],"static":true},"getExpressions":{"signature":"public function getExpressions(): mixed[]","return":{"type":"mixed[]"}},"getOperator":{"signature":"abstract public function getOperator(): string","summary":"Returns the operator that is represented by this condition class, e.g. `AND`, `OR`.","return":{"type":"string"},"abstract":true}}},"yii\\db\\conditions\\ConjunctionConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/conjunctionconditionbuilder/","summary":"Class ConjunctionConditionBuilder builds objects of abstract class `yii\\db\\conditions\\ConjunctionCondition`","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface|yii\\db\\conditions\\ConjunctionCondition $condition, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$condition","type":"yii\\db\\ExpressionInterface|yii\\db\\conditions\\ConjunctionCondition","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\conditions\\ExistsCondition":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/existscondition/","summary":"Condition that represents `EXISTS` operator.","since":"2.0.14","implements":["yii\\db\\conditions\\ConditionInterface"],"methods":{"__construct":{"signature":"public function __construct(string $operator, yii\\db\\Query $query)","summary":"ExistsCondition constructor.","params":[{"name":"$operator","type":"string","description":"The operator to use (e.g. `EXISTS` or `NOT EXISTS`)"},{"name":"$query","type":"yii\\db\\Query","description":"The `yii\\db\\Query` object representing the sub-query."}]},"fromArrayDefinition":{"signature":"public static function fromArrayDefinition(mixed $operator, mixed $operands): static","summary":"Creates object by array-definition as described in [Query Builder – Operator format](https://yii2-framework.github.io/docs/guide/db-query-builder/#operator-format) guide article.","params":[{"name":"$operator","type":"mixed","description":"Operator in uppercase."},{"name":"$operands","type":"mixed","description":"Array of corresponding operands"}],"return":{"type":"static"},"throws":[{"type":"InvalidArgumentException","description":"if input parameters are not suitable for this condition"}],"static":true},"getOperator":{"signature":"public function getOperator(): string","return":{"type":"string"}},"getQuery":{"signature":"public function getQuery(): yii\\db\\Query","return":{"type":"yii\\db\\Query"}}}},"yii\\db\\conditions\\ExistsConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/existsconditionbuilder/","summary":"Class ExistsConditionBuilder builds objects of `yii\\db\\conditions\\ExistsCondition`","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface|yii\\db\\conditions\\ExistsCondition $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface|yii\\db\\conditions\\ExistsCondition","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\conditions\\HashCondition":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/hashcondition/","summary":"Condition based on column-value pairs.","since":"2.0.14","implements":["yii\\db\\conditions\\ConditionInterface"],"methods":{"__construct":{"signature":"public function __construct(array|null $hash)","summary":"HashCondition constructor.","params":[{"name":"$hash","type":"array|null"}]},"fromArrayDefinition":{"signature":"public static function fromArrayDefinition(mixed $operator, mixed $operands): static","summary":"Creates object by array-definition as described in [Query Builder – Operator format](https://yii2-framework.github.io/docs/guide/db-query-builder/#operator-format) guide article.","params":[{"name":"$operator","type":"mixed","description":"Operator in uppercase."},{"name":"$operands","type":"mixed","description":"Array of corresponding operands"}],"return":{"type":"static"},"throws":[{"type":"InvalidArgumentException","description":"if input parameters are not suitable for this condition"}],"static":true},"getHash":{"signature":"public function getHash(): array|null","return":{"type":"array|null"}}}},"yii\\db\\conditions\\HashConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/hashconditionbuilder/","summary":"Class HashConditionBuilder builds objects of `yii\\db\\conditions\\HashCondition`","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface|yii\\db\\conditions\\HashCondition $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface|yii\\db\\conditions\\HashCondition","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\conditions\\InCondition":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/incondition/","summary":"Represents `IN` condition.","since":"2.0.14","implements":["yii\\db\\conditions\\ConditionInterface"],"methods":{"__construct":{"signature":"public function __construct(array|string|yii\\db\\ExpressionInterface|Traversable $column, string $operator, array|int|string|yii\\db\\ExpressionInterface|Traversable $values)","params":[{"name":"$column","type":"array|string|yii\\db\\ExpressionInterface|Traversable","description":"The column name. If it is an array, a composite `IN` condition will be generated."},{"name":"$operator","type":"string","description":"The operator to use (e.g. `IN` or `NOT IN`)."},{"name":"$values","type":"array|int|string|yii\\db\\ExpressionInterface|Traversable","description":"An array of values that `column` value should be among. If it is an empty array the generated expression will be a `false` value if `operator` is `IN` and empty if operator is `NOT IN`."}]},"fromArrayDefinition":{"signature":"public static function fromArrayDefinition(mixed $operator, mixed $operands): static","summary":"Creates object by array-definition as described in [Query Builder – Operator format](https://yii2-framework.github.io/docs/guide/db-query-builder/#operator-format) guide article.","params":[{"name":"$operator","type":"mixed","description":"Operator in uppercase."},{"name":"$operands","type":"mixed","description":"Array of corresponding operands"}],"return":{"type":"static"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if wrong number of operands have been given."}],"static":true},"getColumn":{"signature":"public function getColumn(): array|string|yii\\db\\ExpressionInterface","summary":"Returns the column(s) being matched.","return":{"type":"array|string|yii\\db\\ExpressionInterface","description":"Column name, list of column names for composite conditions, or an expression."}},"getOperator":{"signature":"public function getOperator(): string","summary":"Returns the comparison operator.","return":{"type":"string","description":"Operator (for example, `IN` or `NOT IN`)."}},"getValues":{"signature":"public function getValues(): array|int|string|yii\\db\\ExpressionInterface","summary":"Returns the value(s) to match against.","return":{"type":"array|int|string|yii\\db\\ExpressionInterface","description":"Value list, scalar, or expression used for the comparison."}}}},"yii\\db\\conditions\\InConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/inconditionbuilder/","summary":"Builds objects of `yii\\db\\conditions\\InCondition`.","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface|yii\\db\\conditions\\InCondition $expression, array &$params = []): string","summary":"Builds raw SQL from the expression.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface|yii\\db\\conditions\\InCondition","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}},"buildCompositeInCondition":{"signature":"protected function buildCompositeInCondition(string $operator, array $columns, array $values, array &$params): string","summary":"Builds SQL for composite IN condition.","params":[{"name":"$operator","type":"string","description":"Operator in uppercase."},{"name":"$columns","type":"array","description":"Columns to be matched."},{"name":"$values","type":"array","description":"Row values."},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"SQL for composite IN condition."},"visibility":"protected"},"buildSubqueryInCondition":{"signature":"protected function buildSubqueryInCondition(string $operator, array|string|yii\\db\\ExpressionInterface $columns, yii\\db\\Query $values, array &$params): string","summary":"Builds SQL for IN condition.","params":[{"name":"$operator","type":"string","description":"Operator in uppercase."},{"name":"$columns","type":"array|string|yii\\db\\ExpressionInterface","description":"The columns to be matched."},{"name":"$values","type":"yii\\db\\Query","description":"Subquery values."},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"SQL for IN condition."},"visibility":"protected"},"buildValues":{"signature":"protected function buildValues(yii\\db\\conditions\\ConditionInterface|yii\\db\\conditions\\InCondition $condition, array $values, array &$params): array","summary":"Builds values to be used in `yii\\db\\conditions\\InCondition`.","params":[{"name":"$condition","type":"yii\\db\\conditions\\ConditionInterface|yii\\db\\conditions\\InCondition","description":"The condition to be built."},{"name":"$values","type":"array","description":"The values to bind."},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters."}],"return":{"type":"array","description":"Prepared SQL placeholders."},"visibility":"protected"},"getNotEqualOperator":{"signature":"protected function getNotEqualOperator(): string","summary":"Returns inequality operator for decomposed `NOT IN` conditions.","return":{"type":"string","description":"Inequality operator."},"visibility":"protected"},"getNullCondition":{"signature":"protected function getNullCondition(string $operator, string $column): string","summary":"Builds `IS NULL` / `IS NOT NULL` condition for a scalar column based on the operator.","params":[{"name":"$operator","type":"string","description":"Operator in uppercase."},{"name":"$column","type":"string","description":"Column to be matched."}],"return":{"type":"string","description":"Null condition SQL."},"visibility":"protected","since":"2.0.31"}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\conditions\\LikeCondition":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/likecondition/","summary":"Class LikeCondition represents a `LIKE` condition.","since":"2.0.14","extends":"yii\\db\\conditions\\SimpleCondition","implements":["yii\\db\\conditions\\ConditionInterface"],"properties":{"escapingReplacements":{"type":"array|null|false","default":"null","description":"Map of chars to their replacements, `false` if characters should not be escaped or either `null` or empty array if escaping is condition builder responsibility.","visibility":"protected"}},"methods":{"__construct":{"signature":"public function __construct(string $column, string $operator, string[]|string $value)","params":[{"name":"$column","type":"string","description":"The column name."},{"name":"$operator","type":"string","description":"The operator to use (e.g. `LIKE`, `NOT LIKE`, `OR LIKE` or `OR NOT LIKE`)"},{"name":"$value","type":"string[]|string","description":"Single value or an array of values that $column should be compared with. If it is an empty array the generated expression will be a `false` value if operator is `LIKE` or `OR LIKE` and empty if operator is `NOT LIKE` or `OR NOT LIKE`."}]},"fromArrayDefinition":{"signature":"public static function fromArrayDefinition(mixed $operator, mixed $operands): static","summary":"Creates object by array-definition as described in [Query Builder – Operator format](https://yii2-framework.github.io/docs/guide/db-query-builder/#operator-format) guide article.","params":[{"name":"$operator","type":"mixed","description":"Operator in uppercase."},{"name":"$operands","type":"mixed","description":"Array of corresponding operands"}],"return":{"type":"static"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if wrong number of operands have been given."}],"static":true},"getEscapingReplacements":{"signature":"public function getEscapingReplacements(): array|null|false","return":{"type":"array|null|false"}},"setEscapingReplacements":{"signature":"public function setEscapingReplacements(array|null|false $escapingReplacements): mixed","summary":"This method allows to specify how to escape special characters in the value(s).","params":[{"name":"$escapingReplacements","type":"array|null|false","description":"An array of mappings from the special characters to their escaped counterparts. You may use `false` to indicate the values are already escaped and no escape should be applied, or either `null` or empty array if escaping is condition builder responsibility. Note that when using an escape mapping (or the third operand is not provided), the values will be automatically enclosed within a pair of percentage characters."}],"return":{"type":"mixed"}}},"inherited":{"methods":{"getColumn":"yii\\db\\conditions\\SimpleCondition","getOperator":"yii\\db\\conditions\\SimpleCondition","getValue":"yii\\db\\conditions\\SimpleCondition"}}},"yii\\db\\conditions\\LikeConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/likeconditionbuilder/","summary":"Class LikeConditionBuilder builds objects of `yii\\db\\conditions\\LikeCondition`","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"properties":{"escapeCharacter":{"type":"string|null","default":"null","description":"Character used to escape special characters in LIKE conditions.","visibility":"protected"},"escapingReplacements":{"type":"array","default":"['%' => '\\%', '_' => '\\_', '\\\\' => '\\\\\\\\']","description":"Map of chars to their replacements in LIKE conditions.","visibility":"protected"}},"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface|yii\\db\\conditions\\LikeCondition $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface|yii\\db\\conditions\\LikeCondition","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}},"parseOperator":{"signature":"protected function parseOperator(string $operator): array","params":[{"name":"$operator","type":"string"}],"return":{"type":"array"},"visibility":"protected"}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\conditions\\NotCondition":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/notcondition/","summary":"Condition that inverts passed `condition`.","since":"2.0.14","implements":["yii\\db\\conditions\\ConditionInterface"],"methods":{"__construct":{"signature":"public function __construct(mixed $condition)","summary":"NotCondition constructor.","params":[{"name":"$condition","type":"mixed","description":"The condition to be negated"}]},"fromArrayDefinition":{"signature":"public static function fromArrayDefinition(mixed $operator, mixed $operands): static","summary":"Creates object by array-definition as described in [Query Builder – Operator format](https://yii2-framework.github.io/docs/guide/db-query-builder/#operator-format) guide article.","params":[{"name":"$operator","type":"mixed","description":"Operator in uppercase."},{"name":"$operands","type":"mixed","description":"Array of corresponding operands"}],"return":{"type":"static"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if wrong number of operands have been given."}],"static":true},"getCondition":{"signature":"public function getCondition(): mixed","return":{"type":"mixed"}}}},"yii\\db\\conditions\\NotConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/notconditionbuilder/","summary":"Class NotConditionBuilder builds objects of `yii\\db\\conditions\\NotCondition`","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface|yii\\db\\conditions\\NotCondition $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface|yii\\db\\conditions\\NotCondition","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}},"getNegationOperator":{"signature":"protected function getNegationOperator(): string","return":{"type":"string"},"visibility":"protected"}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\conditions\\OrCondition":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/orcondition/","summary":"Condition that connects two or more SQL expressions with the `AND` operator.","since":"2.0.14","extends":"yii\\db\\conditions\\ConjunctionCondition","implements":["yii\\db\\conditions\\ConditionInterface"],"methods":{"getOperator":{"signature":"public function getOperator(): string","summary":"Returns the operator that is represented by this condition class, e.g. `AND`, `OR`.","return":{"type":"string"}}},"inherited":{"properties":{"expressions":"yii\\db\\conditions\\ConjunctionCondition"},"methods":{"__construct":"yii\\db\\conditions\\ConjunctionCondition","fromArrayDefinition":"yii\\db\\conditions\\ConjunctionCondition","getExpressions":"yii\\db\\conditions\\ConjunctionCondition"}}},"yii\\db\\conditions\\SimpleCondition":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/simplecondition/","summary":"Class SimpleCondition represents a simple condition like `\"column\" operator value`.","since":"2.0.14","implements":["yii\\db\\conditions\\ConditionInterface"],"methods":{"__construct":{"signature":"public function __construct(mixed $column, string $operator, mixed $value)","summary":"SimpleCondition constructor","params":[{"name":"$column","type":"mixed","description":"The literal to the left of $operator"},{"name":"$operator","type":"string","description":"The operator to use. Anything could be used e.g. `>`, `<=`, etc."},{"name":"$value","type":"mixed","description":"The literal to the right of $operator"}]},"fromArrayDefinition":{"signature":"public static function fromArrayDefinition(mixed $operator, mixed $operands): static","summary":"Creates object by array-definition as described in [Query Builder – Operator format](https://yii2-framework.github.io/docs/guide/db-query-builder/#operator-format) guide article.","params":[{"name":"$operator","type":"mixed","description":"Operator in uppercase."},{"name":"$operands","type":"mixed","description":"Array of corresponding operands"}],"return":{"type":"static"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if wrong number of operands have been given."}],"static":true},"getColumn":{"signature":"public function getColumn(): mixed","return":{"type":"mixed"}},"getOperator":{"signature":"public function getOperator(): string","return":{"type":"string"}},"getValue":{"signature":"public function getValue(): mixed","return":{"type":"mixed"}}}},"yii\\db\\conditions\\SimpleConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/conditions/simpleconditionbuilder/","summary":"Class NotConditionBuilder builds objects of `yii\\db\\conditions\\SimpleCondition`","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface|yii\\db\\conditions\\SimpleCondition $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface|yii\\db\\conditions\\SimpleCondition","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\mssql\\ColumnSchema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/columnschema/","summary":"Represents the metadata of a column in a Microsoft SQL Server database table.","since":"2.0.23","extends":"yii\\db\\ColumnSchema","implements":["yii\\base\\Configurable"],"properties":{"isComputed":{"type":"bool","default":"false","description":"Whether this column is a computed column","since":"2.0.39"},"outputColumnDeclaration":{"type":"string","description":"SQL type declaration.","access":"read-only","virtual":true}},"methods":{"dbTypecast":{"signature":"public function dbTypecast(mixed $value): mixed","summary":"Renders a `rowversion`/`timestamp` value as an 8-byte binary literal (`0x...`) for WHERE comparisons, and converts `varbinary` strings to `CONVERT(VARBINARY(MAX), 0x...)` expressions to avoid conversion errors.","params":[{"name":"$value","type":"mixed"}],"return":{"type":"mixed"}},"defaultPhpTypecast":{"signature":"public function defaultPhpTypecast(mixed $value): mixed","summary":"Converts a MSSQL column default value to its PHP representation.","params":[{"name":"$value","type":"mixed","description":"Default value in MSSQL `column_default` format."}],"return":{"type":"mixed","description":"Converted value."},"since":"2.0.24"},"getOutputColumnDeclaration":{"signature":"public function getOutputColumnDeclaration(): string","summary":"Returns the SQL type declaration for this column inside an OUTPUT clause temp table.","return":{"type":"string","description":"SQL type declaration."}},"isRowVersion":{"signature":"public function isRowVersion(): bool","summary":"Returns whether this column is a SQL Server `rowversion` (legacy synonym `timestamp`) auto-versioning column.","return":{"type":"bool"}},"phpTypecast":{"signature":"public function phpTypecast(mixed $value): mixed","summary":"Converts the input value according to `$phpType` after retrieval from the database.","params":[{"name":"$value","type":"mixed","description":"Input value"}],"return":{"type":"mixed","description":"Converted value"}}},"inherited":{"properties":{"allowNull":"yii\\db\\ColumnSchema","autoIncrement":"yii\\db\\ColumnSchema","comment":"yii\\db\\ColumnSchema","dbType":"yii\\db\\ColumnSchema","defaultValue":"yii\\db\\ColumnSchema","enumValues":"yii\\db\\ColumnSchema","isPrimaryKey":"yii\\db\\ColumnSchema","name":"yii\\db\\ColumnSchema","phpType":"yii\\db\\ColumnSchema","precision":"yii\\db\\ColumnSchema","scale":"yii\\db\\ColumnSchema","size":"yii\\db\\ColumnSchema","type":"yii\\db\\ColumnSchema","unsigned":"yii\\db\\ColumnSchema"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isType":"yii\\db\\ColumnSchema","typecast":"yii\\db\\ColumnSchema"}}},"yii\\db\\mssql\\ColumnSchemaBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/columnschemabuilder/","summary":"ColumnSchemaBuilder is the schema builder for MSSQL databases.","since":"2.0.42","extends":"yii\\db\\ColumnSchemaBuilder","implements":["Stringable","yii\\base\\Configurable"],"properties":{"checkValue":{"type":"string|null","description":"The `CHECK` constraint for the column.","access":"read-only","virtual":true},"defaultValue":{"type":"string|yii\\db\\Expression|null","description":"Default value of the column.","access":"read-only","virtual":true},"format":{"default":"'{type}{length}{notnull}{unique}{default}{check}{append}'","visibility":"protected"}},"methods":{"__toString":{"signature":"public function __toString(): string","summary":"Builds the full string for the column's schema.","return":{"type":"string"}},"getCheckValue":{"signature":"public function getCheckValue(): string|null","summary":"Get the `Check` value for constraint","return":{"type":"string|null","description":"The `CHECK` constraint for the column."}},"getDefaultValue":{"signature":"public function getDefaultValue(): string|yii\\db\\Expression|null","summary":"Getting the `Default` value for constraint","return":{"type":"string|yii\\db\\Expression|null","description":"Default value of the column."}},"setAlterColumnFormat":{"signature":"public function setAlterColumnFormat(): mixed","summary":"Changes default format string to MSSQL ALTER COMMAND.","return":{"type":"mixed"}}},"inherited":{"properties":{"after":"yii\\db\\ColumnSchemaBuilder","append":"yii\\db\\ColumnSchemaBuilder","categoryMap":"yii\\db\\ColumnSchemaBuilder","check":"yii\\db\\ColumnSchemaBuilder","comment":"yii\\db\\ColumnSchemaBuilder","db":"yii\\db\\ColumnSchemaBuilder","default":"yii\\db\\ColumnSchemaBuilder","isFirst":"yii\\db\\ColumnSchemaBuilder","isNotNull":"yii\\db\\ColumnSchemaBuilder","isUnique":"yii\\db\\ColumnSchemaBuilder","isUnsigned":"yii\\db\\ColumnSchemaBuilder","length":"yii\\db\\ColumnSchemaBuilder","type":"yii\\db\\ColumnSchemaBuilder","typeCategoryMap":"yii\\db\\ColumnSchemaBuilder","typeDefinition":"yii\\db\\ColumnSchemaBuilder"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\db\\ColumnSchemaBuilder","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","after":"yii\\db\\ColumnSchemaBuilder","append":"yii\\db\\ColumnSchemaBuilder","buildAfterString":"yii\\db\\ColumnSchemaBuilder","buildAppendString":"yii\\db\\ColumnSchemaBuilder","buildCheckString":"yii\\db\\ColumnSchemaBuilder","buildCommentString":"yii\\db\\ColumnSchemaBuilder","buildCompleteString":"yii\\db\\ColumnSchemaBuilder","buildDefaultString":"yii\\db\\ColumnSchemaBuilder","buildDefaultValue":"yii\\db\\ColumnSchemaBuilder","buildFirstString":"yii\\db\\ColumnSchemaBuilder","buildLengthString":"yii\\db\\ColumnSchemaBuilder","buildNotNullString":"yii\\db\\ColumnSchemaBuilder","buildUniqueString":"yii\\db\\ColumnSchemaBuilder","buildUnsignedString":"yii\\db\\ColumnSchemaBuilder","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","check":"yii\\db\\ColumnSchemaBuilder","className":"yii\\base\\BaseObject","comment":"yii\\db\\ColumnSchemaBuilder","defaultExpression":"yii\\db\\ColumnSchemaBuilder","defaultValue":"yii\\db\\ColumnSchemaBuilder","first":"yii\\db\\ColumnSchemaBuilder","getAppend":"yii\\db\\ColumnSchemaBuilder","getCategoryMap":"yii\\db\\ColumnSchemaBuilder","getCheck":"yii\\db\\ColumnSchemaBuilder","getDefault":"yii\\db\\ColumnSchemaBuilder","getTypeCategory":"yii\\db\\ColumnSchemaBuilder","getTypeDefinition":"yii\\db\\ColumnSchemaBuilder","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isNotNull":"yii\\db\\ColumnSchemaBuilder","isUnique":"yii\\db\\ColumnSchemaBuilder","notNull":"yii\\db\\ColumnSchemaBuilder","null":"yii\\db\\ColumnSchemaBuilder","setCategoryMap":"yii\\db\\ColumnSchemaBuilder","unique":"yii\\db\\ColumnSchemaBuilder","unsigned":"yii\\db\\ColumnSchemaBuilder"},"constants":{"CATEGORY_PK":"yii\\db\\ColumnSchemaBuilder","CATEGORY_STRING":"yii\\db\\ColumnSchemaBuilder","CATEGORY_NUMERIC":"yii\\db\\ColumnSchemaBuilder","CATEGORY_TIME":"yii\\db\\ColumnSchemaBuilder","CATEGORY_OTHER":"yii\\db\\ColumnSchemaBuilder"}}},"yii\\db\\mssql\\Command":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/command/","summary":"Command represents an MSSQL SQL statement to be executed against a database.","since":"22.0","extends":"yii\\db\\Command","implements":["yii\\base\\Configurable"],"methods":{"alterColumn":{"signature":"public function alterColumn(mixed $table, mixed $column, mixed $type): $this","summary":"Creates a SQL command for changing the definition of a column.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be changed. The table name will be properly quoted by the method."},{"name":"$column","type":"mixed","description":"The name of the column to be changed. The name will be properly quoted by the method."},{"name":"$type","type":"mixed","description":"The column type. `yii\\db\\QueryBuilder::getColumnType()` will be called to convert the give column type to the physical one. For example, `string` will be converted as `varchar(255)`, and `string not null` becomes `varchar(255) not null`."}],"return":{"type":"$this","description":"The command object itself"}}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","db":"yii\\db\\Command","fetchMode":"yii\\db\\Command","params":"yii\\db\\Command","pdoStatement":"yii\\db\\Command","pendingParams":"yii\\db\\Command","queryCacheDependency":"yii\\db\\Command","queryCacheDuration":"yii\\db\\Command","rawSql":"yii\\db\\Command","sql":"yii\\db\\Command"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","addCheck":"yii\\db\\Command","addColumn":"yii\\db\\Command","addCommentOnColumn":"yii\\db\\Command","addCommentOnTable":"yii\\db\\Command","addDefaultValue":"yii\\db\\Command","addForeignKey":"yii\\db\\Command","addPrimaryKey":"yii\\db\\Command","addUnique":"yii\\db\\Command","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","batchInsert":"yii\\db\\Command","behaviors":"yii\\base\\Component","bindParam":"yii\\db\\Command","bindPendingParams":"yii\\db\\Command","bindValue":"yii\\db\\Command","bindValues":"yii\\db\\Command","cache":"yii\\db\\Command","cancel":"yii\\db\\Command","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","checkIntegrity":"yii\\db\\Command","className":"yii\\base\\BaseObject","createIndex":"yii\\db\\Command","createTable":"yii\\db\\Command","createView":"yii\\db\\Command","delete":"yii\\db\\Command","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","dropCheck":"yii\\db\\Command","dropColumn":"yii\\db\\Command","dropCommentFromColumn":"yii\\db\\Command","dropCommentFromTable":"yii\\db\\Command","dropDefaultValue":"yii\\db\\Command","dropForeignKey":"yii\\db\\Command","dropIndex":"yii\\db\\Command","dropPrimaryKey":"yii\\db\\Command","dropTable":"yii\\db\\Command","dropUnique":"yii\\db\\Command","dropView":"yii\\db\\Command","ensureBehaviors":"yii\\base\\Component","execute":"yii\\db\\Command","executeResetSequence":"yii\\db\\Command","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getCacheKey":"yii\\db\\Command","getRawSql":"yii\\db\\Command","getSql":"yii\\db\\Command","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","insert":"yii\\db\\Command","internalExecute":"yii\\db\\Command","logQuery":"yii\\db\\Command","noCache":"yii\\db\\Command","off":"yii\\base\\Component","on":"yii\\base\\Component","prepare":"yii\\db\\Command","query":"yii\\db\\Command","queryAll":"yii\\db\\Command","queryColumn":"yii\\db\\Command","queryInternal":"yii\\db\\Command","queryOne":"yii\\db\\Command","queryScalar":"yii\\db\\Command","refreshTableSchema":"yii\\db\\Command","renameColumn":"yii\\db\\Command","renameTable":"yii\\db\\Command","requireTableSchemaRefresh":"yii\\db\\Command","requireTransaction":"yii\\db\\Command","reset":"yii\\db\\Command","resetSequence":"yii\\db\\Command","setRawSql":"yii\\db\\Command","setRetryHandler":"yii\\db\\Command","setSql":"yii\\db\\Command","trigger":"yii\\base\\Component","truncateTable":"yii\\db\\Command","update":"yii\\db\\Command","upsert":"yii\\db\\Command"}}},"yii\\db\\mssql\\DBLibPDO":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/dblibpdo/","summary":"This is an extension of the default PDO class of DBLIB drivers.","since":"2.0.41","extends":"PDO","methods":{"getAttribute":{"signature":"public function getAttribute(int $attribute): mixed","summary":"Retrieve a database connection attribute.","params":[{"name":"$attribute","type":"int","description":"One of the PDO::ATTR_* constants."}],"return":{"type":"mixed","description":"A successful call returns the value of the requested PDO attribute. An unsuccessful call returns `null`."}},"lastInsertId":{"signature":"public function lastInsertId(string|null $name = null): string|false","summary":"Returns value of the last inserted ID.","params":[{"name":"$name","type":"string|null","default":"null","optional":true,"description":"The sequence name. Defaults to null."}],"return":{"type":"string|false","description":"Last inserted ID value."}}}},"yii\\db\\mssql\\PDO":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/pdo/","summary":"This is an extension of the default PDO class of MSSQL and DBLIB drivers.","since":"2.0","extends":"PDO","methods":{"beginTransaction":{"signature":"public function beginTransaction(): bool","summary":"Starts a transaction. It is necessary to override PDO's method as MSSQL PDO driver does not natively support transactions.","return":{"type":"bool","description":"The result of a transaction start."}},"commit":{"signature":"public function commit(): bool","summary":"Commits a transaction. It is necessary to override PDO's method as MSSQL PDO driver does not natively support transactions.","return":{"type":"bool","description":"The result of a transaction commit."}},"getAttribute":{"signature":"public function getAttribute(int $attribute): mixed","summary":"Retrieve a database connection attribute.","params":[{"name":"$attribute","type":"int","description":"One of the PDO::ATTR_* constants."}],"return":{"type":"mixed","description":"A successful call returns the value of the requested PDO attribute. An unsuccessful call returns `null`."}},"lastInsertId":{"signature":"public function lastInsertId(string|null $sequence = null): string|false","summary":"Returns value of the last inserted ID.","params":[{"name":"$sequence","type":"string|null","default":"null","optional":true,"description":"The sequence name. Defaults to `null`."}],"return":{"type":"string|false","description":"Last inserted ID value."}},"rollBack":{"signature":"public function rollBack(): bool","summary":"Rollbacks a transaction. It is necessary to override PDO's method as MSSQL PDO driver does not natively support transactions.","return":{"type":"bool","description":"The result of a transaction roll back."}}},"constants":{"SQLSRV_ATTR_ENCODING":{"value":"1000","description":"A constant for the pdo_sqlsrv encoding attribute. Pass as a key in `yii\\db\\Connection::$attributes`."},"SQLSRV_ENCODING_SYSTEM":{"value":"3","description":"A constant for ANSI (system code page) string encoding. Use with `SQLSRV_ATTR_ENCODING` to avoid the implicit `nvarchar`-to-`varchar` conversion that degrades performance on `char`/`varchar` indexed columns."},"SQLSRV_ENCODING_UTF8":{"value":"65001","description":"A constant for UTF-8 string encoding. This is the pdo_sqlsrv default for `PDO::PARAM_STR` parameters."}}},"yii\\db\\mssql\\QueryBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/querybuilder/","summary":"QueryBuilder is the query builder for MS SQL Server databases (version 2019 and above).","since":"2.0","extends":"yii\\db\\QueryBuilder","implements":["yii\\base\\Configurable"],"properties":{"typeMap":{"type":"array","default":"[\\yii\\db\\mssql\\Schema::TYPE_PK => 'int IDENTITY PRIMARY KEY', \\yii\\db\\mssql\\Schema::TYPE_UPK => 'int IDENTITY PRIMARY KEY', \\yii\\db\\mssql\\Schema::TYPE_BIGPK => 'bigint IDENTITY PRIMARY KEY', \\yii\\db\\mssql\\Schema::TYPE_UBIGPK => 'bigint IDENTITY PRIMARY KEY', \\yii\\db\\mssql\\Schema::TYPE_CHAR => 'nchar(1)', \\yii\\db\\mssql\\Schema::TYPE_STRING => 'nvarchar(255)', \\yii\\db\\mssql\\Schema::TYPE_TEXT => 'nvarchar(max)', \\yii\\db\\mssql\\Schema::TYPE_TINYINT => 'tinyint', \\yii\\db\\mssql\\Schema::TYPE_SMALLINT => 'smallint', \\yii\\db\\mssql\\Schema::TYPE_INTEGER => 'int', \\yii\\db\\mssql\\Schema::TYPE_BIGINT => 'bigint', \\yii\\db\\mssql\\Schema::TYPE_FLOAT => 'float', \\yii\\db\\mssql\\Schema::TYPE_DOUBLE => 'float', \\yii\\db\\mssql\\Schema::TYPE_DECIMAL => 'decimal(18,0)', \\yii\\db\\mssql\\Schema::TYPE_DATETIME => 'datetime', \\yii\\db\\mssql\\Schema::TYPE_TIMESTAMP => 'datetime', \\yii\\db\\mssql\\Schema::TYPE_TIME => 'time', \\yii\\db\\mssql\\Schema::TYPE_DATE => 'date', \\yii\\db\\mssql\\Schema::TYPE_BINARY => 'varbinary(max)', \\yii\\db\\mssql\\Schema::TYPE_BOOLEAN => 'bit', \\yii\\db\\mssql\\Schema::TYPE_MONEY => 'decimal(19,4)']","description":"Mapping from abstract column types (keys) to physical column types (values)."}},"methods":{"addCommentOnColumn":{"signature":"public function addCommentOnColumn(mixed $table, mixed $column, mixed $comment): string","summary":"Builds a SQL command for adding comment to column.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"mixed","description":"The name of the column to be commented. The column name will be properly quoted by the method."},{"name":"$comment","type":"mixed","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"since":"2.0.8"},"addCommentOnTable":{"signature":"public function addCommentOnTable(mixed $table, mixed $comment): string","summary":"Builds a SQL command for adding comment to table.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$comment","type":"mixed","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on table"},"since":"2.0.8"},"addDefaultValue":{"signature":"public function addDefaultValue(mixed $name, mixed $table, mixed $column, mixed $value): string","summary":"Creates a SQL command for adding a default value constraint to an existing table.","params":[{"name":"$name","type":"mixed","description":"The name of the default value constraint. The name will be properly quoted by the method."},{"name":"$table","type":"mixed","description":"The table that the default value constraint will be added to. The name will be properly quoted by the method."},{"name":"$column","type":"mixed","description":"The name of the column to that the constraint will be added on. The name will be properly quoted by the method."},{"name":"$value","type":"mixed","description":"Default value."}],"return":{"type":"string","description":"The SQL statement for adding a default value constraint to an existing table."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}],"since":"2.0.13"},"alterColumn":{"signature":"public function alterColumn(string $table, string $column, string $type): string","summary":"Builds a SQL statement for changing the definition of a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be changed. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be changed. The name will be properly quoted by the method."},{"name":"$type","type":"string","description":"The new column type. The `getColumnType()` method will be invoked to convert abstract column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'."}],"return":{"type":"string","description":"The SQL statement for changing the definition of a column."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}]},"buildAddCommentSql":{"signature":"protected function buildAddCommentSql(string $comment, string $table, string|null $column = null): string","summary":"Builds the SQL to add or update the `MS_Description` extended property of a table or column.","params":[{"name":"$comment","type":"string","description":"Comment text. Escaped and wrapped as an `N'...'` literal by the method."},{"name":"$table","type":"string","description":"Target table. May be 'catalog-', 'schema-', or bracket-qualified."},{"name":"$column","type":"string|null","default":"null","optional":true,"description":"Target column, or `null` to comment the table itself."}],"return":{"type":"string","description":"SQL statement that adds or updates the comment."},"visibility":"protected","since":"2.0.24"},"buildOrderByAndLimit":{"signature":"public function buildOrderByAndLimit(mixed $sql, mixed $orderBy, mixed $limit, mixed $offset): string","summary":"Builds the ORDER BY and LIMIT/OFFSET clauses and appends them to the given SQL.","params":[{"name":"$sql","type":"mixed","description":"The existing SQL (without ORDER BY/LIMIT/OFFSET)"},{"name":"$orderBy","type":"mixed","description":"The order by columns. See `yii\\db\\Query::orderBy()` for more details on how to specify this parameter."},{"name":"$limit","type":"mixed","description":"The limit number. See `yii\\db\\Query::limit()` for more details."},{"name":"$offset","type":"mixed","description":"The offset number. See `yii\\db\\Query::offset()` for more details."}],"return":{"type":"string","description":"The SQL completed with ORDER BY/LIMIT/OFFSET (if any)"}},"buildRemoveCommentSql":{"signature":"protected function buildRemoveCommentSql(string $table, string|null $column = null): string","summary":"Builds the SQL to remove the `MS_Description` extended property from a table or column.","params":[{"name":"$table","type":"string","description":"Target table. May be 'catalog-', 'schema-', or bracket-qualified."},{"name":"$column","type":"string|null","default":"null","optional":true,"description":"Target column, or `null` to remove the table comment."}],"return":{"type":"string","description":"SQL statement that removes the comment."},"visibility":"protected","since":"2.0.24"},"buildUnionOrderByAndLimit":{"signature":"public function buildUnionOrderByAndLimit(string $sql, array|null $orderBy, int|yii\\db\\ExpressionInterface|null $limit, int|yii\\db\\ExpressionInterface|null $offset): string","summary":"Builds the global ORDER BY and LIMIT/OFFSET clauses for a UNION query.","params":[{"name":"$sql","type":"string","description":"The complete UNION SQL without global ORDER BY/LIMIT/OFFSET clauses."},{"name":"$orderBy","type":"array|null","description":"The global order by columns."},{"name":"$limit","type":"int|yii\\db\\ExpressionInterface|null","description":"The global limit."},{"name":"$offset","type":"int|yii\\db\\ExpressionInterface|null","description":"The global offset."}],"return":{"type":"string","description":"The completed UNION SQL."},"since":"22.0"},"buildWithQueries":{"signature":"public function buildWithQueries(mixed $withs, mixed &$params): string","params":[{"name":"$withs","type":"mixed","description":"Of configurations for each WITH query"},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters to be populated"}],"return":{"type":"string","description":"Compiled WITH prefix of query including nested queries"},"since":"2.0.35"},"checkIntegrity":{"signature":"public function checkIntegrity(bool $check = true, string $schema = '', string $table = ''): string","summary":"Builds a SQL statement for enabling or disabling integrity checks on table constraints.","params":[{"name":"$check","type":"bool","default":"true","optional":true,"description":"Whether to enable (`true`) or disable (`false`) the integrity checks."},{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Defaults to an empty string, meaning the default schema."},{"name":"$table","type":"string","default":"''","optional":true,"description":"The table name. Defaults to an empty string, meaning every table in the schema."}],"return":{"type":"string","description":"The SQL statement for enabling or disabling the integrity checks."}},"defaultExpressionBuilders":{"signature":"protected function defaultExpressionBuilders(): array","summary":"Contains array of default expression builders. Extend this method and override it, if you want to change default expression builders for this query builder. See `$expressionBuilders` docs for details.","return":{"type":"array"},"visibility":"protected","since":"2.0.14"},"delete":{"signature":"public function delete(mixed $table, mixed $condition, mixed &$params): string","summary":"Creates a DELETE SQL statement.","params":[{"name":"$table","type":"mixed","description":"The table where the data will be deleted from."},{"name":"$condition","type":"mixed","description":"The condition that will be put in the WHERE part. Please refer to `yii\\db\\Query::where()` on how to specify condition."},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters that will be modified by this method so that they can be bound to the DB command later."}],"return":{"type":"string","description":"The DELETE SQL"}},"dropColumn":{"signature":"public function dropColumn(mixed $table, mixed $column): mixed","summary":"Drop all constraints before column delete.","params":[{"name":"$table","type":"mixed"},{"name":"$column","type":"mixed"}],"return":{"type":"mixed"}},"dropCommentFromColumn":{"signature":"public function dropCommentFromColumn(mixed $table, mixed $column): string","summary":"Builds a SQL command for adding comment to column.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"mixed","description":"The name of the column to be commented. The column name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"since":"2.0.8"},"dropCommentFromTable":{"signature":"public function dropCommentFromTable(mixed $table): string","summary":"Builds a SQL command for adding comment to table.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"since":"2.0.8"},"dropDefaultValue":{"signature":"public function dropDefaultValue(mixed $name, mixed $table): string","summary":"Creates a SQL command for dropping a default value constraint.","params":[{"name":"$name","type":"mixed","description":"The name of the default value constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"mixed","description":"The table whose default value constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping a default value constraint."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}],"since":"2.0.13"},"extractAlias":{"signature":"protected function extractAlias(mixed $table): bool|array","summary":"Extracts table alias if there is one or returns false","params":[{"name":"$table","type":"mixed"}],"return":{"type":"bool|array"},"visibility":"protected","since":"2.0.24"},"getColumnType":{"signature":"public function getColumnType(mixed $type): string","summary":"Converts an abstract column type into a physical column type.","params":[{"name":"$type","type":"mixed","description":"Abstract column type"}],"return":{"type":"string","description":"Physical column type."}},"insert":{"signature":"public function insert(mixed $table, mixed $columns, mixed &$params): string","summary":"Creates an INSERT SQL statement.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"mixed","description":"The column data (name => value) to be inserted into the table or instance of Query (`yii\\db\\Query`) to perform INSERT INTO ... SELECT SQL statement. Passing of Query (`yii\\db\\Query`) is available since version 2.0.11."},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"string","description":"The INSERT SQL"}},"prepareSelectQuery":{"signature":"protected function prepareSelectQuery(yii\\db\\Query $query): yii\\db\\Query","summary":"Performs driver-specific preparation after `yii\\db\\Query::prepare()`.","params":[{"name":"$query","type":"yii\\db\\Query","description":"The prepared query."}],"return":{"type":"yii\\db\\Query","description":"The query to build."},"visibility":"protected","since":"22.0"},"renameColumn":{"signature":"public function renameColumn(string $table, string $oldName, string $newName): string","summary":"Builds a SQL statement for renaming a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be renamed. The name will be properly quoted by the method."},{"name":"$oldName","type":"string","description":"The old name of the column. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new name of the column. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for renaming a DB column."}},"renameTable":{"signature":"public function renameTable(string $oldName, string $newName): string","summary":"Builds a SQL statement for renaming a DB table.","params":[{"name":"$oldName","type":"string","description":"The table to be renamed. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new table name. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for renaming a DB table."}},"resetSequence":{"signature":"public function resetSequence(string $tableName, int|null $value = null): string","summary":"Creates a SQL statement for resetting the sequence value of a table's primary key.","params":[{"name":"$tableName","type":"string","description":"The name of the table whose primary key sequence will be reset."},{"name":"$value","type":"int|null","default":"null","optional":true,"description":"The integer value for the primary key of the next new row inserted. If this is not set, the next new row's primary key will have the next value after the current maximum identity value."}],"return":{"type":"string","description":"The SQL statement for resetting sequence."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the table does not exist or there is no sequence associated with the table."}]},"selectExists":{"signature":"public function selectExists(mixed $rawSql): string","summary":"Creates a SELECT EXISTS() SQL statement.","params":[{"name":"$rawSql","type":"mixed","description":"The subquery in a raw form to select from."}],"return":{"type":"string","description":"The SELECT EXISTS() SQL statement."},"since":"2.0.8"},"update":{"signature":"public function update(mixed $table, mixed $columns, mixed $condition, mixed &$params): string","summary":"Creates an UPDATE SQL statement.","params":[{"name":"$table","type":"mixed","description":"The table to be updated."},{"name":"$columns","type":"mixed","description":"The column data (name => value) to be updated."},{"name":"$condition","type":"mixed","description":"The condition that will be put in the WHERE part. Please refer to `yii\\db\\Query::where()` on how to specify condition."},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters that will be modified by this method so that they can be bound to the DB command later."}],"return":{"type":"string","description":"The UPDATE SQL"}},"upsert":{"signature":"public function upsert(mixed $table, mixed $insertColumns, mixed $updateColumns, mixed &$params): mixed","summary":"Generates a `MERGE` statement that inserts a row or updates the matching one in a single atomic operation.","params":[{"name":"$table","type":"mixed"},{"name":"$insertColumns","type":"mixed"},{"name":"$updateColumns","type":"mixed"},{"name":"$params","type":"mixed","byReference":true}],"return":{"type":"mixed"}}},"inherited":{"properties":{"conditionClasses":"yii\\db\\QueryBuilder","db":"yii\\db\\QueryBuilder","expressionBuilders":"yii\\db\\QueryBuilder","separator":"yii\\db\\QueryBuilder"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\db\\QueryBuilder","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","addCheck":"yii\\db\\QueryBuilder","addColumn":"yii\\db\\QueryBuilder","addForeignKey":"yii\\db\\QueryBuilder","addPrimaryKey":"yii\\db\\QueryBuilder","addUnique":"yii\\db\\QueryBuilder","batchInsert":"yii\\db\\QueryBuilder","bindParam":"yii\\db\\QueryBuilder","build":"yii\\db\\QueryBuilder","buildColumns":"yii\\db\\QueryBuilder","buildCondition":"yii\\db\\QueryBuilder","buildExpression":"yii\\db\\QueryBuilder","buildFrom":"yii\\db\\QueryBuilder","buildGroupBy":"yii\\db\\QueryBuilder","buildHaving":"yii\\db\\QueryBuilder","buildJoin":"yii\\db\\QueryBuilder","buildLimit":"yii\\db\\QueryBuilder","buildOrderBy":"yii\\db\\QueryBuilder","buildSelect":"yii\\db\\QueryBuilder","buildUnion":"yii\\db\\QueryBuilder","buildWhere":"yii\\db\\QueryBuilder","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","concatUnionSql":"yii\\db\\QueryBuilder","createConditionFromArray":"yii\\db\\QueryBuilder","createIndex":"yii\\db\\QueryBuilder","createTable":"yii\\db\\QueryBuilder","createView":"yii\\db\\QueryBuilder","defaultConditionClasses":"yii\\db\\QueryBuilder","dropCheck":"yii\\db\\QueryBuilder","dropForeignKey":"yii\\db\\QueryBuilder","dropIndex":"yii\\db\\QueryBuilder","dropPrimaryKey":"yii\\db\\QueryBuilder","dropTable":"yii\\db\\QueryBuilder","dropUnique":"yii\\db\\QueryBuilder","dropView":"yii\\db\\QueryBuilder","executeResetSequence":"yii\\db\\QueryBuilder","getExpressionBuilder":"yii\\db\\QueryBuilder","hasLimit":"yii\\db\\QueryBuilder","hasMethod":"yii\\base\\BaseObject","hasOffset":"yii\\db\\QueryBuilder","hasProperty":"yii\\base\\BaseObject","init":"yii\\db\\QueryBuilder","prepareInsertSelectSubQuery":"yii\\db\\QueryBuilder","prepareInsertValues":"yii\\db\\QueryBuilder","prepareUpdateSets":"yii\\db\\QueryBuilder","prepareUpsertColumns":"yii\\db\\QueryBuilder","prepareUpsertSets":"yii\\db\\QueryBuilder","setConditionClasses":"yii\\db\\QueryBuilder","setExpressionBuilders":"yii\\db\\QueryBuilder","truncateTable":"yii\\db\\QueryBuilder"},"constants":{"PARAM_PREFIX":"yii\\db\\QueryBuilder"}}},"yii\\db\\mssql\\Quoter":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/quoter/","summary":"Provides connection-free helpers for quoting MSSQL values and identifiers when building SQL.","since":"22.0","methods":{"escapeLiteralValue":{"signature":"public static function escapeLiteralValue(string $value): string","summary":"Escapes single quotes in a value for embedding as a Transact-SQL string literal.","params":[{"name":"$value","type":"string","description":"Value to escape."}],"return":{"type":"string","description":"Value with single quotes doubled, ready to embed inside a quoted literal."},"static":true},"extractSimpleIdentifier":{"signature":"public static function extractSimpleIdentifier(string $name): string","summary":"Returns the trailing single-part identifier of a bracket-quoted qualified name, keeping its brackets.","params":[{"name":"$name","type":"string","description":"Bracket-quoted qualified identifier."}],"return":{"type":"string","description":"Trailing single-part identifier with brackets preserved."},"static":true},"isIdentifierBracketQuoted":{"signature":"public static function isIdentifierBracketQuoted(string $identifier): bool","summary":"Returns whether an identifier is already wrapped in MSSQL square brackets (`[identifier]`).","params":[{"name":"$identifier","type":"string","description":"Identifier to inspect."}],"return":{"type":"bool","description":"Whether the identifier is already bracket-quoted."},"static":true}}},"yii\\db\\mssql\\RowVersionBehavior":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/rowversionbehavior/","summary":"Refreshes a server-managed `rowversion` optimistic lock attribute from the database after each write.","extends":"yii\\base\\Behavior","implements":["yii\\base\\Configurable"],"methods":{"events":{"signature":"public function events(): array","summary":"Declares event handlers for the `$owner`'s events.","return":{"type":"array","description":"Events (array keys) and the corresponding event handler methods (array values)."}},"refreshRowVersion":{"signature":"public function refreshRowVersion(): void","summary":"Re-reads the `rowversion` optimistic lock attribute from the database into the owner instance.","return":{"type":"void"}}},"inherited":{"properties":{"owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","attach":"yii\\base\\Behavior","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\Behavior","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\mssql\\Schema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/schema/","summary":"Schema is the class for retrieving metadata from MS SQL Server databases (version 2019 and above).","since":"2.0","extends":"yii\\db\\Schema","implements":["yii\\db\\ConstraintFinderInterface","yii\\base\\Configurable"],"traits":["yii\\db\\ViewFinderTrait","yii\\db\\ConstraintFinderTrait"],"properties":{"columnQuoteCharacter":{"type":"string|string[]","default":"['[', ']']","visibility":"protected","since":"2.0.14"},"columnSchemaClass":{"type":"class-string|array{class?: class-string, __class?: class-string}","default":"\\yii\\db\\mssql\\ColumnSchema::class","since":"2.0.11"},"defaultSchema":{"type":"string","default":"'dbo'","description":"The default schema used for the current session."},"systemSchemaNames":{"type":"array","default":"['guest']"},"tableQuoteCharacter":{"type":"string|string[]","default":"['[', ']']","visibility":"protected","since":"2.0.14"},"typeMap":{"type":"array","default":"['bigint' => self::TYPE_BIGINT, 'numeric' => self::TYPE_DECIMAL, 'bit' => self::TYPE_SMALLINT, 'smallint' => self::TYPE_SMALLINT, 'decimal' => self::TYPE_DECIMAL, 'smallmoney' => self::TYPE_MONEY, 'int' => self::TYPE_INTEGER, 'tinyint' => self::TYPE_TINYINT, 'money' => self::TYPE_MONEY, 'float' => self::TYPE_FLOAT, 'double' => self::TYPE_DOUBLE, 'real' => self::TYPE_FLOAT, 'date' => self::TYPE_DATE, 'datetimeoffset' => self::TYPE_DATETIME, 'datetime2' => self::TYPE_DATETIME, 'smalldatetime' => self::TYPE_DATETIME, 'datetime' => self::TYPE_DATETIME, 'time' => self::TYPE_TIME, 'char' => self::TYPE_CHAR, 'varchar' => self::TYPE_STRING, 'text' => self::TYPE_TEXT, 'nchar' => self::TYPE_CHAR, 'nvarchar' => self::TYPE_STRING, 'ntext' => self::TYPE_TEXT, 'binary' => self::TYPE_BINARY, 'varbinary' => self::TYPE_BINARY, 'image' => self::TYPE_BINARY, 'timestamp' => self::TYPE_TIMESTAMP, 'hierarchyid' => self::TYPE_STRING, 'uniqueidentifier' => self::TYPE_STRING, 'sql_variant' => self::TYPE_STRING, 'xml' => self::TYPE_STRING, 'table' => self::TYPE_STRING]","description":"Mapping from physical column types (keys) to abstract column types (values)."}},"methods":{"createColumnSchemaBuilder":{"signature":"public function createColumnSchemaBuilder(mixed $type, mixed $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Create a column schema builder instance giving the type and value precision.","params":[{"name":"$type","type":"mixed","description":"Type of the column. See `yii\\db\\mssql\\ColumnSchemaBuilder::$type`."},{"name":"$length","type":"mixed","default":"null","optional":true,"description":"Length or precision of the column. See `yii\\db\\mssql\\ColumnSchemaBuilder::$length`."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"Column schema builder instance"},"since":"2.0.6"},"createQueryBuilder":{"signature":"public function createQueryBuilder(): yii\\db\\mssql\\QueryBuilder","summary":"Creates a query builder for the MSSQL database.","return":{"type":"yii\\db\\mssql\\QueryBuilder","description":"Query builder interface."}},"createSavepoint":{"signature":"public function createSavepoint(mixed $name): mixed","summary":"Creates a new savepoint.","params":[{"name":"$name","type":"mixed","description":"The savepoint name"}],"return":{"type":"mixed"}},"findColumns":{"signature":"protected function findColumns(yii\\db\\mssql\\TableSchema $table): bool","summary":"Collects the metadata of table columns.","params":[{"name":"$table","type":"yii\\db\\mssql\\TableSchema","description":"The table metadata."}],"return":{"type":"bool","description":"Whether the table exists in the database."},"visibility":"protected"},"findForeignKeys":{"signature":"protected function findForeignKeys(yii\\db\\mssql\\TableSchema $table): mixed","summary":"Collects the foreign key column details for the given table.","params":[{"name":"$table","type":"yii\\db\\mssql\\TableSchema","description":"The table metadata"}],"return":{"type":"mixed"},"visibility":"protected"},"findPrimaryKeys":{"signature":"protected function findPrimaryKeys(yii\\db\\mssql\\TableSchema $table): mixed","summary":"Collects the primary key column details for the given table.","params":[{"name":"$table","type":"yii\\db\\mssql\\TableSchema","description":"The table metadata"}],"return":{"type":"mixed"},"visibility":"protected"},"findSchemaNames":{"signature":"protected function findSchemaNames(): array","summary":"Returns all schema names in the database, including the default one but not system schemas.","return":{"type":"array","description":"All schema names in the database, except system schemas."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected","since":"2.0.4"},"findTableConstraints":{"signature":"protected function findTableConstraints(yii\\db\\mssql\\TableSchema $table, string $type): array","summary":"Collects the constraint details for the given table and constraint type.","params":[{"name":"$table","type":"yii\\db\\mssql\\TableSchema","description":"The table metadata."},{"name":"$type","type":"string","description":"Either `PK` or `UQ`."}],"return":{"type":"array","description":"Each entry contains index_name and field_name."},"visibility":"protected","since":"2.0.4"},"findTableNames":{"signature":"protected function findTableNames(mixed $schema = ''): array","summary":"Returns all table names in the database.","params":[{"name":"$schema","type":"mixed","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema."}],"return":{"type":"array","description":"All table names in the database. The names have NO schema name prefix."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected"},"findUniqueIndexes":{"signature":"public function findUniqueIndexes(yii\\db\\mssql\\TableSchema $table): array","summary":"Returns all unique indexes for the given table.","params":[{"name":"$table","type":"yii\\db\\mssql\\TableSchema","description":"The table metadata."}],"return":{"type":"array","description":"All unique indexes for the given table."},"since":"2.0.4"},"findViewNames":{"signature":"protected function findViewNames(mixed $schema = '')","params":[{"name":"$schema","type":"mixed","default":"''","optional":true}],"visibility":"protected"},"getSchemaMetadata":{"signature":"protected function getSchemaMetadata(mixed $schema, mixed $type, mixed $refresh): array","summary":"Returns the metadata of the given type for all tables in the given schema.","params":[{"name":"$schema","type":"mixed","description":"The schema of the metadata. Defaults to empty string, meaning the current or default schema name."},{"name":"$type","type":"mixed","description":"Metadata type."},{"name":"$refresh","type":"mixed","description":"Whether to fetch the latest available table metadata. If this is `false`, cached data may be returned if available."}],"return":{"type":"array","description":"Array of metadata."},"visibility":"protected","since":"2.0.13"},"getTableNameParts":{"signature":"protected function getTableNameParts(mixed $name): array","summary":"Splits full table name into parts.","params":[{"name":"$name","type":"mixed","description":"Full table name."}],"return":{"type":"array","description":"Table name parts."},"visibility":"protected","since":"2.0.22"},"insert":{"signature":"public function insert(mixed $table, mixed $columns): array|false","summary":"Executes the INSERT command, returning primary key values.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"mixed","description":"The column data (name => value) to be inserted into the table."}],"return":{"type":"array|false","description":"Primary key values or false if the command fails"},"since":"2.0.4"},"loadColumnSchema":{"signature":"protected function loadColumnSchema(array $info): yii\\db\\mssql\\T","summary":"Loads the column information into a `yii\\db\\mssql\\ColumnSchema` object.","params":[{"name":"$info","type":"array","description":"Column information."}],"return":{"type":"yii\\db\\mssql\\T","description":"The column schema object."},"visibility":"protected"},"loadTableChecks":{"signature":"protected function loadTableChecks(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableDefaultValues":{"signature":"protected function loadTableDefaultValues(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableForeignKeys":{"signature":"protected function loadTableForeignKeys(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableIndexes":{"signature":"protected function loadTableIndexes(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTablePrimaryKey":{"signature":"protected function loadTablePrimaryKey(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableSchema":{"signature":"protected function loadTableSchema(mixed $name): yii\\db\\TableSchema|null","summary":"Loads the metadata for the specified table.","params":[{"name":"$name","type":"mixed","description":"Table name"}],"return":{"type":"yii\\db\\TableSchema|null","description":"DBMS-dependent table metadata, `null` if the table does not exist."},"visibility":"protected"},"loadTableUniques":{"signature":"protected function loadTableUniques(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"quoteColumnName":{"signature":"public function quoteColumnName(mixed $name): string","summary":"Quotes a column name for use in a query.","params":[{"name":"$name","type":"mixed","description":"Column name."}],"return":{"type":"string","description":"The properly quoted column name."}},"quoteSystemCatalogName":{"signature":"public function quoteSystemCatalogName(string|null $catalogName): string","summary":"Quotes the `[sys]` system catalog name, optionally qualified by the database catalog.","params":[{"name":"$catalogName","type":"string|null","description":"The database catalog name, or `null` to target the current database."}],"return":{"type":"string","description":"The `[sys]` schema name, prefixed with the quoted catalog when one is provided."},"since":"22.0"},"quoteTableName":{"signature":"public function quoteTableName(mixed $name): mixed","summary":"Qualifies single-part table names with `$defaultSchema` when it differs from `'dbo'`, ensuring unqualified DDL and DML statements target the configured schema rather than the SQL Server login default.","params":[{"name":"$name","type":"mixed"}],"return":{"type":"mixed"}},"releaseSavepoint":{"signature":"public function releaseSavepoint(mixed $name): mixed","summary":"Releases an existing savepoint.","params":[{"name":"$name","type":"mixed","description":"The savepoint name"}],"return":{"type":"mixed"}},"resolveRawCatalogSchemaName":{"signature":"public function resolveRawCatalogSchemaName(string $schema): array{string|null, string}","summary":"Resolves a schema argument into optional catalog and schema names without loading database metadata.","params":[{"name":"$schema","type":"string","description":"The schema argument."}],"return":{"type":"array{string|null, string}","description":"The catalog and schema names."},"since":"22.0"},"resolveTableName":{"signature":"protected function resolveTableName(string $name): yii\\db\\mssql\\TableSchema","summary":"Resolves the table name and schema name (if any).","params":[{"name":"$name","type":"string","description":"The table name"}],"return":{"type":"yii\\db\\mssql\\TableSchema","description":"Resolved table, schema, etc. names."},"visibility":"protected"},"rollBackSavepoint":{"signature":"public function rollBackSavepoint(mixed $name): mixed","summary":"Rolls back to a previously created savepoint.","params":[{"name":"$name","type":"mixed","description":"The savepoint name"}],"return":{"type":"mixed"}}},"inherited":{"properties":{"db":"yii\\db\\Schema","exceptionMap":"yii\\db\\Schema","lastInsertID":"yii\\db\\Schema","queryBuilder":"yii\\db\\Schema","schemaChecks":"yii\\db\\ConstraintFinderTrait","schemaDefaultValues":"yii\\db\\ConstraintFinderTrait","schemaForeignKeys":"yii\\db\\ConstraintFinderTrait","schemaIndexes":"yii\\db\\ConstraintFinderTrait","schemaNames":"yii\\db\\Schema","schemaPrimaryKeys":"yii\\db\\ConstraintFinderTrait","schemaUniques":"yii\\db\\ConstraintFinderTrait","serverVersion":"yii\\db\\Schema","tableNames":"yii\\db\\Schema","tableSchemas":"yii\\db\\Schema","transactionIsolationLevel":"yii\\db\\Schema","viewNames":"yii\\db\\ViewFinderTrait"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","convertException":"yii\\db\\Schema","createColumnSchema":"yii\\db\\Schema","getCacheKey":"yii\\db\\Schema","getCacheTag":"yii\\db\\Schema","getColumnPhpType":"yii\\db\\Schema","getLastInsertID":"yii\\db\\Schema","getPdoType":"yii\\db\\Schema","getQueryBuilder":"yii\\db\\Schema","getRawTableName":"yii\\db\\Schema","getSchemaChecks":"yii\\db\\ConstraintFinderTrait","getSchemaDefaultValues":"yii\\db\\ConstraintFinderTrait","getSchemaForeignKeys":"yii\\db\\ConstraintFinderTrait","getSchemaIndexes":"yii\\db\\ConstraintFinderTrait","getSchemaNames":"yii\\db\\Schema","getSchemaPrimaryKeys":"yii\\db\\ConstraintFinderTrait","getSchemaUniques":"yii\\db\\ConstraintFinderTrait","getServerVersion":"yii\\db\\Schema","getTableChecks":"yii\\db\\ConstraintFinderTrait","getTableDefaultValues":"yii\\db\\ConstraintFinderTrait","getTableForeignKeys":"yii\\db\\ConstraintFinderTrait","getTableIndexes":"yii\\db\\ConstraintFinderTrait","getTableMetadata":"yii\\db\\Schema","getTableNames":"yii\\db\\Schema","getTablePrimaryKey":"yii\\db\\ConstraintFinderTrait","getTableSchema":"yii\\db\\Schema","getTableSchemas":"yii\\db\\Schema","getTableUniques":"yii\\db\\ConstraintFinderTrait","getViewNames":"yii\\db\\ViewFinderTrait","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isReadQuery":"yii\\db\\Schema","normalizePdoRowKeyCase":"yii\\db\\Schema","quoteSimpleColumnName":"yii\\db\\Schema","quoteSimpleTableName":"yii\\db\\Schema","quoteValue":"yii\\db\\Schema","refresh":"yii\\db\\Schema","refreshTableSchema":"yii\\db\\Schema","resolveRawTableName":"yii\\db\\Schema","setTableMetadata":"yii\\db\\Schema","setTransactionIsolationLevel":"yii\\db\\Schema","supportsSavepoint":"yii\\db\\Schema","unquoteSimpleColumnName":"yii\\db\\Schema","unquoteSimpleTableName":"yii\\db\\Schema"},"constants":{"TYPE_PK":"yii\\db\\Schema","TYPE_UPK":"yii\\db\\Schema","TYPE_BIGPK":"yii\\db\\Schema","TYPE_UBIGPK":"yii\\db\\Schema","TYPE_CHAR":"yii\\db\\Schema","TYPE_STRING":"yii\\db\\Schema","TYPE_TEXT":"yii\\db\\Schema","TYPE_TINYINT":"yii\\db\\Schema","TYPE_SMALLINT":"yii\\db\\Schema","TYPE_INTEGER":"yii\\db\\Schema","TYPE_BIGINT":"yii\\db\\Schema","TYPE_FLOAT":"yii\\db\\Schema","TYPE_DOUBLE":"yii\\db\\Schema","TYPE_DECIMAL":"yii\\db\\Schema","TYPE_DATETIME":"yii\\db\\Schema","TYPE_TIMESTAMP":"yii\\db\\Schema","TYPE_TIME":"yii\\db\\Schema","TYPE_DATE":"yii\\db\\Schema","TYPE_BINARY":"yii\\db\\Schema","TYPE_BOOLEAN":"yii\\db\\Schema","TYPE_MONEY":"yii\\db\\Schema","TYPE_JSON":"yii\\db\\Schema","SCHEMA_CACHE_VERSION":"yii\\db\\Schema"}}},"yii\\db\\mssql\\SqlsrvPDO":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/sqlsrvpdo/","summary":"This is an extension of the default PDO class of SQLSRV driver.","since":"2.0","extends":"PDO","methods":{"lastInsertId":{"signature":"public function lastInsertId(string|null $sequence = null): string|false","summary":"Returns value of the last inserted ID.","params":[{"name":"$sequence","type":"string|null","default":"null","optional":true,"description":"The sequence name. Defaults to `null`."}],"return":{"type":"string|false","description":"Last inserted ID value."}}},"constants":{"SQLSRV_ATTR_ENCODING":{"value":"1000","description":"A constant for the pdo_sqlsrv encoding attribute. Pass as a key in `yii\\db\\Connection::$attributes`."},"SQLSRV_ENCODING_SYSTEM":{"value":"3","description":"A constant for ANSI (system code page) string encoding. Use with `SQLSRV_ATTR_ENCODING` to avoid the implicit `nvarchar`-to-`varchar` conversion that degrades performance on `char`/`varchar` indexed columns."},"SQLSRV_ENCODING_UTF8":{"value":"65001","description":"A constant for UTF-8 string encoding. This is the pdo_sqlsrv default for `PDO::PARAM_STR` parameters."}}},"yii\\db\\mssql\\TableSchema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/tableschema/","summary":"TableSchema represents the metadata of a database table.","since":"2.0","extends":"yii\\db\\TableSchema","implements":["yii\\base\\Configurable"],"properties":{"catalogName":{"type":"string|null","default":"null","description":"Name of the catalog (database) that this table belongs to."}},"inherited":{"properties":{"columnNames":"yii\\db\\TableSchema","columns":"yii\\db\\TableSchema","foreignKeys":"yii\\db\\TableSchema","fullName":"yii\\db\\TableSchema","name":"yii\\db\\TableSchema","primaryKey":"yii\\db\\TableSchema","schemaName":"yii\\db\\TableSchema","sequenceName":"yii\\db\\TableSchema"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","fixPrimaryKey":"yii\\db\\TableSchema","getColumn":"yii\\db\\TableSchema","getColumnNames":"yii\\db\\TableSchema","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\db\\mssql\\conditions\\InConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/conditions/inconditionbuilder/","summary":"Builds objects of `yii\\db\\conditions\\InCondition`.","since":"2.0.14","extends":"yii\\db\\conditions\\InConditionBuilder","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"buildSubqueryInCondition":{"signature":"protected function buildSubqueryInCondition(string $operator, array|string|yii\\db\\ExpressionInterface $columns, yii\\db\\Query $values, array &$params): string","summary":"Builds SQL for IN condition.","params":[{"name":"$operator","type":"string","description":"Operator in uppercase."},{"name":"$columns","type":"array|string|yii\\db\\ExpressionInterface","description":"The columns to be matched."},{"name":"$values","type":"yii\\db\\Query","description":"Subquery values."},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"SQL for IN condition."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if `$columns` is an array"}],"visibility":"protected"},"getNotEqualOperator":{"signature":"protected function getNotEqualOperator(): string","summary":"Returns inequality operator for decomposed `NOT IN` conditions.","return":{"type":"string","description":"Inequality operator."},"visibility":"protected"}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait","build":"yii\\db\\conditions\\InConditionBuilder","buildCompositeInCondition":"yii\\db\\conditions\\InConditionBuilder","buildValues":"yii\\db\\conditions\\InConditionBuilder","getNullCondition":"yii\\db\\conditions\\InConditionBuilder"}}},"yii\\db\\mssql\\conditions\\LikeConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mssql/conditions/likeconditionbuilder/","summary":"Class LikeConditionBuilder builds objects of `yii\\db\\conditions\\LikeCondition`","extends":"yii\\db\\conditions\\LikeConditionBuilder","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"properties":{"escapingReplacements":{"type":"array","default":"['%' => '[%]', '_' => '[_]', '[' => '[[]', ']' => '[]]', '\\\\' => '[\\]']","visibility":"protected"}},"inherited":{"properties":{"escapeCharacter":"yii\\db\\conditions\\LikeConditionBuilder","queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait","build":"yii\\db\\conditions\\LikeConditionBuilder","parseOperator":"yii\\db\\conditions\\LikeConditionBuilder"}}},"yii\\db\\mysql\\ColumnSchema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mysql/columnschema/","summary":"Represents the metadata of a column in a MySQL database table.","since":"2.0.14.1","extends":"yii\\db\\ColumnSchema","implements":["yii\\base\\Configurable"],"properties":{"isDefaultExpression":{"type":"bool","default":"false","description":"Whether MySQL reports the column default as an expression (`DEFAULT_GENERATED`).","since":"22.0"}},"methods":{"dbTypecast":{"signature":"public function dbTypecast(mixed $value): mixed","summary":"Converts the input value according to `$type` and `$dbType` for use in a db query.","params":[{"name":"$value","type":"mixed","description":"Input value"}],"return":{"type":"mixed","description":"Converted value. This may also be an array containing the value as the first element and the PDO type as the second element."}},"defaultPhpTypecast":{"signature":"public function defaultPhpTypecast(mixed $value): mixed","summary":"Converts a MySQL column default value to its PHP representation.","params":[{"name":"$value","type":"mixed","description":"Default value in the format reported by `SHOW FULL COLUMNS`."}],"return":{"type":"mixed","description":"Converted value."},"since":"22.0"},"phpTypecast":{"signature":"public function phpTypecast(mixed $value): mixed","summary":"Converts the input value according to `$phpType` after retrieval from the database.","params":[{"name":"$value","type":"mixed","description":"Input value"}],"return":{"type":"mixed","description":"Converted value"}}},"inherited":{"properties":{"allowNull":"yii\\db\\ColumnSchema","autoIncrement":"yii\\db\\ColumnSchema","comment":"yii\\db\\ColumnSchema","dbType":"yii\\db\\ColumnSchema","defaultValue":"yii\\db\\ColumnSchema","enumValues":"yii\\db\\ColumnSchema","isPrimaryKey":"yii\\db\\ColumnSchema","name":"yii\\db\\ColumnSchema","phpType":"yii\\db\\ColumnSchema","precision":"yii\\db\\ColumnSchema","scale":"yii\\db\\ColumnSchema","size":"yii\\db\\ColumnSchema","type":"yii\\db\\ColumnSchema","unsigned":"yii\\db\\ColumnSchema"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isType":"yii\\db\\ColumnSchema","typecast":"yii\\db\\ColumnSchema"}}},"yii\\db\\mysql\\ColumnSchemaBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mysql/columnschemabuilder/","summary":"ColumnSchemaBuilder is the schema builder for MySQL databases.","since":"2.0.8","extends":"yii\\db\\ColumnSchemaBuilder","implements":["Stringable","yii\\base\\Configurable"],"methods":{"__toString":{"signature":"public function __toString(): string","summary":"Builds the full string for the column's schema.","return":{"type":"string"}},"buildAfterString":{"signature":"protected function buildAfterString(): string","summary":"Builds the after constraint for the column. Defaults to unsupported.","return":{"type":"string","description":"A string containing the AFTER constraint."},"visibility":"protected","since":"2.0.8"},"buildCommentString":{"signature":"protected function buildCommentString(): string","summary":"Builds the comment specification for the column.","return":{"type":"string","description":"A string containing the COMMENT keyword and the comment itself"},"visibility":"protected","since":"2.0.8"},"buildFirstString":{"signature":"protected function buildFirstString(): string","summary":"Builds the first constraint for the column. Defaults to unsupported.","return":{"type":"string","description":"A string containing the FIRST constraint."},"visibility":"protected","since":"2.0.8"},"buildUnsignedString":{"signature":"protected function buildUnsignedString(): string","summary":"Builds the unsigned string for column. Defaults to unsupported.","return":{"type":"string","description":"A string containing UNSIGNED keyword."},"visibility":"protected","since":"2.0.7"}},"inherited":{"properties":{"after":"yii\\db\\ColumnSchemaBuilder","append":"yii\\db\\ColumnSchemaBuilder","categoryMap":"yii\\db\\ColumnSchemaBuilder","check":"yii\\db\\ColumnSchemaBuilder","comment":"yii\\db\\ColumnSchemaBuilder","db":"yii\\db\\ColumnSchemaBuilder","default":"yii\\db\\ColumnSchemaBuilder","isFirst":"yii\\db\\ColumnSchemaBuilder","isNotNull":"yii\\db\\ColumnSchemaBuilder","isUnique":"yii\\db\\ColumnSchemaBuilder","isUnsigned":"yii\\db\\ColumnSchemaBuilder","length":"yii\\db\\ColumnSchemaBuilder","type":"yii\\db\\ColumnSchemaBuilder","typeCategoryMap":"yii\\db\\ColumnSchemaBuilder","typeDefinition":"yii\\db\\ColumnSchemaBuilder"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\db\\ColumnSchemaBuilder","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","after":"yii\\db\\ColumnSchemaBuilder","append":"yii\\db\\ColumnSchemaBuilder","buildAppendString":"yii\\db\\ColumnSchemaBuilder","buildCheckString":"yii\\db\\ColumnSchemaBuilder","buildCompleteString":"yii\\db\\ColumnSchemaBuilder","buildDefaultString":"yii\\db\\ColumnSchemaBuilder","buildDefaultValue":"yii\\db\\ColumnSchemaBuilder","buildLengthString":"yii\\db\\ColumnSchemaBuilder","buildNotNullString":"yii\\db\\ColumnSchemaBuilder","buildUniqueString":"yii\\db\\ColumnSchemaBuilder","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","check":"yii\\db\\ColumnSchemaBuilder","className":"yii\\base\\BaseObject","comment":"yii\\db\\ColumnSchemaBuilder","defaultExpression":"yii\\db\\ColumnSchemaBuilder","defaultValue":"yii\\db\\ColumnSchemaBuilder","first":"yii\\db\\ColumnSchemaBuilder","getAppend":"yii\\db\\ColumnSchemaBuilder","getCategoryMap":"yii\\db\\ColumnSchemaBuilder","getCheck":"yii\\db\\ColumnSchemaBuilder","getDefault":"yii\\db\\ColumnSchemaBuilder","getTypeCategory":"yii\\db\\ColumnSchemaBuilder","getTypeDefinition":"yii\\db\\ColumnSchemaBuilder","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isNotNull":"yii\\db\\ColumnSchemaBuilder","isUnique":"yii\\db\\ColumnSchemaBuilder","notNull":"yii\\db\\ColumnSchemaBuilder","null":"yii\\db\\ColumnSchemaBuilder","setCategoryMap":"yii\\db\\ColumnSchemaBuilder","unique":"yii\\db\\ColumnSchemaBuilder","unsigned":"yii\\db\\ColumnSchemaBuilder"},"constants":{"CATEGORY_PK":"yii\\db\\ColumnSchemaBuilder","CATEGORY_STRING":"yii\\db\\ColumnSchemaBuilder","CATEGORY_NUMERIC":"yii\\db\\ColumnSchemaBuilder","CATEGORY_TIME":"yii\\db\\ColumnSchemaBuilder","CATEGORY_OTHER":"yii\\db\\ColumnSchemaBuilder"}}},"yii\\db\\mysql\\JsonExpressionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mysql/jsonexpressionbuilder/","summary":"Class JsonExpressionBuilder builds `yii\\db\\JsonExpression` for MySQL DBMS.","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\JsonExpression|yii\\db\\ExpressionInterface $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\JsonExpression|yii\\db\\ExpressionInterface","description":"The expression to be built"},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}}},"constants":{"PARAM_PREFIX":{"value":"':qp'"}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\mysql\\QueryBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mysql/querybuilder/","summary":"QueryBuilder is the query builder for MySQL databases (MySQL 8.0+ and MariaDB 10.6+).","since":"2.0","extends":"yii\\db\\QueryBuilder","implements":["yii\\base\\Configurable"],"properties":{"typeMap":{"type":"array","default":"[\\yii\\db\\mysql\\Schema::TYPE_PK => 'int NOT NULL AUTO_INCREMENT PRIMARY KEY', \\yii\\db\\mysql\\Schema::TYPE_UPK => 'int UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY', \\yii\\db\\mysql\\Schema::TYPE_BIGPK => 'bigint NOT NULL AUTO_INCREMENT PRIMARY KEY', \\yii\\db\\mysql\\Schema::TYPE_UBIGPK => 'bigint UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY', \\yii\\db\\mysql\\Schema::TYPE_CHAR => 'char(1)', \\yii\\db\\mysql\\Schema::TYPE_STRING => 'varchar(255)', \\yii\\db\\mysql\\Schema::TYPE_TEXT => 'text', \\yii\\db\\mysql\\Schema::TYPE_TINYINT => 'tinyint', \\yii\\db\\mysql\\Schema::TYPE_SMALLINT => 'smallint', \\yii\\db\\mysql\\Schema::TYPE_INTEGER => 'int', \\yii\\db\\mysql\\Schema::TYPE_BIGINT => 'bigint', \\yii\\db\\mysql\\Schema::TYPE_FLOAT => 'float', \\yii\\db\\mysql\\Schema::TYPE_DOUBLE => 'double', \\yii\\db\\mysql\\Schema::TYPE_DECIMAL => 'decimal(10,0)', \\yii\\db\\mysql\\Schema::TYPE_DATE => 'date', \\yii\\db\\mysql\\Schema::TYPE_BINARY => 'blob', \\yii\\db\\mysql\\Schema::TYPE_BOOLEAN => 'tinyint(1)', \\yii\\db\\mysql\\Schema::TYPE_MONEY => 'decimal(19,4)', \\yii\\db\\mysql\\Schema::TYPE_JSON => 'json']","description":"Mapping from abstract column types (keys) to physical column types (values)."}},"methods":{"addCommentOnColumn":{"signature":"public function addCommentOnColumn(mixed $table, mixed $column, mixed $comment): string","summary":"Builds a SQL command for adding comment to column.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"mixed","description":"The name of the column to be commented. The column name will be properly quoted by the method."},{"name":"$comment","type":"mixed","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"since":"2.0.8"},"addCommentOnTable":{"signature":"public function addCommentOnTable(mixed $table, mixed $comment): string","summary":"Builds a SQL command for adding comment to table.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$comment","type":"mixed","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on table"},"since":"2.0.8"},"buildLimit":{"signature":"public function buildLimit(mixed $limit, mixed $offset): string","params":[{"name":"$limit","type":"mixed"},{"name":"$offset","type":"mixed"}],"return":{"type":"string","description":"The LIMIT and OFFSET clauses"}},"buildOffsetFetch":{"signature":"protected function buildOffsetFetch(int|yii\\db\\Expression $limit, int|yii\\db\\Expression $offset): string","summary":"Builds the OFFSET/FETCH clauses for MariaDB 10.6 or newer.","params":[{"name":"$limit","type":"int|yii\\db\\Expression","description":"The limit number. See `yii\\db\\Query::limit()` for more details."},{"name":"$offset","type":"int|yii\\db\\Expression","description":"The offset number. See `yii\\db\\Query::offset()` for more details."}],"return":{"type":"string","description":"SQL statement for OFFSET/FETCH clauses."},"visibility":"protected"},"checkIntegrity":{"signature":"public function checkIntegrity(bool $check = true, string $schema = '', string $table = ''): string","summary":"Builds a SQL statement for enabling or disabling integrity check.","params":[{"name":"$check","type":"bool","default":"true","optional":true,"description":"Whether to turn on or off the integrity check."},{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Meaningless for MySQL."},{"name":"$table","type":"string","default":"''","optional":true,"description":"The table name. Meaningless for MySQL."}],"return":{"type":"string","description":"The SQL statement for checking integrity"}},"createIndex":{"signature":"public function createIndex(string $name, string $table, array|string $columns, bool $unique = false): string","summary":"Builds a SQL statement for creating a new index.","params":[{"name":"$name","type":"string","description":"The name of the index. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the new index will be created for. The name will be properly quoted by the method."},{"name":"$columns","type":"array|string","description":"The column(s) that should be included in the index. If there are multiple columns, separate them with commas or use an array to represent them. Each column name will be properly quoted by the method, unless a parenthesis is found in the name."},{"name":"$unique","type":"bool","default":"false","optional":true,"description":"Whether to add a `UNIQUE` constraint on the created index."}],"return":{"type":"string","description":"The SQL statement for creating a new index."}},"defaultExpressionBuilders":{"signature":"protected function defaultExpressionBuilders(): array","summary":"Contains array of default expression builders. Extend this method and override it, if you want to change default expression builders for this query builder. See `$expressionBuilders` docs for details.","return":{"type":"array"},"visibility":"protected","since":"2.0.14"},"dropCommentFromColumn":{"signature":"public function dropCommentFromColumn(mixed $table, mixed $column): string","summary":"Builds a SQL command for adding comment to column.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"mixed","description":"The name of the column to be commented. The column name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"since":"2.0.8"},"dropCommentFromTable":{"signature":"public function dropCommentFromTable(mixed $table): string","summary":"Builds a SQL command for adding comment to table.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"since":"2.0.8"},"dropForeignKey":{"signature":"public function dropForeignKey(string $name, string $table): string","summary":"Builds a SQL statement for dropping a foreign key constraint.","params":[{"name":"$name","type":"string","description":"The name of the foreign key constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose foreign key is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping a foreign key constraint."}},"dropPrimaryKey":{"signature":"public function dropPrimaryKey(string $name, string $table): string","summary":"Builds a SQL statement for removing a primary key constraint from an existing table.","params":[{"name":"$name","type":"string","description":"The name of the primary key constraint to be removed. Ignored by MySQL."},{"name":"$table","type":"string","description":"The table that the primary key constraint will be removed from. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for removing a primary key constraint from an existing table."}},"dropUnique":{"signature":"public function dropUnique(mixed $name, mixed $table): string","summary":"Creates a SQL command for dropping an unique constraint.","params":[{"name":"$name","type":"mixed","description":"The name of the unique constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"mixed","description":"The table whose unique constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping an unique constraint."},"since":"2.0.13"},"hasLimit":{"signature":"protected function hasLimit(mixed $limit): bool","summary":"Checks to see if the given limit is effective.","params":[{"name":"$limit","type":"mixed","description":"The given limit"}],"return":{"type":"bool","description":"Whether the limit is effective"},"visibility":"protected"},"hasOffset":{"signature":"protected function hasOffset(mixed $offset): bool","summary":"Checks to see if the given offset is effective.","params":[{"name":"$offset","type":"mixed","description":"The given offset"}],"return":{"type":"bool","description":"Whether the offset is effective"},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"isMariaDb":{"signature":"public function isMariaDb(): bool","summary":"Returns whether the connected server is MariaDB.","return":{"type":"bool","description":"Whether the connected server is MariaDB."}},"prepareInsertValues":{"signature":"protected function prepareInsertValues(mixed $table, mixed $columns, mixed $params = []): array","summary":"Prepares a `VALUES` part for an `INSERT` SQL statement.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"mixed","description":"The column data (name => value) to be inserted into the table or instance of Query (`yii\\db\\Query`) to perform INSERT INTO ... SELECT SQL statement."},{"name":"$params","type":"mixed","default":"[]","optional":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"array","description":"Array of column names, placeholders, values and params."},"visibility":"protected","since":"2.0.14"},"resetSequence":{"signature":"public function resetSequence(string $tableName, int|null $value = null): string","summary":"Creates a SQL statement for resetting the sequence value of a table's primary key.","params":[{"name":"$tableName","type":"string","description":"The name of the table whose primary key sequence will be reset."},{"name":"$value","type":"int|null","default":"null","optional":true,"description":"The integer value for the primary key of the next new row inserted. If this is not set, the next new row's primary key will have the maximum existing value `+1`."}],"return":{"type":"string","description":"The SQL statement for resetting sequence."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the table does not exist or there is no sequence associated with the table."}]},"selectExists":{"signature":"public function selectExists(mixed $rawSql): string","summary":"Creates a SELECT EXISTS() SQL statement.","params":[{"name":"$rawSql","type":"mixed","description":"The subquery in a raw form to select from."}],"return":{"type":"string","description":"The SELECT EXISTS() SQL statement."},"since":"2.0.8"},"upsert":{"signature":"public function upsert(mixed $table, mixed $insertColumns, mixed $updateColumns, mixed &$params): string","summary":"Creates an SQL statement to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into/updated in."},{"name":"$insertColumns","type":"mixed","description":"The column data (name => value) to be inserted into the table or instance of `yii\\db\\Query` to perform `INSERT INTO ... SELECT` SQL statement."},{"name":"$updateColumns","type":"mixed","description":"The column data (name => value) to be updated if they already exist. If `true` is passed, the column data will be updated to match the insert column data. If `false` is passed, no update will be performed if the column data already exists."},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"string","description":"The resulting SQL."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}],"since":"2.0.14"}},"inherited":{"properties":{"conditionClasses":"yii\\db\\QueryBuilder","db":"yii\\db\\QueryBuilder","expressionBuilders":"yii\\db\\QueryBuilder","separator":"yii\\db\\QueryBuilder"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\db\\QueryBuilder","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","addCheck":"yii\\db\\QueryBuilder","addColumn":"yii\\db\\QueryBuilder","addDefaultValue":"yii\\db\\QueryBuilder","addForeignKey":"yii\\db\\QueryBuilder","addPrimaryKey":"yii\\db\\QueryBuilder","addUnique":"yii\\db\\QueryBuilder","alterColumn":"yii\\db\\QueryBuilder","batchInsert":"yii\\db\\QueryBuilder","bindParam":"yii\\db\\QueryBuilder","build":"yii\\db\\QueryBuilder","buildColumns":"yii\\db\\QueryBuilder","buildCondition":"yii\\db\\QueryBuilder","buildExpression":"yii\\db\\QueryBuilder","buildFrom":"yii\\db\\QueryBuilder","buildGroupBy":"yii\\db\\QueryBuilder","buildHaving":"yii\\db\\QueryBuilder","buildJoin":"yii\\db\\QueryBuilder","buildOrderBy":"yii\\db\\QueryBuilder","buildOrderByAndLimit":"yii\\db\\QueryBuilder","buildSelect":"yii\\db\\QueryBuilder","buildUnion":"yii\\db\\QueryBuilder","buildUnionOrderByAndLimit":"yii\\db\\QueryBuilder","buildWhere":"yii\\db\\QueryBuilder","buildWithQueries":"yii\\db\\QueryBuilder","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","concatUnionSql":"yii\\db\\QueryBuilder","createConditionFromArray":"yii\\db\\QueryBuilder","createTable":"yii\\db\\QueryBuilder","createView":"yii\\db\\QueryBuilder","defaultConditionClasses":"yii\\db\\QueryBuilder","delete":"yii\\db\\QueryBuilder","dropCheck":"yii\\db\\QueryBuilder","dropColumn":"yii\\db\\QueryBuilder","dropDefaultValue":"yii\\db\\QueryBuilder","dropIndex":"yii\\db\\QueryBuilder","dropTable":"yii\\db\\QueryBuilder","dropView":"yii\\db\\QueryBuilder","executeResetSequence":"yii\\db\\QueryBuilder","extractAlias":"yii\\db\\QueryBuilder","getColumnType":"yii\\db\\QueryBuilder","getExpressionBuilder":"yii\\db\\QueryBuilder","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","insert":"yii\\db\\QueryBuilder","prepareInsertSelectSubQuery":"yii\\db\\QueryBuilder","prepareSelectQuery":"yii\\db\\QueryBuilder","prepareUpdateSets":"yii\\db\\QueryBuilder","prepareUpsertColumns":"yii\\db\\QueryBuilder","prepareUpsertSets":"yii\\db\\QueryBuilder","renameColumn":"yii\\db\\QueryBuilder","renameTable":"yii\\db\\QueryBuilder","setConditionClasses":"yii\\db\\QueryBuilder","setExpressionBuilders":"yii\\db\\QueryBuilder","truncateTable":"yii\\db\\QueryBuilder","update":"yii\\db\\QueryBuilder"},"constants":{"PARAM_PREFIX":"yii\\db\\QueryBuilder"}}},"yii\\db\\mysql\\Schema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/mysql/schema/","summary":"Schema is the class for retrieving metadata from a MySQL database (version 8.0 and later).","since":"2.0","extends":"yii\\db\\Schema","implements":["yii\\db\\ConstraintFinderInterface","yii\\base\\Configurable"],"traits":["yii\\db\\ConstraintFinderTrait"],"properties":{"columnQuoteCharacter":{"type":"string|string[]","default":"'`'","visibility":"protected","since":"2.0.14"},"columnSchemaClass":{"type":"class-string|array{class?: class-string, __class?: class-string}","default":"'yii\\db\\mysql\\ColumnSchema'","since":"2.0.11"},"tableQuoteCharacter":{"type":"string|string[]","default":"'`'","visibility":"protected","since":"2.0.14"},"typeMap":{"type":"array","default":"['tinyint' => self::TYPE_TINYINT, 'bool' => self::TYPE_TINYINT, 'boolean' => self::TYPE_TINYINT, 'bit' => self::TYPE_INTEGER, 'smallint' => self::TYPE_SMALLINT, 'mediumint' => self::TYPE_INTEGER, 'int' => self::TYPE_INTEGER, 'integer' => self::TYPE_INTEGER, 'bigint' => self::TYPE_BIGINT, 'float' => self::TYPE_FLOAT, 'double' => self::TYPE_DOUBLE, 'double precision' => self::TYPE_DOUBLE, 'real' => self::TYPE_FLOAT, 'decimal' => self::TYPE_DECIMAL, 'numeric' => self::TYPE_DECIMAL, 'dec' => self::TYPE_DECIMAL, 'fixed' => self::TYPE_DECIMAL, 'tinytext' => self::TYPE_TEXT, 'mediumtext' => self::TYPE_TEXT, 'longtext' => self::TYPE_TEXT, 'longblob' => self::TYPE_BINARY, 'blob' => self::TYPE_BINARY, 'text' => self::TYPE_TEXT, 'varchar' => self::TYPE_STRING, 'string' => self::TYPE_STRING, 'char' => self::TYPE_CHAR, 'datetime' => self::TYPE_DATETIME, 'year' => self::TYPE_DATE, 'date' => self::TYPE_DATE, 'time' => self::TYPE_TIME, 'timestamp' => self::TYPE_TIMESTAMP, 'enum' => self::TYPE_STRING, 'set' => self::TYPE_STRING, 'binary' => self::TYPE_BINARY, 'varbinary' => self::TYPE_BINARY, 'json' => self::TYPE_JSON]","description":"Mapping from physical column types (keys) to abstract column types (values)"}},"methods":{"createColumnSchemaBuilder":{"signature":"public function createColumnSchemaBuilder(mixed $type, mixed $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Create a column schema builder instance giving the type and value precision.","params":[{"name":"$type","type":"mixed","description":"Type of the column. See `yii\\db\\mysql\\ColumnSchemaBuilder::$type`."},{"name":"$length","type":"mixed","default":"null","optional":true,"description":"Length or precision of the column. See `yii\\db\\mysql\\ColumnSchemaBuilder::$length`."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"Column schema builder instance"},"since":"2.0.6"},"createQueryBuilder":{"signature":"public function createQueryBuilder(): yii\\db\\mysql\\QueryBuilder","summary":"Creates a query builder for the MySQL database.","return":{"type":"yii\\db\\mysql\\QueryBuilder","description":"Query builder instance"}},"findColumns":{"signature":"protected function findColumns(yii\\db\\TableSchema $table): bool","summary":"Collects the metadata of table columns.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"bool","description":"Whether the table exists in the database"},"throws":[{"type":"Exception","description":"if DB query fails"}],"visibility":"protected"},"findConstraints":{"signature":"protected function findConstraints(yii\\db\\TableSchema $table): mixed","summary":"Collects the foreign key column details for the given table.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"mixed"},"throws":[{"type":"Exception"}],"visibility":"protected"},"findTableNames":{"signature":"protected function findTableNames(mixed $schema = ''): array","summary":"Returns all table names in the database.","params":[{"name":"$schema","type":"mixed","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema."}],"return":{"type":"array","description":"All table names in the database. The names have NO schema name prefix."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected"},"findUniqueIndexes":{"signature":"public function findUniqueIndexes(yii\\db\\TableSchema $table): array","summary":"Returns all unique indexes for the given table.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"array","description":"All unique indexes for the given table."}},"getCreateTableSql":{"signature":"protected function getCreateTableSql(yii\\db\\TableSchema $table): string","summary":"Gets the CREATE TABLE sql string.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"string","description":"$sql the result of 'SHOW CREATE TABLE'"},"visibility":"protected"},"loadColumnSchema":{"signature":"protected function loadColumnSchema(array $info): yii\\db\\mysql\\T","summary":"Loads the column information into a `yii\\db\\mysql\\ColumnSchema` object.","params":[{"name":"$info","type":"array","description":"Column information"}],"return":{"type":"yii\\db\\mysql\\T","description":"The column schema object"},"visibility":"protected"},"loadTableChecks":{"signature":"protected function loadTableChecks(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableDefaultValues":{"signature":"protected function loadTableDefaultValues(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is called."}],"visibility":"protected"},"loadTableForeignKeys":{"signature":"protected function loadTableForeignKeys(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableIndexes":{"signature":"protected function loadTableIndexes(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTablePrimaryKey":{"signature":"protected function loadTablePrimaryKey(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableSchema":{"signature":"protected function loadTableSchema(mixed $name): yii\\db\\TableSchema|null","summary":"Loads the metadata for the specified table.","params":[{"name":"$name","type":"mixed","description":"Table name"}],"return":{"type":"yii\\db\\TableSchema|null","description":"DBMS-dependent table metadata, `null` if the table does not exist."},"visibility":"protected"},"loadTableUniques":{"signature":"protected function loadTableUniques(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"resolveTableName":{"signature":"protected function resolveTableName(mixed $name): yii\\db\\TableSchema","summary":"Resolves the table name and schema name (if any).","params":[{"name":"$name","type":"mixed","description":"The table name"}],"return":{"type":"yii\\db\\TableSchema","description":"`yii\\db\\TableSchema` with resolved table, schema, etc. names."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected","since":"2.0.13"}},"inherited":{"properties":{"db":"yii\\db\\Schema","defaultSchema":"yii\\db\\Schema","exceptionMap":"yii\\db\\Schema","lastInsertID":"yii\\db\\Schema","queryBuilder":"yii\\db\\Schema","schemaChecks":"yii\\db\\ConstraintFinderTrait","schemaDefaultValues":"yii\\db\\ConstraintFinderTrait","schemaForeignKeys":"yii\\db\\ConstraintFinderTrait","schemaIndexes":"yii\\db\\ConstraintFinderTrait","schemaNames":"yii\\db\\Schema","schemaPrimaryKeys":"yii\\db\\ConstraintFinderTrait","schemaUniques":"yii\\db\\ConstraintFinderTrait","serverVersion":"yii\\db\\Schema","systemSchemaNames":"yii\\db\\Schema","tableNames":"yii\\db\\Schema","tableSchemas":"yii\\db\\Schema","transactionIsolationLevel":"yii\\db\\Schema"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","convertException":"yii\\db\\Schema","createColumnSchema":"yii\\db\\Schema","createSavepoint":"yii\\db\\Schema","findSchemaNames":"yii\\db\\Schema","getCacheKey":"yii\\db\\Schema","getCacheTag":"yii\\db\\Schema","getColumnPhpType":"yii\\db\\Schema","getLastInsertID":"yii\\db\\Schema","getPdoType":"yii\\db\\Schema","getQueryBuilder":"yii\\db\\Schema","getRawTableName":"yii\\db\\Schema","getSchemaChecks":"yii\\db\\ConstraintFinderTrait","getSchemaDefaultValues":"yii\\db\\ConstraintFinderTrait","getSchemaForeignKeys":"yii\\db\\ConstraintFinderTrait","getSchemaIndexes":"yii\\db\\ConstraintFinderTrait","getSchemaMetadata":"yii\\db\\Schema","getSchemaNames":"yii\\db\\Schema","getSchemaPrimaryKeys":"yii\\db\\ConstraintFinderTrait","getSchemaUniques":"yii\\db\\ConstraintFinderTrait","getServerVersion":"yii\\db\\Schema","getTableChecks":"yii\\db\\ConstraintFinderTrait","getTableDefaultValues":"yii\\db\\ConstraintFinderTrait","getTableForeignKeys":"yii\\db\\ConstraintFinderTrait","getTableIndexes":"yii\\db\\ConstraintFinderTrait","getTableMetadata":"yii\\db\\Schema","getTableNameParts":"yii\\db\\Schema","getTableNames":"yii\\db\\Schema","getTablePrimaryKey":"yii\\db\\ConstraintFinderTrait","getTableSchema":"yii\\db\\Schema","getTableSchemas":"yii\\db\\Schema","getTableUniques":"yii\\db\\ConstraintFinderTrait","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","insert":"yii\\db\\Schema","isReadQuery":"yii\\db\\Schema","normalizePdoRowKeyCase":"yii\\db\\Schema","quoteColumnName":"yii\\db\\Schema","quoteSimpleColumnName":"yii\\db\\Schema","quoteSimpleTableName":"yii\\db\\Schema","quoteTableName":"yii\\db\\Schema","quoteValue":"yii\\db\\Schema","refresh":"yii\\db\\Schema","refreshTableSchema":"yii\\db\\Schema","releaseSavepoint":"yii\\db\\Schema","resolveRawTableName":"yii\\db\\Schema","rollBackSavepoint":"yii\\db\\Schema","setTableMetadata":"yii\\db\\Schema","setTransactionIsolationLevel":"yii\\db\\Schema","supportsSavepoint":"yii\\db\\Schema","unquoteSimpleColumnName":"yii\\db\\Schema","unquoteSimpleTableName":"yii\\db\\Schema"},"constants":{"TYPE_PK":"yii\\db\\Schema","TYPE_UPK":"yii\\db\\Schema","TYPE_BIGPK":"yii\\db\\Schema","TYPE_UBIGPK":"yii\\db\\Schema","TYPE_CHAR":"yii\\db\\Schema","TYPE_STRING":"yii\\db\\Schema","TYPE_TEXT":"yii\\db\\Schema","TYPE_TINYINT":"yii\\db\\Schema","TYPE_SMALLINT":"yii\\db\\Schema","TYPE_INTEGER":"yii\\db\\Schema","TYPE_BIGINT":"yii\\db\\Schema","TYPE_FLOAT":"yii\\db\\Schema","TYPE_DOUBLE":"yii\\db\\Schema","TYPE_DECIMAL":"yii\\db\\Schema","TYPE_DATETIME":"yii\\db\\Schema","TYPE_TIMESTAMP":"yii\\db\\Schema","TYPE_TIME":"yii\\db\\Schema","TYPE_DATE":"yii\\db\\Schema","TYPE_BINARY":"yii\\db\\Schema","TYPE_BOOLEAN":"yii\\db\\Schema","TYPE_MONEY":"yii\\db\\Schema","TYPE_JSON":"yii\\db\\Schema","SCHEMA_CACHE_VERSION":"yii\\db\\Schema"}}},"yii\\db\\oci\\ColumnSchema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/oci/columnschema/","summary":"Represents the metadata of a column in an Oracle database table.","since":"22.0","extends":"yii\\db\\ColumnSchema","implements":["yii\\base\\Configurable"],"methods":{"dbTypecast":{"signature":"public function dbTypecast(mixed $value): mixed","summary":"Converts the input value according to `$type` and `$dbType` for use in a db query.","params":[{"name":"$value","type":"mixed","description":"Input value"}],"return":{"type":"mixed","description":"Converted value. This may also be an array containing the value as the first element and the PDO type as the second element."}},"defaultPhpTypecast":{"signature":"public function defaultPhpTypecast(mixed $value): mixed","summary":"Converts an Oracle column default value to its PHP representation.","params":[{"name":"$value","type":"mixed","description":"Default value in Oracle `DATA_DEFAULT` format."}],"return":{"type":"mixed","description":"Converted value."},"since":"22.0"}},"inherited":{"properties":{"allowNull":"yii\\db\\ColumnSchema","autoIncrement":"yii\\db\\ColumnSchema","comment":"yii\\db\\ColumnSchema","dbType":"yii\\db\\ColumnSchema","defaultValue":"yii\\db\\ColumnSchema","enumValues":"yii\\db\\ColumnSchema","isPrimaryKey":"yii\\db\\ColumnSchema","name":"yii\\db\\ColumnSchema","phpType":"yii\\db\\ColumnSchema","precision":"yii\\db\\ColumnSchema","scale":"yii\\db\\ColumnSchema","size":"yii\\db\\ColumnSchema","type":"yii\\db\\ColumnSchema","unsigned":"yii\\db\\ColumnSchema"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isType":"yii\\db\\ColumnSchema","phpTypecast":"yii\\db\\ColumnSchema","typecast":"yii\\db\\ColumnSchema"}}},"yii\\db\\oci\\ColumnSchemaBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/oci/columnschemabuilder/","summary":"ColumnSchemaBuilder is the schema builder for Oracle databases.","since":"2.0.6","extends":"yii\\db\\ColumnSchemaBuilder","implements":["Stringable","yii\\base\\Configurable"],"methods":{"__toString":{"signature":"public function __toString(): string","summary":"Builds the full string for the column's schema.","return":{"type":"string"}},"buildUnsignedString":{"signature":"protected function buildUnsignedString(): string","summary":"Builds the unsigned string for column. Defaults to unsupported.","return":{"type":"string","description":"A string containing UNSIGNED keyword."},"visibility":"protected","since":"2.0.7"}},"inherited":{"properties":{"after":"yii\\db\\ColumnSchemaBuilder","append":"yii\\db\\ColumnSchemaBuilder","categoryMap":"yii\\db\\ColumnSchemaBuilder","check":"yii\\db\\ColumnSchemaBuilder","comment":"yii\\db\\ColumnSchemaBuilder","db":"yii\\db\\ColumnSchemaBuilder","default":"yii\\db\\ColumnSchemaBuilder","isFirst":"yii\\db\\ColumnSchemaBuilder","isNotNull":"yii\\db\\ColumnSchemaBuilder","isUnique":"yii\\db\\ColumnSchemaBuilder","isUnsigned":"yii\\db\\ColumnSchemaBuilder","length":"yii\\db\\ColumnSchemaBuilder","type":"yii\\db\\ColumnSchemaBuilder","typeCategoryMap":"yii\\db\\ColumnSchemaBuilder","typeDefinition":"yii\\db\\ColumnSchemaBuilder"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\db\\ColumnSchemaBuilder","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","after":"yii\\db\\ColumnSchemaBuilder","append":"yii\\db\\ColumnSchemaBuilder","buildAfterString":"yii\\db\\ColumnSchemaBuilder","buildAppendString":"yii\\db\\ColumnSchemaBuilder","buildCheckString":"yii\\db\\ColumnSchemaBuilder","buildCommentString":"yii\\db\\ColumnSchemaBuilder","buildCompleteString":"yii\\db\\ColumnSchemaBuilder","buildDefaultString":"yii\\db\\ColumnSchemaBuilder","buildDefaultValue":"yii\\db\\ColumnSchemaBuilder","buildFirstString":"yii\\db\\ColumnSchemaBuilder","buildLengthString":"yii\\db\\ColumnSchemaBuilder","buildNotNullString":"yii\\db\\ColumnSchemaBuilder","buildUniqueString":"yii\\db\\ColumnSchemaBuilder","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","check":"yii\\db\\ColumnSchemaBuilder","className":"yii\\base\\BaseObject","comment":"yii\\db\\ColumnSchemaBuilder","defaultExpression":"yii\\db\\ColumnSchemaBuilder","defaultValue":"yii\\db\\ColumnSchemaBuilder","first":"yii\\db\\ColumnSchemaBuilder","getAppend":"yii\\db\\ColumnSchemaBuilder","getCategoryMap":"yii\\db\\ColumnSchemaBuilder","getCheck":"yii\\db\\ColumnSchemaBuilder","getDefault":"yii\\db\\ColumnSchemaBuilder","getTypeCategory":"yii\\db\\ColumnSchemaBuilder","getTypeDefinition":"yii\\db\\ColumnSchemaBuilder","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isNotNull":"yii\\db\\ColumnSchemaBuilder","isUnique":"yii\\db\\ColumnSchemaBuilder","notNull":"yii\\db\\ColumnSchemaBuilder","null":"yii\\db\\ColumnSchemaBuilder","setCategoryMap":"yii\\db\\ColumnSchemaBuilder","unique":"yii\\db\\ColumnSchemaBuilder","unsigned":"yii\\db\\ColumnSchemaBuilder"},"constants":{"CATEGORY_PK":"yii\\db\\ColumnSchemaBuilder","CATEGORY_STRING":"yii\\db\\ColumnSchemaBuilder","CATEGORY_NUMERIC":"yii\\db\\ColumnSchemaBuilder","CATEGORY_TIME":"yii\\db\\ColumnSchemaBuilder","CATEGORY_OTHER":"yii\\db\\ColumnSchemaBuilder"}}},"yii\\db\\oci\\Command":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/oci/command/","summary":"Command represents an Oracle SQL statement to be executed against a database.","since":"2.0.33","extends":"yii\\db\\Command","implements":["yii\\base\\Configurable"],"methods":{"bindPendingParams":{"signature":"protected function bindPendingParams(): mixed","summary":"Binds pending parameters that were registered via `bindValue()` and `bindValues()`.","return":{"type":"mixed"},"visibility":"protected"},"cancel":{"signature":"public function cancel(): mixed","summary":"Cancels the execution of the SQL statement.","return":{"type":"mixed"}},"execute":{"signature":"public function execute(): int","summary":"Executes the SQL statement.","return":{"type":"int","description":"Number of rows affected by the execution."},"throws":[{"type":"yii\\db\\Exception","description":"execution failed"}]},"reset":{"signature":"protected function reset(): mixed","summary":"Resets command properties to their initial state.","return":{"type":"mixed"},"visibility":"protected","since":"2.0.13"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","db":"yii\\db\\Command","fetchMode":"yii\\db\\Command","params":"yii\\db\\Command","pdoStatement":"yii\\db\\Command","pendingParams":"yii\\db\\Command","queryCacheDependency":"yii\\db\\Command","queryCacheDuration":"yii\\db\\Command","rawSql":"yii\\db\\Command","sql":"yii\\db\\Command"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","addCheck":"yii\\db\\Command","addColumn":"yii\\db\\Command","addCommentOnColumn":"yii\\db\\Command","addCommentOnTable":"yii\\db\\Command","addDefaultValue":"yii\\db\\Command","addForeignKey":"yii\\db\\Command","addPrimaryKey":"yii\\db\\Command","addUnique":"yii\\db\\Command","alterColumn":"yii\\db\\Command","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","batchInsert":"yii\\db\\Command","behaviors":"yii\\base\\Component","bindParam":"yii\\db\\Command","bindValue":"yii\\db\\Command","bindValues":"yii\\db\\Command","cache":"yii\\db\\Command","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","checkIntegrity":"yii\\db\\Command","className":"yii\\base\\BaseObject","createIndex":"yii\\db\\Command","createTable":"yii\\db\\Command","createView":"yii\\db\\Command","delete":"yii\\db\\Command","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","dropCheck":"yii\\db\\Command","dropColumn":"yii\\db\\Command","dropCommentFromColumn":"yii\\db\\Command","dropCommentFromTable":"yii\\db\\Command","dropDefaultValue":"yii\\db\\Command","dropForeignKey":"yii\\db\\Command","dropIndex":"yii\\db\\Command","dropPrimaryKey":"yii\\db\\Command","dropTable":"yii\\db\\Command","dropUnique":"yii\\db\\Command","dropView":"yii\\db\\Command","ensureBehaviors":"yii\\base\\Component","executeResetSequence":"yii\\db\\Command","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getCacheKey":"yii\\db\\Command","getRawSql":"yii\\db\\Command","getSql":"yii\\db\\Command","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","insert":"yii\\db\\Command","internalExecute":"yii\\db\\Command","logQuery":"yii\\db\\Command","noCache":"yii\\db\\Command","off":"yii\\base\\Component","on":"yii\\base\\Component","prepare":"yii\\db\\Command","query":"yii\\db\\Command","queryAll":"yii\\db\\Command","queryColumn":"yii\\db\\Command","queryInternal":"yii\\db\\Command","queryOne":"yii\\db\\Command","queryScalar":"yii\\db\\Command","refreshTableSchema":"yii\\db\\Command","renameColumn":"yii\\db\\Command","renameTable":"yii\\db\\Command","requireTableSchemaRefresh":"yii\\db\\Command","requireTransaction":"yii\\db\\Command","resetSequence":"yii\\db\\Command","setRawSql":"yii\\db\\Command","setRetryHandler":"yii\\db\\Command","setSql":"yii\\db\\Command","trigger":"yii\\base\\Component","truncateTable":"yii\\db\\Command","update":"yii\\db\\Command","upsert":"yii\\db\\Command"}}},"yii\\db\\oci\\LobValue":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/api/yii/db/oci/lobvalue/","summary":"Represents an Oracle `BLOB` value bound through a PDO LOB locator.","since":"22.0","implements":["yii\\db\\ExpressionInterface"],"methods":{"__construct":{"signature":"public function __construct(string $columnName, string|resource $value)","params":[{"name":"$columnName","type":"string"},{"name":"$value","type":"string|resource","description":"Binary payload."}]},"getColumnName":{"signature":"public function getColumnName(): string","summary":"Returns the unquoted target column name.","return":{"type":"string"}},"getValue":{"signature":"public function getValue(): string|resource","return":{"type":"string|resource","description":"Binary payload."}}}},"yii\\db\\oci\\LobValueBuilder":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/api/yii/db/oci/lobvaluebuilder/","summary":"Builds the SQL value expression for an `yii\\db\\oci\\LobValue`.","since":"22.0","implements":["yii\\db\\ExpressionBuilderInterface"],"methods":{"bind":{"signature":"public static function bind(yii\\db\\oci\\LobValue $expression, array &$params): array{0: string, 1: string}","summary":"Registers the payload under a fresh locator placeholder.","params":[{"name":"$expression","type":"yii\\db\\oci\\LobValue","description":"LOB value to register."},{"name":"$params","type":"array","byReference":true,"description":"The parameters to be bound to the SQL statement. This parameter is passed by reference and will be modified by this method."}],"return":{"type":"array{0: string, 1: string}","description":"SQL value expression and locator placeholder."},"static":true},"build":{"signature":"public function build(yii\\db\\oci\\LobValue $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\oci\\LobValue","description":"LOB value to build."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}}},"constants":{"PARAM_PREFIX":{"value":"':lob'"}}},"yii\\db\\oci\\QueryBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/oci/querybuilder/","summary":"QueryBuilder is the query builder for Oracle databases (version 12.1 and above).","since":"2.0","extends":"yii\\db\\QueryBuilder","implements":["yii\\base\\Configurable"],"properties":{"typeMap":{"type":"array","default":"[\\yii\\db\\oci\\Schema::TYPE_PK => 'NUMBER(10) GENERATED BY DEFAULT ON NULL AS IDENTITY NOT NULL PRIMARY KEY', \\yii\\db\\oci\\Schema::TYPE_UPK => 'NUMBER(10) GENERATED BY DEFAULT ON NULL AS IDENTITY NOT NULL PRIMARY KEY', \\yii\\db\\oci\\Schema::TYPE_BIGPK => 'NUMBER(20) GENERATED BY DEFAULT ON NULL AS IDENTITY NOT NULL PRIMARY KEY', \\yii\\db\\oci\\Schema::TYPE_UBIGPK => 'NUMBER(20) GENERATED BY DEFAULT ON NULL AS IDENTITY NOT NULL PRIMARY KEY', \\yii\\db\\oci\\Schema::TYPE_CHAR => 'CHAR(1)', \\yii\\db\\oci\\Schema::TYPE_STRING => 'VARCHAR2(255)', \\yii\\db\\oci\\Schema::TYPE_TEXT => 'CLOB', \\yii\\db\\oci\\Schema::TYPE_TINYINT => 'NUMBER(3)', \\yii\\db\\oci\\Schema::TYPE_SMALLINT => 'NUMBER(5)', \\yii\\db\\oci\\Schema::TYPE_INTEGER => 'NUMBER(10)', \\yii\\db\\oci\\Schema::TYPE_BIGINT => 'NUMBER(20)', \\yii\\db\\oci\\Schema::TYPE_FLOAT => 'NUMBER', \\yii\\db\\oci\\Schema::TYPE_DOUBLE => 'NUMBER', \\yii\\db\\oci\\Schema::TYPE_DECIMAL => 'NUMBER', \\yii\\db\\oci\\Schema::TYPE_DATETIME => 'TIMESTAMP', \\yii\\db\\oci\\Schema::TYPE_TIMESTAMP => 'TIMESTAMP', \\yii\\db\\oci\\Schema::TYPE_TIME => 'TIMESTAMP', \\yii\\db\\oci\\Schema::TYPE_DATE => 'DATE', \\yii\\db\\oci\\Schema::TYPE_BINARY => 'BLOB', \\yii\\db\\oci\\Schema::TYPE_BOOLEAN => 'NUMBER(1)', \\yii\\db\\oci\\Schema::TYPE_MONEY => 'NUMBER(19,4)']","description":"Mapping from abstract column types (keys) to physical column types (values)."}},"methods":{"addForeignKey":{"signature":"public function addForeignKey(mixed $name, mixed $table, mixed $columns, mixed $refTable, mixed $refColumns, mixed $delete = null, mixed $update = null): string","summary":"Builds a SQL statement for adding a foreign key constraint to an existing table.","params":[{"name":"$name","type":"mixed","description":"The name of the foreign key constraint."},{"name":"$table","type":"mixed","description":"The table that the foreign key constraint will be added to."},{"name":"$columns","type":"mixed","description":"The name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array to represent them."},{"name":"$refTable","type":"mixed","description":"The table that the foreign key references to."},{"name":"$refColumns","type":"mixed","description":"The name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array to represent them."},{"name":"$delete","type":"mixed","default":"null","optional":true,"description":"The ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL"},{"name":"$update","type":"mixed","default":"null","optional":true,"description":"The ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL"}],"return":{"type":"string","description":"The SQL statement for adding a foreign key constraint to an existing table."}},"alterColumn":{"signature":"public function alterColumn(string $table, string $column, string $type): string","summary":"Builds a SQL statement for changing the definition of a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be changed. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be changed. The name will be properly quoted by the method."},{"name":"$type","type":"string","description":"The new column type. The `getColumnType()` method will be invoked to convert abstract column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'."}],"return":{"type":"string","description":"The SQL statement for changing the definition of a column."}},"batchInsert":{"signature":"public function batchInsert(string $table, array $columns, array|Generator $rows, array &$params = []): string","summary":"Generates a batch INSERT SQL statement.","params":[{"name":"$table","type":"string","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"array","description":"The column names."},{"name":"$rows","type":"array|Generator","description":"The rows to be batch inserted into the table."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The parameters to be bound to the batch INSERT SQL statement. This parameter is passed by reference and will be modified by this method."}],"return":{"type":"string","description":"The batch INSERT SQL statement."}},"buildOrderByAndLimit":{"signature":"public function buildOrderByAndLimit(mixed $sql, mixed $orderBy, mixed $limit, mixed $offset): string","summary":"Builds the ORDER BY and LIMIT/OFFSET clauses and appends them to the given SQL.","params":[{"name":"$sql","type":"mixed","description":"The existing SQL (without ORDER BY/LIMIT/OFFSET)"},{"name":"$orderBy","type":"mixed","description":"The order by columns. See `yii\\db\\Query::orderBy()` for more details on how to specify this parameter."},{"name":"$limit","type":"mixed","description":"The limit number. See `yii\\db\\Query::limit()` for more details."},{"name":"$offset","type":"mixed","description":"The offset number. See `yii\\db\\Query::offset()` for more details."}],"return":{"type":"string","description":"The SQL completed with ORDER BY/LIMIT/OFFSET (if any)"}},"buildWithQueries":{"signature":"public function buildWithQueries(mixed $withs, mixed &$params): string","params":[{"name":"$withs","type":"mixed","description":"Of configurations for each WITH query"},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters to be populated"}],"return":{"type":"string","description":"Compiled WITH prefix of query including nested queries"},"since":"2.0.35"},"defaultExpressionBuilders":{"signature":"protected function defaultExpressionBuilders(): array","summary":"Contains array of default expression builders. Extend this method and override it, if you want to change default expression builders for this query builder. See `$expressionBuilders` docs for details.","return":{"type":"array"},"visibility":"protected","since":"2.0.14"},"dropCommentFromColumn":{"signature":"public function dropCommentFromColumn(mixed $table, mixed $column): string","summary":"Builds a SQL command for adding comment to column.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"mixed","description":"The name of the column to be commented. The column name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"since":"2.0.8"},"dropCommentFromTable":{"signature":"public function dropCommentFromTable(mixed $table): string","summary":"Builds a SQL command for adding comment to table.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"since":"2.0.8"},"dropIndex":{"signature":"public function dropIndex(string $name, string $table): string","summary":"Builds a SQL statement for dropping an index.","params":[{"name":"$name","type":"string","description":"The name of the index to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose index is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping an index."}},"executeResetSequence":{"signature":"public function executeResetSequence(mixed $table, mixed $value = null): mixed","summary":"Execute a SQL statement for resetting the sequence value of a table's primary key.","params":[{"name":"$table","type":"mixed","description":"The name of the table whose primary key sequence is reset."},{"name":"$value","type":"mixed","default":"null","optional":true,"description":"The integer value for the primary key of the next new row inserted. If this is not set, the next new row's primary key will have the maximum existing value `+1`."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS"}],"since":"2.0.16"},"insert":{"signature":"public function insert(mixed $table, mixed $columns, mixed &$params): string","summary":"Creates an INSERT SQL statement.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"mixed","description":"The column data (name => value) to be inserted into the table or instance of Query (`yii\\db\\Query`) to perform INSERT INTO ... SELECT SQL statement. Passing of Query (`yii\\db\\Query`) is available since version 2.0.11."},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"string","description":"The INSERT SQL"}},"mergeReturning":{"signature":"public function mergeReturning(string $sql, array $params, array $placeholders): string","summary":"Appends a `RETURNING` clause for the given OUT placeholders, merging any locator clause already present.","params":[{"name":"$sql","type":"string","description":"DML statement built by this query builder."},{"name":"$params","type":"array","description":"The parameters bound to the SQL statement."},{"name":"$placeholders","type":"array","description":"OUT placeholders indexed by unquoted column name."}],"return":{"type":"string","description":"The SQL statement with the merged `RETURNING` clause."}},"prepareInsertValues":{"signature":"protected function prepareInsertValues(mixed $table, mixed $columns, mixed $params = []): array","summary":"Prepares a `VALUES` part for an `INSERT` SQL statement.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"mixed","description":"The column data (name => value) to be inserted into the table or instance of Query (`yii\\db\\Query`) to perform INSERT INTO ... SELECT SQL statement."},{"name":"$params","type":"mixed","default":"[]","optional":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"array","description":"Array of column names, placeholders, values and params."},"visibility":"protected","since":"2.0.14"},"renameTable":{"signature":"public function renameTable(string $table, string $newName): string","summary":"Builds a SQL statement for renaming a DB table.","params":[{"name":"$table","type":"string","description":"The table to be renamed. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new table name. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for renaming a DB table."}},"selectExists":{"signature":"public function selectExists(mixed $rawSql): string","summary":"Creates a SELECT EXISTS() SQL statement.","params":[{"name":"$rawSql","type":"mixed","description":"The subquery in a raw form to select from."}],"return":{"type":"string","description":"The SELECT EXISTS() SQL statement."},"since":"2.0.8"},"update":{"signature":"public function update(mixed $table, mixed $columns, mixed $condition, mixed &$params): string","summary":"Creates an UPDATE SQL statement.","params":[{"name":"$table","type":"mixed","description":"The table to be updated."},{"name":"$columns","type":"mixed","description":"The column data (name => value) to be updated."},{"name":"$condition","type":"mixed","description":"The condition that will be put in the WHERE part. Please refer to `yii\\db\\Query::where()` on how to specify condition."},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters that will be modified by this method so that they can be bound to the DB command later."}],"return":{"type":"string","description":"The UPDATE SQL"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if the condition does not cover a unique key using non-null scalar values."}]},"upsert":{"signature":"public function upsert(mixed $table, mixed $insertColumns, mixed $updateColumns, mixed &$params): string","summary":"Creates an SQL statement to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into/updated in."},{"name":"$insertColumns","type":"mixed","description":"The column data (name => value) to be inserted into the table or instance of `yii\\db\\Query` to perform `INSERT INTO ... SELECT` SQL statement."},{"name":"$updateColumns","type":"mixed","description":"The column data (name => value) to be updated if they already exist. If `true` is passed, the column data will be updated to match the insert column data. If `false` is passed, no update will be performed if the column data already exists."},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"string","description":"The resulting SQL."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}],"since":"2.0.14"}},"constants":{"UPSERT_AFFECTED_PARAM_PREFIX":{"value":"':yii_upsert_affected'","description":"Parameter name prefix for the affected-row OUT bind registered by a `BLOB` upsert."}},"inherited":{"properties":{"conditionClasses":"yii\\db\\QueryBuilder","db":"yii\\db\\QueryBuilder","expressionBuilders":"yii\\db\\QueryBuilder","separator":"yii\\db\\QueryBuilder"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\db\\QueryBuilder","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","addCheck":"yii\\db\\QueryBuilder","addColumn":"yii\\db\\QueryBuilder","addCommentOnColumn":"yii\\db\\QueryBuilder","addCommentOnTable":"yii\\db\\QueryBuilder","addDefaultValue":"yii\\db\\QueryBuilder","addPrimaryKey":"yii\\db\\QueryBuilder","addUnique":"yii\\db\\QueryBuilder","bindParam":"yii\\db\\QueryBuilder","build":"yii\\db\\QueryBuilder","buildColumns":"yii\\db\\QueryBuilder","buildCondition":"yii\\db\\QueryBuilder","buildExpression":"yii\\db\\QueryBuilder","buildFrom":"yii\\db\\QueryBuilder","buildGroupBy":"yii\\db\\QueryBuilder","buildHaving":"yii\\db\\QueryBuilder","buildJoin":"yii\\db\\QueryBuilder","buildLimit":"yii\\db\\QueryBuilder","buildOrderBy":"yii\\db\\QueryBuilder","buildSelect":"yii\\db\\QueryBuilder","buildUnion":"yii\\db\\QueryBuilder","buildUnionOrderByAndLimit":"yii\\db\\QueryBuilder","buildWhere":"yii\\db\\QueryBuilder","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","checkIntegrity":"yii\\db\\QueryBuilder","className":"yii\\base\\BaseObject","concatUnionSql":"yii\\db\\QueryBuilder","createConditionFromArray":"yii\\db\\QueryBuilder","createIndex":"yii\\db\\QueryBuilder","createTable":"yii\\db\\QueryBuilder","createView":"yii\\db\\QueryBuilder","defaultConditionClasses":"yii\\db\\QueryBuilder","delete":"yii\\db\\QueryBuilder","dropCheck":"yii\\db\\QueryBuilder","dropColumn":"yii\\db\\QueryBuilder","dropDefaultValue":"yii\\db\\QueryBuilder","dropForeignKey":"yii\\db\\QueryBuilder","dropPrimaryKey":"yii\\db\\QueryBuilder","dropTable":"yii\\db\\QueryBuilder","dropUnique":"yii\\db\\QueryBuilder","dropView":"yii\\db\\QueryBuilder","extractAlias":"yii\\db\\QueryBuilder","getColumnType":"yii\\db\\QueryBuilder","getExpressionBuilder":"yii\\db\\QueryBuilder","hasLimit":"yii\\db\\QueryBuilder","hasMethod":"yii\\base\\BaseObject","hasOffset":"yii\\db\\QueryBuilder","hasProperty":"yii\\base\\BaseObject","init":"yii\\db\\QueryBuilder","prepareInsertSelectSubQuery":"yii\\db\\QueryBuilder","prepareSelectQuery":"yii\\db\\QueryBuilder","prepareUpdateSets":"yii\\db\\QueryBuilder","prepareUpsertColumns":"yii\\db\\QueryBuilder","prepareUpsertSets":"yii\\db\\QueryBuilder","renameColumn":"yii\\db\\QueryBuilder","resetSequence":"yii\\db\\QueryBuilder","setConditionClasses":"yii\\db\\QueryBuilder","setExpressionBuilders":"yii\\db\\QueryBuilder","truncateTable":"yii\\db\\QueryBuilder"},"constants":{"PARAM_PREFIX":"yii\\db\\QueryBuilder"}}},"yii\\db\\oci\\Schema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/oci/schema/","summary":"Schema is the class for retrieving metadata from an Oracle database.","since":"2.0","extends":"yii\\db\\Schema","implements":["yii\\db\\ConstraintFinderInterface","yii\\base\\Configurable"],"traits":["yii\\db\\ConstraintFinderTrait"],"properties":{"columnSchemaClass":{"type":"class-string|array{class?: class-string, __class?: class-string}","default":"\\yii\\db\\oci\\ColumnSchema::class","since":"2.0.11"},"exceptionMap":{"type":"array","default":"['ORA-00001: unique constraint' => \\yii\\db\\IntegrityException::class]","description":"Map of DB errors and corresponding exceptions If left part is found in DB error message exception class from the right part is used."},"lastInsertID":{"type":"string","description":"The row ID of the last row inserted, or the last value retrieved from the sequence object.","access":"read-only","virtual":true},"tableQuoteCharacter":{"type":"string|string[]","default":"'\"'","visibility":"protected","since":"2.0.14"}},"methods":{"createColumn":{"signature":"protected function createColumn(array $column): yii\\db\\oci\\T","summary":"Creates ColumnSchema instance.","params":[{"name":"$column","type":"array"}],"return":{"type":"yii\\db\\oci\\T"},"visibility":"protected"},"createColumnSchemaBuilder":{"signature":"public function createColumnSchemaBuilder(mixed $type, mixed $length = null): yii\\db\\ColumnSchemaBuilder","summary":"Create a column schema builder instance giving the type and value precision.","params":[{"name":"$type","type":"mixed","description":"Type of the column. See `yii\\db\\oci\\ColumnSchemaBuilder::$type`."},{"name":"$length","type":"mixed","default":"null","optional":true,"description":"Length or precision of the column. See `yii\\db\\oci\\ColumnSchemaBuilder::$length`."}],"return":{"type":"yii\\db\\ColumnSchemaBuilder","description":"Column schema builder instance"},"since":"2.0.6"},"createQueryBuilder":{"signature":"public function createQueryBuilder(): yii\\db\\TQueryBuilder","summary":"Creates a query builder for the database.","return":{"type":"yii\\db\\TQueryBuilder","description":"Query builder instance"}},"extractColumnSize":{"signature":"protected function extractColumnSize(yii\\db\\oci\\ColumnSchema $column, string $dbType, string $precision, string $scale, string $length): mixed","summary":"Extracts size, precision and scale information from column's DB type.","params":[{"name":"$column","type":"yii\\db\\oci\\ColumnSchema"},{"name":"$dbType","type":"string","description":"The column's DB type"},{"name":"$precision","type":"string","description":"Total number of digits. This parameter is available since version 2.0.4."},{"name":"$scale","type":"string","description":"Number of digits on the right of the decimal separator. This parameter is available since version 2.0.4."},{"name":"$length","type":"string","description":"Length for character types. This parameter is available since version 2.0.4."}],"return":{"type":"mixed"},"visibility":"protected"},"extractColumnType":{"signature":"protected function extractColumnType(yii\\db\\oci\\ColumnSchema $column, string $dbType, string $precision, string $scale, string $length): mixed","summary":"Extracts the data types for the given column.","params":[{"name":"$column","type":"yii\\db\\oci\\ColumnSchema"},{"name":"$dbType","type":"string","description":"DB type"},{"name":"$precision","type":"string","description":"Total number of digits. This parameter is available since version 2.0.4."},{"name":"$scale","type":"string","description":"Number of digits on the right of the decimal separator. This parameter is available since version 2.0.4."},{"name":"$length","type":"string","description":"Length for character types. This parameter is available since version 2.0.4."}],"return":{"type":"mixed"},"visibility":"protected"},"findColumns":{"signature":"protected function findColumns(yii\\db\\TableSchema $table): bool","summary":"Collects the table column metadata.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table schema."}],"return":{"type":"bool","description":"Whether the table exists."},"visibility":"protected"},"findConstraints":{"signature":"protected function findConstraints(yii\\db\\TableSchema $table): mixed","summary":"Finds constraints and fills them into TableSchema object passed.","params":[{"name":"$table","type":"yii\\db\\TableSchema"}],"return":{"type":"mixed"},"visibility":"protected"},"findSchemaNames":{"signature":"protected function findSchemaNames(): array","summary":"Returns all schema names in the database, including the default one but not system schemas.","return":{"type":"array","description":"All schema names in the database, except system schemas."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected","since":"2.0.4"},"findTableNames":{"signature":"protected function findTableNames(mixed $schema = ''): array","summary":"Returns all table names in the database.","params":[{"name":"$schema","type":"mixed","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema."}],"return":{"type":"array","description":"All table names in the database. The names have NO schema name prefix."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected"},"findUniqueIndexes":{"signature":"public function findUniqueIndexes(yii\\db\\TableSchema $table): array","summary":"Returns all unique indexes for the given table.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata."}],"return":{"type":"array","description":"All unique indexes for the given table."},"since":"2.0.4"},"getLastInsertID":{"signature":"public function getLastInsertID(string $sequenceName = ''): string","params":[{"name":"$sequenceName","type":"string","default":"''","optional":true,"description":"Name of the sequence object (required by some DBMS)"}],"return":{"type":"string","description":"The row ID of the last row inserted, or the last value retrieved from the sequence object"},"throws":[{"type":"yii\\base\\InvalidCallException","description":"if the DB connection is not active"}]},"getTableSequenceName":{"signature":"protected function getTableSequenceName(string $tableName): string|null","summary":"Sequence name of table.","params":[{"name":"$tableName","type":"string","description":"Table name."}],"return":{"type":"string|null","description":"Whether the sequence exists."},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"insert":{"signature":"public function insert(mixed $table, mixed $columns): array|false","summary":"Executes the INSERT command, returning primary key values.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"mixed","description":"The column data (name => value) to be inserted into the table."}],"return":{"type":"array|false","description":"Primary key values or false if the command fails"},"since":"2.0.4"},"loadTableChecks":{"signature":"protected function loadTableChecks(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableDefaultValues":{"signature":"protected function loadTableDefaultValues(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is called."}],"visibility":"protected"},"loadTableForeignKeys":{"signature":"protected function loadTableForeignKeys(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableIndexes":{"signature":"protected function loadTableIndexes(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTablePrimaryKey":{"signature":"protected function loadTablePrimaryKey(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableSchema":{"signature":"protected function loadTableSchema(mixed $name): yii\\db\\TableSchema|null","summary":"Loads the metadata for the specified table.","params":[{"name":"$name","type":"mixed","description":"Table name"}],"return":{"type":"yii\\db\\TableSchema|null","description":"DBMS-dependent table metadata, `null` if the table does not exist."},"visibility":"protected"},"loadTableUniques":{"signature":"protected function loadTableUniques(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"releaseSavepoint":{"signature":"public function releaseSavepoint(mixed $name): mixed","summary":"Releases an existing savepoint.","params":[{"name":"$name","type":"mixed","description":"The savepoint name"}],"return":{"type":"mixed"}},"resolveTableName":{"signature":"protected function resolveTableName(mixed $name): yii\\db\\TableSchema","summary":"Resolves the table name and schema name (if any).","params":[{"name":"$name","type":"mixed","description":"The table name"}],"return":{"type":"yii\\db\\TableSchema","description":"`yii\\db\\TableSchema` with resolved table, schema, etc. names."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected","since":"2.0.13"}},"inherited":{"properties":{"columnQuoteCharacter":"yii\\db\\Schema","db":"yii\\db\\Schema","defaultSchema":"yii\\db\\Schema","queryBuilder":"yii\\db\\Schema","schemaChecks":"yii\\db\\ConstraintFinderTrait","schemaDefaultValues":"yii\\db\\ConstraintFinderTrait","schemaForeignKeys":"yii\\db\\ConstraintFinderTrait","schemaIndexes":"yii\\db\\ConstraintFinderTrait","schemaNames":"yii\\db\\Schema","schemaPrimaryKeys":"yii\\db\\ConstraintFinderTrait","schemaUniques":"yii\\db\\ConstraintFinderTrait","serverVersion":"yii\\db\\Schema","systemSchemaNames":"yii\\db\\Schema","tableNames":"yii\\db\\Schema","tableSchemas":"yii\\db\\Schema","transactionIsolationLevel":"yii\\db\\Schema"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","convertException":"yii\\db\\Schema","createColumnSchema":"yii\\db\\Schema","createSavepoint":"yii\\db\\Schema","getCacheKey":"yii\\db\\Schema","getCacheTag":"yii\\db\\Schema","getColumnPhpType":"yii\\db\\Schema","getPdoType":"yii\\db\\Schema","getQueryBuilder":"yii\\db\\Schema","getRawTableName":"yii\\db\\Schema","getSchemaChecks":"yii\\db\\ConstraintFinderTrait","getSchemaDefaultValues":"yii\\db\\ConstraintFinderTrait","getSchemaForeignKeys":"yii\\db\\ConstraintFinderTrait","getSchemaIndexes":"yii\\db\\ConstraintFinderTrait","getSchemaMetadata":"yii\\db\\Schema","getSchemaNames":"yii\\db\\Schema","getSchemaPrimaryKeys":"yii\\db\\ConstraintFinderTrait","getSchemaUniques":"yii\\db\\ConstraintFinderTrait","getServerVersion":"yii\\db\\Schema","getTableChecks":"yii\\db\\ConstraintFinderTrait","getTableDefaultValues":"yii\\db\\ConstraintFinderTrait","getTableForeignKeys":"yii\\db\\ConstraintFinderTrait","getTableIndexes":"yii\\db\\ConstraintFinderTrait","getTableMetadata":"yii\\db\\Schema","getTableNameParts":"yii\\db\\Schema","getTableNames":"yii\\db\\Schema","getTablePrimaryKey":"yii\\db\\ConstraintFinderTrait","getTableSchema":"yii\\db\\Schema","getTableSchemas":"yii\\db\\Schema","getTableUniques":"yii\\db\\ConstraintFinderTrait","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","isReadQuery":"yii\\db\\Schema","normalizePdoRowKeyCase":"yii\\db\\Schema","quoteColumnName":"yii\\db\\Schema","quoteSimpleColumnName":"yii\\db\\Schema","quoteSimpleTableName":"yii\\db\\Schema","quoteTableName":"yii\\db\\Schema","quoteValue":"yii\\db\\Schema","refresh":"yii\\db\\Schema","refreshTableSchema":"yii\\db\\Schema","resolveRawTableName":"yii\\db\\Schema","rollBackSavepoint":"yii\\db\\Schema","setTableMetadata":"yii\\db\\Schema","setTransactionIsolationLevel":"yii\\db\\Schema","supportsSavepoint":"yii\\db\\Schema","unquoteSimpleColumnName":"yii\\db\\Schema","unquoteSimpleTableName":"yii\\db\\Schema"},"constants":{"TYPE_PK":"yii\\db\\Schema","TYPE_UPK":"yii\\db\\Schema","TYPE_BIGPK":"yii\\db\\Schema","TYPE_UBIGPK":"yii\\db\\Schema","TYPE_CHAR":"yii\\db\\Schema","TYPE_STRING":"yii\\db\\Schema","TYPE_TEXT":"yii\\db\\Schema","TYPE_TINYINT":"yii\\db\\Schema","TYPE_SMALLINT":"yii\\db\\Schema","TYPE_INTEGER":"yii\\db\\Schema","TYPE_BIGINT":"yii\\db\\Schema","TYPE_FLOAT":"yii\\db\\Schema","TYPE_DOUBLE":"yii\\db\\Schema","TYPE_DECIMAL":"yii\\db\\Schema","TYPE_DATETIME":"yii\\db\\Schema","TYPE_TIMESTAMP":"yii\\db\\Schema","TYPE_TIME":"yii\\db\\Schema","TYPE_DATE":"yii\\db\\Schema","TYPE_BINARY":"yii\\db\\Schema","TYPE_BOOLEAN":"yii\\db\\Schema","TYPE_MONEY":"yii\\db\\Schema","TYPE_JSON":"yii\\db\\Schema","SCHEMA_CACHE_VERSION":"yii\\db\\Schema"}}},"yii\\db\\oci\\conditions\\InConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/oci/conditions/inconditionbuilder/","summary":"Builds objects of `yii\\db\\conditions\\InCondition`.","extends":"yii\\db\\conditions\\InConditionBuilder","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface|yii\\db\\conditions\\InCondition $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface|yii\\db\\conditions\\InCondition","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}},"splitCondition":{"signature":"protected function splitCondition(yii\\db\\conditions\\InCondition $condition, array &$params): string|null","summary":"Oracle DBMS does not support more than 1000 parameters in `IN` condition.","params":[{"name":"$condition","type":"yii\\db\\conditions\\InCondition","description":"The expression to be built."},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters."}],"return":{"type":"string|null","description":"Null when split is not required. Otherwise - built SQL condition."},"visibility":"protected"}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait","buildCompositeInCondition":"yii\\db\\conditions\\InConditionBuilder","buildSubqueryInCondition":"yii\\db\\conditions\\InConditionBuilder","buildValues":"yii\\db\\conditions\\InConditionBuilder","getNotEqualOperator":"yii\\db\\conditions\\InConditionBuilder","getNullCondition":"yii\\db\\conditions\\InConditionBuilder"}}},"yii\\db\\oci\\conditions\\LikeConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/oci/conditions/likeconditionbuilder/","summary":"Class LikeConditionBuilder builds objects of `yii\\db\\conditions\\LikeCondition`","extends":"yii\\db\\conditions\\LikeConditionBuilder","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"properties":{"escapeCharacter":{"type":"string|null","default":"'!'","visibility":"protected"},"escapingReplacements":{"default":"['%' => '!%', '_' => '!_', '!' => '!!']","description":"`\\` is initialized in `buildLikeCondition()` method since we need to choose replacement value based on `yii\\db\\Schema::quoteValue()`.","visibility":"protected"}},"methods":{"build":{"signature":"public function build(yii\\db\\ExpressionInterface $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface","description":"The expression to be built."},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait","parseOperator":"yii\\db\\conditions\\LikeConditionBuilder"}}},"yii\\db\\pgsql\\ArrayExpressionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/pgsql/arrayexpressionbuilder/","summary":"Class ArrayExpressionBuilder builds `yii\\db\\ArrayExpression` for PostgreSQL DBMS.","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\ArrayExpression|yii\\db\\ExpressionInterface $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\ArrayExpression|yii\\db\\ExpressionInterface","description":"The expression to be built"},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}},"buildPlaceholders":{"signature":"protected function buildPlaceholders(yii\\db\\ExpressionInterface|yii\\db\\ArrayExpression $expression, array &$params): array","summary":"Builds placeholders array out of $expression values","params":[{"name":"$expression","type":"yii\\db\\ExpressionInterface|yii\\db\\ArrayExpression"},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters."}],"return":{"type":"array"},"visibility":"protected"},"buildSubqueryArray":{"signature":"protected function buildSubqueryArray(string $sql, yii\\db\\ArrayExpression $expression): string","summary":"Build an array expression from a subquery SQL.","params":[{"name":"$sql","type":"string","description":"The subquery SQL."},{"name":"$expression","type":"yii\\db\\ArrayExpression"}],"return":{"type":"string","description":"The subquery array expression."},"visibility":"protected"},"getTypehint":{"signature":"protected function getTypehint(yii\\db\\ArrayExpression $expression): string","params":[{"name":"$expression","type":"yii\\db\\ArrayExpression"}],"return":{"type":"string","description":"The typecast expression based on `type`."},"visibility":"protected"},"typecastValue":{"signature":"protected function typecastValue(yii\\db\\ArrayExpression $expression, mixed $value): mixed","summary":"Casts $value to use in $expression","params":[{"name":"$expression","type":"yii\\db\\ArrayExpression"},{"name":"$value","type":"mixed"}],"return":{"type":"mixed"},"visibility":"protected"}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\pgsql\\ArrayParser":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/pgsql/arrayparser/","summary":"The class converts PostgreSQL array representation to PHP array","since":"2.0.14","methods":{"parse":{"signature":"public function parse(string $value): array|null","summary":"Convert array from PostgreSQL to PHP","params":[{"name":"$value","type":"string","description":"String to be converted"}],"return":{"type":"array|null"}}}},"yii\\db\\pgsql\\ColumnSchema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/pgsql/columnschema/","summary":"Represents the metadata of a column in a PostgreSQL database table.","since":"2.0","extends":"yii\\db\\ColumnSchema","implements":["yii\\base\\Configurable"],"properties":{"dimension":{"type":"int","default":"0","description":"The dimension of array."},"sequenceName":{"type":"string|null","default":"null","description":"Name of associated sequence if column is auto-incremental. `null` if no sequence.","since":"2.0.29"}},"methods":{"dbTypecast":{"signature":"public function dbTypecast(mixed $value): mixed","summary":"Converts the input value according to `$type` and `$dbType` for use in a db query.","params":[{"name":"$value","type":"mixed","description":"Input value"}],"return":{"type":"mixed","description":"Converted value. This may also be an array containing the value as the first element and the PDO type as the second element."}},"defaultPhpTypecast":{"signature":"public function defaultPhpTypecast(mixed $value): mixed","summary":"Converts a PostgreSQL column default value to its PHP representation.","params":[{"name":"$value","type":"mixed","description":"Raw default value in PostgreSQL schema metadata format."}],"return":{"type":"mixed","description":"Converted PHP value."},"since":"22.0"},"getArrayParser":{"signature":"protected function getArrayParser(): yii\\db\\pgsql\\ArrayParser","summary":"Creates instance of ArrayParser","return":{"type":"yii\\db\\pgsql\\ArrayParser"},"visibility":"protected"},"phpTypecast":{"signature":"public function phpTypecast(mixed $value): mixed","summary":"Converts the input value according to `$phpType` after retrieval from the database.","params":[{"name":"$value","type":"mixed","description":"Input value"}],"return":{"type":"mixed","description":"Converted value"}},"phpTypecastValue":{"signature":"protected function phpTypecastValue(string|null $value): bool|mixed|null","summary":"Casts $value after retrieving from the DBMS to PHP representation.","params":[{"name":"$value","type":"string|null"}],"return":{"type":"bool|mixed|null"},"visibility":"protected"}},"inherited":{"properties":{"allowNull":"yii\\db\\ColumnSchema","autoIncrement":"yii\\db\\ColumnSchema","comment":"yii\\db\\ColumnSchema","dbType":"yii\\db\\ColumnSchema","defaultValue":"yii\\db\\ColumnSchema","enumValues":"yii\\db\\ColumnSchema","isPrimaryKey":"yii\\db\\ColumnSchema","name":"yii\\db\\ColumnSchema","phpType":"yii\\db\\ColumnSchema","precision":"yii\\db\\ColumnSchema","scale":"yii\\db\\ColumnSchema","size":"yii\\db\\ColumnSchema","type":"yii\\db\\ColumnSchema","unsigned":"yii\\db\\ColumnSchema"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isType":"yii\\db\\ColumnSchema","typecast":"yii\\db\\ColumnSchema"}}},"yii\\db\\pgsql\\JsonExpressionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/pgsql/jsonexpressionbuilder/","summary":"Class JsonExpressionBuilder builds `yii\\db\\JsonExpression` for PostgreSQL DBMS.","since":"2.0.14","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"build":{"signature":"public function build(yii\\db\\JsonExpression|yii\\db\\ExpressionInterface $expression, array &$params = []): string","summary":"Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.","params":[{"name":"$expression","type":"yii\\db\\JsonExpression|yii\\db\\ExpressionInterface","description":"The expression to be built"},{"name":"$params","type":"array","default":"[]","optional":true,"byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"The raw SQL that will not be additionally escaped or quoted."}},"getTypecast":{"signature":"protected function getTypecast(yii\\db\\JsonExpression $expression): string","params":[{"name":"$expression","type":"yii\\db\\JsonExpression"}],"return":{"type":"string","description":"The typecast expression based on `type`."},"visibility":"protected"}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait"}}},"yii\\db\\pgsql\\QueryBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/pgsql/querybuilder/","summary":"QueryBuilder is the query builder for PostgreSQL databases (version 14 and above).","since":"2.0","extends":"yii\\db\\QueryBuilder","implements":["yii\\base\\Configurable"],"properties":{"typeMap":{"type":"array","default":"[\\yii\\db\\pgsql\\Schema::TYPE_PK => 'serial NOT NULL PRIMARY KEY', \\yii\\db\\pgsql\\Schema::TYPE_UPK => 'serial NOT NULL PRIMARY KEY', \\yii\\db\\pgsql\\Schema::TYPE_BIGPK => 'bigserial NOT NULL PRIMARY KEY', \\yii\\db\\pgsql\\Schema::TYPE_UBIGPK => 'bigserial NOT NULL PRIMARY KEY', \\yii\\db\\pgsql\\Schema::TYPE_CHAR => 'char(1)', \\yii\\db\\pgsql\\Schema::TYPE_STRING => 'varchar(255)', \\yii\\db\\pgsql\\Schema::TYPE_TEXT => 'text', \\yii\\db\\pgsql\\Schema::TYPE_TINYINT => 'smallint', \\yii\\db\\pgsql\\Schema::TYPE_SMALLINT => 'smallint', \\yii\\db\\pgsql\\Schema::TYPE_INTEGER => 'integer', \\yii\\db\\pgsql\\Schema::TYPE_BIGINT => 'bigint', \\yii\\db\\pgsql\\Schema::TYPE_FLOAT => 'double precision', \\yii\\db\\pgsql\\Schema::TYPE_DOUBLE => 'double precision', \\yii\\db\\pgsql\\Schema::TYPE_DECIMAL => 'numeric(10,0)', \\yii\\db\\pgsql\\Schema::TYPE_DATETIME => 'timestamp(0)', \\yii\\db\\pgsql\\Schema::TYPE_TIMESTAMP => 'timestamp(0)', \\yii\\db\\pgsql\\Schema::TYPE_TIME => 'time(0)', \\yii\\db\\pgsql\\Schema::TYPE_DATE => 'date', \\yii\\db\\pgsql\\Schema::TYPE_BINARY => 'bytea', \\yii\\db\\pgsql\\Schema::TYPE_BOOLEAN => 'boolean', \\yii\\db\\pgsql\\Schema::TYPE_MONEY => 'numeric(19,4)', \\yii\\db\\pgsql\\Schema::TYPE_JSON => 'jsonb']","description":"Mapping from abstract column types (keys) to physical column types (values)."}},"methods":{"alterColumn":{"signature":"public function alterColumn(string $table, string $column, yii\\db\\ColumnSchemaBuilder|string $type): string","summary":"Builds a SQL statement for changing the definition of a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be changed. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be changed. The name will be properly quoted by the method."},{"name":"$type","type":"yii\\db\\ColumnSchemaBuilder|string","description":"The new column definition. A `yii\\db\\ColumnSchemaBuilder` carries the structured column state; a string is resolved through `getColumnType()` to the physical column type unless it is a `SET`/`DROP`/`RESET`/`RESTART`/`ADD GENERATED` action, which is emitted verbatim."}],"return":{"type":"string","description":"The SQL statement for changing the definition of a column."}},"batchInsert":{"signature":"public function batchInsert(mixed $table, mixed $columns, mixed $rows, mixed &$params = []): string","summary":"Generates a batch INSERT SQL statement.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"mixed","description":"The column names"},{"name":"$rows","type":"mixed","description":"The rows to be batch inserted into the table"},{"name":"$params","type":"mixed","default":"[]","optional":true,"byReference":true,"description":"The binding parameters. This parameter exists since 2.0.14"}],"return":{"type":"string","description":"The batch INSERT SQL statement"}},"buildLimit":{"signature":"public function buildLimit(int|yii\\db\\ExpressionInterface|null $limit, int|yii\\db\\ExpressionInterface|null $offset): string","summary":"Builds the LIMIT and OFFSET clauses for a SELECT query using the PostgreSQL `OFFSET ... FETCH` syntax.","params":[{"name":"$limit","type":"int|yii\\db\\ExpressionInterface|null","description":"The LIMIT value. `null` or a negative value means no limit; `0` is valid and emits `FETCH NEXT 0 ROWS ONLY`."},{"name":"$offset","type":"int|yii\\db\\ExpressionInterface|null","description":"The OFFSET value. `null` or `0` means no offset."}],"return":{"type":"string","description":"The LIMIT and OFFSET clauses built for PostgreSQL `14+`."}},"buildLimitOffsetValue":{"signature":"protected function buildLimitOffsetValue(int|yii\\db\\Expression $value): string","summary":"Builds a PostgreSQL row-limiting value for `OFFSET` / `FETCH` clauses.","params":[{"name":"$value","type":"int|yii\\db\\Expression","description":"The row-limiting value."}],"return":{"type":"string","description":"The value SQL."},"visibility":"protected"},"checkIntegrity":{"signature":"public function checkIntegrity(bool $check = true, string $schema = '', string $table = ''): string","summary":"Builds a SQL statement for enabling or disabling integrity checks.","params":[{"name":"$check","type":"bool","default":"true","optional":true,"description":"Whether to enable or disable integrity checks."},{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema containing the tables."},{"name":"$table","type":"string","default":"''","optional":true,"description":"The table name. An empty string applies the operation to all tables in the schema."}],"return":{"type":"string","description":"The SQL statement for changing the integrity-check state."}},"createIndex":{"signature":"public function createIndex(string $name, string $table, string|array $columns, bool|string $unique = false): string","summary":"Builds a SQL statement for creating a new index.","params":[{"name":"$name","type":"string","description":"The name of the index. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table that the new index will be created for. The table name will be properly quoted by the method."},{"name":"$columns","type":"string|array","description":"The column(s) that should be included in the index. If there are multiple columns, separate them with commas or use an array to represent them. Each column name will be properly quoted by the method, unless a parenthesis is found in the name."},{"name":"$unique","type":"bool|string","default":"false","optional":true,"description":"Whether to make this a UNIQUE index constraint. You can pass `true` or `INDEX_UNIQUE` to create a unique index, `false` to make a non-unique index using the default index type, or one of the following constants to specify the index method to use: `INDEX_B_TREE`, `INDEX_HASH`, `INDEX_GIST`, `INDEX_GIN`."}],"return":{"type":"string","description":"The SQL statement for creating a new index."}},"defaultConditionClasses":{"signature":"protected function defaultConditionClasses(): array","summary":"Contains array of default condition classes. Extend this method, if you want to change default condition classes for the query builder. See `$conditionClasses` docs for details.","return":{"type":"array"},"visibility":"protected","since":"2.0.14"},"defaultExpressionBuilders":{"signature":"protected function defaultExpressionBuilders(): array","summary":"Contains array of default expression builders. Extend this method and override it, if you want to change default expression builders for this query builder. See `$expressionBuilders` docs for details.","return":{"type":"array"},"visibility":"protected","since":"2.0.14"},"dropIndex":{"signature":"public function dropIndex(string $name, string $table): string","summary":"Builds a SQL statement for dropping an index.","params":[{"name":"$name","type":"string","description":"The name of the index to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose index is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping an index."}},"insert":{"signature":"public function insert(mixed $table, mixed $columns, mixed &$params): string","summary":"Creates an INSERT SQL statement.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"mixed","description":"The column data (name => value) to be inserted into the table or instance of Query (`yii\\db\\Query`) to perform INSERT INTO ... SELECT SQL statement. Passing of Query (`yii\\db\\Query`) is available since version 2.0.11."},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"string","description":"The INSERT SQL"}},"renameTable":{"signature":"public function renameTable(string $oldName, string $newName): string","summary":"Builds a SQL statement for renaming a DB table.","params":[{"name":"$oldName","type":"string","description":"The table to be renamed. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new table name. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for renaming a DB table."}},"resetSequence":{"signature":"public function resetSequence(string $tableName, int|null $value = null): string","summary":"Creates a SQL statement for resetting the sequence value of a table's primary key.","params":[{"name":"$tableName","type":"string","description":"The name of the table whose primary key sequence will be reset."},{"name":"$value","type":"int|null","default":"null","optional":true,"description":"The integer value for the primary key of the next new row inserted. If this is not set, the next new row's primary key will have a value `1`."}],"return":{"type":"string","description":"The SQL statement for resetting sequence."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the table does not exist or there is no sequence associated with the table."}]},"truncateTable":{"signature":"public function truncateTable(string $table): string","summary":"Builds a SQL statement for truncating a DB table.","params":[{"name":"$table","type":"string","description":"The table to be truncated. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for truncating a DB table."}},"update":{"signature":"public function update(mixed $table, mixed $columns, mixed $condition, mixed &$params): string","summary":"Creates an UPDATE SQL statement.","params":[{"name":"$table","type":"mixed","description":"The table to be updated."},{"name":"$columns","type":"mixed","description":"The column data (name => value) to be updated."},{"name":"$condition","type":"mixed","description":"The condition that will be put in the WHERE part. Please refer to `yii\\db\\Query::where()` on how to specify condition."},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters that will be modified by this method so that they can be bound to the DB command later."}],"return":{"type":"string","description":"The UPDATE SQL"}},"upsert":{"signature":"public function upsert(mixed $table, mixed $insertColumns, mixed $updateColumns, mixed &$params): string","summary":"Creates an SQL statement to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into/updated in."},{"name":"$insertColumns","type":"mixed","description":"The column data (name => value) to be inserted into the table or instance of `yii\\db\\Query` to perform `INSERT INTO ... SELECT` SQL statement."},{"name":"$updateColumns","type":"mixed","description":"The column data (name => value) to be updated if they already exist. If `true` is passed, the column data will be updated to match the insert column data. If `false` is passed, no update will be performed if the column data already exists."},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"string","description":"The resulting SQL."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}],"since":"2.0.14"}},"constants":{"INDEX_UNIQUE":{"value":"'unique'","description":"Defines a UNIQUE index for `createIndex()`.","since":"2.0.6"},"INDEX_B_TREE":{"value":"'btree'","description":"Defines a B-tree index for `createIndex()`.","since":"2.0.6"},"INDEX_HASH":{"value":"'hash'","description":"Defines a hash index for `createIndex()`.","since":"2.0.6"},"INDEX_GIST":{"value":"'gist'","description":"Defines a GiST index for `createIndex()`.","since":"2.0.6"},"INDEX_GIN":{"value":"'gin'","description":"Defines a GIN index for `createIndex()`.","since":"2.0.6"}},"inherited":{"properties":{"conditionClasses":"yii\\db\\QueryBuilder","db":"yii\\db\\QueryBuilder","expressionBuilders":"yii\\db\\QueryBuilder","separator":"yii\\db\\QueryBuilder"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\db\\QueryBuilder","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","addCheck":"yii\\db\\QueryBuilder","addColumn":"yii\\db\\QueryBuilder","addCommentOnColumn":"yii\\db\\QueryBuilder","addCommentOnTable":"yii\\db\\QueryBuilder","addDefaultValue":"yii\\db\\QueryBuilder","addForeignKey":"yii\\db\\QueryBuilder","addPrimaryKey":"yii\\db\\QueryBuilder","addUnique":"yii\\db\\QueryBuilder","bindParam":"yii\\db\\QueryBuilder","build":"yii\\db\\QueryBuilder","buildColumns":"yii\\db\\QueryBuilder","buildCondition":"yii\\db\\QueryBuilder","buildExpression":"yii\\db\\QueryBuilder","buildFrom":"yii\\db\\QueryBuilder","buildGroupBy":"yii\\db\\QueryBuilder","buildHaving":"yii\\db\\QueryBuilder","buildJoin":"yii\\db\\QueryBuilder","buildOrderBy":"yii\\db\\QueryBuilder","buildOrderByAndLimit":"yii\\db\\QueryBuilder","buildSelect":"yii\\db\\QueryBuilder","buildUnion":"yii\\db\\QueryBuilder","buildUnionOrderByAndLimit":"yii\\db\\QueryBuilder","buildWhere":"yii\\db\\QueryBuilder","buildWithQueries":"yii\\db\\QueryBuilder","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","concatUnionSql":"yii\\db\\QueryBuilder","createConditionFromArray":"yii\\db\\QueryBuilder","createTable":"yii\\db\\QueryBuilder","createView":"yii\\db\\QueryBuilder","delete":"yii\\db\\QueryBuilder","dropCheck":"yii\\db\\QueryBuilder","dropColumn":"yii\\db\\QueryBuilder","dropCommentFromColumn":"yii\\db\\QueryBuilder","dropCommentFromTable":"yii\\db\\QueryBuilder","dropDefaultValue":"yii\\db\\QueryBuilder","dropForeignKey":"yii\\db\\QueryBuilder","dropPrimaryKey":"yii\\db\\QueryBuilder","dropTable":"yii\\db\\QueryBuilder","dropUnique":"yii\\db\\QueryBuilder","dropView":"yii\\db\\QueryBuilder","executeResetSequence":"yii\\db\\QueryBuilder","extractAlias":"yii\\db\\QueryBuilder","getColumnType":"yii\\db\\QueryBuilder","getExpressionBuilder":"yii\\db\\QueryBuilder","hasLimit":"yii\\db\\QueryBuilder","hasMethod":"yii\\base\\BaseObject","hasOffset":"yii\\db\\QueryBuilder","hasProperty":"yii\\base\\BaseObject","init":"yii\\db\\QueryBuilder","prepareInsertSelectSubQuery":"yii\\db\\QueryBuilder","prepareInsertValues":"yii\\db\\QueryBuilder","prepareSelectQuery":"yii\\db\\QueryBuilder","prepareUpdateSets":"yii\\db\\QueryBuilder","prepareUpsertColumns":"yii\\db\\QueryBuilder","prepareUpsertSets":"yii\\db\\QueryBuilder","renameColumn":"yii\\db\\QueryBuilder","selectExists":"yii\\db\\QueryBuilder","setConditionClasses":"yii\\db\\QueryBuilder","setExpressionBuilders":"yii\\db\\QueryBuilder"},"constants":{"PARAM_PREFIX":"yii\\db\\QueryBuilder"}}},"yii\\db\\pgsql\\Schema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/pgsql/schema/","summary":"Schema is the class for retrieving metadata from a PostgreSQL database (version 14.0 and above).","since":"2.0","extends":"yii\\db\\Schema","implements":["yii\\db\\ConstraintFinderInterface","yii\\base\\Configurable"],"traits":["yii\\db\\ViewFinderTrait","yii\\db\\ConstraintFinderTrait"],"properties":{"columnSchemaClass":{"type":"class-string|array{class?: class-string, __class?: class-string}","default":"'yii\\db\\pgsql\\ColumnSchema'","since":"2.0.11"},"defaultSchema":{"type":"string","default":"'public'","description":"The schema used for unqualified table metadata lookups."},"tableQuoteCharacter":{"type":"string|string[]","default":"'\"'","visibility":"protected","since":"2.0.14"},"typeMap":{"type":"array","default":"['bit' => self::TYPE_INTEGER, 'bit varying' => self::TYPE_INTEGER, 'varbit' => self::TYPE_INTEGER, 'bool' => self::TYPE_BOOLEAN, 'boolean' => self::TYPE_BOOLEAN, 'box' => self::TYPE_STRING, 'circle' => self::TYPE_STRING, 'point' => self::TYPE_STRING, 'line' => self::TYPE_STRING, 'lseg' => self::TYPE_STRING, 'polygon' => self::TYPE_STRING, 'path' => self::TYPE_STRING, 'character' => self::TYPE_CHAR, 'char' => self::TYPE_CHAR, 'bpchar' => self::TYPE_CHAR, 'character varying' => self::TYPE_STRING, 'varchar' => self::TYPE_STRING, 'text' => self::TYPE_TEXT, 'bytea' => self::TYPE_BINARY, 'cidr' => self::TYPE_STRING, 'inet' => self::TYPE_STRING, 'macaddr' => self::TYPE_STRING, 'real' => self::TYPE_FLOAT, 'float4' => self::TYPE_FLOAT, 'double precision' => self::TYPE_DOUBLE, 'float8' => self::TYPE_DOUBLE, 'decimal' => self::TYPE_DECIMAL, 'numeric' => self::TYPE_DECIMAL, 'money' => self::TYPE_MONEY, 'smallint' => self::TYPE_SMALLINT, 'int2' => self::TYPE_SMALLINT, 'int4' => self::TYPE_INTEGER, 'int' => self::TYPE_INTEGER, 'integer' => self::TYPE_INTEGER, 'bigint' => self::TYPE_BIGINT, 'int8' => self::TYPE_BIGINT, 'oid' => self::TYPE_BIGINT, 'smallserial' => self::TYPE_SMALLINT, 'serial2' => self::TYPE_SMALLINT, 'serial4' => self::TYPE_INTEGER, 'serial' => self::TYPE_INTEGER, 'bigserial' => self::TYPE_BIGINT, 'serial8' => self::TYPE_BIGINT, 'pg_lsn' => self::TYPE_BIGINT, 'date' => self::TYPE_DATE, 'interval' => self::TYPE_STRING, 'time without time zone' => self::TYPE_TIME, 'time' => self::TYPE_TIME, 'time with time zone' => self::TYPE_TIME, 'timetz' => self::TYPE_TIME, 'timestamp without time zone' => self::TYPE_TIMESTAMP, 'timestamp' => self::TYPE_TIMESTAMP, 'timestamp with time zone' => self::TYPE_TIMESTAMP, 'timestamptz' => self::TYPE_TIMESTAMP, 'abstime' => self::TYPE_TIMESTAMP, 'tsquery' => self::TYPE_STRING, 'tsvector' => self::TYPE_STRING, 'txid_snapshot' => self::TYPE_STRING, 'unknown' => self::TYPE_STRING, 'uuid' => self::TYPE_STRING, 'json' => self::TYPE_JSON, 'jsonb' => self::TYPE_JSON, 'xml' => self::TYPE_STRING]","description":"Mapping from physical column types (keys) to abstract column types (values)"}},"methods":{"createQueryBuilder":{"signature":"public function createQueryBuilder(): yii\\db\\pgsql\\QueryBuilder","summary":"Creates a query builder for the PostgreSQL database.","return":{"type":"yii\\db\\pgsql\\QueryBuilder","description":"Query builder instance"}},"findColumns":{"signature":"protected function findColumns(yii\\db\\TableSchema $table): bool","summary":"Collects the metadata of table columns.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"bool","description":"Whether the table exists in the database"},"visibility":"protected"},"findConstraints":{"signature":"protected function findConstraints(yii\\db\\TableSchema $table): mixed","summary":"Collects the foreign key column details for the given table.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"mixed"},"visibility":"protected"},"findSchemaNames":{"signature":"protected function findSchemaNames(): array","summary":"Returns all schema names in the database, including the default one but not system schemas.","return":{"type":"array","description":"All schema names in the database, except system schemas."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected","since":"2.0.4"},"findTableNames":{"signature":"protected function findTableNames(mixed $schema = ''): array","summary":"Returns all table names in the database.","params":[{"name":"$schema","type":"mixed","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema."}],"return":{"type":"array","description":"All table names in the database. The names have NO schema name prefix."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected"},"findUniqueIndexes":{"signature":"public function findUniqueIndexes(yii\\db\\TableSchema $table): array","summary":"Returns all unique indexes for the given table.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"array","description":"All unique indexes for the given table."}},"findViewNames":{"signature":"protected function findViewNames(mixed $schema = ''): mixed","summary":"{@inheritdoc]","params":[{"name":"$schema","type":"mixed","default":"''","optional":true}],"return":{"type":"mixed"},"visibility":"protected"},"getUniqueIndexInformation":{"signature":"protected function getUniqueIndexInformation(yii\\db\\TableSchema $table): array","summary":"Gets information about given table unique indexes.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"array","description":"With index and column names"},"visibility":"protected"},"insert":{"signature":"public function insert(mixed $table, mixed $columns): array|false","summary":"Executes the INSERT command, returning primary key values.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into."},{"name":"$columns","type":"mixed","description":"The column data (name => value) to be inserted into the table."}],"return":{"type":"array|false","description":"Primary key values or false if the command fails"},"since":"2.0.4"},"loadColumnSchema":{"signature":"protected function loadColumnSchema(array $info): yii\\db\\pgsql\\T","summary":"Loads the column information into a `yii\\db\\pgsql\\ColumnSchema` object.","params":[{"name":"$info","type":"array","description":"Column information"}],"return":{"type":"yii\\db\\pgsql\\T","description":"The column schema object"},"visibility":"protected"},"loadTableChecks":{"signature":"protected function loadTableChecks(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableDefaultValues":{"signature":"protected function loadTableDefaultValues(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is called."}],"visibility":"protected"},"loadTableForeignKeys":{"signature":"protected function loadTableForeignKeys(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableIndexes":{"signature":"protected function loadTableIndexes(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTablePrimaryKey":{"signature":"protected function loadTablePrimaryKey(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableSchema":{"signature":"protected function loadTableSchema(mixed $name): yii\\db\\TableSchema|null","summary":"Loads the metadata for the specified table.","params":[{"name":"$name","type":"mixed","description":"Table name"}],"return":{"type":"yii\\db\\TableSchema|null","description":"DBMS-dependent table metadata, `null` if the table does not exist."},"visibility":"protected"},"loadTableUniques":{"signature":"protected function loadTableUniques(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"resolveTableName":{"signature":"protected function resolveTableName(mixed $name): yii\\db\\TableSchema","summary":"Resolves the table name and schema name (if any).","params":[{"name":"$name","type":"mixed","description":"The table name"}],"return":{"type":"yii\\db\\TableSchema","description":"`yii\\db\\TableSchema` with resolved table, schema, etc. names."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected","since":"2.0.13"}},"constants":{"TYPE_JSONB":{"value":"'jsonb'"}},"inherited":{"properties":{"columnQuoteCharacter":"yii\\db\\Schema","db":"yii\\db\\Schema","exceptionMap":"yii\\db\\Schema","lastInsertID":"yii\\db\\Schema","queryBuilder":"yii\\db\\Schema","schemaChecks":"yii\\db\\ConstraintFinderTrait","schemaDefaultValues":"yii\\db\\ConstraintFinderTrait","schemaForeignKeys":"yii\\db\\ConstraintFinderTrait","schemaIndexes":"yii\\db\\ConstraintFinderTrait","schemaNames":"yii\\db\\Schema","schemaPrimaryKeys":"yii\\db\\ConstraintFinderTrait","schemaUniques":"yii\\db\\ConstraintFinderTrait","serverVersion":"yii\\db\\Schema","systemSchemaNames":"yii\\db\\Schema","tableNames":"yii\\db\\Schema","tableSchemas":"yii\\db\\Schema","transactionIsolationLevel":"yii\\db\\Schema","viewNames":"yii\\db\\ViewFinderTrait"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","convertException":"yii\\db\\Schema","createColumnSchema":"yii\\db\\Schema","createColumnSchemaBuilder":"yii\\db\\Schema","createSavepoint":"yii\\db\\Schema","getCacheKey":"yii\\db\\Schema","getCacheTag":"yii\\db\\Schema","getColumnPhpType":"yii\\db\\Schema","getLastInsertID":"yii\\db\\Schema","getPdoType":"yii\\db\\Schema","getQueryBuilder":"yii\\db\\Schema","getRawTableName":"yii\\db\\Schema","getSchemaChecks":"yii\\db\\ConstraintFinderTrait","getSchemaDefaultValues":"yii\\db\\ConstraintFinderTrait","getSchemaForeignKeys":"yii\\db\\ConstraintFinderTrait","getSchemaIndexes":"yii\\db\\ConstraintFinderTrait","getSchemaMetadata":"yii\\db\\Schema","getSchemaNames":"yii\\db\\Schema","getSchemaPrimaryKeys":"yii\\db\\ConstraintFinderTrait","getSchemaUniques":"yii\\db\\ConstraintFinderTrait","getServerVersion":"yii\\db\\Schema","getTableChecks":"yii\\db\\ConstraintFinderTrait","getTableDefaultValues":"yii\\db\\ConstraintFinderTrait","getTableForeignKeys":"yii\\db\\ConstraintFinderTrait","getTableIndexes":"yii\\db\\ConstraintFinderTrait","getTableMetadata":"yii\\db\\Schema","getTableNameParts":"yii\\db\\Schema","getTableNames":"yii\\db\\Schema","getTablePrimaryKey":"yii\\db\\ConstraintFinderTrait","getTableSchema":"yii\\db\\Schema","getTableSchemas":"yii\\db\\Schema","getTableUniques":"yii\\db\\ConstraintFinderTrait","getViewNames":"yii\\db\\ViewFinderTrait","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isReadQuery":"yii\\db\\Schema","normalizePdoRowKeyCase":"yii\\db\\Schema","quoteColumnName":"yii\\db\\Schema","quoteSimpleColumnName":"yii\\db\\Schema","quoteSimpleTableName":"yii\\db\\Schema","quoteTableName":"yii\\db\\Schema","quoteValue":"yii\\db\\Schema","refresh":"yii\\db\\Schema","refreshTableSchema":"yii\\db\\Schema","releaseSavepoint":"yii\\db\\Schema","resolveRawTableName":"yii\\db\\Schema","rollBackSavepoint":"yii\\db\\Schema","setTableMetadata":"yii\\db\\Schema","setTransactionIsolationLevel":"yii\\db\\Schema","supportsSavepoint":"yii\\db\\Schema","unquoteSimpleColumnName":"yii\\db\\Schema","unquoteSimpleTableName":"yii\\db\\Schema"},"constants":{"TYPE_PK":"yii\\db\\Schema","TYPE_UPK":"yii\\db\\Schema","TYPE_BIGPK":"yii\\db\\Schema","TYPE_UBIGPK":"yii\\db\\Schema","TYPE_CHAR":"yii\\db\\Schema","TYPE_STRING":"yii\\db\\Schema","TYPE_TEXT":"yii\\db\\Schema","TYPE_TINYINT":"yii\\db\\Schema","TYPE_SMALLINT":"yii\\db\\Schema","TYPE_INTEGER":"yii\\db\\Schema","TYPE_BIGINT":"yii\\db\\Schema","TYPE_FLOAT":"yii\\db\\Schema","TYPE_DOUBLE":"yii\\db\\Schema","TYPE_DECIMAL":"yii\\db\\Schema","TYPE_DATETIME":"yii\\db\\Schema","TYPE_TIMESTAMP":"yii\\db\\Schema","TYPE_TIME":"yii\\db\\Schema","TYPE_DATE":"yii\\db\\Schema","TYPE_BINARY":"yii\\db\\Schema","TYPE_BOOLEAN":"yii\\db\\Schema","TYPE_MONEY":"yii\\db\\Schema","TYPE_JSON":"yii\\db\\Schema","SCHEMA_CACHE_VERSION":"yii\\db\\Schema"}}},"yii\\db\\pgsql\\Transaction":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/pgsql/transaction/","summary":"Represents a PostgreSQL DB transaction.","since":"22.0","extends":"yii\\db\\Transaction","implements":["yii\\base\\Configurable"],"methods":{"begin":{"signature":"public function begin(mixed $isolationLevel = null): mixed","summary":"Begins a transaction.","params":[{"name":"$isolationLevel","type":"mixed","default":"null","optional":true,"description":"The [isolation level][] to use for this transaction. This can be one of `READ_UNCOMMITTED`, `READ_COMMITTED`, `REPEATABLE_READ` and `SERIALIZABLE` but also a string containing DBMS specific syntax to be used after `SET TRANSACTION ISOLATION LEVEL`. If not specified (`null`) the isolation level will not be set explicitly and the DBMS default will be used. > Note: Some DBMS allow setting of the isolation level only for the whole connection so subsequent transactions may get the same isolation level even if you did not specify any. When using this feature you may need to set the isolation level for all transactions explicitly to avoid conflicting settings. At the time of this writing affected DBMS are MSSQL and SQLite. > Note: The isolation level applies to the outermost transaction only. Nested transactions are implemented with savepoints and always run at the isolation level of the outer transaction, so an `$isolationLevel` passed to a nested `begin()` call is ignored and a warning is logged (since 2.0.56). [isolation level]: https://en.wikipedia.org/wiki/Isolation_%28database_systems%29#Isolation_levels Starting from version 2.0.16, this method throws exception when beginning nested transaction and underlying DBMS does not support savepoints."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$db` is `null`"},{"type":"yii\\base\\NotSupportedException","description":"if the DBMS does not support nested transactions"},{"type":"yii\\db\\Exception","description":"if DB connection fails"}]}},"inherited":{"properties":{"db":"yii\\db\\Transaction","isActive":"yii\\db\\Transaction","isolationLevel":"yii\\db\\Transaction","level":"yii\\db\\Transaction"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","commit":"yii\\db\\Transaction","getIsActive":"yii\\db\\Transaction","getLevel":"yii\\db\\Transaction","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","rollBack":"yii\\db\\Transaction","setIsolationLevel":"yii\\db\\Transaction"},"constants":{"READ_UNCOMMITTED":"yii\\db\\Transaction","READ_COMMITTED":"yii\\db\\Transaction","REPEATABLE_READ":"yii\\db\\Transaction","SERIALIZABLE":"yii\\db\\Transaction"}}},"yii\\db\\sqlite\\ColumnSchema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/sqlite/columnschema/","summary":"Represents the metadata of a column in a SQLite database table.","since":"22.0","extends":"yii\\db\\ColumnSchema","implements":["yii\\base\\Configurable"],"methods":{"defaultPhpTypecast":{"signature":"public function defaultPhpTypecast(mixed $value): mixed","summary":"Converts a SQLite column default value to its PHP representation.","params":[{"name":"$value","type":"mixed","description":"Default value in SQLite `dflt_value` format."}],"return":{"type":"mixed","description":"Converted value."},"since":"22.0"}},"inherited":{"properties":{"allowNull":"yii\\db\\ColumnSchema","autoIncrement":"yii\\db\\ColumnSchema","comment":"yii\\db\\ColumnSchema","dbType":"yii\\db\\ColumnSchema","defaultValue":"yii\\db\\ColumnSchema","enumValues":"yii\\db\\ColumnSchema","isPrimaryKey":"yii\\db\\ColumnSchema","name":"yii\\db\\ColumnSchema","phpType":"yii\\db\\ColumnSchema","precision":"yii\\db\\ColumnSchema","scale":"yii\\db\\ColumnSchema","size":"yii\\db\\ColumnSchema","type":"yii\\db\\ColumnSchema","unsigned":"yii\\db\\ColumnSchema"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","dbTypecast":"yii\\db\\ColumnSchema","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isType":"yii\\db\\ColumnSchema","phpTypecast":"yii\\db\\ColumnSchema","typecast":"yii\\db\\ColumnSchema"}}},"yii\\db\\sqlite\\ColumnSchemaBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/sqlite/columnschemabuilder/","summary":"ColumnSchemaBuilder is the schema builder for Sqlite databases.","since":"2.0.8","extends":"yii\\db\\ColumnSchemaBuilder","implements":["Stringable","yii\\base\\Configurable"],"methods":{"__toString":{"signature":"public function __toString(): string","summary":"Builds the full string for the column's schema.","return":{"type":"string"}},"buildUnsignedString":{"signature":"protected function buildUnsignedString(): string","summary":"Builds the unsigned string for column. Defaults to unsupported.","return":{"type":"string","description":"A string containing UNSIGNED keyword."},"visibility":"protected","since":"2.0.7"}},"inherited":{"properties":{"after":"yii\\db\\ColumnSchemaBuilder","append":"yii\\db\\ColumnSchemaBuilder","categoryMap":"yii\\db\\ColumnSchemaBuilder","check":"yii\\db\\ColumnSchemaBuilder","comment":"yii\\db\\ColumnSchemaBuilder","db":"yii\\db\\ColumnSchemaBuilder","default":"yii\\db\\ColumnSchemaBuilder","isFirst":"yii\\db\\ColumnSchemaBuilder","isNotNull":"yii\\db\\ColumnSchemaBuilder","isUnique":"yii\\db\\ColumnSchemaBuilder","isUnsigned":"yii\\db\\ColumnSchemaBuilder","length":"yii\\db\\ColumnSchemaBuilder","type":"yii\\db\\ColumnSchemaBuilder","typeCategoryMap":"yii\\db\\ColumnSchemaBuilder","typeDefinition":"yii\\db\\ColumnSchemaBuilder"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\db\\ColumnSchemaBuilder","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","after":"yii\\db\\ColumnSchemaBuilder","append":"yii\\db\\ColumnSchemaBuilder","buildAfterString":"yii\\db\\ColumnSchemaBuilder","buildAppendString":"yii\\db\\ColumnSchemaBuilder","buildCheckString":"yii\\db\\ColumnSchemaBuilder","buildCommentString":"yii\\db\\ColumnSchemaBuilder","buildCompleteString":"yii\\db\\ColumnSchemaBuilder","buildDefaultString":"yii\\db\\ColumnSchemaBuilder","buildDefaultValue":"yii\\db\\ColumnSchemaBuilder","buildFirstString":"yii\\db\\ColumnSchemaBuilder","buildLengthString":"yii\\db\\ColumnSchemaBuilder","buildNotNullString":"yii\\db\\ColumnSchemaBuilder","buildUniqueString":"yii\\db\\ColumnSchemaBuilder","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","check":"yii\\db\\ColumnSchemaBuilder","className":"yii\\base\\BaseObject","comment":"yii\\db\\ColumnSchemaBuilder","defaultExpression":"yii\\db\\ColumnSchemaBuilder","defaultValue":"yii\\db\\ColumnSchemaBuilder","first":"yii\\db\\ColumnSchemaBuilder","getAppend":"yii\\db\\ColumnSchemaBuilder","getCategoryMap":"yii\\db\\ColumnSchemaBuilder","getCheck":"yii\\db\\ColumnSchemaBuilder","getDefault":"yii\\db\\ColumnSchemaBuilder","getTypeCategory":"yii\\db\\ColumnSchemaBuilder","getTypeDefinition":"yii\\db\\ColumnSchemaBuilder","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isNotNull":"yii\\db\\ColumnSchemaBuilder","isUnique":"yii\\db\\ColumnSchemaBuilder","notNull":"yii\\db\\ColumnSchemaBuilder","null":"yii\\db\\ColumnSchemaBuilder","setCategoryMap":"yii\\db\\ColumnSchemaBuilder","unique":"yii\\db\\ColumnSchemaBuilder","unsigned":"yii\\db\\ColumnSchemaBuilder"},"constants":{"CATEGORY_PK":"yii\\db\\ColumnSchemaBuilder","CATEGORY_STRING":"yii\\db\\ColumnSchemaBuilder","CATEGORY_NUMERIC":"yii\\db\\ColumnSchemaBuilder","CATEGORY_TIME":"yii\\db\\ColumnSchemaBuilder","CATEGORY_OTHER":"yii\\db\\ColumnSchemaBuilder"}}},"yii\\db\\sqlite\\Command":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/sqlite/command/","summary":"Command represents an SQLite's SQL statement to be executed against a database.","since":"2.0.14","extends":"yii\\db\\Command","implements":["yii\\base\\Configurable"],"methods":{"checkIntegrity":{"signature":"public function checkIntegrity(mixed $check = true, mixed $schema = '', mixed $table = ''): $this","summary":"Builds a SQL command for enabling or disabling integrity check.","params":[{"name":"$check","type":"mixed","default":"true","optional":true,"description":"Whether to turn on or off the integrity check."},{"name":"$schema","type":"mixed","default":"''","optional":true,"description":"The schema name of the tables. Defaults to empty string, meaning the current or default schema."},{"name":"$table","type":"mixed","default":"''","optional":true,"description":"The table name."}],"return":{"type":"$this","description":"The command object itself"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS"}]},"execute":{"signature":"public function execute(): int","summary":"Executes the SQL statement.","return":{"type":"int","description":"Number of rows affected by the execution."},"throws":[{"type":"yii\\db\\Exception","description":"execution failed"}]},"prepare":{"signature":"public function prepare(mixed $forRead = null): mixed","summary":"Prepares the SQL statement to be executed.","params":[{"name":"$forRead","type":"mixed","default":"null","optional":true,"description":"Whether this method is called for a read query. If null, it means the SQL statement should be used to determine whether it is for read or write."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\db\\Exception","description":"if there is any DB error"}]},"queryInternal":{"signature":"protected function queryInternal(mixed $method, mixed $fetchMode = null): mixed","summary":"Performs the actual DB query of a SQL statement.","params":[{"name":"$method","type":"mixed","description":"Method of PDOStatement to be called"},{"name":"$fetchMode","type":"mixed","default":"null","optional":true,"description":"The result fetch mode. Please refer to [PHP manual](https://www.php.net/manual/en/function.PDOStatement-setFetchMode.php) for valid fetch modes. If this parameter is null, the value set in `$fetchMode` will be used."}],"return":{"type":"mixed","description":"The method execution result"},"throws":[{"type":"yii\\db\\Exception","description":"if the query causes any problem"}],"visibility":"protected"},"reset":{"signature":"protected function reset(): mixed","summary":"Resets command properties to their initial state.","return":{"type":"mixed"},"visibility":"protected","since":"2.0.13"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","db":"yii\\db\\Command","fetchMode":"yii\\db\\Command","params":"yii\\db\\Command","pdoStatement":"yii\\db\\Command","pendingParams":"yii\\db\\Command","queryCacheDependency":"yii\\db\\Command","queryCacheDuration":"yii\\db\\Command","rawSql":"yii\\db\\Command","sql":"yii\\db\\Command"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","addCheck":"yii\\db\\Command","addColumn":"yii\\db\\Command","addCommentOnColumn":"yii\\db\\Command","addCommentOnTable":"yii\\db\\Command","addDefaultValue":"yii\\db\\Command","addForeignKey":"yii\\db\\Command","addPrimaryKey":"yii\\db\\Command","addUnique":"yii\\db\\Command","alterColumn":"yii\\db\\Command","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","batchInsert":"yii\\db\\Command","behaviors":"yii\\base\\Component","bindParam":"yii\\db\\Command","bindPendingParams":"yii\\db\\Command","bindValue":"yii\\db\\Command","bindValues":"yii\\db\\Command","cache":"yii\\db\\Command","cancel":"yii\\db\\Command","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","createIndex":"yii\\db\\Command","createTable":"yii\\db\\Command","createView":"yii\\db\\Command","delete":"yii\\db\\Command","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","dropCheck":"yii\\db\\Command","dropColumn":"yii\\db\\Command","dropCommentFromColumn":"yii\\db\\Command","dropCommentFromTable":"yii\\db\\Command","dropDefaultValue":"yii\\db\\Command","dropForeignKey":"yii\\db\\Command","dropIndex":"yii\\db\\Command","dropPrimaryKey":"yii\\db\\Command","dropTable":"yii\\db\\Command","dropUnique":"yii\\db\\Command","dropView":"yii\\db\\Command","ensureBehaviors":"yii\\base\\Component","executeResetSequence":"yii\\db\\Command","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getCacheKey":"yii\\db\\Command","getRawSql":"yii\\db\\Command","getSql":"yii\\db\\Command","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","insert":"yii\\db\\Command","internalExecute":"yii\\db\\Command","logQuery":"yii\\db\\Command","noCache":"yii\\db\\Command","off":"yii\\base\\Component","on":"yii\\base\\Component","query":"yii\\db\\Command","queryAll":"yii\\db\\Command","queryColumn":"yii\\db\\Command","queryOne":"yii\\db\\Command","queryScalar":"yii\\db\\Command","refreshTableSchema":"yii\\db\\Command","renameColumn":"yii\\db\\Command","renameTable":"yii\\db\\Command","requireTableSchemaRefresh":"yii\\db\\Command","requireTransaction":"yii\\db\\Command","resetSequence":"yii\\db\\Command","setRawSql":"yii\\db\\Command","setRetryHandler":"yii\\db\\Command","setSql":"yii\\db\\Command","trigger":"yii\\base\\Component","truncateTable":"yii\\db\\Command","update":"yii\\db\\Command","upsert":"yii\\db\\Command"}}},"yii\\db\\sqlite\\QueryBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/sqlite/querybuilder/","summary":"QueryBuilder is the query builder for SQLite databases.","since":"2.0","extends":"yii\\db\\QueryBuilder","implements":["yii\\base\\Configurable"],"properties":{"typeMap":{"type":"array","default":"[\\yii\\db\\sqlite\\Schema::TYPE_PK => 'integer PRIMARY KEY AUTOINCREMENT NOT NULL', \\yii\\db\\sqlite\\Schema::TYPE_UPK => 'integer PRIMARY KEY AUTOINCREMENT NOT NULL', \\yii\\db\\sqlite\\Schema::TYPE_BIGPK => 'integer PRIMARY KEY AUTOINCREMENT NOT NULL', \\yii\\db\\sqlite\\Schema::TYPE_UBIGPK => 'integer PRIMARY KEY AUTOINCREMENT NOT NULL', \\yii\\db\\sqlite\\Schema::TYPE_CHAR => 'char(1)', \\yii\\db\\sqlite\\Schema::TYPE_STRING => 'varchar(255)', \\yii\\db\\sqlite\\Schema::TYPE_TEXT => 'text', \\yii\\db\\sqlite\\Schema::TYPE_TINYINT => 'tinyint', \\yii\\db\\sqlite\\Schema::TYPE_SMALLINT => 'smallint', \\yii\\db\\sqlite\\Schema::TYPE_INTEGER => 'integer', \\yii\\db\\sqlite\\Schema::TYPE_BIGINT => 'bigint', \\yii\\db\\sqlite\\Schema::TYPE_FLOAT => 'float', \\yii\\db\\sqlite\\Schema::TYPE_DOUBLE => 'double', \\yii\\db\\sqlite\\Schema::TYPE_DECIMAL => 'decimal(10,0)', \\yii\\db\\sqlite\\Schema::TYPE_DATETIME => 'datetime', \\yii\\db\\sqlite\\Schema::TYPE_TIMESTAMP => 'timestamp', \\yii\\db\\sqlite\\Schema::TYPE_TIME => 'time', \\yii\\db\\sqlite\\Schema::TYPE_DATE => 'date', \\yii\\db\\sqlite\\Schema::TYPE_BINARY => 'blob', \\yii\\db\\sqlite\\Schema::TYPE_BOOLEAN => 'boolean', \\yii\\db\\sqlite\\Schema::TYPE_MONEY => 'decimal(19,4)']","description":"Mapping from abstract column types (keys) to physical column types (values)."}},"methods":{"addCheck":{"signature":"public function addCheck(mixed $name, mixed $table, mixed $expression): string","summary":"Creates a SQL command for adding a check constraint to an existing table.","params":[{"name":"$name","type":"mixed","description":"The name of the check constraint. The name will be properly quoted by the method."},{"name":"$table","type":"mixed","description":"The table that the check constraint will be added to. The name will be properly quoted by the method."},{"name":"$expression","type":"mixed","description":"The SQL of the `CHECK` constraint."}],"return":{"type":"string","description":"The SQL statement for adding a check constraint to an existing table."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite."}],"since":"2.0.13"},"addCommentOnColumn":{"signature":"public function addCommentOnColumn(mixed $table, mixed $column, mixed $comment): string","summary":"Builds a SQL command for adding comment to column.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"mixed","description":"The name of the column to be commented. The column name will be properly quoted by the method."},{"name":"$comment","type":"mixed","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"throws":[{"type":"yii\\base\\NotSupportedException"}],"since":"2.0.8"},"addCommentOnTable":{"signature":"public function addCommentOnTable(mixed $table, mixed $comment): string","summary":"Builds a SQL command for adding comment to table.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$comment","type":"mixed","description":"The text of the comment to be added. The comment will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on table"},"throws":[{"type":"yii\\base\\NotSupportedException"}],"since":"2.0.8"},"addDefaultValue":{"signature":"public function addDefaultValue(mixed $name, mixed $table, mixed $column, mixed $value): string","summary":"Creates a SQL command for adding a default value constraint to an existing table.","params":[{"name":"$name","type":"mixed","description":"The name of the default value constraint. The name will be properly quoted by the method."},{"name":"$table","type":"mixed","description":"The table that the default value constraint will be added to. The name will be properly quoted by the method."},{"name":"$column","type":"mixed","description":"The name of the column to that the constraint will be added on. The name will be properly quoted by the method."},{"name":"$value","type":"mixed","description":"Default value."}],"return":{"type":"string","description":"The SQL statement for adding a default value constraint to an existing table."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite."}],"since":"2.0.13"},"addForeignKey":{"signature":"public function addForeignKey(string $name, string $table, string|array $columns, string $refTable, string|array $refColumns, string|null $delete = null, string|null $update = null): string","summary":"Builds a SQL statement for adding a foreign key constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the foreign key constraint."},{"name":"$table","type":"string","description":"The table that the foreign key constraint will be added to."},{"name":"$columns","type":"string|array","description":"The name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array to represent them."},{"name":"$refTable","type":"string","description":"The table that the foreign key references to."},{"name":"$refColumns","type":"string|array","description":"The name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array to represent them."},{"name":"$delete","type":"string|null","default":"null","optional":true,"description":"The ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL"},{"name":"$update","type":"string|null","default":"null","optional":true,"description":"The ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL"}],"return":{"type":"string","description":"The SQL statement for adding a foreign key constraint to an existing table."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite"}]},"addPrimaryKey":{"signature":"public function addPrimaryKey(string $name, string $table, string|array $columns): string","summary":"Builds a SQL statement for adding a primary key constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the primary key constraint."},{"name":"$table","type":"string","description":"The table that the primary key constraint will be added to."},{"name":"$columns","type":"string|array","description":"Comma separated string or array of columns that the primary key will consist of."}],"return":{"type":"string","description":"The SQL statement for adding a primary key constraint to an existing table."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite"}]},"addUnique":{"signature":"public function addUnique(mixed $name, mixed $table, mixed $columns): string","summary":"Creates a SQL command for adding an unique constraint to an existing table.","params":[{"name":"$name","type":"mixed","description":"The name of the unique constraint. The name will be properly quoted by the method."},{"name":"$table","type":"mixed","description":"The table that the unique constraint will be added to. The name will be properly quoted by the method."},{"name":"$columns","type":"mixed","description":"The name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding an unique constraint to an existing table."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite."}],"since":"2.0.13"},"alterColumn":{"signature":"public function alterColumn(string $table, string $column, string $type): string","summary":"Builds a SQL statement for changing the definition of a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be changed. The table name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be changed. The name will be properly quoted by the method."},{"name":"$type","type":"string","description":"The new column type. The `getColumnType()` method will be invoked to convert abstract column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'."}],"return":{"type":"string","description":"The SQL statement for changing the definition of a column."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite"}]},"buildLimit":{"signature":"public function buildLimit(mixed $limit, mixed $offset): string","params":[{"name":"$limit","type":"mixed"},{"name":"$offset","type":"mixed"}],"return":{"type":"string","description":"The LIMIT and OFFSET clauses"}},"buildUnion":{"signature":"public function buildUnion(mixed $unions, mixed &$params): string","params":[{"name":"$unions","type":"mixed"},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters to be populated"}],"return":{"type":"string","description":"The UNION clause built from `yii\\db\\Query::$union`."}},"checkIntegrity":{"signature":"public function checkIntegrity(bool $check = true, string $schema = '', string $table = ''): string","summary":"Enables or disables integrity check.","params":[{"name":"$check","type":"bool","default":"true","optional":true,"description":"Whether to turn on or off the integrity check."},{"name":"$schema","type":"string","default":"''","optional":true,"description":"The schema of the tables. Meaningless for SQLite."},{"name":"$table","type":"string","default":"''","optional":true,"description":"The table name. Meaningless for SQLite."}],"return":{"type":"string","description":"The SQL statement for checking integrity."}},"concatUnionSql":{"signature":"protected function concatUnionSql(string $sql, string $union): string","summary":"Concatenates the first `SELECT` statement with the UNION clauses built by `buildUnion()`.","params":[{"name":"$sql","type":"string","description":"The SQL of the first `SELECT` statement."},{"name":"$union","type":"string","description":"The UNION clauses."}],"return":{"type":"string","description":"The compound SQL with the first statement parenthesized."},"visibility":"protected","since":"22.0"},"createIndex":{"signature":"public function createIndex(mixed $name, mixed $table, mixed $columns, mixed $unique = false): string","summary":"Builds a SQL statement for creating a new index.","params":[{"name":"$name","type":"mixed","description":"The name of the index. The name will be properly quoted by the method."},{"name":"$table","type":"mixed","description":"The table that the new index will be created for. The table name will be properly quoted by the method."},{"name":"$columns","type":"mixed","description":"The column(s) that should be included in the index. If there are multiple columns, separate them with commas or use an array to represent them. Each column name will be properly quoted by the method, unless a parenthesis is found in the name."},{"name":"$unique","type":"mixed","default":"false","optional":true,"description":"Whether to add UNIQUE constraint on the created index."}],"return":{"type":"string","description":"The SQL statement for creating a new index."}},"defaultExpressionBuilders":{"signature":"protected function defaultExpressionBuilders(): array","summary":"Contains array of default expression builders. Extend this method and override it, if you want to change default expression builders for this query builder. See `$expressionBuilders` docs for details.","return":{"type":"array"},"visibility":"protected","since":"2.0.14"},"dropCheck":{"signature":"public function dropCheck(mixed $name, mixed $table): string","summary":"Creates a SQL command for dropping a check constraint.","params":[{"name":"$name","type":"mixed","description":"The name of the check constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"mixed","description":"The table whose check constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping a check constraint."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite."}],"since":"2.0.13"},"dropColumn":{"signature":"public function dropColumn(string $table, string $column): string","summary":"Builds a SQL statement for dropping a DB column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be dropped. The name will be properly quoted by the method."},{"name":"$column","type":"string","description":"The name of the column to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping a DB column."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite"}]},"dropCommentFromColumn":{"signature":"public function dropCommentFromColumn(mixed $table, mixed $column): string","summary":"Builds a SQL command for adding comment to column.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."},{"name":"$column","type":"mixed","description":"The name of the column to be commented. The column name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"throws":[{"type":"yii\\base\\NotSupportedException"}],"since":"2.0.8"},"dropCommentFromTable":{"signature":"public function dropCommentFromTable(mixed $table): string","summary":"Builds a SQL command for adding comment to table.","params":[{"name":"$table","type":"mixed","description":"The table whose column is to be commented. The table name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for adding comment on column"},"throws":[{"type":"yii\\base\\NotSupportedException"}],"since":"2.0.8"},"dropDefaultValue":{"signature":"public function dropDefaultValue(mixed $name, mixed $table): string","summary":"Creates a SQL command for dropping a default value constraint.","params":[{"name":"$name","type":"mixed","description":"The name of the default value constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"mixed","description":"The table whose default value constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping a default value constraint."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite."}],"since":"2.0.13"},"dropForeignKey":{"signature":"public function dropForeignKey(string $name, string $table): string","summary":"Builds a SQL statement for dropping a foreign key constraint.","params":[{"name":"$name","type":"string","description":"The name of the foreign key constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose foreign is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping a foreign key constraint."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite"}]},"dropIndex":{"signature":"public function dropIndex(string $name, string $table): string","summary":"Builds a SQL statement for dropping an index.","params":[{"name":"$name","type":"string","description":"The name of the index to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"string","description":"The table whose index is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping an index."}},"dropPrimaryKey":{"signature":"public function dropPrimaryKey(string $name, string $table): string","summary":"Builds a SQL statement for removing a primary key constraint to an existing table.","params":[{"name":"$name","type":"string","description":"The name of the primary key constraint to be removed."},{"name":"$table","type":"string","description":"The table that the primary key constraint will be removed from."}],"return":{"type":"string","description":"The SQL statement for removing a primary key constraint from an existing table."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite"}]},"dropUnique":{"signature":"public function dropUnique(mixed $name, mixed $table): string","summary":"Creates a SQL command for dropping an unique constraint.","params":[{"name":"$name","type":"mixed","description":"The name of the unique constraint to be dropped. The name will be properly quoted by the method."},{"name":"$table","type":"mixed","description":"The table whose unique constraint is to be dropped. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for dropping an unique constraint."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite."}],"since":"2.0.13"},"renameColumn":{"signature":"public function renameColumn(string $table, string $oldName, string $newName): string","summary":"Builds a SQL statement for renaming a column.","params":[{"name":"$table","type":"string","description":"The table whose column is to be renamed. The name will be properly quoted by the method."},{"name":"$oldName","type":"string","description":"The old name of the column. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new name of the column. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for renaming a DB column."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"this is not supported by SQLite"}]},"renameTable":{"signature":"public function renameTable(string $table, string $newName): string","summary":"Builds a SQL statement for renaming a DB table.","params":[{"name":"$table","type":"string","description":"The table to be renamed. The name will be properly quoted by the method."},{"name":"$newName","type":"string","description":"The new table name. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for renaming a DB table."}},"resetSequence":{"signature":"public function resetSequence(string $tableName, int|null $value = null): string","summary":"Creates a SQL statement for resetting the sequence value of a table's primary key.","params":[{"name":"$tableName","type":"string","description":"The name of the table whose primary key sequence will be reset."},{"name":"$value","type":"int|null","default":"null","optional":true,"description":"The integer value for the primary key of the next new row inserted. If this is not set, the next new row's primary key will have a value `1`."}],"return":{"type":"string","description":"The SQL statement for resetting sequence."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the table does not exist or there is no sequence associated with the table."}]},"truncateTable":{"signature":"public function truncateTable(string $table): string","summary":"Builds a SQL statement for truncating a DB table.","params":[{"name":"$table","type":"string","description":"The table to be truncated. The name will be properly quoted by the method."}],"return":{"type":"string","description":"The SQL statement for truncating a DB table."}},"upsert":{"signature":"public function upsert(mixed $table, mixed $insertColumns, mixed $updateColumns, mixed &$params): string","summary":"Creates an SQL statement to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.","params":[{"name":"$table","type":"mixed","description":"The table that new rows will be inserted into/updated in."},{"name":"$insertColumns","type":"mixed","description":"The column data (name => value) to be inserted into the table or instance of `yii\\db\\Query` to perform `INSERT INTO ... SELECT` SQL statement."},{"name":"$updateColumns","type":"mixed","description":"The column data (name => value) to be updated if they already exist. If `true` is passed, the column data will be updated to match the insert column data. If `false` is passed, no update will be performed if the column data already exists."},{"name":"$params","type":"mixed","byReference":true,"description":"The binding parameters that will be generated by this method. They should be bound to the DB command later."}],"return":{"type":"string","description":"The resulting SQL."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this is not supported by the underlying DBMS."}],"since":"2.0.14"}},"inherited":{"properties":{"conditionClasses":"yii\\db\\QueryBuilder","db":"yii\\db\\QueryBuilder","expressionBuilders":"yii\\db\\QueryBuilder","separator":"yii\\db\\QueryBuilder"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\db\\QueryBuilder","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","addColumn":"yii\\db\\QueryBuilder","batchInsert":"yii\\db\\QueryBuilder","bindParam":"yii\\db\\QueryBuilder","build":"yii\\db\\QueryBuilder","buildColumns":"yii\\db\\QueryBuilder","buildCondition":"yii\\db\\QueryBuilder","buildExpression":"yii\\db\\QueryBuilder","buildFrom":"yii\\db\\QueryBuilder","buildGroupBy":"yii\\db\\QueryBuilder","buildHaving":"yii\\db\\QueryBuilder","buildJoin":"yii\\db\\QueryBuilder","buildOrderBy":"yii\\db\\QueryBuilder","buildOrderByAndLimit":"yii\\db\\QueryBuilder","buildSelect":"yii\\db\\QueryBuilder","buildUnionOrderByAndLimit":"yii\\db\\QueryBuilder","buildWhere":"yii\\db\\QueryBuilder","buildWithQueries":"yii\\db\\QueryBuilder","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","createConditionFromArray":"yii\\db\\QueryBuilder","createTable":"yii\\db\\QueryBuilder","createView":"yii\\db\\QueryBuilder","defaultConditionClasses":"yii\\db\\QueryBuilder","delete":"yii\\db\\QueryBuilder","dropTable":"yii\\db\\QueryBuilder","dropView":"yii\\db\\QueryBuilder","executeResetSequence":"yii\\db\\QueryBuilder","extractAlias":"yii\\db\\QueryBuilder","getColumnType":"yii\\db\\QueryBuilder","getExpressionBuilder":"yii\\db\\QueryBuilder","hasLimit":"yii\\db\\QueryBuilder","hasMethod":"yii\\base\\BaseObject","hasOffset":"yii\\db\\QueryBuilder","hasProperty":"yii\\base\\BaseObject","init":"yii\\db\\QueryBuilder","insert":"yii\\db\\QueryBuilder","prepareInsertSelectSubQuery":"yii\\db\\QueryBuilder","prepareInsertValues":"yii\\db\\QueryBuilder","prepareSelectQuery":"yii\\db\\QueryBuilder","prepareUpdateSets":"yii\\db\\QueryBuilder","prepareUpsertColumns":"yii\\db\\QueryBuilder","prepareUpsertSets":"yii\\db\\QueryBuilder","selectExists":"yii\\db\\QueryBuilder","setConditionClasses":"yii\\db\\QueryBuilder","setExpressionBuilders":"yii\\db\\QueryBuilder","update":"yii\\db\\QueryBuilder"},"constants":{"PARAM_PREFIX":"yii\\db\\QueryBuilder"}}},"yii\\db\\sqlite\\Schema":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/sqlite/schema/","summary":"Schema is the class for retrieving metadata from a SQLite (2/3) database.","since":"2.0","extends":"yii\\db\\Schema","implements":["yii\\db\\ConstraintFinderInterface","yii\\base\\Configurable"],"traits":["yii\\db\\ConstraintFinderTrait"],"properties":{"columnQuoteCharacter":{"type":"string|string[]","default":"'`'","visibility":"protected","since":"2.0.14"},"columnSchemaClass":{"type":"class-string|array{class?: class-string, __class?: class-string}","default":"\\yii\\db\\sqlite\\ColumnSchema::class","since":"2.0.11"},"tableQuoteCharacter":{"type":"string|string[]","default":"'`'","visibility":"protected","since":"2.0.14"},"transactionIsolationLevel":{"type":"string","description":"The transaction isolation level to use for this transaction.","access":"write-only","virtual":true},"typeMap":{"type":"array","default":"['tinyint' => self::TYPE_TINYINT, 'bit' => self::TYPE_SMALLINT, 'boolean' => self::TYPE_BOOLEAN, 'bool' => self::TYPE_BOOLEAN, 'smallint' => self::TYPE_SMALLINT, 'mediumint' => self::TYPE_INTEGER, 'int' => self::TYPE_INTEGER, 'integer' => self::TYPE_INTEGER, 'bigint' => self::TYPE_BIGINT, 'float' => self::TYPE_FLOAT, 'double' => self::TYPE_DOUBLE, 'real' => self::TYPE_FLOAT, 'decimal' => self::TYPE_DECIMAL, 'numeric' => self::TYPE_DECIMAL, 'tinytext' => self::TYPE_TEXT, 'mediumtext' => self::TYPE_TEXT, 'longtext' => self::TYPE_TEXT, 'text' => self::TYPE_TEXT, 'varchar' => self::TYPE_STRING, 'string' => self::TYPE_STRING, 'char' => self::TYPE_CHAR, 'blob' => self::TYPE_BINARY, 'datetime' => self::TYPE_DATETIME, 'year' => self::TYPE_DATE, 'date' => self::TYPE_DATE, 'time' => self::TYPE_TIME, 'timestamp' => self::TYPE_TIMESTAMP, 'enum' => self::TYPE_STRING]","description":"Mapping from physical column types (keys) to abstract column types (values)"}},"methods":{"createColumnSchemaBuilder":{"signature":"public function createColumnSchemaBuilder(mixed $type, mixed $length = null): yii\\db\\sqlite\\ColumnSchemaBuilder","summary":"Create a column schema builder instance giving the type and value precision.","params":[{"name":"$type","type":"mixed","description":"Type of the column. See `yii\\db\\sqlite\\ColumnSchemaBuilder::$type`."},{"name":"$length","type":"mixed","default":"null","optional":true,"description":"Length or precision of the column. See `yii\\db\\sqlite\\ColumnSchemaBuilder::$length`."}],"return":{"type":"yii\\db\\sqlite\\ColumnSchemaBuilder","description":"Column schema builder instance"},"since":"2.0.6"},"createQueryBuilder":{"signature":"public function createQueryBuilder(): yii\\db\\sqlite\\QueryBuilder","summary":"Creates a query builder for the MySQL database.","return":{"type":"yii\\db\\sqlite\\QueryBuilder","description":"Query builder instance"}},"findColumns":{"signature":"protected function findColumns(yii\\db\\TableSchema $table): bool","summary":"Collects the table column metadata.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"bool","description":"Whether the table exists in the database"},"visibility":"protected"},"findConstraints":{"signature":"protected function findConstraints(yii\\db\\TableSchema $table): mixed","summary":"Collects the foreign key column details for the given table.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"mixed"},"visibility":"protected"},"findTableNames":{"signature":"protected function findTableNames(mixed $schema = ''): array","summary":"Returns all table names in the database.","params":[{"name":"$schema","type":"mixed","default":"''","optional":true,"description":"The schema of the tables. Defaults to empty string, meaning the current or default schema."}],"return":{"type":"array","description":"All table names in the database. The names have NO schema name prefix."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is not supported by the DBMS."}],"visibility":"protected"},"findUniqueIndexes":{"signature":"public function findUniqueIndexes(yii\\db\\TableSchema $table): array","summary":"Returns all unique indexes for the given table.","params":[{"name":"$table","type":"yii\\db\\TableSchema","description":"The table metadata"}],"return":{"type":"array","description":"All unique indexes for the given table."}},"loadColumnSchema":{"signature":"protected function loadColumnSchema(array $info): yii\\db\\sqlite\\T","summary":"Loads the column information into a `yii\\db\\sqlite\\ColumnSchema` object.","params":[{"name":"$info","type":"array","description":"Column information"}],"return":{"type":"yii\\db\\sqlite\\T","description":"The column schema object"},"visibility":"protected"},"loadTableChecks":{"signature":"protected function loadTableChecks(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableDefaultValues":{"signature":"protected function loadTableDefaultValues(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"throws":[{"type":"yii\\base\\NotSupportedException","description":"if this method is called."}],"visibility":"protected"},"loadTableForeignKeys":{"signature":"protected function loadTableForeignKeys(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableIndexes":{"signature":"protected function loadTableIndexes(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTablePrimaryKey":{"signature":"protected function loadTablePrimaryKey(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"loadTableSchema":{"signature":"protected function loadTableSchema(mixed $name): yii\\db\\TableSchema|null","summary":"Loads the metadata for the specified table.","params":[{"name":"$name","type":"mixed","description":"Table name"}],"return":{"type":"yii\\db\\TableSchema|null","description":"DBMS-dependent table metadata, `null` if the table does not exist."},"visibility":"protected"},"loadTableUniques":{"signature":"protected function loadTableUniques(mixed $tableName)","params":[{"name":"$tableName","type":"mixed"}],"visibility":"protected"},"quoteValue":{"signature":"public function quoteValue(mixed $value): mixed","summary":"Quotes a string value for use in a query.","params":[{"name":"$value","type":"mixed"}],"return":{"type":"mixed","description":"The properly quoted string, or the original data if it is not a string."}},"setTransactionIsolationLevel":{"signature":"public function setTransactionIsolationLevel(string $level): mixed","summary":"Sets the isolation level of the current transaction.","params":[{"name":"$level","type":"string","description":"The transaction isolation level to use for this transaction. This can be either `yii\\db\\Transaction::READ_UNCOMMITTED` or `yii\\db\\Transaction::SERIALIZABLE`."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\NotSupportedException","description":"when unsupported isolation levels are used. SQLite only supports SERIALIZABLE and READ UNCOMMITTED."}]}},"inherited":{"properties":{"db":"yii\\db\\Schema","defaultSchema":"yii\\db\\Schema","exceptionMap":"yii\\db\\Schema","lastInsertID":"yii\\db\\Schema","queryBuilder":"yii\\db\\Schema","schemaChecks":"yii\\db\\ConstraintFinderTrait","schemaDefaultValues":"yii\\db\\ConstraintFinderTrait","schemaForeignKeys":"yii\\db\\ConstraintFinderTrait","schemaIndexes":"yii\\db\\ConstraintFinderTrait","schemaNames":"yii\\db\\Schema","schemaPrimaryKeys":"yii\\db\\ConstraintFinderTrait","schemaUniques":"yii\\db\\ConstraintFinderTrait","serverVersion":"yii\\db\\Schema","systemSchemaNames":"yii\\db\\Schema","tableNames":"yii\\db\\Schema","tableSchemas":"yii\\db\\Schema"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","convertException":"yii\\db\\Schema","createColumnSchema":"yii\\db\\Schema","createSavepoint":"yii\\db\\Schema","findSchemaNames":"yii\\db\\Schema","getCacheKey":"yii\\db\\Schema","getCacheTag":"yii\\db\\Schema","getColumnPhpType":"yii\\db\\Schema","getLastInsertID":"yii\\db\\Schema","getPdoType":"yii\\db\\Schema","getQueryBuilder":"yii\\db\\Schema","getRawTableName":"yii\\db\\Schema","getSchemaChecks":"yii\\db\\ConstraintFinderTrait","getSchemaDefaultValues":"yii\\db\\ConstraintFinderTrait","getSchemaForeignKeys":"yii\\db\\ConstraintFinderTrait","getSchemaIndexes":"yii\\db\\ConstraintFinderTrait","getSchemaMetadata":"yii\\db\\Schema","getSchemaNames":"yii\\db\\Schema","getSchemaPrimaryKeys":"yii\\db\\ConstraintFinderTrait","getSchemaUniques":"yii\\db\\ConstraintFinderTrait","getServerVersion":"yii\\db\\Schema","getTableChecks":"yii\\db\\ConstraintFinderTrait","getTableDefaultValues":"yii\\db\\ConstraintFinderTrait","getTableForeignKeys":"yii\\db\\ConstraintFinderTrait","getTableIndexes":"yii\\db\\ConstraintFinderTrait","getTableMetadata":"yii\\db\\Schema","getTableNameParts":"yii\\db\\Schema","getTableNames":"yii\\db\\Schema","getTablePrimaryKey":"yii\\db\\ConstraintFinderTrait","getTableSchema":"yii\\db\\Schema","getTableSchemas":"yii\\db\\Schema","getTableUniques":"yii\\db\\ConstraintFinderTrait","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","insert":"yii\\db\\Schema","isReadQuery":"yii\\db\\Schema","normalizePdoRowKeyCase":"yii\\db\\Schema","quoteColumnName":"yii\\db\\Schema","quoteSimpleColumnName":"yii\\db\\Schema","quoteSimpleTableName":"yii\\db\\Schema","quoteTableName":"yii\\db\\Schema","refresh":"yii\\db\\Schema","refreshTableSchema":"yii\\db\\Schema","releaseSavepoint":"yii\\db\\Schema","resolveRawTableName":"yii\\db\\Schema","resolveTableName":"yii\\db\\Schema","rollBackSavepoint":"yii\\db\\Schema","setTableMetadata":"yii\\db\\Schema","supportsSavepoint":"yii\\db\\Schema","unquoteSimpleColumnName":"yii\\db\\Schema","unquoteSimpleTableName":"yii\\db\\Schema"},"constants":{"TYPE_PK":"yii\\db\\Schema","TYPE_UPK":"yii\\db\\Schema","TYPE_BIGPK":"yii\\db\\Schema","TYPE_UBIGPK":"yii\\db\\Schema","TYPE_CHAR":"yii\\db\\Schema","TYPE_STRING":"yii\\db\\Schema","TYPE_TEXT":"yii\\db\\Schema","TYPE_TINYINT":"yii\\db\\Schema","TYPE_SMALLINT":"yii\\db\\Schema","TYPE_INTEGER":"yii\\db\\Schema","TYPE_BIGINT":"yii\\db\\Schema","TYPE_FLOAT":"yii\\db\\Schema","TYPE_DOUBLE":"yii\\db\\Schema","TYPE_DECIMAL":"yii\\db\\Schema","TYPE_DATETIME":"yii\\db\\Schema","TYPE_TIMESTAMP":"yii\\db\\Schema","TYPE_TIME":"yii\\db\\Schema","TYPE_DATE":"yii\\db\\Schema","TYPE_BINARY":"yii\\db\\Schema","TYPE_BOOLEAN":"yii\\db\\Schema","TYPE_MONEY":"yii\\db\\Schema","TYPE_JSON":"yii\\db\\Schema","SCHEMA_CACHE_VERSION":"yii\\db\\Schema"}}},"yii\\db\\sqlite\\SqlTokenizer":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/sqlite/sqltokenizer/","summary":"SqlTokenizer splits SQLite query into individual SQL tokens.","since":"2.0.13","extends":"yii\\db\\SqlTokenizer","implements":["yii\\base\\Configurable"],"methods":{"isComment":{"signature":"protected function isComment(mixed &$length): bool","summary":"Returns whether there's a commentary at the current offset.","params":[{"name":"$length","type":"mixed","byReference":true,"description":"Length of the matched string."}],"return":{"type":"bool","description":"Whether there's a commentary at the current offset."},"visibility":"protected"},"isIdentifier":{"signature":"protected function isIdentifier(mixed &$length, mixed &$content): bool","summary":"Returns whether there's an identifier at the current offset.","params":[{"name":"$length","type":"mixed","byReference":true,"description":"Length of the matched string."},{"name":"$content","type":"mixed","byReference":true,"description":"Optional content instead of the matched string."}],"return":{"type":"bool","description":"Whether there's an identifier at the current offset."},"visibility":"protected"},"isKeyword":{"signature":"protected function isKeyword(mixed $string, mixed &$content): bool","summary":"Returns whether the given string is a keyword.","params":[{"name":"$string","type":"mixed","description":"String to be matched."},{"name":"$content","type":"mixed","byReference":true,"description":"Optional content instead of the matched string."}],"return":{"type":"bool","description":"Whether the given string is a keyword."},"visibility":"protected"},"isOperator":{"signature":"protected function isOperator(mixed &$length, mixed &$content): bool","summary":"Returns whether there's an operator at the current offset.","params":[{"name":"$length","type":"mixed","byReference":true,"description":"Length of the matched string."},{"name":"$content","type":"mixed","byReference":true,"description":"Optional content instead of the matched string."}],"return":{"type":"bool","description":"Whether there's an operator at the current offset."},"visibility":"protected"},"isStringLiteral":{"signature":"protected function isStringLiteral(mixed &$length, mixed &$content): bool","summary":"Returns whether there's a string literal at the current offset.","params":[{"name":"$length","type":"mixed","byReference":true,"description":"Length of the matched string."},{"name":"$content","type":"mixed","byReference":true,"description":"Optional content instead of the matched string."}],"return":{"type":"bool","description":"Whether there's a string literal at the current offset."},"visibility":"protected"},"isWhitespace":{"signature":"protected function isWhitespace(mixed &$length): bool","summary":"Returns whether there's a whitespace at the current offset.","params":[{"name":"$length","type":"mixed","byReference":true,"description":"Length of the matched string."}],"return":{"type":"bool","description":"Whether there's a whitespace at the current offset."},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component","length":"yii\\db\\SqlTokenizer","offset":"yii\\db\\SqlTokenizer","sql":"yii\\db\\SqlTokenizer"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\db\\SqlTokenizer","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","indexAfter":"yii\\db\\SqlTokenizer","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","startsWithAnyLongest":"yii\\db\\SqlTokenizer","substring":"yii\\db\\SqlTokenizer","tokenize":"yii\\db\\SqlTokenizer","trigger":"yii\\base\\Component"}}},"yii\\db\\sqlite\\conditions\\InConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/sqlite/conditions/inconditionbuilder/","summary":"Builds objects of `yii\\db\\conditions\\InCondition`.","since":"2.0.14","extends":"yii\\db\\conditions\\InConditionBuilder","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"methods":{"buildSubqueryInCondition":{"signature":"protected function buildSubqueryInCondition(string $operator, array|string|yii\\db\\ExpressionInterface $columns, yii\\db\\Query $values, array &$params): string","summary":"Builds SQL for IN condition.","params":[{"name":"$operator","type":"string","description":"Operator in uppercase."},{"name":"$columns","type":"array|string|yii\\db\\ExpressionInterface","description":"The columns to be matched."},{"name":"$values","type":"yii\\db\\Query","description":"Subquery values."},{"name":"$params","type":"array","byReference":true,"description":"The binding parameters."}],"return":{"type":"string","description":"SQL for IN condition."},"throws":[{"type":"yii\\base\\NotSupportedException","description":"if `$columns` is an array"}],"visibility":"protected"},"getNotEqualOperator":{"signature":"protected function getNotEqualOperator(): string","summary":"Returns inequality operator for decomposed `NOT IN` conditions.","return":{"type":"string","description":"Inequality operator."},"visibility":"protected"}},"inherited":{"properties":{"queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait","build":"yii\\db\\conditions\\InConditionBuilder","buildCompositeInCondition":"yii\\db\\conditions\\InConditionBuilder","buildValues":"yii\\db\\conditions\\InConditionBuilder","getNullCondition":"yii\\db\\conditions\\InConditionBuilder"}}},"yii\\db\\sqlite\\conditions\\LikeConditionBuilder":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/db/sqlite/conditions/likeconditionbuilder/","summary":"Class LikeConditionBuilder builds objects of `yii\\db\\conditions\\LikeCondition`","extends":"yii\\db\\conditions\\LikeConditionBuilder","implements":["yii\\db\\ExpressionBuilderInterface"],"traits":["yii\\db\\ExpressionBuilderTrait"],"properties":{"escapeCharacter":{"type":"string|null","default":"'\\\\'","visibility":"protected"}},"inherited":{"properties":{"escapingReplacements":"yii\\db\\conditions\\LikeConditionBuilder","queryBuilder":"yii\\db\\ExpressionBuilderTrait"},"methods":{"__construct":"yii\\db\\ExpressionBuilderTrait","build":"yii\\db\\conditions\\LikeConditionBuilder","parseOperator":"yii\\db\\conditions\\LikeConditionBuilder"}}},"yii\\di\\Container":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/di/container/","summary":"Container implements a [dependency injection](https://en.wikipedia.org/wiki/Dependency_injection) container.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"definitions":{"type":"array","description":"The list of the object definitions or the loaded shared objects (type or ID => definition or instance).","virtual":true},"resolveArrays":{"type":"bool","description":"Whether to attempt to resolve elements in array dependencies.","access":"write-only","virtual":true},"singleton":{"type":"string","description":"Class name, interface name or alias name","access":"write-only","virtual":true},"singletons":{"type":"array","description":"Array of singleton definitions.","access":"write-only","virtual":true}},"methods":{"build":{"signature":"protected function build(class-string $class, array $params, array $config): yii\\di\\T","summary":"Creates an instance of the specified class.","params":[{"name":"$class","type":"class-string","description":"The class name"},{"name":"$params","type":"array","description":"Constructor parameters"},{"name":"$config","type":"array","description":"Configurations to be applied to the new instance"}],"return":{"type":"yii\\di\\T","description":"The newly created instance of the specified class"},"throws":[{"type":"yii\\di\\NotInstantiableException","description":"If resolved to an abstract class or an interface (since 2.0.9)"}],"visibility":"protected"},"clear":{"signature":"public function clear(string $class): mixed","summary":"Removes the definition for the specified name.","params":[{"name":"$class","type":"string","description":"Class name, interface name or alias name"}],"return":{"type":"mixed"}},"get":{"signature":"public function get(string|class-string|yii\\di\\Instance $class, array $params = [], array $config = []): ($class is class-string ? yii\\di\\T : object)","summary":"Returns an instance of the requested class.","params":[{"name":"$class","type":"string|class-string|yii\\di\\Instance","description":"The class Instance, name, or an alias name (e.g. `foo`) that was previously registered via `set()` or `setSingleton()`."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"A list of constructor parameter values. Use one of two definitions: - Parameters as name-value pairs, for example: `['posts' => PostRepository::class]`. - Parameters in the order they appear in the constructor declaration. If you want to skip some parameters, you should index the remaining ones with the integers that represent their positions in the constructor parameter list. Dependencies indexed by name and by position in the same array are not allowed."},{"name":"$config","type":"array","default":"[]","optional":true,"description":"A list of name-value pairs that will be used to initialize the object properties."}],"return":{"type":"($class is class-string ? yii\\di\\T : object)","description":"An instance of the requested class."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the class cannot be recognized or correspond to an invalid definition"},{"type":"yii\\di\\NotInstantiableException","description":"If resolved to an abstract class or an interface (since 2.0.9)"}]},"getDefinitions":{"signature":"public function getDefinitions(): array","summary":"Returns the list of the object definitions or the loaded shared objects.","return":{"type":"array","description":"The list of the object definitions or the loaded shared objects (type or ID => definition or instance)."}},"getDependencies":{"signature":"protected function getDependencies(class-string $class): array{ReflectionClass, array}","summary":"Returns the dependencies of the specified class.","params":[{"name":"$class","type":"class-string","description":"Class name, interface name or alias name"}],"return":{"type":"array{ReflectionClass, array}","description":"The dependencies of the specified class."},"throws":[{"type":"yii\\di\\NotInstantiableException","description":"if a dependency cannot be resolved or if a dependency cannot be fulfilled."}],"visibility":"protected"},"has":{"signature":"public function has(string $class): bool","summary":"Returns a value indicating whether the container has the definition of the specified name.","params":[{"name":"$class","type":"string","description":"Class name, interface name or alias name"}],"return":{"type":"bool","description":"Whether the container has the definition of the specified name."}},"hasSingleton":{"signature":"public function hasSingleton(string $class, bool $checkInstance = false): bool","summary":"Returns a value indicating whether the given name corresponds to a registered singleton.","params":[{"name":"$class","type":"string","description":"Class name, interface name or alias name"},{"name":"$checkInstance","type":"bool","default":"false","optional":true,"description":"Whether to check if the singleton has been instantiated."}],"return":{"type":"bool","description":"Whether the given name corresponds to a registered singleton. If `$checkInstance` is true, the method should return a value indicating whether the singleton has been instantiated."}},"invoke":{"signature":"public function invoke(callable $callback, array $params = []): mixed","summary":"Invoke a callback with resolving dependencies in parameters.","params":[{"name":"$callback","type":"callable","description":"Callable to be invoked."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The array of parameters for the function. This can be either a list of parameters, or an associative array representing named function parameters."}],"return":{"type":"mixed","description":"The callback return value."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if a dependency cannot be resolved or if a dependency cannot be fulfilled."},{"type":"yii\\di\\NotInstantiableException","description":"If resolved to an abstract class or an interface (since 2.0.9)"}],"since":"2.0.7"},"mergeParams":{"signature":"protected function mergeParams(string $class, array $params): array","summary":"Merges the user-specified constructor parameters with the ones registered via `set()`.","params":[{"name":"$class","type":"string","description":"Class name, interface name or alias name"},{"name":"$params","type":"array","description":"The constructor parameters"}],"return":{"type":"array","description":"The merged parameters"},"visibility":"protected"},"normalizeDefinition":{"signature":"protected function normalizeDefinition(string $class, string|array|callable $definition): array","summary":"Normalizes the class definition.","params":[{"name":"$class","type":"string","description":"Class name"},{"name":"$definition","type":"string|array|callable","description":"The class definition"}],"return":{"type":"array","description":"The normalized class definition"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the definition is invalid."}],"visibility":"protected"},"resolveCallableDependencies":{"signature":"public function resolveCallableDependencies(callable $callback, array $params = []): array","summary":"Resolve dependencies for a function.","params":[{"name":"$callback","type":"callable","description":"Callable to be invoked."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The array of parameters for the function, can be either numeric or associative."}],"return":{"type":"array","description":"The resolved dependencies."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if a dependency cannot be resolved or if a dependency cannot be fulfilled."},{"type":"yii\\di\\NotInstantiableException","description":"If resolved to an abstract class or an interface (since 2.0.9)"}],"since":"2.0.7"},"resolveDependencies":{"signature":"protected function resolveDependencies(array $dependencies, ReflectionClass|null $reflection = null): array","summary":"Resolves dependencies by replacing them with the actual object instances.","params":[{"name":"$dependencies","type":"array","description":"The dependencies"},{"name":"$reflection","type":"ReflectionClass|null","default":"null","optional":true,"description":"The class reflection associated with the dependencies"}],"return":{"type":"array","description":"The resolved dependencies"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if a dependency cannot be resolved or if a dependency cannot be fulfilled."}],"visibility":"protected"},"set":{"signature":"public function set(string $class, mixed $definition = [], array $params = []): $this","summary":"Registers a class definition with this container.","params":[{"name":"$class","type":"string","description":"Class name, interface name or alias name"},{"name":"$definition","type":"mixed","default":"[]","optional":true,"description":"The definition associated with `$class`. It can be one of the following: - a PHP callable: The callable will be executed when `get()` is invoked. The signature of the callable should be `function ($container, $params, $config)`, where `$params` stands for the list of constructor parameters, `$config` the object configuration, and `$container` the container object. The return value of the callable will be returned by `get()` as the object instance requested. - a configuration array: the array contains name-value pairs that will be used to initialize the property values of the newly created object when `get()` is called. The `class` element stands for the class of the object to be created. If `class` is not specified, `$class` will be used as the class name. - a string: a class name, an interface name or an alias name."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The list of constructor parameters. The parameters will be passed to the class constructor when `get()` is called."}],"return":{"type":"$this","description":"The container itself"}},"setDefinitions":{"signature":"public function setDefinitions(array $definitions): mixed","summary":"Registers class definitions within this container.","params":[{"name":"$definitions","type":"array","description":"Array of definitions. There are two allowed formats of array. The first format: - key: class name, interface name or alias name. The key will be passed to the `set()` method as a first argument `$class`. - value: the definition associated with `$class`. Possible values are described in `set()` documentation for the `$definition` parameter. Will be passed to the `set()` method as the second argument `$definition`. Example: ``` $container->setDefinitions([ 'yii\\web\\Request' => 'app\\components\\Request', 'yii\\web\\Response' => [ 'class' => 'app\\components\\Response', 'format' => 'json' ], 'foo\\Bar' => function () { $qux = new Qux; $foo = new Foo($qux); return new Bar($foo); } ]); ``` The second format: - key: class name, interface name or alias name. The key will be passed to the `set()` method as a first argument `$class`. - value: array of two elements. The first element will be passed the `set()` method as the second argument `$definition`, the second one — as `$params`. Example: ``` $container->setDefinitions([ 'foo\\Bar' => [ ['class' => 'app\\Bar'], [Instance::of('baz')] ] ]); ```"}],"return":{"type":"mixed"},"since":"2.0.11"},"setResolveArrays":{"signature":"public function setResolveArrays(bool $value): mixed","params":[{"name":"$value","type":"bool","description":"Whether to attempt to resolve elements in array dependencies"}],"return":{"type":"mixed"},"since":"2.0.37"},"setSingleton":{"signature":"public function setSingleton(string $class, mixed $definition = [], array $params = []): $this","summary":"Registers a class definition with this container and marks the class as a singleton class.","params":[{"name":"$class","type":"string","description":"Class name, interface name or alias name"},{"name":"$definition","type":"mixed","default":"[]","optional":true,"description":"The definition associated with `$class`. See `set()` for more details."},{"name":"$params","type":"array","default":"[]","optional":true,"description":"The list of constructor parameters. The parameters will be passed to the class constructor when `get()` is called."}],"return":{"type":"$this","description":"The container itself"}},"setSingletons":{"signature":"public function setSingletons(array $singletons): mixed","summary":"Registers class definitions as singletons within this container by calling `setSingleton()`.","params":[{"name":"$singletons","type":"array","description":"Array of singleton definitions. See `setDefinitions()` for allowed formats of array."}],"return":{"type":"mixed"},"since":"2.0.11"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\di\\Instance":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/di/instance/","summary":"Instance represents a reference to a named object in a dependency injection (DI) container or a service locator.","since":"2.0","properties":{"id":{"type":"string","default":"null","description":"The component ID, class name, interface name or alias name"},"optional":{"type":"bool","default":"null","description":"If null should be returned instead of throwing an exception"}},"methods":{"__construct":{"signature":"protected function __construct(string $id, bool $optional = false)","summary":"Constructor.","params":[{"name":"$id","type":"string","description":"The component ID"},{"name":"$optional","type":"bool","default":"false","optional":true,"description":"If null should be returned instead of throwing an exception"}],"visibility":"protected"},"__set_state":{"signature":"public static function __set_state(array $state): yii\\di\\Instance","summary":"Restores class state after using `var_export()`.","params":[{"name":"$state","type":"array"}],"return":{"type":"yii\\di\\Instance"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"when $state property does not contain `id` parameter"}],"static":true,"since":"2.0.12"},"ensure":{"signature":"public static function ensure(object|string|array|static $reference, class-string|null $type = null, yii\\di\\ServiceLocator|yii\\di\\Container|null $container = null): ($type is null ? object : yii\\di\\T)","summary":"Resolves the specified reference into the actual object and makes sure it is of the specified type.","params":[{"name":"$reference","type":"object|string|array|static","description":"An object or a reference to the desired object. You may specify a reference in terms of a component ID or an Instance object. Starting from version 2.0.2, you may also pass in a configuration array for creating the object. If the \"class\" value is not specified in the configuration array, it will use the value of `$type`."},{"name":"$type","type":"class-string|null","default":"null","optional":true,"description":"The class/interface name to be checked. If null, type check will not be performed."},{"name":"$container","type":"yii\\di\\ServiceLocator|yii\\di\\Container|null","default":"null","optional":true,"description":"The container. This will be passed to `get()`."}],"return":{"type":"($type is null ? object : yii\\di\\T)","description":"The object referenced by the Instance, or `$reference` itself if it is an object."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the reference is invalid"}],"static":true},"get":{"signature":"public function get(yii\\di\\ServiceLocator|yii\\di\\Container|null $container = null): object|null","summary":"Returns the actual object referenced by this Instance object.","params":[{"name":"$container","type":"yii\\di\\ServiceLocator|yii\\di\\Container|null","default":"null","optional":true,"description":"The container used to locate the referenced object. If null, the method will first try `Yii::$app` then `Yii::$container`."}],"return":{"type":"object|null","description":"The actual object referenced by this Instance object."}},"of":{"signature":"public static function of(string $id, bool $optional = false): yii\\di\\Instance","summary":"Creates a new Instance object.","params":[{"name":"$id","type":"string","description":"The component ID"},{"name":"$optional","type":"bool","default":"false","optional":true,"description":"If null should be returned instead of throwing an exception"}],"return":{"type":"yii\\di\\Instance","description":"The new Instance object."},"static":true}}},"yii\\di\\NotInstantiableException":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/di/notinstantiableexception/","summary":"NotInstantiableException represents an exception caused by incorrect dependency injection container configuration or usage.","since":"2.0.9","extends":"yii\\base\\InvalidConfigException","methods":{"__construct":{"signature":"public function __construct(mixed $class, mixed $message = null, mixed $code = 0, mixed $previous = null)","params":[{"name":"$class","type":"mixed"},{"name":"$message","type":"mixed","default":"null","optional":true},{"name":"$code","type":"mixed","default":"0","optional":true},{"name":"$previous","type":"mixed","default":"null","optional":true}]},"getName":{"signature":"public function getName(): string","return":{"type":"string","description":"The user-friendly name of this exception"}}}},"yii\\di\\ServiceLocator":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/di/servicelocator/","summary":"ServiceLocator implements a [service locator](https://en.wikipedia.org/wiki/Service_locator_pattern).","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"components":{"type":"array","description":"The list of the component definitions or the loaded component instances (ID => definition or instance).","virtual":true}},"methods":{"__get":{"signature":"public function __get(string $name): mixed","summary":"Getter magic method.","params":[{"name":"$name","type":"string","description":"Component or property name"}],"return":{"type":"mixed","description":"The named property value"}},"__isset":{"signature":"public function __isset(string $name): bool","summary":"Checks if a property value is null.","params":[{"name":"$name","type":"string","description":"The property name or the event name"}],"return":{"type":"bool","description":"Whether the property value is null"}},"clear":{"signature":"public function clear(string $id): mixed","summary":"Removes the component from the locator.","params":[{"name":"$id","type":"string","description":"The component ID"}],"return":{"type":"mixed"}},"get":{"signature":"public function get(string $id, bool $throwException = true): ($throwException is true ? object : object|null)","summary":"Returns the component instance with the specified ID.","params":[{"name":"$id","type":"string","description":"Component ID (e.g. `db`)."},{"name":"$throwException","type":"bool","default":"true","optional":true,"description":"Whether to throw an exception if `$id` is not registered with the locator before."}],"return":{"type":"($throwException is true ? object : object|null)","description":"The component of the specified ID. If `$throwException` is false and `$id` is not registered before, null will be returned."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$id` refers to a nonexistent component ID"}]},"getComponents":{"signature":"public function getComponents(bool $returnDefinitions = true): array","summary":"Returns the list of the component definitions or the loaded component instances.","params":[{"name":"$returnDefinitions","type":"bool","default":"true","optional":true,"description":"Whether to return component definitions instead of the loaded component instances."}],"return":{"type":"array","description":"The list of the component definitions or the loaded component instances (ID => definition or instance)."}},"has":{"signature":"public function has(string $id, bool $checkInstance = false): bool","summary":"Returns a value indicating whether the locator has the specified component definition or has instantiated the component.","params":[{"name":"$id","type":"string","description":"Component ID (e.g. `db`)."},{"name":"$checkInstance","type":"bool","default":"false","optional":true,"description":"Whether the method should check if the component is shared and instantiated."}],"return":{"type":"bool","description":"Whether the locator has the specified component definition or has instantiated the component."}},"set":{"signature":"public function set(string $id, mixed $definition): mixed","summary":"Registers a component definition with this locator.","params":[{"name":"$id","type":"string","description":"Component ID (e.g. `db`)."},{"name":"$definition","type":"mixed","description":"The component definition to be registered with this locator. It can be one of the following: - a class name - a configuration array: the array contains name-value pairs that will be used to initialize the property values of the newly created object when `get()` is called. The `class` element is required and stands for the the class of the object to be created. - a PHP callable: either an anonymous function or an array representing a class method (e.g. `['Foo', 'bar']`). The callable will be called by `get()` to return an object associated with the specified component ID. - an object: When `get()` is called, this object will be returned."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the definition is an invalid configuration array"}]},"setComponents":{"signature":"public function setComponents(array $components): mixed","summary":"Registers a set of component definitions in this locator.","params":[{"name":"$components","type":"array","description":"Component definitions or instances"}],"return":{"type":"mixed"}}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\filters\\AccessControl":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/accesscontrol/","summary":"AccessControl provides simple access control based on a set of rules.","since":"2.0","extends":"yii\\base\\ActionFilter","implements":["yii\\base\\Configurable"],"properties":{"denyCallback":{"type":"callable|null","default":"null","description":"A callback that will be called if the access should be denied to the current user."},"ruleConfig":{"type":"array","default":"['class' => 'yii\\filters\\AccessRule']","description":"The default configuration of access rules."},"rules":{"type":"array","default":"[]","description":"A list of access rule objects or configuration arrays for creating the rule objects."},"user":{"type":"yii\\web\\User|array|string|false","default":"'user'","description":"The user object representing the authentication status or the ID of the user application component."}},"methods":{"beforeAction":{"signature":"public function beforeAction(mixed $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.","params":[{"name":"$action","type":"mixed","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"denyAccess":{"signature":"protected function denyAccess(yii\\web\\User|false $user): mixed","summary":"Denies the access of the user.","params":[{"name":"$user","type":"yii\\web\\User|false","description":"The current user or boolean `false` in case of detached User component"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\web\\ForbiddenHttpException","description":"if the user is already logged in or in case of detached User component."}],"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes the `$rules` array by instantiating rule objects from configurations.","return":{"type":"mixed"}}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter"}}},"yii\\filters\\AccessRule":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/accessrule/","summary":"This class represents an access rule defined by the `yii\\filters\\AccessControl` action filter.","since":"2.0","extends":"yii\\base\\Component","implements":["yii\\base\\Configurable"],"properties":{"actions":{"type":"array|null","default":"null","description":"List of action IDs that this rule applies to."},"allow":{"type":"bool","default":"false","description":"Whether this is an 'allow' rule or 'deny' rule."},"controllers":{"type":"array|null","default":"null","description":"List of the controller IDs that this rule applies to."},"denyCallback":{"type":"callable|null","default":"null","description":"A callback that will be called if this rule determines the access to the current action should be denied."},"ips":{"type":"array|null","default":"null","description":"List of user IP addresses that this rule applies to."},"matchCallback":{"type":"callable","default":"null","description":"A callback that will be called to determine if the rule should be applied."},"permissions":{"type":"array|null","default":"null","description":"List of RBAC (Role-Based Access Control) permissions that this rules applies to. `yii\\web\\User::can()` will be called to check access.","since":"2.0.12"},"roleParams":{"type":"array|object|Closure","default":"[]","description":"Parameters to pass to the `yii\\web\\User::can()` function for evaluating user permissions in `$roles`.","since":"2.0.12"},"roles":{"type":"array|null","default":"null","description":"List of roles that this rule applies to (requires properly configured User component)."},"verbs":{"type":"array|null","default":"null","description":"List of request methods (e.g. `GET`, `POST`) that this rule applies to."}},"methods":{"allows":{"signature":"public function allows(yii\\base\\Action $action, yii\\web\\User|false $user, yii\\web\\Request $request): bool|null","summary":"Checks whether the Web user is allowed to perform the specified action.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action to be performed"},{"name":"$user","type":"yii\\web\\User|false","description":"The user object or `false` in case of detached User component"},{"name":"$request","type":"yii\\web\\Request"}],"return":{"type":"bool|null","description":"`true` if the user is allowed, `false` if the user is denied, `null` if the rule does not apply to the user"}},"matchAction":{"signature":"protected function matchAction(yii\\base\\Action $action): bool","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action"}],"return":{"type":"bool","description":"Whether the rule applies to the action"},"visibility":"protected"},"matchController":{"signature":"protected function matchController(yii\\base\\Controller|null $controller): bool","params":[{"name":"$controller","type":"yii\\base\\Controller|null","description":"The controller, or `null` when the action runs as a standalone action dispatched by `yii\\base\\Module::$actionMap` (since 22.0)."}],"return":{"type":"bool","description":"Whether the rule applies to the controller."},"visibility":"protected"},"matchCustom":{"signature":"protected function matchCustom(yii\\base\\Action $action): bool","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action to be performed"}],"return":{"type":"bool","description":"Whether the rule should be applied"},"visibility":"protected"},"matchIP":{"signature":"protected function matchIP(string|null $ip): bool","params":[{"name":"$ip","type":"string|null","description":"The IP address"}],"return":{"type":"bool","description":"Whether the rule applies to the IP address"},"visibility":"protected"},"matchRole":{"signature":"protected function matchRole(yii\\web\\User $user): bool","params":[{"name":"$user","type":"yii\\web\\User","description":"The user object"}],"return":{"type":"bool","description":"Whether the rule applies to the role"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if User component is detached"}],"visibility":"protected"},"matchVerb":{"signature":"protected function matchVerb(string $verb): bool","params":[{"name":"$verb","type":"string","description":"The request method."}],"return":{"type":"bool","description":"Whether the rule applies to the request"},"visibility":"protected"}},"inherited":{"properties":{"behaviors":"yii\\base\\Component"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","off":"yii\\base\\Component","on":"yii\\base\\Component","trigger":"yii\\base\\Component"}}},"yii\\filters\\AjaxFilter":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/ajaxfilter/","summary":"AjaxFilter allow to limit access only for ajax requests.","since":"2.0.13","extends":"yii\\base\\ActionFilter","implements":["yii\\base\\Configurable"],"properties":{"errorMessage":{"type":"string","default":"'Request must be XMLHttpRequest.'","description":"The message to be displayed when request isn't ajax"},"request":{"type":"yii\\web\\Request|null","default":"null","description":"The current request."}},"methods":{"beforeAction":{"signature":"public function beforeAction(mixed $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.","params":[{"name":"$action","type":"mixed","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter"}}},"yii\\filters\\ContentNegotiator":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/contentnegotiator/","summary":"ContentNegotiator supports response format negotiation and application language negotiation.","since":"2.0","extends":"yii\\base\\ActionFilter","implements":["yii\\base\\BootstrapInterface","yii\\base\\Configurable"],"properties":{"formatParam":{"type":"string","default":"'_format'","description":"The name of the GET parameter that specifies the response format."},"formats":{"type":"array|null","default":"null","description":"List of supported response formats."},"languageParam":{"type":"string","default":"'_lang'","description":"The name of the GET parameter that specifies the application language (`yii\\base\\Application::$language`)."},"languages":{"type":"array|null","default":"null","description":"A list of supported languages."},"request":{"type":"yii\\web\\Request","default":"null","description":"The current request."},"response":{"type":"yii\\web\\Response|null","default":"null","description":"The response to be sent."}},"methods":{"beforeAction":{"signature":"public function beforeAction(mixed $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.","params":[{"name":"$action","type":"mixed","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"bootstrap":{"signature":"public function bootstrap(mixed $app): mixed","summary":"Bootstrap method to be called during application bootstrap stage.","params":[{"name":"$app","type":"mixed","description":"The application currently running"}],"return":{"type":"mixed"}},"isLanguageSupported":{"signature":"protected function isLanguageSupported(string $requested, string $supported): bool","summary":"Returns a value indicating whether the requested language matches the supported language.","params":[{"name":"$requested","type":"string","description":"The requested language code"},{"name":"$supported","type":"string","description":"The supported language code"}],"return":{"type":"bool","description":"Whether the requested language is supported"},"visibility":"protected"},"negotiate":{"signature":"public function negotiate(): mixed","summary":"Negotiates the response format and application language.","return":{"type":"mixed"}},"negotiateContentType":{"signature":"protected function negotiateContentType(yii\\web\\Request $request, yii\\web\\Response $response): mixed","summary":"Negotiates the response format.","params":[{"name":"$request","type":"yii\\web\\Request"},{"name":"$response","type":"yii\\web\\Response"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\web\\BadRequestHttpException","description":"if an array received for GET parameter `$formatParam`."},{"type":"yii\\web\\NotAcceptableHttpException","description":"if none of the requested content types is accepted."}],"visibility":"protected"},"negotiateLanguage":{"signature":"protected function negotiateLanguage(yii\\web\\Request $request): string","summary":"Negotiates the application language.","params":[{"name":"$request","type":"yii\\web\\Request"}],"return":{"type":"string","description":"The chosen language"},"visibility":"protected"}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter"}}},"yii\\filters\\Cors":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/cors/","summary":"Cors filter implements [Cross Origin Resource Sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing).","since":"2.0","extends":"yii\\base\\ActionFilter","implements":["yii\\base\\Configurable"],"properties":{"actions":{"type":"array","default":"[]","description":"Define specific CORS rules for specific actions"},"cors":{"type":"array","default":"['Origin' => ['*'], 'Access-Control-Request-Method' => ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS'], 'Access-Control-Request-Headers' => ['*'], 'Access-Control-Allow-Credentials' => null, 'Access-Control-Max-Age' => 86400, 'Access-Control-Expose-Headers' => []]","description":"Basic headers handled for the CORS requests."},"request":{"type":"yii\\web\\Request|null","default":"null","description":"The current request."},"response":{"type":"yii\\web\\Response|null","default":"null","description":"The response to be sent."}},"methods":{"addCorsHeaders":{"signature":"public function addCorsHeaders(yii\\web\\Response $response, array $headers): mixed","summary":"Adds the CORS headers to the response.","params":[{"name":"$response","type":"yii\\web\\Response"},{"name":"$headers","type":"array","description":"CORS headers which have been computed"}],"return":{"type":"mixed"}},"beforeAction":{"signature":"public function beforeAction(mixed $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.","params":[{"name":"$action","type":"mixed","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"extractHeaders":{"signature":"public function extractHeaders(): array","summary":"Extract CORS headers from the request.","return":{"type":"array","description":"CORS headers to handle"}},"headerize":{"signature":"protected function headerize(string $string): string","summary":"Convert any string (including php headers with HTTP prefix) to header format.","params":[{"name":"$string","type":"string","description":"String to convert"}],"return":{"type":"string","description":"The result in \"header\" format"},"visibility":"protected"},"headerizeToPhp":{"signature":"protected function headerizeToPhp(string $string): string","summary":"Convert any string (including php headers with HTTP prefix) to header format.","params":[{"name":"$string","type":"string","description":"String to convert"}],"return":{"type":"string","description":"The result in \"php $_SERVER header\" format"},"visibility":"protected"},"overrideDefaultSettings":{"signature":"public function overrideDefaultSettings(yii\\base\\Action $action): mixed","summary":"Override settings for specific action.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action settings to override"}],"return":{"type":"mixed"}},"prepareAllowHeaders":{"signature":"protected function prepareAllowHeaders(string $type, array $requestHeaders, array &$responseHeaders): mixed","summary":"Handle classic CORS request to avoid duplicate code.","params":[{"name":"$type","type":"string","description":"The kind of headers we would handle"},{"name":"$requestHeaders","type":"array","description":"CORS headers request by client"},{"name":"$responseHeaders","type":"array","byReference":true,"description":"CORS response headers sent to the client"}],"return":{"type":"mixed"},"visibility":"protected"},"prepareHeaders":{"signature":"public function prepareHeaders(array $requestHeaders): array","summary":"For each CORS headers create the specific response.","params":[{"name":"$requestHeaders","type":"array","description":"CORS headers we have detected"}],"return":{"type":"array","description":"CORS headers ready to be sent"}}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter"}}},"yii\\filters\\HostControl":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/hostcontrol/","summary":"HostControl provides simple control over requested host name.","since":"2.0.11","extends":"yii\\base\\ActionFilter","implements":["yii\\base\\Configurable"],"properties":{"allowedHosts":{"type":"array|Closure|null","default":"null","description":"List of host names, which are allowed."},"denyCallback":{"type":"callable|null","default":"null","description":"A callback that will be called if the current host does not match `$allowedHosts`."},"fallbackHostInfo":{"type":"string|null","default":"''","description":"Fallback host info (e.g. `https://www.yiiframework.com`) used when Request::$hostInfo (`yii\\web\\Request::$hostInfo`) is invalid."}},"methods":{"beforeAction":{"signature":"public function beforeAction(mixed $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.","params":[{"name":"$action","type":"mixed","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"denyAccess":{"signature":"protected function denyAccess(yii\\base\\Action $action): mixed","summary":"Denies the access.","params":[{"name":"$action","type":"yii\\base\\Action","description":"The action to be executed."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\web\\NotFoundHttpException"}],"visibility":"protected"}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter"}}},"yii\\filters\\HttpCache":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/httpcache/","summary":"HttpCache implements client-side caching by utilizing the `Last-Modified` and `ETag` HTTP headers.","since":"2.0","extends":"yii\\base\\ActionFilter","implements":["yii\\base\\Configurable"],"properties":{"cacheControlHeader":{"type":"string|null","default":"'public, max-age=3600'","description":"The value of the `Cache-Control` HTTP header."},"enabled":{"type":"bool","default":"true","description":"A value indicating whether this filter should be enabled."},"etagSeed":{"type":"callable","default":"null","description":"A PHP callback that generates the ETag seed string."},"lastModified":{"type":"callable","default":"null","description":"A PHP callback that returns the UNIX timestamp of the last modification time."},"params":{"type":"mixed","default":"null","description":"Additional parameters that should be passed to the `$lastModified` and `$etagSeed` callbacks."},"sessionCacheLimiter":{"type":"string|null","default":"''","description":"The name of the cache limiter to be set when [session_cache_limiter()](https://www.php.net/manual/en/function.session-cache-limiter.php) is called."},"weakEtag":{"type":"bool","default":"false","description":"Whether to generate weak ETags.","since":"2.0.8"}},"methods":{"beforeAction":{"signature":"public function beforeAction(mixed $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.","params":[{"name":"$action","type":"mixed","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"generateEtag":{"signature":"protected function generateEtag(string $seed): string","summary":"Generates an ETag from the given seed string.","params":[{"name":"$seed","type":"string","description":"Seed for the ETag"}],"return":{"type":"string","description":"The generated ETag"},"visibility":"protected"},"sendCacheControlHeader":{"signature":"protected function sendCacheControlHeader(): mixed","summary":"Sends the cache control header to the client.","return":{"type":"mixed"},"visibility":"protected"},"validateCache":{"signature":"protected function validateCache(int|null $lastModified, string|null $etag): bool","summary":"Validates if the HTTP cache contains valid content.","params":[{"name":"$lastModified","type":"int|null","description":"The calculated Last-Modified value in terms of a UNIX timestamp. If null, the Last-Modified header will not be validated."},{"name":"$etag","type":"string|null","description":"The calculated ETag value. If null, the ETag header will not be validated."}],"return":{"type":"bool","description":"Whether the HTTP cache is still valid."},"visibility":"protected"}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter"}}},"yii\\filters\\PageCache":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/pagecache/","summary":"PageCache implements server-side caching of whole pages.","since":"2.0","extends":"yii\\base\\ActionFilter","implements":["yii\\base\\DynamicContentAwareInterface","yii\\base\\Configurable"],"traits":["yii\\base\\DynamicContentAwareTrait"],"properties":{"cache":{"type":"yii\\caching\\CacheInterface|array|string","default":"'cache'","description":"The cache object or the application component ID of the cache object."},"cacheCookies":{"type":"bool|array","default":"false","description":"A boolean value indicating whether to cache all cookies, or an array of cookie names indicating which cookies can be cached.","since":"2.0.4"},"cacheHeaders":{"type":"bool|array","default":"true","description":"A boolean value indicating whether to cache all HTTP headers, or an array of HTTP header names (case-sensitive) indicating which HTTP headers can be cached.","since":"2.0.4"},"dependency":{"type":"array|yii\\caching\\Dependency","default":"null","description":"The dependency that the cached content depends on."},"duration":{"type":"int","default":"60","description":"Number of seconds that the data can remain valid in cache."},"enabled":{"type":"bool","default":"true","description":"Whether to enable the page cache."},"variations":{"type":"string[]|string|callable","default":"null","description":"List of factors that would cause the variation of the content being cached."},"varyByRoute":{"type":"bool","default":"true","description":"Whether the content being cached should be differentiated according to the route."},"view":{"type":"yii\\base\\View|null","default":"null","description":"The view component to use for caching."}},"methods":{"afterRestoreResponse":{"signature":"public function afterRestoreResponse(array|null $data): mixed","summary":"This method is invoked right after the response restoring is finished (but before the response is sent).","params":[{"name":"$data","type":"array|null","description":"An array of an additional data stored in a cache entry or `null`."}],"return":{"type":"mixed"},"since":"2.0.11"},"beforeAction":{"signature":"public function beforeAction(mixed $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.","params":[{"name":"$action","type":"mixed","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"beforeCacheResponse":{"signature":"public function beforeCacheResponse(): bool|array","summary":"This method is invoked right before the response caching is to be started.","return":{"type":"bool|array","description":"Whether to cache or not, return an array instead of `true` to store an additional data."},"since":"2.0.11"},"cacheResponse":{"signature":"public function cacheResponse(): mixed","summary":"Caches response properties.","return":{"type":"mixed"},"since":"2.0.3"},"calculateCacheKey":{"signature":"protected function calculateCacheKey(): array","return":{"type":"array","description":"The key used to cache response properties."},"visibility":"protected","since":"2.0.3"},"getView":{"signature":"public function getView()"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"restoreResponse":{"signature":"protected function restoreResponse(yii\\web\\Response $response, array $data): mixed","summary":"Restores response properties from the given data.","params":[{"name":"$response","type":"yii\\web\\Response","description":"The response to be restored."},{"name":"$data","type":"array","description":"The response property data."}],"return":{"type":"mixed"},"visibility":"protected","since":"2.0.3"}},"constants":{"PAGE_CACHE_VERSION":{"value":"1","description":"Page cache version, to detect incompatibilities in cached values when the data format of the cache changes."}},"inherited":{"properties":{"dynamicPlaceholders":"yii\\base\\DynamicContentAwareTrait","except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","addDynamicPlaceholder":"yii\\base\\DynamicContentAwareTrait","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","getDynamicPlaceholders":"yii\\base\\DynamicContentAwareTrait","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter","setDynamicPlaceholders":"yii\\base\\DynamicContentAwareTrait","updateDynamicContent":"yii\\base\\DynamicContentAwareTrait"}}},"yii\\filters\\RateLimitInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/filters/ratelimitinterface/","summary":"RateLimitInterface is the interface that may be implemented by an identity object to enforce rate limiting.","since":"2.0","methods":{"getRateLimit":{"signature":"abstract public function getRateLimit(yii\\web\\Request $request, yii\\base\\Action $action): array","summary":"Returns the maximum number of allowed requests and the window size.","params":[{"name":"$request","type":"yii\\web\\Request","description":"The current request"},{"name":"$action","type":"yii\\base\\Action","description":"The action to be executed"}],"return":{"type":"array","description":"An array of two elements. The first element is the maximum number of allowed requests, and the second element is the size of the window in seconds."},"abstract":true},"loadAllowance":{"signature":"abstract public function loadAllowance(yii\\web\\Request $request, yii\\base\\Action $action): array","summary":"Loads the number of allowed requests and the corresponding timestamp from a persistent storage.","params":[{"name":"$request","type":"yii\\web\\Request","description":"The current request"},{"name":"$action","type":"yii\\base\\Action","description":"The action to be executed"}],"return":{"type":"array","description":"An array of two elements. The first element is the number of allowed requests, and the second element is the corresponding UNIX timestamp."},"abstract":true},"saveAllowance":{"signature":"abstract public function saveAllowance(yii\\web\\Request $request, yii\\base\\Action $action, int $allowance, int $timestamp): mixed","summary":"Saves the number of allowed requests and the corresponding timestamp to a persistent storage.","params":[{"name":"$request","type":"yii\\web\\Request","description":"The current request"},{"name":"$action","type":"yii\\base\\Action","description":"The action to be executed"},{"name":"$allowance","type":"int","description":"The number of allowed requests remaining."},{"name":"$timestamp","type":"int","description":"The current timestamp."}],"return":{"type":"mixed"},"abstract":true}}},"yii\\filters\\RateLimiter":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/ratelimiter/","summary":"RateLimiter implements a rate limiting algorithm based on the [leaky bucket algorithm](https://en.wikipedia.org/wiki/Leaky_bucket).","since":"2.0","extends":"yii\\base\\ActionFilter","implements":["yii\\base\\Configurable"],"properties":{"enableRateLimitHeaders":{"type":"bool","default":"true","description":"Whether to include rate limit headers in the response"},"errorMessage":{"type":"string","default":"'Rate limit exceeded.'","description":"The message to be displayed when rate limit exceeds"},"request":{"type":"yii\\web\\Request|null","default":"null","description":"The current request."},"response":{"type":"yii\\web\\Response|null","default":"null","description":"The response to be sent."},"user":{"type":"yii\\filters\\RateLimitInterface|yii\\web\\IdentityInterface|Closure|null","default":"null","description":"The user object that implements the RateLimitInterface."}},"methods":{"addRateLimitHeaders":{"signature":"public function addRateLimitHeaders(yii\\web\\Response $response, int $limit, int $remaining, int $reset): mixed","summary":"Adds the rate limit headers to the response.","params":[{"name":"$response","type":"yii\\web\\Response"},{"name":"$limit","type":"int","description":"The maximum number of allowed requests during a period"},{"name":"$remaining","type":"int","description":"The remaining number of allowed requests within the current period"},{"name":"$reset","type":"int","description":"The number of seconds to wait before having maximum number of allowed requests again"}],"return":{"type":"mixed"}},"beforeAction":{"signature":"public function beforeAction(mixed $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.","params":[{"name":"$action","type":"mixed","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"checkRateLimit":{"signature":"public function checkRateLimit(yii\\filters\\RateLimitInterface $user, yii\\web\\Request $request, yii\\web\\Response $response, yii\\base\\Action $action): mixed","summary":"Checks whether the rate limit exceeds.","params":[{"name":"$user","type":"yii\\filters\\RateLimitInterface","description":"The current user"},{"name":"$request","type":"yii\\web\\Request"},{"name":"$response","type":"yii\\web\\Response"},{"name":"$action","type":"yii\\base\\Action","description":"The action to be executed"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\web\\TooManyRequestsHttpException","description":"if rate limit exceeds"}]},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter"}}},"yii\\filters\\VerbFilter":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/verbfilter/","summary":"VerbFilter is an action filter that filters by HTTP request methods.","since":"2.0","extends":"yii\\base\\Behavior","implements":["yii\\base\\Configurable"],"properties":{"actions":{"type":"array","default":"[]","description":"This property defines the allowed request methods for each action."}},"methods":{"beforeAction":{"signature":"public function beforeAction(yii\\base\\ActionEvent $event): bool","params":[{"name":"$event","type":"yii\\base\\ActionEvent"}],"return":{"type":"bool"},"throws":[{"type":"yii\\web\\MethodNotAllowedHttpException","description":"when the request method is not allowed."}]},"events":{"signature":"public function events(): array","summary":"Declares event handlers for the `$owner`'s events.","return":{"type":"array","description":"Events (array keys) and the corresponding event handler methods (array values)."}}},"inherited":{"properties":{"owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","attach":"yii\\base\\Behavior","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\Behavior","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\filters\\auth\\AuthInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/api/yii/filters/auth/authinterface/","summary":"AuthInterface is the interface that should be implemented by auth method classes.","since":"2.0","methods":{"authenticate":{"signature":"abstract public function authenticate(yii\\web\\User $user, yii\\web\\Request $request, yii\\web\\Response $response): yii\\web\\IdentityInterface|null","summary":"Authenticates the current user.","params":[{"name":"$user","type":"yii\\web\\User"},{"name":"$request","type":"yii\\web\\Request"},{"name":"$response","type":"yii\\web\\Response"}],"return":{"type":"yii\\web\\IdentityInterface|null","description":"The authenticated user identity. If authentication information is not provided, null will be returned."},"throws":[{"type":"yii\\web\\UnauthorizedHttpException","description":"if authentication information is provided but is invalid."}],"abstract":true},"challenge":{"signature":"abstract public function challenge(yii\\web\\Response $response): mixed","summary":"Generates challenges upon authentication failure.","params":[{"name":"$response","type":"yii\\web\\Response"}],"return":{"type":"mixed"},"abstract":true},"handleFailure":{"signature":"abstract public function handleFailure(yii\\web\\Response $response): mixed","summary":"Handles authentication failure.","params":[{"name":"$response","type":"yii\\web\\Response"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\web\\UnauthorizedHttpException"}],"abstract":true}}},"yii\\filters\\auth\\AuthMethod":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/api/yii/filters/auth/authmethod/","summary":"AuthMethod is a base class implementing the `yii\\filters\\auth\\AuthInterface` interface.","since":"2.0","extends":"yii\\base\\ActionFilter","implements":["yii\\filters\\auth\\AuthInterface","yii\\base\\Configurable"],"properties":{"optional":{"type":"array","default":"[]","description":"List of action IDs that this filter will be applied to, but auth failure will not lead to error.","since":"2.0.7"},"request":{"type":"yii\\web\\Request|null","default":"null","description":"The current request."},"response":{"type":"yii\\web\\Response|null","default":"null","description":"The response to be sent."},"user":{"type":"yii\\web\\User|null","default":"null","description":"The user object representing the user authentication status."}},"methods":{"beforeAction":{"signature":"public function beforeAction(mixed $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.","params":[{"name":"$action","type":"mixed","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"challenge":{"signature":"public function challenge(mixed $response): mixed","summary":"Generates challenges upon authentication failure.","params":[{"name":"$response","type":"mixed"}],"return":{"type":"mixed"}},"handleFailure":{"signature":"public function handleFailure(mixed $response): mixed","summary":"Handles authentication failure.","params":[{"name":"$response","type":"mixed"}],"return":{"type":"mixed"},"throws":[{"type":"yii\\web\\UnauthorizedHttpException"}]},"isOptional":{"signature":"protected function isOptional(yii\\base\\Action $action): bool","summary":"Checks, whether authentication is optional for the given action.","params":[{"name":"$action","type":"yii\\base\\Action","description":"Action to be checked."}],"return":{"type":"bool","description":"Whether authentication is optional or not."},"visibility":"protected","since":"2.0.7"}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","owner":"yii\\base\\Behavior"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","authenticate":"yii\\filters\\auth\\AuthInterface","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter"}}},"yii\\filters\\auth\\CompositeAuth":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/auth/compositeauth/","summary":"CompositeAuth is an action filter that supports multiple authentication methods at the same time.","since":"2.0","extends":"yii\\filters\\auth\\AuthMethod","implements":["yii\\filters\\auth\\AuthInterface","yii\\base\\Configurable"],"properties":{"authMethods":{"type":"list|array{class: class-string}>","default":"[]","description":"The supported authentication methods."}},"methods":{"authenticate":{"signature":"public function authenticate(mixed $user, mixed $request, mixed $response): yii\\web\\IdentityInterface|null","summary":"Authenticates the current user.","params":[{"name":"$user","type":"mixed"},{"name":"$request","type":"mixed"},{"name":"$response","type":"mixed"}],"return":{"type":"yii\\web\\IdentityInterface|null","description":"The authenticated user identity. If authentication information is not provided, null will be returned."},"throws":[{"type":"yii\\web\\UnauthorizedHttpException","description":"if authentication information is provided but is invalid."}]},"beforeAction":{"signature":"public function beforeAction(mixed $action): bool","summary":"This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.","params":[{"name":"$action","type":"mixed","description":"The action to be executed."}],"return":{"type":"bool","description":"Whether the action should continue to be executed."}},"challenge":{"signature":"public function challenge(mixed $response): mixed","summary":"Generates challenges upon authentication failure.","params":[{"name":"$response","type":"mixed"}],"return":{"type":"mixed"}}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","optional":"yii\\filters\\auth\\AuthMethod","owner":"yii\\base\\Behavior","request":"yii\\filters\\auth\\AuthMethod","response":"yii\\filters\\auth\\AuthMethod","user":"yii\\filters\\auth\\AuthMethod"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","handleFailure":"yii\\filters\\auth\\AuthMethod","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter","isOptional":"yii\\filters\\auth\\AuthMethod"}}},"yii\\filters\\auth\\HttpBasicAuth":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/auth/httpbasicauth/","summary":"HttpBasicAuth is an action filter that supports the HTTP Basic authentication method.","since":"2.0","extends":"yii\\filters\\auth\\AuthMethod","implements":["yii\\filters\\auth\\AuthInterface","yii\\base\\Configurable"],"properties":{"auth":{"type":"callable|null","default":"null","description":"A PHP callable that will authenticate the user with the HTTP basic auth information."},"realm":{"type":"string","default":"'api'","description":"The HTTP authentication realm"}},"methods":{"authenticate":{"signature":"public function authenticate(mixed $user, mixed $request, mixed $response): yii\\web\\IdentityInterface|null","summary":"Authenticates the current user.","params":[{"name":"$user","type":"mixed"},{"name":"$request","type":"mixed"},{"name":"$response","type":"mixed"}],"return":{"type":"yii\\web\\IdentityInterface|null","description":"The authenticated user identity. If authentication information is not provided, null will be returned."},"throws":[{"type":"yii\\web\\UnauthorizedHttpException","description":"if authentication information is provided but is invalid."}]},"challenge":{"signature":"public function challenge(mixed $response): mixed","summary":"Generates challenges upon authentication failure.","params":[{"name":"$response","type":"mixed"}],"return":{"type":"mixed"}}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","optional":"yii\\filters\\auth\\AuthMethod","owner":"yii\\base\\Behavior","request":"yii\\filters\\auth\\AuthMethod","response":"yii\\filters\\auth\\AuthMethod","user":"yii\\filters\\auth\\AuthMethod"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeAction":"yii\\filters\\auth\\AuthMethod","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","handleFailure":"yii\\filters\\auth\\AuthMethod","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter","isOptional":"yii\\filters\\auth\\AuthMethod"}}},"yii\\filters\\auth\\HttpBearerAuth":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/auth/httpbearerauth/","summary":"HttpBearerAuth is an action filter that supports the authentication method based on HTTP Bearer token.","since":"2.0","extends":"yii\\filters\\auth\\HttpHeaderAuth","implements":["yii\\filters\\auth\\AuthInterface","yii\\base\\Configurable"],"properties":{"header":{"type":"string","default":"'Authorization'"},"pattern":{"type":"string","default":"'/^Bearer\\s+(.*?)$/'"},"realm":{"type":"string","default":"'api'","description":"The HTTP authentication realm"}},"methods":{"challenge":{"signature":"public function challenge(mixed $response): mixed","summary":"Generates challenges upon authentication failure.","params":[{"name":"$response","type":"mixed"}],"return":{"type":"mixed"}}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","optional":"yii\\filters\\auth\\AuthMethod","owner":"yii\\base\\Behavior","request":"yii\\filters\\auth\\AuthMethod","response":"yii\\filters\\auth\\AuthMethod","user":"yii\\filters\\auth\\AuthMethod"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","authenticate":"yii\\filters\\auth\\HttpHeaderAuth","beforeAction":"yii\\filters\\auth\\AuthMethod","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","handleFailure":"yii\\filters\\auth\\AuthMethod","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter","isOptional":"yii\\filters\\auth\\AuthMethod"}}},"yii\\filters\\auth\\HttpHeaderAuth":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/auth/httpheaderauth/","summary":"HttpHeaderAuth is an action filter that supports HTTP authentication through HTTP Headers.","since":"2.0.14","extends":"yii\\filters\\auth\\AuthMethod","implements":["yii\\filters\\auth\\AuthInterface","yii\\base\\Configurable"],"properties":{"header":{"type":"string","default":"'X-Api-Key'","description":"The HTTP header name"},"pattern":{"type":"string","default":"null","description":"A pattern to use to extract the HTTP authentication value"}},"methods":{"authenticate":{"signature":"public function authenticate(mixed $user, mixed $request, mixed $response): yii\\web\\IdentityInterface|null","summary":"Authenticates the current user.","params":[{"name":"$user","type":"mixed"},{"name":"$request","type":"mixed"},{"name":"$response","type":"mixed"}],"return":{"type":"yii\\web\\IdentityInterface|null","description":"The authenticated user identity. If authentication information is not provided, null will be returned."},"throws":[{"type":"yii\\web\\UnauthorizedHttpException","description":"if authentication information is provided but is invalid."}]}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","optional":"yii\\filters\\auth\\AuthMethod","owner":"yii\\base\\Behavior","request":"yii\\filters\\auth\\AuthMethod","response":"yii\\filters\\auth\\AuthMethod","user":"yii\\filters\\auth\\AuthMethod"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeAction":"yii\\filters\\auth\\AuthMethod","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","challenge":"yii\\filters\\auth\\AuthMethod","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","handleFailure":"yii\\filters\\auth\\AuthMethod","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter","isOptional":"yii\\filters\\auth\\AuthMethod"}}},"yii\\filters\\auth\\QueryParamAuth":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/filters/auth/queryparamauth/","summary":"QueryParamAuth is an action filter that supports the authentication based on the access token passed through a query parameter.","since":"2.0","extends":"yii\\filters\\auth\\AuthMethod","implements":["yii\\filters\\auth\\AuthInterface","yii\\base\\Configurable"],"properties":{"tokenParam":{"type":"string","default":"'access-token'","description":"The parameter name for passing the access token"}},"methods":{"authenticate":{"signature":"public function authenticate(mixed $user, mixed $request, mixed $response): yii\\web\\IdentityInterface|null","summary":"Authenticates the current user.","params":[{"name":"$user","type":"mixed"},{"name":"$request","type":"mixed"},{"name":"$response","type":"mixed"}],"return":{"type":"yii\\web\\IdentityInterface|null","description":"The authenticated user identity. If authentication information is not provided, null will be returned."},"throws":[{"type":"yii\\web\\UnauthorizedHttpException","description":"if authentication information is provided but is invalid."}]}},"inherited":{"properties":{"except":"yii\\base\\ActionFilter","only":"yii\\base\\ActionFilter","optional":"yii\\filters\\auth\\AuthMethod","owner":"yii\\base\\Behavior","request":"yii\\filters\\auth\\AuthMethod","response":"yii\\filters\\auth\\AuthMethod","user":"yii\\filters\\auth\\AuthMethod"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","afterAction":"yii\\base\\ActionFilter","afterFilter":"yii\\base\\ActionFilter","attach":"yii\\base\\ActionFilter","beforeAction":"yii\\filters\\auth\\AuthMethod","beforeFilter":"yii\\base\\ActionFilter","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","challenge":"yii\\filters\\auth\\AuthMethod","className":"yii\\base\\BaseObject","detach":"yii\\base\\ActionFilter","events":"yii\\base\\Behavior","getActionId":"yii\\base\\ActionFilter","handleFailure":"yii\\filters\\auth\\AuthMethod","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","isActive":"yii\\base\\ActionFilter","isOptional":"yii\\filters\\auth\\AuthMethod"}}},"yii\\grid\\ActionColumn":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/grid/actioncolumn/","summary":"ActionColumn is a column for the `yii\\grid\\GridView` widget that displays buttons for viewing and manipulating the items.","since":"2.0","extends":"yii\\grid\\Column","implements":["yii\\base\\Configurable"],"properties":{"buttonOptions":{"type":"array","default":"[]","description":"Html options to be applied to the default button (`initDefaultButton()`).","since":"2.0.4"},"buttons":{"type":"array","default":"[]","description":"Button rendering callbacks."},"controller":{"type":"string|null","default":"null","description":"The ID of the controller that should handle the actions specified here."},"headerOptions":{"type":"array","default":"['class' => 'action-column']"},"icons":{"type":"array","default":"['eye-open' => '', 'pencil' => '', 'trash' => '']","description":"Button icons.","since":"2.0.42"},"template":{"type":"string","default":"'{view} {update} {delete}'","description":"The template used for composing each cell in the action column."},"urlCreator":{"type":"callable|null","default":"null","description":"A callback that creates a button URL using the specified model information."},"visibleButtons":{"type":"array","default":"[]","description":"Visibility conditions for each button.","since":"2.0.7"}},"methods":{"createUrl":{"signature":"public function createUrl(string $action, yii\\db\\ActiveRecordInterface $model, mixed $key, int $index): string","summary":"Creates a URL for the given action and model.","params":[{"name":"$action","type":"string","description":"The button name (or action ID)"},{"name":"$model","type":"yii\\db\\ActiveRecordInterface","description":"The data model"},{"name":"$key","type":"mixed","description":"The key associated with the data model"},{"name":"$index","type":"int","description":"The current row index"}],"return":{"type":"string","description":"The created URL"}},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"initDefaultButton":{"signature":"protected function initDefaultButton(string $name, string $iconName, array $additionalOptions = []): mixed","summary":"Initializes the default button rendering callback for single button.","params":[{"name":"$name","type":"string","description":"Button name as it's written in template"},{"name":"$iconName","type":"string","description":"The icon name used as key in `$icons`"},{"name":"$additionalOptions","type":"array","default":"[]","optional":true,"description":"Array of additional options"}],"return":{"type":"mixed"},"visibility":"protected","since":"2.0.11"},"initDefaultButtons":{"signature":"protected function initDefaultButtons(): mixed","summary":"Initializes the default button rendering callbacks.","return":{"type":"mixed"},"visibility":"protected"},"renderDataCellContent":{"signature":"protected function renderDataCellContent(mixed $model, mixed $key, mixed $index): string","summary":"Renders the data cell content.","params":[{"name":"$model","type":"mixed","description":"The data model"},{"name":"$key","type":"mixed","description":"The key associated with the data model"},{"name":"$index","type":"mixed","description":"The zero-based index of the data model among the models array returned by `yii\\grid\\GridView::$dataProvider`."}],"return":{"type":"string","description":"The rendering result"},"visibility":"protected"}},"inherited":{"properties":{"content":"yii\\grid\\Column","contentOptions":"yii\\grid\\Column","filterOptions":"yii\\grid\\Column","footer":"yii\\grid\\Column","footerOptions":"yii\\grid\\Column","grid":"yii\\grid\\Column","header":"yii\\grid\\Column","options":"yii\\grid\\Column","visible":"yii\\grid\\Column"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","getHeaderCellLabel":"yii\\grid\\Column","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","renderDataCell":"yii\\grid\\Column","renderFilterCell":"yii\\grid\\Column","renderFilterCellContent":"yii\\grid\\Column","renderFooterCell":"yii\\grid\\Column","renderFooterCellContent":"yii\\grid\\Column","renderHeaderCell":"yii\\grid\\Column","renderHeaderCellContent":"yii\\grid\\Column"}}},"yii\\grid\\CheckboxColumn":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/grid/checkboxcolumn/","summary":"CheckboxColumn displays a column of checkboxes in a grid view.","since":"2.0","extends":"yii\\grid\\Column","implements":["yii\\base\\Configurable"],"properties":{"checkboxOptions":{"type":"array|Closure","default":"[]","description":"The HTML attributes for checkboxes."},"clientScript":{"type":"array|yii\\web\\client\\ClientScriptInterface|null","default":"null","description":"Client script class to use for client-side validation."},"cssClass":{"type":"string","default":"null","description":"The css class that will be used to find the checkboxes.","since":"2.0.9"},"multiple":{"type":"bool","default":"true","description":"Whether it is possible to select multiple rows."},"name":{"type":"string","default":"'selection'","description":"The name of the input checkbox input fields."}},"methods":{"getHeaderCheckBoxName":{"signature":"protected function getHeaderCheckBoxName(): string","summary":"Returns header checkbox name.","return":{"type":"string","description":"Header checkbox name"},"visibility":"protected","since":"2.0.8"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$name` is not set."}]},"registerClientScript":{"signature":"public function registerClientScript(): mixed","summary":"Registers the needed JavaScript.","return":{"type":"mixed"},"since":"2.0.8"},"renderDataCellContent":{"signature":"protected function renderDataCellContent(mixed $model, mixed $key, mixed $index): string","summary":"Renders the data cell content.","params":[{"name":"$model","type":"mixed","description":"The data model"},{"name":"$key","type":"mixed","description":"The key associated with the data model"},{"name":"$index","type":"mixed","description":"The zero-based index of the data model among the models array returned by `yii\\grid\\GridView::$dataProvider`."}],"return":{"type":"string","description":"The rendering result"},"visibility":"protected"},"renderHeaderCellContent":{"signature":"protected function renderHeaderCellContent(): string","summary":"Renders the header cell content.","return":{"type":"string","description":"The rendering result"},"visibility":"protected"}},"inherited":{"properties":{"content":"yii\\grid\\Column","contentOptions":"yii\\grid\\Column","filterOptions":"yii\\grid\\Column","footer":"yii\\grid\\Column","footerOptions":"yii\\grid\\Column","grid":"yii\\grid\\Column","header":"yii\\grid\\Column","headerOptions":"yii\\grid\\Column","options":"yii\\grid\\Column","visible":"yii\\grid\\Column"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","getHeaderCellLabel":"yii\\grid\\Column","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","renderDataCell":"yii\\grid\\Column","renderFilterCell":"yii\\grid\\Column","renderFilterCellContent":"yii\\grid\\Column","renderFooterCell":"yii\\grid\\Column","renderFooterCellContent":"yii\\grid\\Column","renderHeaderCell":"yii\\grid\\Column"}}},"yii\\grid\\Column":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/grid/column/","summary":"Column is the base class of all `yii\\grid\\GridView` column classes.","since":"2.0","extends":"yii\\base\\BaseObject","implements":["yii\\base\\Configurable"],"properties":{"content":{"type":"callable","default":"null","description":"This is a callable that will be used to generate the content of each cell."},"contentOptions":{"type":"array|Closure","default":"[]","description":"The HTML attributes for the data cell tag."},"filterOptions":{"type":"array","default":"[]","description":"The HTML attributes for the filter cell tag."},"footer":{"type":"string","default":"null","description":"The footer cell content."},"footerOptions":{"type":"array","default":"[]","description":"The HTML attributes for the footer cell tag."},"grid":{"type":"yii\\grid\\GridView","default":"null","description":"The grid view object that owns this column."},"header":{"type":"string|null","default":"null","description":"The header cell content."},"headerOptions":{"type":"array","default":"[]","description":"The HTML attributes for the header cell tag."},"options":{"type":"array","default":"[]","description":"The HTML attributes for the column group tag."},"visible":{"type":"bool","default":"true","description":"Whether this column is visible."}},"methods":{"getHeaderCellLabel":{"signature":"protected function getHeaderCellLabel(): string","summary":"Returns header cell label.","return":{"type":"string","description":"Label"},"visibility":"protected","since":"2.0.8"},"renderDataCell":{"signature":"public function renderDataCell(mixed $model, mixed $key, int $index): string","summary":"Renders a data cell.","params":[{"name":"$model","type":"mixed","description":"The data model being rendered"},{"name":"$key","type":"mixed","description":"The key associated with the data model"},{"name":"$index","type":"int","description":"The zero-based index of the data item among the item array returned by `yii\\grid\\GridView::$dataProvider`."}],"return":{"type":"string","description":"The rendering result"}},"renderDataCellContent":{"signature":"protected function renderDataCellContent(mixed $model, mixed $key, int $index): string","summary":"Renders the data cell content.","params":[{"name":"$model","type":"mixed","description":"The data model"},{"name":"$key","type":"mixed","description":"The key associated with the data model"},{"name":"$index","type":"int","description":"The zero-based index of the data model among the models array returned by `yii\\grid\\GridView::$dataProvider`."}],"return":{"type":"string","description":"The rendering result"},"visibility":"protected"},"renderFilterCell":{"signature":"public function renderFilterCell(): mixed","summary":"Renders the filter cell.","return":{"type":"mixed"}},"renderFilterCellContent":{"signature":"protected function renderFilterCellContent(): string","summary":"Renders the filter cell content.","return":{"type":"string","description":"The rendering result"},"visibility":"protected"},"renderFooterCell":{"signature":"public function renderFooterCell(): mixed","summary":"Renders the footer cell.","return":{"type":"mixed"}},"renderFooterCellContent":{"signature":"protected function renderFooterCellContent(): string","summary":"Renders the footer cell content.","return":{"type":"string","description":"The rendering result"},"visibility":"protected"},"renderHeaderCell":{"signature":"public function renderHeaderCell(): mixed","summary":"Renders the header cell.","return":{"type":"mixed"}},"renderHeaderCellContent":{"signature":"protected function renderHeaderCellContent(): string","summary":"Renders the header cell content.","return":{"type":"string","description":"The rendering result"},"visibility":"protected"}},"inherited":{"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject"}}},"yii\\grid\\DataColumn":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/grid/datacolumn/","summary":"DataColumn is the default column type for the `yii\\grid\\GridView` widget.","since":"2.0","extends":"yii\\grid\\Column","implements":["yii\\base\\Configurable"],"properties":{"attribute":{"type":"string","default":"null","description":"The attribute name associated with this column."},"enableSorting":{"type":"bool","default":"true","description":"Whether to allow sorting by this column."},"encodeLabel":{"type":"bool","default":"true","description":"Whether the header label should be HTML-encoded.","since":"2.0.1"},"filter":{"type":"string|array|null|false","default":"null","description":"The HTML code representing a filter input (e.g. a text field, a dropdown list) that is used for this data column."},"filterAttribute":{"type":"string|null","default":"null","description":"The attribute name of the `yii\\grid\\GridView::$filterModel` associated with this column.","since":"2.0.41"},"filterInputOptions":{"type":"array","default":"['id' => null]","description":"The HTML attributes for the filter input fields."},"format":{"type":"string|array|Closure","default":"'text'","description":"In which format should the value of each data model be displayed as (e.g. `\"raw\"`, `\"text\"`, `\"html\"`, `['date', 'php:Y-m-d']`)."},"label":{"type":"string|null","default":"null","description":"Label to be displayed in the header cell (`$header`) and also to be used as the sorting link label when sorting is enabled for this column."},"sortLinkOptions":{"type":"array","default":"[]","description":"The HTML attributes for the link tag in the header cell generated by `yii\\data\\Sort::link()` when sorting is enabled for this column."},"value":{"type":"string|Closure|null","default":"null","description":"An anonymous function or a string that is used to determine the value to display in the current column."}},"methods":{"getDataCellValue":{"signature":"public function getDataCellValue(mixed $model, mixed $key, int $index): string|null","summary":"Returns the data cell value.","params":[{"name":"$model","type":"mixed","description":"The data model"},{"name":"$key","type":"mixed","description":"The key associated with the data model"},{"name":"$index","type":"int","description":"The zero-based index of the data model among the models array returned by `yii\\grid\\GridView::$dataProvider`."}],"return":{"type":"string|null","description":"The data cell value"}},"getHeaderCellLabel":{"signature":"protected function getHeaderCellLabel(): string","summary":"Returns header cell label.","return":{"type":"string","description":"Label"},"visibility":"protected","since":"2.0.8"},"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"}},"renderDataCellContent":{"signature":"protected function renderDataCellContent(mixed $model, mixed $key, mixed $index): string","summary":"Renders the data cell content.","params":[{"name":"$model","type":"mixed","description":"The data model"},{"name":"$key","type":"mixed","description":"The key associated with the data model"},{"name":"$index","type":"mixed","description":"The zero-based index of the data model among the models array returned by `yii\\grid\\GridView::$dataProvider`."}],"return":{"type":"string","description":"The rendering result"},"visibility":"protected"},"renderFilterCellContent":{"signature":"protected function renderFilterCellContent(): string","summary":"Renders the filter cell content.","return":{"type":"string","description":"The rendering result"},"visibility":"protected"},"renderHeaderCellContent":{"signature":"protected function renderHeaderCellContent(): string","summary":"Renders the header cell content.","return":{"type":"string","description":"The rendering result"},"visibility":"protected"}},"inherited":{"properties":{"content":"yii\\grid\\Column","contentOptions":"yii\\grid\\Column","filterOptions":"yii\\grid\\Column","footer":"yii\\grid\\Column","footerOptions":"yii\\grid\\Column","grid":"yii\\grid\\Column","header":"yii\\grid\\Column","headerOptions":"yii\\grid\\Column","options":"yii\\grid\\Column","visible":"yii\\grid\\Column"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","renderDataCell":"yii\\grid\\Column","renderFilterCell":"yii\\grid\\Column","renderFooterCell":"yii\\grid\\Column","renderFooterCellContent":"yii\\grid\\Column","renderHeaderCell":"yii\\grid\\Column"}}},"yii\\grid\\GridView":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/grid/gridview/","summary":"The GridView widget is used to display data in a grid.","since":"2.0","extends":"yii\\widgets\\BaseListView","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"afterRow":{"type":"Closure","default":"null","description":"An anonymous function that is called once AFTER rendering each data model."},"beforeRow":{"type":"Closure","default":"null","description":"An anonymous function that is called once BEFORE rendering each data model."},"caption":{"type":"string","default":"null","description":"The caption of the grid table"},"captionOptions":{"type":"array","default":"[]","description":"The HTML attributes for the caption element."},"clientScript":{"type":"array|yii\\web\\client\\ClientScriptInterface|null","default":"null","description":"Client script class to use for client-side validation."},"columns":{"type":"array","default":"[]","description":"Grid column configuration."},"dataColumnClass":{"type":"string","default":"null","description":"The default data column class if the class name is not explicitly specified when configuring a data column."},"emptyCell":{"type":"string","default":"' '","description":"The HTML display when the content of a cell is empty."},"filterErrorOptions":{"type":"array","default":"['class' => 'field-error']","description":"The options for rendering every filter error message."},"filterErrorSummaryOptions":{"type":"array","default":"['class' => 'error-summary']","description":"The options for rendering the filter error summary."},"filterModel":{"type":"yii\\base\\Model|null","default":"null","description":"The model that keeps the user-entered filter data."},"filterOnFocusOut":{"type":"bool","default":"true","description":"Whatever to apply filters on losing focus.","since":"2.0.16"},"filterPosition":{"type":"string","default":"self::FILTER_POS_BODY","description":"Whether the filters should be displayed in the grid view."},"filterRowOptions":{"type":"array","default":"['class' => 'filters']","description":"The HTML attributes for the filter row element."},"filterSelector":{"type":"string|Closure(string, string): string","default":"null","description":"JQuery selector for selecting filter input fields."},"filterUrl":{"type":"string|array|null","default":"null","description":"The URL for returning the filtering result. `Url::to()` will be called to normalize the URL."},"footerRowOptions":{"type":"array","default":"[]","description":"The HTML attributes for the table footer row."},"formatter":{"type":"array|yii\\i18n\\Formatter|null","default":"null","description":"The formatter used to format model attribute values into displayable texts."},"headerRowOptions":{"type":"array","default":"[]","description":"The HTML attributes for the table header row."},"layout":{"type":"string","default":"\"{summary}\\n{items}\\n{pager}\"","description":"The layout that determines how different sections of the grid view should be organized."},"options":{"type":"array","default":"['class' => 'grid-view']","description":"The HTML attributes for the container tag of the grid view."},"overrideFilterSelector":{"type":"bool","default":"false","description":"If set, `$filterSelector` overrides the default selector of '#$id input, #$id select' (where $id is the filter row ID) rather than being added to it."},"placeFooterAfterBody":{"type":"bool","default":"false","description":"Whether to place footer after body in DOM if $showFooter is true","since":"2.0.14"},"rowOptions":{"type":"array|Closure","default":"[]","description":"The HTML attributes for the table body rows."},"showFooter":{"type":"bool","default":"false","description":"Whether to show the footer section of the grid table."},"showHeader":{"type":"bool","default":"true","description":"Whether to show the header section of the grid table."},"showOnEmpty":{"type":"bool","default":"true","description":"Whether to show the grid view if `$dataProvider` returns no data."},"tableOptions":{"type":"array","default":"[]","description":"The HTML attributes for the grid table element."}},"methods":{"createDataColumn":{"signature":"protected function createDataColumn(string $text): yii\\grid\\DataColumn","summary":"Creates a `yii\\grid\\DataColumn` object based on a string in the format of \"attribute:format:label\".","params":[{"name":"$text","type":"string","description":"The column specification string"}],"return":{"type":"yii\\grid\\DataColumn","description":"The column instance"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if the column specification is invalid"}],"visibility":"protected"},"getClientOptions":{"signature":"protected function getClientOptions(): array","summary":"Returns the options for the grid view JS widget.","return":{"type":"array","description":"The options"},"visibility":"protected"},"guessColumns":{"signature":"protected function guessColumns(): mixed","summary":"This function tries to guess the columns to show from the given data if `$columns` are not explicitly specified.","return":{"type":"mixed"},"visibility":"protected"},"init":{"signature":"public function init(): mixed","summary":"Initializes the grid view.","return":{"type":"mixed"}},"initColumns":{"signature":"protected function initColumns(): mixed","summary":"Creates column objects and initializes them.","return":{"type":"mixed"},"visibility":"protected"},"renderCaption":{"signature":"public function renderCaption(): bool|string","summary":"Renders the caption element.","return":{"type":"bool|string","description":"The rendered caption element or `false` if no caption element should be rendered."}},"renderColumnGroup":{"signature":"public function renderColumnGroup(): bool|string","summary":"Renders the column group HTML.","return":{"type":"bool|string","description":"The column group HTML or `false` if no column group should be rendered."}},"renderErrors":{"signature":"public function renderErrors(): string","summary":"Renders validator errors of filter model.","return":{"type":"string","description":"The rendering result."}},"renderFilters":{"signature":"public function renderFilters(): string","summary":"Renders the filter.","return":{"type":"string","description":"The rendering result."}},"renderItems":{"signature":"public function renderItems(): string","summary":"Renders the data models for the grid view.","return":{"type":"string","description":"The HTML code of table"}},"renderSection":{"signature":"public function renderSection(mixed $name): string|bool","summary":"Renders a section of the specified name.","params":[{"name":"$name","type":"mixed","description":"The section name, e.g., `{summary}`, `{items}`."}],"return":{"type":"string|bool","description":"The rendering result of the section, or false if the named section is not supported."}},"renderTableBody":{"signature":"public function renderTableBody(): string","summary":"Renders the table body.","return":{"type":"string","description":"The rendering result."}},"renderTableFooter":{"signature":"public function renderTableFooter(): string","summary":"Renders the table footer.","return":{"type":"string","description":"The rendering result."}},"renderTableHeader":{"signature":"public function renderTableHeader(): string","summary":"Renders the table header.","return":{"type":"string","description":"The rendering result."}},"renderTableRow":{"signature":"public function renderTableRow(mixed $model, mixed $key, int $index): string","summary":"Renders a table row with the given data model and key.","params":[{"name":"$model","type":"mixed","description":"The data model to be rendered"},{"name":"$key","type":"mixed","description":"The key associated with the data model"},{"name":"$index","type":"int","description":"The zero-based index of the data model among the model array returned by `$dataProvider`."}],"return":{"type":"string","description":"The rendering result"}},"run":{"signature":"public function run(): mixed","summary":"Runs the widget.","return":{"type":"mixed"}}},"constants":{"FILTER_POS_HEADER":{"value":"'header'"},"FILTER_POS_FOOTER":{"value":"'footer'"},"FILTER_POS_BODY":{"value":"'body'"}},"inherited":{"properties":{"autoIdPrefix":"yii\\base\\Widget","behaviors":"yii\\base\\Component","dataProvider":"yii\\widgets\\BaseListView","emptyText":"yii\\widgets\\BaseListView","emptyTextOptions":"yii\\widgets\\BaseListView","id":"yii\\base\\Widget","pager":"yii\\widgets\\BaseListView","sorter":"yii\\widgets\\BaseListView","summary":"yii\\widgets\\BaseListView","summaryOptions":"yii\\widgets\\BaseListView","view":"yii\\base\\Widget","viewPath":"yii\\base\\Widget"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","afterRun":"yii\\base\\Widget","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeRun":"yii\\base\\Widget","begin":"yii\\base\\Widget","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","end":"yii\\base\\Widget","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getId":"yii\\base\\Widget","getView":"yii\\base\\Widget","getViewPath":"yii\\base\\Widget","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","render":"yii\\base\\Widget","renderEmpty":"yii\\widgets\\BaseListView","renderFile":"yii\\base\\Widget","renderPager":"yii\\widgets\\BaseListView","renderSorter":"yii\\widgets\\BaseListView","renderSummary":"yii\\widgets\\BaseListView","setId":"yii\\base\\Widget","setView":"yii\\base\\Widget","trigger":"yii\\base\\Component","widget":"yii\\base\\Widget"},"events":{"EVENT_INIT":"yii\\base\\Widget","EVENT_BEFORE_RUN":"yii\\base\\Widget","EVENT_AFTER_RUN":"yii\\base\\Widget"}}},"yii\\grid\\GridViewAsset":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/grid/gridviewasset/","summary":"This asset bundle provides the javascript files for the `yii\\grid\\GridView` widget.","since":"2.0","extends":"yii\\web\\AssetBundle","implements":["yii\\base\\Configurable"],"properties":{"depends":{"default":"['yii\\web\\YiiAsset']"},"js":{"default":"['yii.gridView.js']"},"sourcePath":{"default":"'@yii/assets'"}},"inherited":{"properties":{"basePath":"yii\\web\\AssetBundle","baseUrl":"yii\\web\\AssetBundle","css":"yii\\web\\AssetBundle","cssOptions":"yii\\web\\AssetBundle","jsOptions":"yii\\web\\AssetBundle","publishOptions":"yii\\web\\AssetBundle"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\web\\AssetBundle","publish":"yii\\web\\AssetBundle","register":"yii\\web\\AssetBundle","registerAssetFiles":"yii\\web\\AssetBundle"}}},"yii\\grid\\RadioButtonColumn":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/grid/radiobuttoncolumn/","summary":"RadioButtonColumn displays a column of radio buttons in a grid view.","since":"2.0.11","extends":"yii\\grid\\Column","implements":["yii\\base\\Configurable"],"properties":{"name":{"type":"string","default":"'radioButtonSelection'","description":"The name of the input radio button input fields."},"radioOptions":{"type":"array|Closure","default":"[]","description":"The HTML attributes for the radio buttons."}},"methods":{"init":{"signature":"public function init(): mixed","summary":"Initializes the object.","return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"if `$name` is not set."}]},"renderDataCellContent":{"signature":"protected function renderDataCellContent(mixed $model, mixed $key, mixed $index): string","summary":"Renders the data cell content.","params":[{"name":"$model","type":"mixed","description":"The data model"},{"name":"$key","type":"mixed","description":"The key associated with the data model"},{"name":"$index","type":"mixed","description":"The zero-based index of the data model among the models array returned by `yii\\grid\\GridView::$dataProvider`."}],"return":{"type":"string","description":"The rendering result"},"visibility":"protected"}},"inherited":{"properties":{"content":"yii\\grid\\Column","contentOptions":"yii\\grid\\Column","filterOptions":"yii\\grid\\Column","footer":"yii\\grid\\Column","footerOptions":"yii\\grid\\Column","grid":"yii\\grid\\Column","header":"yii\\grid\\Column","headerOptions":"yii\\grid\\Column","options":"yii\\grid\\Column","visible":"yii\\grid\\Column"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","getHeaderCellLabel":"yii\\grid\\Column","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","renderDataCell":"yii\\grid\\Column","renderFilterCell":"yii\\grid\\Column","renderFilterCellContent":"yii\\grid\\Column","renderFooterCell":"yii\\grid\\Column","renderFooterCellContent":"yii\\grid\\Column","renderHeaderCell":"yii\\grid\\Column","renderHeaderCellContent":"yii\\grid\\Column"}}},"yii\\grid\\SerialColumn":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/grid/serialcolumn/","summary":"SerialColumn displays a column of row numbers (1-based).","since":"2.0","extends":"yii\\grid\\Column","implements":["yii\\base\\Configurable"],"properties":{"header":{"type":"string|null","default":"'#'"}},"methods":{"renderDataCellContent":{"signature":"protected function renderDataCellContent(mixed $model, mixed $key, mixed $index): string","summary":"Renders the data cell content.","params":[{"name":"$model","type":"mixed","description":"The data model"},{"name":"$key","type":"mixed","description":"The key associated with the data model"},{"name":"$index","type":"mixed","description":"The zero-based index of the data model among the models array returned by `yii\\grid\\GridView::$dataProvider`."}],"return":{"type":"string","description":"The rendering result"},"visibility":"protected"}},"inherited":{"properties":{"content":"yii\\grid\\Column","contentOptions":"yii\\grid\\Column","filterOptions":"yii\\grid\\Column","footer":"yii\\grid\\Column","footerOptions":"yii\\grid\\Column","grid":"yii\\grid\\Column","headerOptions":"yii\\grid\\Column","options":"yii\\grid\\Column","visible":"yii\\grid\\Column"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","getHeaderCellLabel":"yii\\grid\\Column","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\base\\BaseObject","renderDataCell":"yii\\grid\\Column","renderFilterCell":"yii\\grid\\Column","renderFilterCellContent":"yii\\grid\\Column","renderFooterCell":"yii\\grid\\Column","renderFooterCellContent":"yii\\grid\\Column","renderHeaderCell":"yii\\grid\\Column","renderHeaderCellContent":"yii\\grid\\Column"}}},"yii\\helpers\\ArrayHelper":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/helpers/arrayhelper/","summary":"ArrayHelper provides additional array functionality that you can use in your application.","since":"2.0","extends":"yii\\helpers\\BaseArrayHelper","inherited":{"methods":{"filter":"yii\\helpers\\BaseArrayHelper","flatten":"yii\\helpers\\BaseArrayHelper","getColumn":"yii\\helpers\\BaseArrayHelper","getValue":"yii\\helpers\\BaseArrayHelper","htmlDecode":"yii\\helpers\\BaseArrayHelper","htmlEncode":"yii\\helpers\\BaseArrayHelper","index":"yii\\helpers\\BaseArrayHelper","isAssociative":"yii\\helpers\\BaseArrayHelper","isIn":"yii\\helpers\\BaseArrayHelper","isIndexed":"yii\\helpers\\BaseArrayHelper","isSubset":"yii\\helpers\\BaseArrayHelper","isTraversable":"yii\\helpers\\BaseArrayHelper","keyExists":"yii\\helpers\\BaseArrayHelper","map":"yii\\helpers\\BaseArrayHelper","merge":"yii\\helpers\\BaseArrayHelper","multisort":"yii\\helpers\\BaseArrayHelper","recursiveSort":"yii\\helpers\\BaseArrayHelper","remove":"yii\\helpers\\BaseArrayHelper","removeValue":"yii\\helpers\\BaseArrayHelper","setValue":"yii\\helpers\\BaseArrayHelper","toArray":"yii\\helpers\\BaseArrayHelper"}}},"yii\\helpers\\BaseArrayHelper":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/helpers/basearrayhelper/","summary":"BaseArrayHelper provides concrete implementation for `yii\\helpers\\ArrayHelper`.","since":"2.0","methods":{"filter":{"signature":"public static function filter(array $array, iterable $filters): array","summary":"Filters array according to rules specified.","params":[{"name":"$array","type":"array","description":"Source array"},{"name":"$filters","type":"iterable","description":"Rules that define array keys which should be left or removed from results. Each rule is: - `var` - `$array['var']` will be left in result. - `var.key` = only `$array['var']['key'] will be left in result. - `!var.key` = `$array['var']['key'] will be removed from result."}],"return":{"type":"array","description":"Filtered array"},"static":true,"since":"2.0.9"},"flatten":{"signature":"public static function flatten(array $array, string $separator = '.'): array","summary":"Flattens a multidimensional array into a one-dimensional array.","params":[{"name":"$array","type":"array","description":"The input array to be flattened in terms of name-value pairs."},{"name":"$separator","type":"string","default":"'.'","optional":true,"description":"The separator to use between keys. Defaults to '.'."}],"return":{"type":"array","description":"The flattened array."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if `$array` is neither traversable nor an array."}],"static":true},"getColumn":{"signature":"public static function getColumn(array $array, int|string|array|Closure $name, bool $keepKeys = true): array","summary":"Returns the values of a specified column in an array.","params":[{"name":"$array","type":"array"},{"name":"$name","type":"int|string|array|Closure"},{"name":"$keepKeys","type":"bool","default":"true","optional":true,"description":"Whether to maintain the array keys. If false, the resulting array will be re-indexed with integers."}],"return":{"type":"array","description":"The list of column values"},"static":true},"getValue":{"signature":"public static function getValue(array|object $array, string|Closure|array $key, mixed $default = null): mixed","summary":"Retrieves the value of an array element or object property with the given key or property name.","params":[{"name":"$array","type":"array|object","description":"Array or object to extract value from"},{"name":"$key","type":"string|Closure|array","description":"Key name of the array element, an array of keys or property name of the object, or an anonymous function returning the value. The anonymous function signature should be: `function($array, $defaultValue)`. The possibility to pass an array of keys is available since version 2.0.4."},{"name":"$default","type":"mixed","default":"null","optional":true,"description":"The default value to be returned if the specified array key does not exist. Not used when getting value from an object."}],"return":{"type":"mixed","description":"The value of the element if found, default value otherwise"},"static":true},"htmlDecode":{"signature":"public static function htmlDecode(array $data, bool $valuesOnly = true): array","summary":"Decodes HTML entities into the corresponding characters in an array of strings.","params":[{"name":"$data","type":"array","description":"Data to be decoded"},{"name":"$valuesOnly","type":"bool","default":"true","optional":true,"description":"Whether to decode array values only. If `false`, then both the array keys and array values will be decoded."}],"return":{"type":"array","description":"The decoded data"},"static":true},"htmlEncode":{"signature":"public static function htmlEncode(array $data, bool $valuesOnly = true, string|null $charset = null): array","summary":"Encodes special characters in an array of strings into HTML entities.","params":[{"name":"$data","type":"array","description":"Data to be encoded"},{"name":"$valuesOnly","type":"bool","default":"true","optional":true,"description":"Whether to encode array values only. If false, both the array keys and array values will be encoded."},{"name":"$charset","type":"string|null","default":"null","optional":true,"description":"The charset that the data is using. If not set, `yii\\base\\Application::$charset` will be used."}],"return":{"type":"array","description":"The encoded data"},"static":true},"index":{"signature":"public static function index(array $array, string|Closure|null $key, string|string[]|Closure[]|null $groups = []): array","summary":"Indexes and/or groups the array according to a specified key.","params":[{"name":"$array","type":"array","description":"The array that needs to be indexed or grouped"},{"name":"$key","type":"string|Closure|null","description":"The column name or anonymous function which result will be used to index the array"},{"name":"$groups","type":"string|string[]|Closure[]|null","default":"[]","optional":true,"description":"The array of keys, that will be used to group the input array by one or more keys. If the $key attribute or its value for the particular element is null and $groups is not defined, the array element will be discarded. Otherwise, if $groups is specified, array element will be added to the result array without any key. This parameter is available since version 2.0.8."}],"return":{"type":"array","description":"The indexed and/or grouped array"},"static":true},"isAssociative":{"signature":"public static function isAssociative(array $array, bool $allStrings = true): bool","summary":"Returns a value indicating whether the given array is an associative array.","params":[{"name":"$array","type":"array","description":"The array being checked"},{"name":"$allStrings","type":"bool","default":"true","optional":true,"description":"Whether the array keys must be all strings in order for the array to be treated as associative."}],"return":{"type":"bool","description":"Whether the array is associative"},"static":true},"isIn":{"signature":"public static function isIn(mixed $needle, iterable $haystack, bool $strict = false): bool","summary":"Check whether an array or `Traversable` contains an element.","params":[{"name":"$needle","type":"mixed","description":"The value to look for."},{"name":"$haystack","type":"iterable","description":"The set of values to search."},{"name":"$strict","type":"bool","default":"false","optional":true,"description":"Whether to enable strict (`===`) comparison."}],"return":{"type":"bool","description":"`true` if `$needle` was found in `$haystack`, `false` otherwise."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if `$haystack` is neither traversable nor an array."}],"static":true,"since":"2.0.7"},"isIndexed":{"signature":"public static function isIndexed(array $array, bool $consecutive = false): bool","summary":"Returns a value indicating whether the given array is an indexed array.","params":[{"name":"$array","type":"array","description":"The array being checked"},{"name":"$consecutive","type":"bool","default":"false","optional":true,"description":"Whether the array keys must be a consecutive sequence in order for the array to be treated as indexed."}],"return":{"type":"bool","description":"Whether the array is indexed"},"static":true},"isSubset":{"signature":"public static function isSubset(iterable $needles, iterable $haystack, bool $strict = false): bool","summary":"Checks whether an array or `Traversable` is a subset of another array or `Traversable`.","params":[{"name":"$needles","type":"iterable","description":"The values that must **all** be in `$haystack`."},{"name":"$haystack","type":"iterable","description":"The set of value to search."},{"name":"$strict","type":"bool","default":"false","optional":true,"description":"Whether to enable strict (`===`) comparison."}],"return":{"type":"bool","description":"`true` if `$needles` is a subset of `$haystack`, `false` otherwise."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if `$haystack` or `$needles` is neither traversable nor an array."}],"static":true,"since":"2.0.7"},"isTraversable":{"signature":"public static function isTraversable(mixed $var): bool","summary":"Checks whether a variable is an array or `Traversable`.","params":[{"name":"$var","type":"mixed","description":"The variable being evaluated."}],"return":{"type":"bool","description":"Whether $var can be traversed via foreach"},"static":true,"since":"2.0.8"},"keyExists":{"signature":"public static function keyExists(string|int $key, array|ArrayAccess $array, bool $caseSensitive = true): bool","summary":"Checks if the given array contains the specified key.","params":[{"name":"$key","type":"string|int","description":"The key to check"},{"name":"$array","type":"array|ArrayAccess","description":"The array with keys to check"},{"name":"$caseSensitive","type":"bool","default":"true","optional":true,"description":"Whether the key comparison should be case-sensitive"}],"return":{"type":"bool","description":"Whether the array contains the specified key"},"static":true},"map":{"signature":"public static function map(array $array, string|Closure $from, string|Closure $to, string|Closure|null $group = null): array","summary":"Builds a map (key-value pairs) from a multidimensional array or an array of objects.","params":[{"name":"$array","type":"array"},{"name":"$from","type":"string|Closure"},{"name":"$to","type":"string|Closure"},{"name":"$group","type":"string|Closure|null","default":"null","optional":true}],"return":{"type":"array"},"static":true},"merge":{"signature":"public static function merge(array $a, array ...$b): array","summary":"Merges two or more arrays into one recursively.","params":[{"name":"$a","type":"array","description":"Array to be merged to"},{"name":"$b","type":"array","optional":true,"variadic":true,"description":"Array to be merged from. You can specify additional arrays via third argument, fourth argument etc."}],"return":{"type":"array","description":"The merged array (the original arrays are not changed.)"},"static":true},"multisort":{"signature":"public static function multisort(array &$array, string|Closure|array $key, int|array $direction = \\yii\\helpers\\SORT_ASC, int|array $sortFlag = \\yii\\helpers\\SORT_REGULAR): mixed","summary":"Sorts an array of objects or arrays (with the same structure) by one or several keys.","params":[{"name":"$array","type":"array","byReference":true,"description":"The array to be sorted. The array will be modified after calling this method."},{"name":"$key","type":"string|Closure|array","description":"The key(s) to be sorted by. This refers to a key name of the sub-array elements, a property name of the objects, or an anonymous function returning the values for comparison purpose. The anonymous function signature should be: `function($item)`. To sort by multiple keys, provide an array of keys here."},{"name":"$direction","type":"int|array","default":"\\yii\\helpers\\SORT_ASC","optional":true,"description":"The sorting direction. It can be either `SORT_ASC` or `SORT_DESC`. When sorting by multiple keys with different sorting directions, use an array of sorting directions."},{"name":"$sortFlag","type":"int|array","default":"\\yii\\helpers\\SORT_REGULAR","optional":true,"description":"The PHP sort flag. Valid values include `SORT_REGULAR`, `SORT_NUMERIC`, `SORT_STRING`, `SORT_LOCALE_STRING`, `SORT_NATURAL` and `SORT_FLAG_CASE`. Please refer to [PHP manual](https://www.php.net/manual/en/function.sort.php) for more details. When sorting by multiple keys with different sort flags, use an array of sort flags."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the $direction or $sortFlag parameters do not have correct number of elements as that of $key."}],"static":true},"recursiveSort":{"signature":"public static function recursiveSort(array &$array, callable|null $sorter = null): array","summary":"Sorts array recursively.","params":[{"name":"$array","type":"array","byReference":true,"description":"An array passing by reference."},{"name":"$sorter","type":"callable|null","default":"null","optional":true,"description":"The array sorter. If omitted, sort index array by values, sort assoc array by keys."}],"return":{"type":"array"},"static":true},"remove":{"signature":"public static function remove(array &$array, string $key, mixed $default = null): mixed|null","summary":"Removes an item from an array and returns the value. If the key does not exist in the array, the default value will be returned instead.","params":[{"name":"$array","type":"array","byReference":true,"description":"The array to extract value from"},{"name":"$key","type":"string","description":"Key name of the array element"},{"name":"$default","type":"mixed","default":"null","optional":true,"description":"The default value to be returned if the specified key does not exist"}],"return":{"type":"mixed|null","description":"The value of the element if found, default value otherwise"},"static":true},"removeValue":{"signature":"public static function removeValue(array &$array, mixed $value): array","summary":"Removes items with matching values from the array and returns the removed items.","params":[{"name":"$array","type":"array","byReference":true,"description":"The array where to look the value from"},{"name":"$value","type":"mixed","description":"The value to remove from the array"}],"return":{"type":"array","description":"The items that were removed from the array"},"static":true,"since":"2.0.11"},"setValue":{"signature":"public static function setValue(array &$array, string|array|null $path, mixed $value): mixed","summary":"Writes a value into an associative array at the key path specified.","params":[{"name":"$array","type":"array","byReference":true,"description":"The array to write the value to"},{"name":"$path","type":"string|array|null","description":"The path of where do you want to write a value to `$array` the path can be described by a string when each key should be separated by a dot you can also describe the path as an array of keys if the path is null then `$array` will be assigned the `$value`"},{"name":"$value","type":"mixed","description":"The value to be written"}],"return":{"type":"mixed"},"static":true,"since":"2.0.13"},"toArray":{"signature":"public static function toArray(object|array|string $object, array $properties = [], bool $recursive = true): array","summary":"Converts an object or an array of objects into an array.","params":[{"name":"$object","type":"object|array|string","description":"The object to be converted into an array"},{"name":"$properties","type":"array","default":"[]","optional":true,"description":"A mapping from object class names to the properties that need to put into the resulting arrays. The properties specified for each class is an array of the following format: ``` [ 'app\\models\\Post' => [ 'id', 'title', // the key name in array result => property name 'createTime' => 'created_at', // the key name in array result => anonymous function 'length' => function ($post) { return strlen($post->content); }, ], ] ``` The result of `ArrayHelper::toArray($post, $properties)` could be like the following: ``` [ 'id' => 123, 'title' => 'test', 'createTime' => '2013-01-01 12:00AM', 'length' => 301, ] ```"},{"name":"$recursive","type":"bool","default":"true","optional":true,"description":"Whether to recursively converts properties which are objects into arrays."}],"return":{"type":"array","description":"The array representation of the object"},"static":true}}},"yii\\helpers\\BaseConsole":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/helpers/baseconsole/","summary":"BaseConsole provides concrete implementation for `yii\\helpers\\Console`.","since":"2.0","methods":{"ansiColorizedSubstr":{"signature":"public static function ansiColorizedSubstr(string $string, int $start, int $length): string","summary":"Returns the portion with ANSI color codes of string specified by the start and length parameters.","params":[{"name":"$string","type":"string"},{"name":"$start","type":"int"},{"name":"$length","type":"int"}],"return":{"type":"string"},"static":true},"ansiFormat":{"signature":"public static function ansiFormat(string $string, array $format = []): string","summary":"Will return a string formatted with the given ANSI style.","params":[{"name":"$string","type":"string","description":"The string to be formatted"},{"name":"$format","type":"array","default":"[]","optional":true,"description":"An array containing formatting values. You can pass any of the `FG_*`, `BG_*` and `TEXT_*` constants and also `xtermFgColor()` and `xtermBgColor()` to specify a format."}],"return":{"type":"string"},"static":true},"ansiFormatCode":{"signature":"public static function ansiFormatCode(array $format): string","summary":"Returns the ANSI format code.","params":[{"name":"$format","type":"array","description":"An array containing formatting values. You can pass any of the `FG_*`, `BG_*` and `TEXT_*` constants and also `xtermFgColor()` and `xtermBgColor()` to specify a format."}],"return":{"type":"string","description":"The ANSI format code according to the given formatting constants."},"static":true},"ansiStrlen":{"signature":"public static function ansiStrlen(string $string): int","summary":"Returns the length of the string without ANSI color codes.","params":[{"name":"$string","type":"string","description":"The string to measure"}],"return":{"type":"int","description":"The length of the string not counting ANSI format characters"},"static":true},"ansiStrwidth":{"signature":"public static function ansiStrwidth(string $string): int","summary":"Returns the width of the string without ANSI color codes.","params":[{"name":"$string","type":"string","description":"The string to measure"}],"return":{"type":"int","description":"The width of the string not counting ANSI format characters"},"static":true,"since":"2.0.36"},"ansiToHtml":{"signature":"public static function ansiToHtml(string $string, array $styleMap = []): string","summary":"Converts an ANSI formatted string to HTML.","params":[{"name":"$string","type":"string","description":"The string to convert."},{"name":"$styleMap","type":"array","default":"[]","optional":true,"description":"An optional mapping of ANSI control codes such as FG\\_*COLOR* or `BOLD` to a set of css style definitions. The CSS style definitions are represented as an array where the array keys correspond to the css style attribute names and the values are the css values. values may be arrays that will be merged and imploded with `' '` when rendered."}],"return":{"type":"string","description":"HTML representation of the ANSI formatted string"},"static":true},"beginAnsiFormat":{"signature":"public static function beginAnsiFormat(array $format): mixed","summary":"Echoes an ANSI format code that affects the formatting of any text that is printed afterwards.","params":[{"name":"$format","type":"array","description":"An array containing formatting values. You can pass any of the `FG_*`, `BG_*` and `TEXT_*` constants and also `xtermFgColor()` and `xtermBgColor()` to specify a format."}],"return":{"type":"mixed"},"static":true},"clearLine":{"signature":"public static function clearLine(): mixed","summary":"Clears the line, the cursor is currently on by sending ANSI control code EL with argument 2 to the terminal.","return":{"type":"mixed"},"static":true},"clearLineAfterCursor":{"signature":"public static function clearLineAfterCursor(): mixed","summary":"Clears text from cursor position to the end of the line by sending ANSI control code EL with argument 0 to the terminal.","return":{"type":"mixed"},"static":true},"clearLineBeforeCursor":{"signature":"public static function clearLineBeforeCursor(): mixed","summary":"Clears text from cursor position to the beginning of the line by sending ANSI control code EL with argument 1 to the terminal.","return":{"type":"mixed"},"static":true},"clearScreen":{"signature":"public static function clearScreen(): mixed","summary":"Clears entire screen content by sending ANSI control code ED with argument 2 to the terminal.","return":{"type":"mixed"},"static":true},"clearScreenAfterCursor":{"signature":"public static function clearScreenAfterCursor(): mixed","summary":"Clears text from cursor to the end of the screen by sending ANSI control code ED with argument 0 to the terminal.","return":{"type":"mixed"},"static":true},"clearScreenBeforeCursor":{"signature":"public static function clearScreenBeforeCursor(): mixed","summary":"Clears text from cursor to the beginning of the screen by sending ANSI control code ED with argument 1 to the terminal.","return":{"type":"mixed"},"static":true},"confirm":{"signature":"public static function confirm(string $message, bool $default = false): bool","summary":"Asks user to confirm by typing y or n.","params":[{"name":"$message","type":"string","description":"To print out before waiting for user input"},{"name":"$default","type":"bool","default":"false","optional":true,"description":"This value is returned if no selection is made."}],"return":{"type":"bool","description":"Whether user confirmed"},"static":true},"endAnsiFormat":{"signature":"public static function endAnsiFormat(): mixed","summary":"Resets any ANSI format set by previous method `beginAnsiFormat()` Any output after this will have default text format.","return":{"type":"mixed"},"static":true},"endProgress":{"signature":"public static function endProgress(string|bool $remove = false, bool $keepPrefix = true): mixed","summary":"Ends a progress bar that has been started by `startProgress()`.","params":[{"name":"$remove","type":"string|bool","default":"false","optional":true,"description":"This can be `false` to leave the progress bar on screen and just print a newline. If set to `true`, the line of the progress bar will be cleared. This may also be a string to be displayed instead of the progress bar."},{"name":"$keepPrefix","type":"bool","default":"true","optional":true,"description":"Whether to keep the prefix that has been specified for the progressbar when progressbar gets removed. Defaults to true."}],"return":{"type":"mixed"},"static":true},"error":{"signature":"public static function error(string|null $string = null): int|bool","summary":"Prints text to STDERR appended with a carriage return (PHP_EOL).","params":[{"name":"$string","type":"string|null","default":"null","optional":true,"description":"The text to print"}],"return":{"type":"int|bool","description":"Number of bytes printed or false on error."},"static":true},"errorSummary":{"signature":"public static function errorSummary(yii\\base\\Model|yii\\base\\Model[] $models, array $options = []): string","summary":"Generates a summary of the validation errors.","params":[{"name":"$models","type":"yii\\base\\Model|yii\\base\\Model[]","description":"The model(s) whose validation errors are to be displayed."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. The following options are specially handled: - showAllErrors: boolean, if set to true every error message for each attribute will be shown otherwise only the first error message for each attribute will be shown. Defaults to `false`."}],"return":{"type":"string","description":"The generated error summary"},"static":true,"since":"2.0.14"},"escape":{"signature":"public static function escape(string $string): string","summary":"Escapes % so they don't get interpreted as color codes when the string is parsed by `renderColoredString()`.","params":[{"name":"$string","type":"string","description":"String to escape"}],"return":{"type":"string"},"static":true},"getScreenSize":{"signature":"public static function getScreenSize(bool $refresh = false): array|bool","summary":"Returns terminal screen size.","params":[{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to force checking and not re-use cached size value. This is useful to detect changing window size while the application is running but may not get up to date values on every terminal."}],"return":{"type":"array|bool","description":"An array of ($width, $height) or false when it was not able to determine size."},"static":true},"hideCursor":{"signature":"public static function hideCursor(): mixed","summary":"Hides the cursor by sending ANSI DECTCEM code ?25l to the terminal.","return":{"type":"mixed"},"static":true},"input":{"signature":"public static function input(string|null $prompt = null): string","summary":"Asks the user for input. Ends when the user types a carriage return (PHP_EOL). Optionally, It also provides a prompt.","params":[{"name":"$prompt","type":"string|null","default":"null","optional":true,"description":"The prompt to display before waiting for input (optional)"}],"return":{"type":"string","description":"The user's input"},"static":true},"isRunningOnWindows":{"signature":"public static function isRunningOnWindows(): bool","summary":"Returns true if the console is running on windows.","return":{"type":"bool"},"static":true},"markdownToAnsi":{"signature":"public static function markdownToAnsi(string $markdown): string","summary":"Converts Markdown to be better readable in console environments by applying some ANSI format.","params":[{"name":"$markdown","type":"string","description":"The markdown string."}],"return":{"type":"string","description":"The parsed result as ANSI formatted string."},"static":true},"moveCursorBackward":{"signature":"public static function moveCursorBackward(int $steps = 1): mixed","summary":"Moves the terminal cursor backward by sending ANSI control code CUB to the terminal.","params":[{"name":"$steps","type":"int","default":"1","optional":true,"description":"Number of steps the cursor should be moved backward"}],"return":{"type":"mixed"},"static":true},"moveCursorDown":{"signature":"public static function moveCursorDown(int $rows = 1): mixed","summary":"Moves the terminal cursor down by sending ANSI control code CUD to the terminal.","params":[{"name":"$rows","type":"int","default":"1","optional":true,"description":"Number of rows the cursor should be moved down"}],"return":{"type":"mixed"},"static":true},"moveCursorForward":{"signature":"public static function moveCursorForward(int $steps = 1): mixed","summary":"Moves the terminal cursor forward by sending ANSI control code CUF to the terminal.","params":[{"name":"$steps","type":"int","default":"1","optional":true,"description":"Number of steps the cursor should be moved forward"}],"return":{"type":"mixed"},"static":true},"moveCursorNextLine":{"signature":"public static function moveCursorNextLine(int $lines = 1): mixed","summary":"Moves the terminal cursor to the beginning of the next line by sending ANSI control code CNL to the terminal.","params":[{"name":"$lines","type":"int","default":"1","optional":true,"description":"Number of lines the cursor should be moved down"}],"return":{"type":"mixed"},"static":true},"moveCursorPrevLine":{"signature":"public static function moveCursorPrevLine(int $lines = 1): mixed","summary":"Moves the terminal cursor to the beginning of the previous line by sending ANSI control code CPL to the terminal.","params":[{"name":"$lines","type":"int","default":"1","optional":true,"description":"Number of lines the cursor should be moved up"}],"return":{"type":"mixed"},"static":true},"moveCursorTo":{"signature":"public static function moveCursorTo(int $column, int|null $row = null): mixed","summary":"Moves the cursor to an absolute position given as column and row by sending ANSI control code CUP or CHA to the terminal.","params":[{"name":"$column","type":"int","description":"1-based column number, 1 is the left edge of the screen."},{"name":"$row","type":"int|null","default":"null","optional":true,"description":"1-based row number, 1 is the top edge of the screen. if not set, will move cursor only in current line."}],"return":{"type":"mixed"},"static":true},"moveCursorUp":{"signature":"public static function moveCursorUp(int $rows = 1): mixed","summary":"Moves the terminal cursor up by sending ANSI control code CUU to the terminal.","params":[{"name":"$rows","type":"int","default":"1","optional":true,"description":"Number of rows the cursor should be moved up"}],"return":{"type":"mixed"},"static":true},"output":{"signature":"public static function output(string|null $string = null): int|bool","summary":"Prints text to STDOUT appended with a carriage return (PHP_EOL).","params":[{"name":"$string","type":"string|null","default":"null","optional":true,"description":"The text to print"}],"return":{"type":"int|bool","description":"Number of bytes printed or false on error."},"static":true},"prompt":{"signature":"public static function prompt(string $text, array $options = []): string","summary":"Prompts the user for input and validates it.","params":[{"name":"$text","type":"string","description":"Prompt string"},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The options to validate the input: - `required`: whether it is required or not - `default`: default value if no input is inserted by the user - `pattern`: regular expression pattern to validate user input - `validator`: a callable function to validate input. The function must accept two parameters: - `input`: the user input to validate - `error`: the error value passed by reference if validation failed."}],"return":{"type":"string","description":"The user input"},"static":true},"renderColoredString":{"signature":"public static function renderColoredString(string $string, bool $colored = true): string","summary":"Converts a string to ansi formatted by replacing patterns like %y (for yellow) with ansi control codes.","params":[{"name":"$string","type":"string","description":"String to convert"},{"name":"$colored","type":"bool","default":"true","optional":true,"description":"Should the string be colored?"}],"return":{"type":"string"},"static":true},"restoreCursorPosition":{"signature":"public static function restoreCursorPosition(): mixed","summary":"Restores the cursor position saved with `saveCursorPosition()` by sending ANSI control code RCP to the terminal.","return":{"type":"mixed"},"static":true},"saveCursorPosition":{"signature":"public static function saveCursorPosition(): mixed","summary":"Saves the current cursor position by sending ANSI control code SCP to the terminal.","return":{"type":"mixed"},"static":true},"scrollDown":{"signature":"public static function scrollDown(int $lines = 1): mixed","summary":"Scrolls whole page down by sending ANSI control code SD to the terminal.","params":[{"name":"$lines","type":"int","default":"1","optional":true,"description":"Number of lines to scroll down"}],"return":{"type":"mixed"},"static":true},"scrollUp":{"signature":"public static function scrollUp(int $lines = 1): mixed","summary":"Scrolls whole page up by sending ANSI control code SU to the terminal.","params":[{"name":"$lines","type":"int","default":"1","optional":true,"description":"Number of lines to scroll up"}],"return":{"type":"mixed"},"static":true},"select":{"signature":"public static function select(string $prompt, array $options = [], string|null $default = null): string","summary":"Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations.","params":[{"name":"$prompt","type":"string","description":"The prompt message"},{"name":"$options","type":"array","default":"[]","optional":true,"description":"Key-value array of options to choose from. Key is what is inputed and used, value is what's displayed to end user by help command."},{"name":"$default","type":"string|null","default":"null","optional":true,"description":"Value to use when the user doesn't provide an option. If the default is `null`, the user is required to select an option."}],"return":{"type":"string","description":"An option character the user chose"},"static":true},"showCursor":{"signature":"public static function showCursor(): mixed","summary":"Will show a cursor again when it has been hidden by `hideCursor()` by sending ANSI DECTCEM code ?25h to the terminal.","return":{"type":"mixed"},"static":true},"startProgress":{"signature":"public static function startProgress(int $done, int $total, string $prefix = '', int|float|bool|null $width = null): mixed","summary":"Starts display of a progress bar on screen.","params":[{"name":"$done","type":"int","description":"The number of items that are completed."},{"name":"$total","type":"int","description":"The total value of items that are to be done."},{"name":"$prefix","type":"string","default":"''","optional":true,"description":"An optional string to display before the progress bar. Default to empty string which results in no prefix to be displayed."},{"name":"$width","type":"int|float|bool|null","default":"null","optional":true,"description":"Optional width of the progressbar. This can be an integer representing the number of characters to display for the progress bar or a float between 0 and 1 representing the percentage of screen with the progress bar may take. It can also be set to false to disable the bar and only show progress information like percent, number of items and ETA. If not set, the bar will be as wide as the screen. Screen size will be detected using `getScreenSize()`."}],"return":{"type":"mixed"},"static":true},"stderr":{"signature":"public static function stderr(string $string): int|bool","summary":"Prints a string to STDERR.","params":[{"name":"$string","type":"string","description":"The string to print"}],"return":{"type":"int|bool","description":"Number of bytes printed or false on error"},"static":true},"stdin":{"signature":"public static function stdin(bool $raw = false): string","summary":"Gets input from STDIN and returns a string right-trimmed for EOLs.","params":[{"name":"$raw","type":"bool","default":"false","optional":true,"description":"If set to true, returns the raw string without trimming"}],"return":{"type":"string","description":"The string read from stdin"},"static":true},"stdout":{"signature":"public static function stdout(string $string): int|bool","summary":"Prints a string to STDOUT.","params":[{"name":"$string","type":"string","description":"The string to print"}],"return":{"type":"int|bool","description":"Number of bytes printed or false on error"},"static":true},"streamSupportsAnsiColors":{"signature":"public static function streamSupportsAnsiColors(mixed $stream): bool","summary":"Returns true if the stream supports colorization. ANSI colors are disabled if not supported by the stream.","params":[{"name":"$stream","type":"mixed"}],"return":{"type":"bool","description":"True if the stream supports ANSI colors, otherwise false."},"static":true},"stripAnsiFormat":{"signature":"public static function stripAnsiFormat(string $string): string","summary":"Strips ANSI control codes from a string.","params":[{"name":"$string","type":"string","description":"String to strip"}],"return":{"type":"string"},"static":true},"updateProgress":{"signature":"public static function updateProgress(int $done, int $total, string|null $prefix = null): mixed","summary":"Updates a progress bar that has been started by `startProgress()`.","params":[{"name":"$done","type":"int","description":"The number of items that are completed."},{"name":"$total","type":"int","description":"The total value of items that are to be done."},{"name":"$prefix","type":"string|null","default":"null","optional":true,"description":"An optional string to display before the progress bar. Defaults to null meaning the prefix specified by `startProgress()` will be used. If prefix is specified it will update the prefix that will be used by later calls."}],"return":{"type":"mixed"},"static":true},"wrapText":{"signature":"public static function wrapText(string $text, int $indent = 0, bool $refresh = false): string","summary":"Word wrap text with indentation to fit the screen size.","params":[{"name":"$text","type":"string","description":"The text to be wrapped"},{"name":"$indent","type":"int","default":"0","optional":true,"description":"Number of spaces to use for indentation."},{"name":"$refresh","type":"bool","default":"false","optional":true,"description":"Whether to force refresh of screen size. This will be passed to `getScreenSize()`."}],"return":{"type":"string","description":"The wrapped text."},"static":true,"since":"2.0.4"},"xtermBgColor":{"signature":"public static function xtermBgColor(int $colorCode): string","summary":"Returns the ansi format code for xterm background color.","params":[{"name":"$colorCode","type":"int","description":"Xterm color code"}],"return":{"type":"string"},"static":true},"xtermFgColor":{"signature":"public static function xtermFgColor(int $colorCode): string","summary":"Returns the ansi format code for xterm foreground color.","params":[{"name":"$colorCode","type":"int","description":"Xterm color code"}],"return":{"type":"string"},"static":true}},"constants":{"FG_BLACK":{"value":"30"},"FG_RED":{"value":"31"},"FG_GREEN":{"value":"32"},"FG_YELLOW":{"value":"33"},"FG_BLUE":{"value":"34"},"FG_PURPLE":{"value":"35"},"FG_CYAN":{"value":"36"},"FG_GREY":{"value":"37"},"BG_BLACK":{"value":"40"},"BG_RED":{"value":"41"},"BG_GREEN":{"value":"42"},"BG_YELLOW":{"value":"43"},"BG_BLUE":{"value":"44"},"BG_PURPLE":{"value":"45"},"BG_CYAN":{"value":"46"},"BG_GREY":{"value":"47"},"RESET":{"value":"0"},"NORMAL":{"value":"0"},"BOLD":{"value":"1"},"ITALIC":{"value":"3"},"UNDERLINE":{"value":"4"},"BLINK":{"value":"5"},"NEGATIVE":{"value":"7"},"CONCEALED":{"value":"8"},"CROSSED_OUT":{"value":"9"},"FRAMED":{"value":"51"},"ENCIRCLED":{"value":"52"},"OVERLINED":{"value":"53"}}},"yii\\helpers\\BaseFileHelper":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/helpers/basefilehelper/","summary":"BaseFileHelper provides concrete implementation for `yii\\helpers\\FileHelper`.","since":"2.0","properties":{"mimeAliasesFile":{"type":"string","default":"'@yii/helpers/mimeAliases.php'","description":"The path (or alias) of a PHP file containing MIME aliases.","static":true,"since":"2.0.14"},"mimeExtensionsFile":{"type":"string","default":"'@yii/helpers/mimeExtensions.php'","description":"The path (or alias) of a PHP file containing extensions per MIME type.","static":true,"since":"2.0.48"},"mimeMagicFile":{"type":"string","default":"'@yii/helpers/mimeTypes.php'","description":"The path (or alias) of a PHP file containing MIME type information.","static":true}},"methods":{"changeOwnership":{"signature":"public static function changeOwnership(string $path, string|array|int|null $ownership, int|null $mode = null): mixed","summary":"Changes the Unix user and/or group ownership of a file or directory, and optionally the mode.","params":[{"name":"$path","type":"string","description":"The path to the file or directory."},{"name":"$ownership","type":"string|array|int|null","description":"The user and/or group ownership for the file or directory. When $ownership is a string, the format is 'user:group' where both are optional. E.g. 'user' or 'user:' will only change the user, ':group' will only change the group, 'user:group' will change both. When $owners is an index array the format is [0 => user, 1 => group], e.g. `[$myUser, $myGroup]`. It is also possible to pass an associative array, e.g. ['user' => $myUser, 'group' => $myGroup]. In case $owners is an integer it will be used as user id. If `null`, an empty array or an empty string is passed, the ownership will not be changed."},{"name":"$mode","type":"int|null","default":"null","optional":true,"description":"The permission to be set for the file or directory. If `null` is passed, the mode will not be changed."}],"return":{"type":"mixed"},"static":true,"since":"2.0.43"},"copyDirectory":{"signature":"public static function copyDirectory(string $src, string $dst, array $options = []): mixed","summary":"Copies a whole directory as another one.","params":[{"name":"$src","type":"string","description":"The source directory"},{"name":"$dst","type":"string","description":"The destination directory"},{"name":"$options","type":"array","default":"[]","optional":true,"description":"Options for directory copy. Valid options are: - dirMode: integer, the permission to be set for newly copied directories. Defaults to 0775. - fileMode: integer, the permission to be set for newly copied files. Defaults to the current environment setting. - filter: callback, a PHP callback that is called for each directory or file. The signature of the callback should be: `function ($path)`, where `$path` refers the full path to be filtered. The callback can return one of the following values: * true: the directory or file will be copied (the \"only\" and \"except\" options will be ignored) * false: the directory or file will NOT be copied (the \"only\" and \"except\" options will be ignored) * null: the \"only\" and \"except\" options will determine whether the directory or file should be copied - only: array, list of patterns that the file paths should match if they want to be copied. A path matches a pattern if it contains the pattern string at its end. For example, '.php' matches all file paths ending with '.php'. Note, the '/' characters in a pattern matches both '/' and '\\' in the paths. If a file path matches a pattern in both \"only\" and \"except\", it will NOT be copied. - except: array, list of patterns that the files or directories should match if they want to be excluded from being copied. A path matches a pattern if it contains the pattern string at its end. Patterns ending with '/' apply to directory paths only, and patterns not ending with '/' apply to file paths only. For example, '/a/b' matches all file paths ending with '/a/b'; and '.svn/' matches directory paths ending with '.svn'. Note, the '/' characters in a pattern matches both '/' and '\\' in the paths. - caseSensitive: boolean, whether patterns specified at \"only\" or \"except\" should be case sensitive. Defaults to true. - recursive: boolean, whether the files under the subdirectories should also be copied. Defaults to true. - beforeCopy: callback, a PHP callback that is called before copying each sub-directory or file. If the callback returns false, the copy operation for the sub-directory or file will be cancelled. The signature of the callback should be: `function ($from, $to)`, where `$from` is the sub-directory or file to be copied from, while `$to` is the copy target. - afterCopy: callback, a PHP callback that is called after each sub-directory or file is successfully copied. The signature of the callback should be: `function ($from, $to)`, where `$from` is the sub-directory or file copied from, while `$to` is the copy target. - copyEmptyDirectories: boolean, whether to copy empty directories. Set this to false to avoid creating directories that do not contain files. This affects directories that do not contain files initially as well as directories that do not contain files at the target destination because files have been filtered via `only` or `except`. Defaults to true. This option is available since version 2.0.12. Before 2.0.12 empty directories are always copied."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if unable to open directory"}],"static":true},"createDirectory":{"signature":"public static function createDirectory(string $path, int $mode = 0775, bool $recursive = true): bool","summary":"Creates a new directory.","params":[{"name":"$path","type":"string","description":"Path of the directory to be created."},{"name":"$mode","type":"int","default":"0775","optional":true,"description":"The permission to be set for the created directory."},{"name":"$recursive","type":"bool","default":"true","optional":true,"description":"Whether to create parent directories if they do not exist."}],"return":{"type":"bool","description":"Whether the directory is created successfully"},"throws":[{"type":"yii\\base\\Exception","description":"if the directory could not be created (i.e. php error due to parallel changes)"}],"static":true},"filterPath":{"signature":"public static function filterPath(string $path, array $options): bool","summary":"Checks if the given file path satisfies the filtering options.","params":[{"name":"$path","type":"string","description":"The path of the file or directory to be checked"},{"name":"$options","type":"array","description":"The filtering options. See `findFiles()` for explanations of the supported options."}],"return":{"type":"bool","description":"Whether the file or directory satisfies the filtering options."},"static":true},"findDirectories":{"signature":"public static function findDirectories(string $dir, array $options = []): array","summary":"Returns the directories found under the specified directory and subdirectories.","params":[{"name":"$dir","type":"string","description":"The directory under which the files will be looked for."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"Options for directory searching. Valid options are: - `filter`: callback, a PHP callback that is called for each directory or file. The signature of the callback should be: `function (string $path): bool`, where `$path` refers the full path to be filtered. The callback can return one of the following values: * `true`: the directory will be returned * `false`: the directory will NOT be returned - `recursive`: boolean, whether the files under the subdirectories should also be looked for. Defaults to `true`. See `findFiles()` for more options."}],"return":{"type":"array","description":"Directories found under the directory, in no particular order. Ordering depends on the files system used."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the dir is invalid."}],"static":true,"since":"2.0.14"},"findFiles":{"signature":"public static function findFiles(string $dir, array $options = []): array","summary":"Returns the files found under the specified directory and subdirectories.","params":[{"name":"$dir","type":"string","description":"The directory under which the files will be looked for."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"Options for file searching. Valid options are: - `filter`: callback, a PHP callback that is called for each directory or file. The signature of the callback should be: `function ($path)`, where `$path` refers the full path to be filtered. The callback can return one of the following values: * `true`: the directory or file will be returned (the `only` and `except` options will be ignored) * `false`: the directory or file will NOT be returned (the `only` and `except` options will be ignored) * `null`: the `only` and `except` options will determine whether the directory or file should be returned - `except`: array, list of patterns excluding from the results matching file or directory paths. Patterns ending with slash ('/') apply to directory paths only, and patterns not ending with '/' apply to file paths only. For example, '/a/b' matches all file paths ending with '/a/b'; and `.svn/` matches directory paths ending with `.svn`. If the pattern does not contain a slash (`/`), it is treated as a shell glob pattern and checked for a match against the pathname relative to `$dir`. Otherwise, the pattern is treated as a shell glob suitable for consumption by `fnmatch(3)` with the `FNM_PATHNAME` flag: wildcards in the pattern will not match a `/` in the pathname. For example, `views/*.php` matches `views/index.php` but not `views/controller/index.php`. A leading slash matches the beginning of the pathname. For example, `/*.php` matches `index.php` but not `views/start/index.php`. An optional prefix `!` which negates the pattern; any matching file excluded by a previous pattern will become included again. If a negated pattern matches, this will override lower precedence patterns sources. Put a backslash (`\\`) in front of the first `!` for patterns that begin with a literal `!`, for example, `\\!important!.txt`. Note, the '/' characters in a pattern matches both '/' and '\\' in the paths. You can find more details about the gitignore pattern format [here](https://git-scm.com/docs/gitignore/en#_pattern_format). - `only`: array, list of patterns that the file paths should match if they are to be returned. Directory paths are not checked against them. Same pattern matching rules as in the `except` option are used. If a file path matches a pattern in both `only` and `except`, it will NOT be returned. - `caseSensitive`: boolean, whether patterns specified at `only` or `except` should be case sensitive. Defaults to `true`. - `recursive`: boolean, whether the files under the subdirectories should also be looked for. Defaults to `true`."}],"return":{"type":"array","description":"Files found under the directory, in no particular order. Ordering depends on the files system used."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if the dir is invalid."}],"static":true},"getExtensionByMimeType":{"signature":"public static function getExtensionByMimeType(string $mimeType, bool $preferShort = false, string|null $magicFile = null): string|null","summary":"Determines the most common extension by given MIME type.","params":[{"name":"$mimeType","type":"string","description":"File MIME type."},{"name":"$preferShort","type":"bool","default":"false","optional":true,"description":"Return an extension with a maximum of 3 characters."},{"name":"$magicFile","type":"string|null","default":"null","optional":true,"description":"The path (or alias) of the file that contains all available MIME type information. If this is not set, the file specified by `$mimeMagicFile` will be used."}],"return":{"type":"string|null","description":"The extensions corresponding to the specified MIME type"},"static":true,"since":"2.0.48"},"getExtensionsByMimeType":{"signature":"public static function getExtensionsByMimeType(string $mimeType, string|null $magicFile = null): array","summary":"Determines the extensions by given MIME type.","params":[{"name":"$mimeType","type":"string","description":"File MIME type."},{"name":"$magicFile","type":"string|null","default":"null","optional":true,"description":"The path (or alias) of the file that contains all available MIME type information. If this is not set, the file specified by `$mimeMagicFile` will be used."}],"return":{"type":"array","description":"The extensions corresponding to the specified MIME type"},"static":true},"getMimeType":{"signature":"public static function getMimeType(string $file, string|null $magicFile = null, bool $checkExtension = true): string|null","summary":"Determines the MIME type of the specified file.","params":[{"name":"$file","type":"string","description":"The file name."},{"name":"$magicFile","type":"string|null","default":"null","optional":true,"description":"Name of the optional magic database file (or alias), usually something like `/path/to/magic.mime`. This will be passed as the second parameter to [finfo_open()](https://www.php.net/manual/en/function.finfo-open.php) when the `fileinfo` extension is installed. If the MIME type is being determined based via `getMimeTypeByExtension()` and this is null, it will use the file specified by `$mimeMagicFile`."},{"name":"$checkExtension","type":"bool","default":"true","optional":true,"description":"Whether to use the file extension to determine the MIME type in case `finfo_open()` cannot determine it."}],"return":{"type":"string|null","description":"The MIME type (e.g. `text/plain`). Null is returned if the MIME type cannot be determined."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"when the `fileinfo` PHP extension is not installed and `$checkExtension` is `false`."}],"static":true},"getMimeTypeByExtension":{"signature":"public static function getMimeTypeByExtension(string $file, string|null $magicFile = null): string|null","summary":"Determines the MIME type based on the extension name of the specified file.","params":[{"name":"$file","type":"string","description":"The file name."},{"name":"$magicFile","type":"string|null","default":"null","optional":true,"description":"The path (or alias) of the file that contains all available MIME type information. If this is not set, the file specified by `$mimeMagicFile` will be used."}],"return":{"type":"string|null","description":"The MIME type. Null is returned if the MIME type cannot be determined."},"static":true},"loadMimeAliases":{"signature":"protected static function loadMimeAliases(string|null $aliasesFile): array","summary":"Loads MIME aliases from the specified file.","params":[{"name":"$aliasesFile","type":"string|null","description":"The path (or alias) of the file that contains MIME type aliases. If this is not set, the file specified by `$mimeAliasesFile` will be used."}],"return":{"type":"array","description":"The mapping from file extensions to MIME types"},"visibility":"protected","static":true,"since":"2.0.14"},"loadMimeExtensions":{"signature":"protected static function loadMimeExtensions(string|null $extensionsFile): array","summary":"Loads MIME extensions from the specified file.","params":[{"name":"$extensionsFile","type":"string|null","description":"The path (or alias) of the file that contains MIME type aliases. If this is not set, the file specified by `$mimeAliasesFile` will be used."}],"return":{"type":"array","description":"The mapping from file extensions to MIME types"},"visibility":"protected","static":true,"since":"2.0.48"},"loadMimeTypes":{"signature":"protected static function loadMimeTypes(string|null $magicFile): array","summary":"Loads MIME types from the specified file.","params":[{"name":"$magicFile","type":"string|null","description":"The path (or alias) of the file that contains all available MIME type information. If this is not set, the file specified by `$mimeMagicFile` will be used."}],"return":{"type":"array","description":"The mapping from file extensions to MIME types"},"visibility":"protected","static":true},"localize":{"signature":"public static function localize(string $file, string|null $language = null, string|null $sourceLanguage = null): string","summary":"Returns the localized version of a specified file.","params":[{"name":"$file","type":"string","description":"The original file"},{"name":"$language","type":"string|null","default":"null","optional":true,"description":"The target language that the file should be localized to. If not set, the value of `yii\\base\\Application::$language` will be used."},{"name":"$sourceLanguage","type":"string|null","default":"null","optional":true,"description":"The language that the original file is in. If not set, the value of `yii\\base\\Application::$sourceLanguage` will be used."}],"return":{"type":"string","description":"The matching localized file, or the original file if the localized version is not found. If the target and the source language codes are the same, the original file will be returned."},"static":true},"normalizeOptions":{"signature":"protected static function normalizeOptions(array $options): array","params":[{"name":"$options","type":"array","description":"Raw options"}],"return":{"type":"array","description":"Normalized options"},"visibility":"protected","static":true,"since":"2.0.12"},"normalizePath":{"signature":"public static function normalizePath(string $path, string $ds = \\yii\\helpers\\DIRECTORY_SEPARATOR): string","summary":"Normalizes a file/directory path.","params":[{"name":"$path","type":"string","description":"The file/directory path to be normalized"},{"name":"$ds","type":"string","default":"\\yii\\helpers\\DIRECTORY_SEPARATOR","optional":true,"description":"The directory separator to be used in the normalized result. Defaults to `DIRECTORY_SEPARATOR`."}],"return":{"type":"string","description":"The normalized file/directory path"},"static":true},"removeDirectory":{"signature":"public static function removeDirectory(string $dir, array $options = []): mixed","summary":"Removes a directory (and all its content) recursively.","params":[{"name":"$dir","type":"string","description":"The directory to be deleted recursively."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"Options for directory remove. Valid options are: - traverseSymlinks: boolean, whether symlinks to the directories should be traversed too. Defaults to `false`, meaning the content of the symlinked directory would not be deleted. Only symlink would be removed in that default case."}],"return":{"type":"mixed"},"throws":[{"type":"yii\\base\\ErrorException","description":"in case of failure"}],"static":true},"unlink":{"signature":"public static function unlink(string $path): bool","summary":"Removes a file or symlink in a cross-platform way","params":[{"name":"$path","type":"string"}],"return":{"type":"bool"},"static":true,"since":"2.0.14"}},"constants":{"PATTERN_NODIR":{"value":"1"},"PATTERN_ENDSWITH":{"value":"4"},"PATTERN_MUSTBEDIR":{"value":"8"},"PATTERN_NEGATIVE":{"value":"16"},"PATTERN_CASE_INSENSITIVE":{"value":"32"}}},"yii\\helpers\\BaseFormatConverter":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/helpers/baseformatconverter/","summary":"BaseFormatConverter provides concrete implementation for `yii\\helpers\\FormatConverter`.","since":"2.0","properties":{"juiFallbackDatePatterns":{"type":"array","default":"['short' => ['date' => 'd/m/y', 'time' => '', 'datetime' => 'd/m/y'], 'medium' => ['date' => 'M d, yy', 'time' => '', 'datetime' => 'M d, yy'], 'long' => ['date' => 'MM d, yy', 'time' => '', 'datetime' => 'MM d, yy'], 'full' => ['date' => 'DD, MM d, yy', 'time' => '', 'datetime' => 'DD, MM d, yy']]","description":"The jQuery UI fallback definition to use for the ICU short patterns `short`, `medium`, `long` and `full`.","static":true},"phpFallbackDatePatterns":{"type":"array","default":"['short' => ['date' => 'n/j/y', 'time' => 'H:i', 'datetime' => 'n/j/y H:i'], 'medium' => ['date' => 'M j, Y', 'time' => 'g:i:s A', 'datetime' => 'M j, Y g:i:s A'], 'long' => ['date' => 'F j, Y', 'time' => 'g:i:sA', 'datetime' => 'F j, Y g:i:sA'], 'full' => ['date' => 'l, F j, Y', 'time' => 'g:i:sA T', 'datetime' => 'l, F j, Y g:i:sA T']]","description":"The php fallback definition to use for the ICU short patterns `short`, `medium`, `long` and `full`.","static":true}},"methods":{"convertDateIcuToJui":{"signature":"public static function convertDateIcuToJui(string $pattern, string $type = 'date', string|null $locale = null): string","summary":"Converts a date format pattern from [ICU format](https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax) to [jQuery UI date format](https://api.jqueryui.com/datepicker/#utility-formatDate).","params":[{"name":"$pattern","type":"string","description":"Date format pattern in ICU format."},{"name":"$type","type":"string","default":"'date'","optional":true,"description":"'date', 'time', or 'datetime'."},{"name":"$locale","type":"string|null","default":"null","optional":true,"description":"The locale to use for converting ICU short patterns `short`, `medium`, `long` and `full`. If not given, `Yii::$app->language` will be used."}],"return":{"type":"string","description":"The converted date format pattern."},"throws":[{"type":"Exception"}],"static":true},"convertDateIcuToPhp":{"signature":"public static function convertDateIcuToPhp(string $pattern, string $type = 'date', string|null $locale = null): string","summary":"Converts a date format pattern from [ICU format](https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax) to [PHP `date()` function format](https://www.php.net/manual/en/function.date).","params":[{"name":"$pattern","type":"string","description":"Date format pattern in ICU format."},{"name":"$type","type":"string","default":"'date'","optional":true,"description":"'date', 'time', or 'datetime'."},{"name":"$locale","type":"string|null","default":"null","optional":true,"description":"The locale to use for converting ICU short patterns `short`, `medium`, `long` and `full`. If not given, `Yii::$app->language` will be used."}],"return":{"type":"string","description":"The converted date format pattern."},"throws":[{"type":"Exception"}],"static":true},"convertDatePhpToIcu":{"signature":"public static function convertDatePhpToIcu(string $pattern): string","summary":"Converts a date format pattern from [PHP `date()` function format](https://www.php.net/manual/en/function.date) to [ICU format](https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax).","params":[{"name":"$pattern","type":"string","description":"Date format pattern in PHP `date()` function format."}],"return":{"type":"string","description":"The converted date format pattern."},"static":true},"convertDatePhpToJui":{"signature":"public static function convertDatePhpToJui(string $pattern): string","summary":"Converts a date format pattern from [PHP `date()` function format](https://www.php.net/manual/en/function.date) to [jQuery UI date format](https://api.jqueryui.com/datepicker/#utility-formatDate).","params":[{"name":"$pattern","type":"string","description":"Date format pattern in PHP `date()` function format."}],"return":{"type":"string","description":"The converted date format pattern."},"static":true}}},"yii\\helpers\\BaseHtml":{"kind":"class","url":"https://yii2-framework.github.io/docs/api/yii/helpers/basehtml/","summary":"BaseHtml provides concrete implementation for `yii\\helpers\\Html`.","since":"2.0","properties":{"attributeOrder":{"type":"array","default":"['type', 'id', 'class', 'name', 'value', 'href', 'src', 'srcset', 'form', 'action', 'method', 'selected', 'checked', 'readonly', 'disabled', 'multiple', 'size', 'maxlength', 'width', 'height', 'rows', 'cols', 'alt', 'title', 'rel', 'media']","description":"The preferred order of attributes in a tag.","static":true},"attributeRegex":{"type":"string","default":"'/(^|.*\\])([\\w\\.\\+]+)(\\[.*|$)/u'","description":"Regular expression used for attribute name validation.","static":true,"since":"2.0.12"},"dataAttributes":{"type":"array","default":"['aria', 'data', 'data-ng', 'ng']","description":"List of tag attributes that should be specially handled when their values are of array type.","static":true,"since":"2.0.3"},"normalizeClassAttribute":{"type":"bool","default":"false","description":"Whether to removes duplicate class names in tag attribute `class`","static":true,"since":"2.0.44"},"voidElements":{"type":"array","default":"['area' => 1, 'base' => 1, 'br' => 1, 'col' => 1, 'command' => 1, 'embed' => 1, 'hr' => 1, 'img' => 1, 'input' => 1, 'keygen' => 1, 'link' => 1, 'meta' => 1, 'param' => 1, 'source' => 1, 'track' => 1, 'wbr' => 1]","description":"List of void elements (element name => 1)","static":true}},"methods":{"a":{"signature":"public static function a(string $text, array|string|null $url = null, array $options = []): string","summary":"Generates a hyperlink tag.","params":[{"name":"$text","type":"string","description":"Link body. It will NOT be HTML-encoded. Therefore you can pass in HTML code such as an image tag. If this is coming from end users, you should consider `encode()` it to prevent XSS attacks."},{"name":"$url","type":"array|string|null","default":"null","optional":true,"description":"The URL for the hyperlink tag. This parameter will be processed by `yii\\helpers\\Url::to()` and will be used for the \"href\" attribute of the tag. If this parameter is null, the \"href\" attribute will not be generated. If you want to use an absolute url you can call `yii\\helpers\\Url::to()` yourself, before passing the URL to this method, like this: ``` Html::a('link text', Url::to($url, true)) ```"},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. If a value is null, the corresponding attribute will not be rendered. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated hyperlink"},"static":true},"activeBooleanInput":{"signature":"protected static function activeBooleanInput(string $type, yii\\base\\Model $model, string $attribute, array $options = []): string","summary":"Generates a boolean input This method is mainly called by `activeCheckbox()` and `activeRadio()`.","params":[{"name":"$type","type":"string","description":"The input type. This can be either `radio` or `checkbox`."},{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. See `booleanInput()` for details about accepted attributes."}],"return":{"type":"string","description":"The generated input element"},"visibility":"protected","static":true,"since":"2.0.9"},"activeCheckbox":{"signature":"public static function activeCheckbox(yii\\base\\Model $model, string $attribute, array $options = []): string","summary":"Generates a checkbox tag together with a label for the given model attribute.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. See `booleanInput()` for details about accepted attributes."}],"return":{"type":"string","description":"The generated checkbox tag"},"static":true},"activeCheckboxList":{"signature":"public static function activeCheckboxList(yii\\base\\Model $model, string $attribute, array $items, array $options = []): string","summary":"Generates a list of checkboxes.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$items","type":"array","description":"The data item used to generate the checkboxes. The array keys are the checkbox values, and the array values are the corresponding labels."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"Options (name => config) for the checkbox list container tag. The following options are specially handled: - tag: string|false, the tag name of the container element. False to render checkbox without container. See also `tag()`. - unselect: string, the value that should be submitted when none of the checkboxes is selected. You may set this option to be null to prevent default value submission. If this option is not set, an empty string will be submitted. - encode: boolean, whether to HTML-encode the checkbox labels. Defaults to true. This option is ignored if `item` option is set. - separator: string, the HTML code that separates items. - itemOptions: array, the options for generating the checkbox tag using `checkbox()`. - item: callable, a callback that can be used to customize the generation of the HTML code corresponding to a single item in $items. The signature of this callback must be: ``` function ($index, $label, $name, $checked, $value) ``` where $index is the zero-based index of the checkbox in the whole list; $label is the label for the checkbox; and $name, $value and $checked represent the name, value and the checked status of the checkbox input. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated checkbox list"},"static":true},"activeDropDownList":{"signature":"public static function activeDropDownList(yii\\base\\Model $model, string $attribute, array $items, array $options = []): string","summary":"Generates a drop-down list for the given model attribute.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$items","type":"array","description":"The option data items. The array keys are option values, and the array values are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). For each sub-array, an option group will be generated whose label is the key associated with the sub-array. If you have a list of data models, you may convert them into the format described above using `yii\\helpers\\ArrayHelper::map()`. Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in the labels will also be HTML-encoded."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. The following options are specially handled: - prompt: string, a prompt text to be displayed as the first option. Since version 2.0.11 you can use an array to override the value and to set other tag attributes: ``` ['text' => 'Please select', 'options' => ['value' => 'none', 'class' => 'prompt', 'label' => 'Select']], ``` - options: array, the attributes for the select option tags. The array keys must be valid option values, and the array values are the extra attributes for the corresponding option tags. For example, ``` [ 'value1' => ['disabled' => true], 'value2' => ['label' => 'value 2'], ]; ``` - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options', except that the array keys represent the optgroup labels specified in $items. - encodeSpaces: bool, whether to encode spaces in option prompt and option value with ` ` character. Defaults to false. - encode: bool, whether to encode option prompt and option value characters. Defaults to `true`. This option is available since 2.0.3. The rest of the options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. If a value is null, the corresponding attribute will not be rendered. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated drop-down list tag"},"static":true},"activeFileInput":{"signature":"public static function activeFileInput(yii\\base\\Model $model, string $attribute, array $options = []): string","summary":"Generates a file input tag for the given model attribute.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. See `renderTagAttributes()` for details on how attributes are being rendered. If `hiddenOptions` parameter which is another set of HTML options array is defined, it will be extracted from `$options` to be used for the hidden input."}],"return":{"type":"string","description":"The generated input tag"},"static":true},"activeHiddenInput":{"signature":"public static function activeHiddenInput(yii\\base\\Model $model, string $attribute, array $options = []): string","summary":"Generates a hidden input tag for the given model attribute.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated input tag"},"static":true},"activeHint":{"signature":"public static function activeHint(yii\\base\\Model $model, string $attribute, array $options = []): string","summary":"Generates a hint tag for the given model attribute.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. If a value is null, the corresponding attribute will not be rendered. The following options are specially handled: - hint: this specifies the hint to be displayed. Note that this will NOT be encoded (`encode()`). If this is not set, `yii\\base\\Model::getAttributeHint()` will be called to get the hint for display (without encoding). See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated hint tag"},"static":true,"since":"2.0.4"},"activeInput":{"signature":"public static function activeInput(string $type, yii\\base\\Model $model, string $attribute, array $options = []): string","summary":"Generates an input tag for the given model attribute.","params":[{"name":"$type","type":"string","description":"The input type (e.g. 'text', 'password')"},{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated input tag"},"static":true},"activeLabel":{"signature":"public static function activeLabel(yii\\base\\Model $model, string $attribute, array $options = []): string","summary":"Generates a label tag for the given model attribute.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. If a value is null, the corresponding attribute will not be rendered. The following options are specially handled: - label: this specifies the label to be displayed. Note that this will NOT be encoded (`encode()`). If this is not set, `yii\\base\\Model::getAttributeLabel()` will be called to get the label for display (after encoding). See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated label tag"},"static":true},"activeListBox":{"signature":"public static function activeListBox(yii\\base\\Model $model, string $attribute, array $items, array $options = []): string","summary":"Generates a list box.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$items","type":"array","description":"The option data items. The array keys are option values, and the array values are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). For each sub-array, an option group will be generated whose label is the key associated with the sub-array. If you have a list of data models, you may convert them into the format described above using `yii\\helpers\\ArrayHelper::map()`. Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in the labels will also be HTML-encoded."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. The following options are specially handled: - prompt: string, a prompt text to be displayed as the first option. Since version 2.0.11 you can use an array to override the value and to set other tag attributes: ``` ['text' => 'Please select', 'options' => ['value' => 'none', 'class' => 'prompt', 'label' => 'Select']], ``` - options: array, the attributes for the select option tags. The array keys must be valid option values, and the array values are the extra attributes for the corresponding option tags. For example, ``` [ 'value1' => ['disabled' => true], 'value2' => ['label' => 'value 2'], ]; ``` - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options', except that the array keys represent the optgroup labels specified in $items. - unselect: string, the value that will be submitted when no option is selected. When this attribute is set, a hidden field will be generated so that if no option is selected in multiple mode, we can still obtain the posted unselect value. - encodeSpaces: bool, whether to encode spaces in option prompt and option value with ` ` character. Defaults to false. - encode: bool, whether to encode option prompt and option value characters. Defaults to `true`. This option is available since 2.0.3. The rest of the options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. If a value is null, the corresponding attribute will not be rendered. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated list box tag"},"static":true},"activeListInput":{"signature":"protected static function activeListInput(string $type, yii\\base\\Model $model, string $attribute, array $items, array $options = []): string","summary":"Generates a list of input fields.","params":[{"name":"$type","type":"string","description":"The input type. This can be 'listBox', 'radioList', or 'checkBoxList'."},{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$items","type":"array","description":"The data item used to generate the input fields. The array keys are the input values, and the array values are the corresponding labels."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"Options (name => config) for the input list. The supported special options depend on the input type specified by `$type`."}],"return":{"type":"string","description":"The generated input list"},"visibility":"protected","static":true},"activePasswordInput":{"signature":"public static function activePasswordInput(yii\\base\\Model $model, string $attribute, array $options = []): string","summary":"Generates a password input tag for the given model attribute.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. See `renderTagAttributes()` for details on how attributes are being rendered. The following special options are recognized: - maxlength: integer|boolean, when `maxlength` is set true and the model attribute is validated by a string validator, the `maxlength` option will take the max value of `yii\\validators\\StringValidator::$max` and [[\\yii\\validators\\StringValidator::length]. This is available since version 2.0.6 and improved taking `length` into account since version 2.0.42. - placeholder: string|boolean, when `placeholder` equals `true`, the attribute label from the $model will be used as a placeholder (this behavior is available since version 2.0.14)."}],"return":{"type":"string","description":"The generated input tag"},"static":true},"activeRadio":{"signature":"public static function activeRadio(yii\\base\\Model $model, string $attribute, array $options = []): string","summary":"Generates a radio button tag together with a label for the given model attribute.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. See `booleanInput()` for details about accepted attributes."}],"return":{"type":"string","description":"The generated radio button tag"},"static":true},"activeRadioList":{"signature":"public static function activeRadioList(yii\\base\\Model $model, string $attribute, array $items, array $options = []): string","summary":"Generates a list of radio buttons.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$items","type":"array","description":"The data item used to generate the radio buttons. The array keys are the radio values, and the array values are the corresponding labels."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"Options (name => config) for the radio button list container tag. The following options are specially handled: - tag: string|false, the tag name of the container element. False to render radio button without container. See also `tag()`. - unselect: string, the value that should be submitted when none of the radio buttons is selected. You may set this option to be null to prevent default value submission. If this option is not set, an empty string will be submitted. - encode: boolean, whether to HTML-encode the checkbox labels. Defaults to true. This option is ignored if `item` option is set. - separator: string, the HTML code that separates items. - itemOptions: array, the options for generating the radio button tag using `radio()`. - item: callable, a callback that can be used to customize the generation of the HTML code corresponding to a single item in $items. The signature of this callback must be: ``` function ($index, $label, $name, $checked, $value) ``` where $index is the zero-based index of the radio button in the whole list; $label is the label for the radio button; and $name, $value and $checked represent the name, value and the checked status of the radio button input. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated radio button list"},"static":true},"activeTextarea":{"signature":"public static function activeTextarea(yii\\base\\Model $model, string $attribute, array $options = []): string","summary":"Generates a textarea tag for the given model attribute.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. See `renderTagAttributes()` for details on how attributes are being rendered. The following special options are recognized: - maxlength: integer|boolean, when `maxlength` is set true and the model attribute is validated by a string validator, the `maxlength` option will take the max value of `yii\\validators\\StringValidator::$max` and [[\\yii\\validators\\StringValidator::length]. This is available since version 2.0.6 and improved taking `length` into account since version 2.0.42. - placeholder: string|boolean, when `placeholder` equals `true`, the attribute label from the $model will be used as a placeholder (this behavior is available since version 2.0.14)."}],"return":{"type":"string","description":"The generated textarea tag"},"static":true},"activeTextInput":{"signature":"public static function activeTextInput(yii\\base\\Model $model, string $attribute, array $options = []): string","summary":"Generates a text input tag for the given model attribute.","params":[{"name":"$model","type":"yii\\base\\Model","description":"The model object"},{"name":"$attribute","type":"string","description":"The attribute name or expression. See `getAttributeName()` for the format about attribute expression."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. See `renderTagAttributes()` for details on how attributes are being rendered. The following special options are recognized: - maxlength: integer|boolean, when `maxlength` is set true and the model attribute is validated by a string validator, the `maxlength` option will take the max value of `yii\\validators\\StringValidator::$max` and [[\\yii\\validators\\StringValidator::length]. This is available since version 2.0.3 and improved taking `length` into account since version 2.0.42. - placeholder: string|boolean, when `placeholder` equals `true`, the attribute label from the $model will be used as a placeholder (this behavior is available since version 2.0.14)."}],"return":{"type":"string","description":"The generated input tag"},"static":true},"addCssClass":{"signature":"public static function addCssClass(array &$options, string|array $class): mixed","summary":"Adds a CSS class (or several classes) to the specified options.","params":[{"name":"$options","type":"array","byReference":true,"description":"The options to be modified."},{"name":"$class","type":"string|array","description":"The CSS class(es) to be added"}],"return":{"type":"mixed"},"static":true},"addCssStyle":{"signature":"public static function addCssStyle(array &$options, string|array $style, bool $overwrite = true): mixed","summary":"Adds the specified CSS style to the HTML options.","params":[{"name":"$options","type":"array","byReference":true,"description":"The HTML options to be modified."},{"name":"$style","type":"string|array","description":"The new style string (e.g. `'width: 100px; height: 200px'`) or array (e.g. `['width' => '100px', 'height' => '200px']`)."},{"name":"$overwrite","type":"bool","default":"true","optional":true,"description":"Whether to overwrite existing CSS properties if the new style contain them too."}],"return":{"type":"mixed"},"static":true},"beginForm":{"signature":"public static function beginForm(array|string $action = '', string $method = 'post', array $options = []): string","summary":"Generates a form start tag.","params":[{"name":"$action","type":"array|string","default":"''","optional":true,"description":"The form action URL. This parameter will be processed by `yii\\helpers\\Url::to()`."},{"name":"$method","type":"string","default":"'post'","optional":true,"description":"The form submission method, such as \"post\", \"get\", \"put\", \"delete\" (case-insensitive). Since most browsers only support \"post\" and \"get\", if other methods are given, they will be simulated using \"post\", and a hidden input will be added which contains the actual method type. See `yii\\web\\Request::$methodParam` for more details."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. If a value is null, the corresponding attribute will not be rendered. See `renderTagAttributes()` for details on how attributes are being rendered. Special options: - `csrf`: whether to generate the CSRF hidden input. Defaults to true."}],"return":{"type":"string","description":"The generated form start tag."},"static":true},"beginTag":{"signature":"public static function beginTag(string|bool|null $name, array $options = []): string","summary":"Generates a start tag.","params":[{"name":"$name","type":"string|bool|null","description":"The tag name. If $name is `null` or `false`, the corresponding content will be rendered without any tag."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. If a value is null, the corresponding attribute will not be rendered. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated start tag"},"static":true},"booleanInput":{"signature":"protected static function booleanInput(string $type, string $name, bool $checked = false, array $options = []): string","summary":"Generates a boolean input.","params":[{"name":"$type","type":"string","description":"The input type. This can be either `radio` or `checkbox`."},{"name":"$name","type":"string","description":"The name attribute."},{"name":"$checked","type":"bool","default":"false","optional":true,"description":"Whether the checkbox should be checked."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. The following options are specially handled: - uncheck: string, the value associated with the uncheck state of the checkbox. When this attribute is present, a hidden input will be generated so that if the checkbox is not checked and is submitted, the value of this attribute will still be submitted to the server via the hidden input. - label: string, a label displayed next to the checkbox. It will NOT be HTML-encoded. Therefore you can pass in HTML code such as an image tag. If this is is coming from end users, you should `encode()` it to prevent XSS attacks. When this option is specified, the checkbox will be enclosed by a label tag. - labelOptions: array, the HTML attributes for the label tag. Do not set this option unless you set the \"label\" option. The rest of the options will be rendered as the attributes of the resulting checkbox tag. The values will be HTML-encoded using `encode()`. If a value is null, the corresponding attribute will not be rendered. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated checkbox tag"},"visibility":"protected","static":true,"since":"2.0.9"},"button":{"signature":"public static function button(string $content = 'Button', array $options = []): string","summary":"Generates a button tag.","params":[{"name":"$content","type":"string","default":"'Button'","optional":true,"description":"The content enclosed within the button tag. It will NOT be HTML-encoded. Therefore you can pass in HTML code such as an image tag. If this is is coming from end users, you should consider `encode()` it to prevent XSS attacks."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. If a value is null, the corresponding attribute will not be rendered. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated button tag"},"static":true},"buttonInput":{"signature":"public static function buttonInput(string|null $label = 'Button', array $options = []): string","summary":"Generates an input button.","params":[{"name":"$label","type":"string|null","default":"'Button'","optional":true,"description":"The value attribute. If it is null, the value attribute will not be generated."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using `encode()`. If a value is null, the corresponding attribute will not be rendered. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated button tag"},"static":true},"checkbox":{"signature":"public static function checkbox(string $name, bool $checked = false, array $options = []): string","summary":"Generates a checkbox input.","params":[{"name":"$name","type":"string","description":"The name attribute."},{"name":"$checked","type":"bool","default":"false","optional":true,"description":"Whether the checkbox should be checked."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. See `booleanInput()` for details about accepted attributes."}],"return":{"type":"string","description":"The generated checkbox tag"},"static":true},"checkboxList":{"signature":"public static function checkboxList(string $name, string|array|null $selection = null, array $items = [], array $options = []): string","summary":"Generates a list of checkboxes.","params":[{"name":"$name","type":"string","description":"The name attribute of each checkbox."},{"name":"$selection","type":"string|array|null","default":"null","optional":true,"description":"The selected value(s). String for single or array for multiple selection(s)."},{"name":"$items","type":"array","default":"[]","optional":true,"description":"The data item used to generate the checkboxes. The array keys are the checkbox values, while the array values are the corresponding labels."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"Options (name => config) for the checkbox list container tag. The following options are specially handled: - tag: string|false, the tag name of the container element. False to render checkbox without container. See also `tag()`. - unselect: string, the value that should be submitted when none of the checkboxes is selected. By setting this option, a hidden input will be generated. - disabled: boolean, whether the generated by unselect option hidden input should be disabled. Defaults to false. This option is available since version 2.0.16. - encode: boolean, whether to HTML-encode the checkbox labels. Defaults to true. This option is ignored if `item` option is set. - strict: boolean, if `$selection` is an array and this value is true a strict comparison will be performed on `$items` keys. Defaults to false. This option is available since 2.0.37. - separator: string, the HTML code that separates items. - itemOptions: array, the options for generating the checkbox tag using `checkbox()`. - item: callable, a callback that can be used to customize the generation of the HTML code corresponding to a single item in $items. The signature of this callback must be: ``` function ($index, $label, $name, $checked, $value) ``` where $index is the zero-based index of the checkbox in the whole list; $label is the label for the checkbox; and $name, $value and $checked represent the name, value and the checked status of the checkbox input, respectively. See `renderTagAttributes()` for details on how attributes are being rendered."}],"return":{"type":"string","description":"The generated checkbox list"},"static":true},"csrfMetaTags":{"signature":"public static function csrfMetaTags(): string","summary":"Generates the meta tags containing CSRF token information.","return":{"type":"string","description":"The generated meta tags"},"static":true},"cssFile":{"signature":"public static function cssFile(array|string $url, array $options = []): string","summary":"Generates a link tag that refers to an external CSS file.","params":[{"name":"$url","type":"array|string","description":"The URL of the external CSS file. This parameter will be processed by `yii\\helpers\\Url::to()`."},{"name":"$options","type":"array","default":"[]","optional":true,"description":"The tag options in terms of name-value pairs. The following options are specially handled: - condition: specifies the conditional comments for IE, e.g., `lt IE 9`. When this is specified, the generated `link` tag will be enclosed within the conditional comments. This is mainly useful for supporting old versions of IE browsers. - noscript: if set to true, `link` tag will be wrapped into `