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/assets -H 'Accept: application/json'

Class Description
Yiisoft\Assets\AssetBundle AssetBundle represents a collection of asset files, such as CSS, JS, images.
Yiisoft\Assets\AssetConverter AssetConverter supports conversion of several popular script formats into JavaScript or CSS.
Yiisoft\Assets\AssetConverterInterface The AssetConverterInterface must be implemented by asset converter classes. The job of such class is to convert an asset from one format to another. For example, from Sass to CSS.
Yiisoft\Assets\AssetExporterInterface The AssetExporterInterface must be implemented by asset exporter classes. The job of such class is to export asset bundles provided into a format readable by third party tools such as Webpack.
Yiisoft\Assets\AssetLoader AssetLoader is responsible for executing the loading of the assets from {@see AssetBundle::$basePath} to {@see AssetBundle::$baseUrl}.
Yiisoft\Assets\AssetLoaderInterface The AssetLoaderInterface must be implemented by asset loader classes. The job of such class is executing the loading of the assets from {@see AssetBundle::$basePath} to {@see AssetBundle::$baseUrl}.
Yiisoft\Assets\AssetManager AssetManager manages asset bundle configuration and loading.
Yiisoft\Assets\AssetPublisher AssetPublisher is responsible for executing the publication of the assets from {@see AssetBundle::$sourcePath} to {@see AssetBundle::$basePath}.
Yiisoft\Assets\AssetPublisherInterface The AssetPublisherInterface must be implemented by asset publisher classes.
Yiisoft\Assets\AssetRegistrar AssetRegistrar registers asset files, code blocks and variables from a bundle considering dependencies.
Yiisoft\Assets\AssetUtil AssetUtil shared functions.
Yiisoft\Assets\Debug\AssetCollector
Yiisoft\Assets\Debug\AssetLoaderInterfaceProxy
Yiisoft\Assets\Exception\InvalidConfigException InvalidConfigException is thrown when configuration of asset bundle is not valid.
Yiisoft\Assets\Exporter\JsonAssetExporter Exports the file paths of asset bundles {@see AssetBundle::$export} to a JSON file.
Yiisoft\Assets\Exporter\WebpackAssetExporter Exports the file paths of asset bundles {@see AssetBundle::$export}, converting them to import '/path/to/file'; expressions and placing them in the specified JavaScript file for later loading into Webpack.