• Home
• yii
• web
• AssetManager

PHP Class yii\web\AssetManager

AssetManager is configured as an application component in Application by default. You can access that instance via Yii::$app->assetManager. You can modify its configuration by adding an array to your application config under components as shown in the following example: php 'assetManager' => [ 'bundles' => [ you can override AssetBundle configs here ], ] For more details and usage information on AssetManager, see the guide article on assets. ファイルを表示 Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property	Type	Description
$afterCopy		a PHP callback that is called after a sub-directory or file is successfully copied. This option is used only when publishing a directory. The signature of the callback is the same as for [[beforeCopy]]. This is passed as a parameter afterCopy to [[\yii\helpers\FileHelper::copyDirectory()]].
$appendTimestamp		whether to append a timestamp to the URL of every published asset. When this is true, the URL of a published asset may look like /path/to/asset?v=timestamp, where timestamp is the last modification time of the published asset file. You normally would want to set this property to true when you have enabled HTTP caching for assets, because it allows you to bust caching when the assets are updated.
$assetMap		mapping from source asset files (keys) to target asset files (values). This property is provided to support fixing incorrect asset file paths in some asset bundles. When an asset bundle is registered with a view, each relative asset file in its [[AssetBundle::css|css]] and [[AssetBundle::js|js]] arrays will be examined against this map. If any of the keys is found to be the last part of an asset file (which is prefixed with [[AssetBundle::sourcePath]] if available), the corresponding value will replace the asset and be registered with the view. For example, an asset file my/path/to/jquery.js matches a key jquery.js. Note that the target asset files should be absolute URLs, domain relative URLs (starting from '/') or paths relative to [[baseUrl]] and [[basePath]]. In the following example, any assets ending with jquery.min.js will be replaced with jquery/dist/jquery.js which is relative to [[baseUrl]] and [[basePath]]. php [ 'jquery.min.js' => 'jquery/dist/jquery.js', ] You may also use aliases while specifying map value, for example: php [ 'jquery.min.js' => '@web/js/jquery/jquery.js', ]
$basePath		the root directory storing the published asset files.
$baseUrl		the base URL through which the published asset files can be accessed.
$beforeCopy		a PHP callback that is called before copying each sub-directory or file. This option is used only when publishing a directory. 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. This is passed as a parameter beforeCopy to [[\yii\helpers\FileHelper::copyDirectory()]].
$bundles		list of asset bundle configurations. This property is provided to customize asset bundles. When a bundle is being loaded by AssetManager::getBundle, if it has a corresponding configuration specified here, the configuration will be applied to the bundle. The array keys are the asset bundle names, which typically are asset bundle class names without leading backslash. The array values are the corresponding configurations. If a value is false, it means the corresponding asset bundle is disabled and AssetManager::getBundle should return null. If this property is false, it means the whole asset bundle feature is disabled and AssetManager::getBundle will always return null. The following example shows how to disable the bootstrap css file used by Bootstrap widgets (because you want to use your own styles): php [ 'yii\bootstrap\BootstrapAsset' => [ 'css' => [], ], ]
$dirMode		the permission to be set for newly generated asset directories. This value will be used by PHP chmod() function. No umask will be applied. Defaults to 0775, meaning the directory is read-writable by owner and group, but read-only for other users.
$fileMode		the permission to be set for newly published asset files. This value will be used by PHP chmod() function. No umask will be applied. If not set, the permission will be determined by the current environment.
$forceCopy		whether the directory being published should be copied even if it is found in the target directory. This option is used only when publishing a directory. You may want to set this to be true during the development stage to make sure the published directory is always up-to-date. Do not set this to true on production servers as it will significantly degrade the performance.
$hashCallback		a callback that will be called to produce hash for asset directory generation. The signature of the callback should be as follows: function ($path) where $path is the asset path. Note that the $path can be either directory where the asset files reside or a single file. For a CSS file that uses relative path in url(), the hash implementation should use the directory path of the file instead of the file path to include the relative asset files in the copying. If this is not set, the asset manager will use the default CRC32 and filemtime in the hash method. Example of an implementation using MD4 hash: php function ($path) { return hash('md4', $path); }
$linkAssets		whether to use symbolic link to publish asset files. Defaults to false, meaning asset files are copied to [[basePath]]. Using symbolic links has the benefit that the published assets will always be consistent with the source assets and there is no copy operation required. This is especially useful during development. However, there are special requirements for hosting environments in order to use symbolic links. In particular, symbolic links are supported only on Linux/Unix, and Windows Vista/2008 or greater. Moreover, some Web servers need to be properly configured so that the linked assets are accessible to Web users. For example, for Apache Web server, the following configuration directive should be added for the Web folder: apache Options FollowSymLinks

Public Methods

Method	Description
getAssetPath ( AssetBundle $bundle, string $asset ) : string | false	Returns the actual file path for the specified asset.
getAssetUrl ( AssetBundle $bundle, string $asset ) : string	Returns the actual URL for the specified asset.
getBundle ( string $name, boolean $publish = true ) : AssetBundle	Returns the named asset bundle.
getConverter ( ) : yii\web\AssetConverterInterface	Returns the asset converter.
getPublishedPath ( string $path ) : string | false	Returns the published path of a file path.
getPublishedUrl ( string $path ) : string | false	Returns the URL of a published file path.
init ( )	Initializes the component.
publish ( string $path, array $options = [] ) : array	Publishes a file or a directory.
setConverter ( array | yii\web\AssetConverterInterface $value )	Sets the asset converter.

Protected Methods

Method	Description
hash ( string $path ) : string	Generate a CRC32 hash for the directory path. Collisions are higher than MD5 but generates a much smaller hash string.
loadBundle ( string $name, array $config = [], boolean $publish = true ) : AssetBundle	Loads asset bundle class by name
loadDummyBundle ( string $name ) : AssetBundle	Loads dummy bundle by name
publishDirectory ( string $src, array $options ) : string[]	Publishes a directory.
publishFile ( string $src ) : string[]	Publishes a file.
resolveAsset ( AssetBundle $bundle, string $asset ) : string | boolean

Method Details

Property Details