0 follower

Yii Framework 3.0 API Documentation

This is the Yii Framework API Documentation. Here you will find detailed information about all classes provided by the Framework. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 3.0 of the framework. You can use the dropdown menu on the top right to switch between versions.

You can search API documentation using the search form on the top. You can search for class names and also method and property names, e.g. ActiveRecord.save() or just .save() or ::save().

This page is also available in JSON format:
curl https://www.yiiframework.com/doc/api/3.0/config -H 'Accept: application/json'

Class Description
Yiisoft\Config\Command\ConfigCommandProvider
Yiisoft\Config\Command\CopyCommand CopyCommand copies the package configuration files from the vendor to the application.
Yiisoft\Config\Command\InfoCommand
Yiisoft\Config\Command\RebuildCommand RebuildCommand crawls all the configuration files and updates the merge plan file.
Yiisoft\Config\Composer\ConfigSettings
Yiisoft\Config\Composer\EventHandler ComposerEventHandler responds to composer event. In the package, its job is to prepare a merge plan that is later used by {@see Config}.
Yiisoft\Config\Composer\MergePlanProcess
Yiisoft\Config\Composer\Options
Yiisoft\Config\Composer\PackageFile
Yiisoft\Config\Composer\PackageFilesProcess
Yiisoft\Config\Composer\PackagesListBuilder
Yiisoft\Config\Composer\ProcessHelper
Yiisoft\Config\Config Config takes merge plan prepared by {@see \Yiisoft\Config\Composer\EventHandler} and executes actual merge for the config group specified.
Yiisoft\Config\ConfigInterface Provides methods for loading configuration of the groups.
Yiisoft\Config\ConfigPaths Store the configuration paths necessary for using the {@see Config} instance.
Yiisoft\Config\Context
Yiisoft\Config\DataModifiers
Yiisoft\Config\FilesExtractor
Yiisoft\Config\MergePlan
Yiisoft\Config\Merger
Yiisoft\Config\Modifier\RecursiveMerge Enable recursive merge for specified groups.
Yiisoft\Config\Modifier\RemoveFromVendor
Yiisoft\Config\Modifier\RemoveGroupsFromVendor
Yiisoft\Config\Modifier\RemoveKeysFromVendor
Yiisoft\Config\Modifier\ReverseMerge Result of reverse merge is being ordered descending by data source. It is useful for merging module config with base config where more specific config (i.e. module's) has more priority.