クラス yii\web\JqueryAsset
継承 | yii\web\JqueryAsset » yii\web\AssetBundle » yii\base\BaseObject |
---|---|
実装 | yii\base\Configurable |
利用可能バージョン | 2.0 |
ソースコード | https://github.com/yiisoft/yii2/blob/master/framework/web/JqueryAsset.php |
このアセットバンドルは、jQuery JavaScriptライブラリを提供します。
公開プロパティ
プロパティ | 型 | 説明 | 定義元 |
---|---|---|---|
$basePath |
string | このバンドル内のアセットファイルを含む、Webからアクセス可能なディレクトリ。 | yii\web\AssetBundle |
$baseUrl |
string | $js および$css にリストされている相対アセットファイルのベースURL。 |
yii\web\AssetBundle |
$css |
array | このバンドルに含まれるCSSファイルのリスト。 | yii\web\AssetBundle |
$cssOptions |
array | このバンドルのCSSファイルを登録する際に、yii\web\View::registerCssFile() に渡されるオプション。 |
yii\web\AssetBundle |
$depends |
array | このバンドルが依存するバンドルクラス名のリスト。 | yii\web\AssetBundle |
$js |
yii\web\JqueryAsset | ||
$jsOptions |
array | このバンドルのJSファイルを登録する際に、yii\web\View::registerJsFile() に渡されるオプション。 |
yii\web\AssetBundle |
$publishOptions |
array | アセットバンドルが公開される際に、yii\web\AssetManager::publish() に渡されるオプション。 |
yii\web\AssetBundle |
$sourcePath |
yii\web\JqueryAsset |
公開メソッド
メソッド | 説明 | 定義元 |
---|---|---|
__call() |
クラスメソッドではない、指定されたメソッドを呼び出します。 | yii\base\BaseObject |
__construct() |
コンストラクタ。 | yii\base\BaseObject |
__get() |
オブジェクトプロパティの値を返します。 | yii\base\BaseObject |
__isset() |
プロパティが設定されているか(定義されていてnullでないか)を確認します。 | yii\base\BaseObject |
__set() |
オブジェクトプロパティの値を設定します。 | yii\base\BaseObject |
__unset() |
オブジェクトプロパティをnullに設定します。 | 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() |
ソースコードがWebからアクセス可能なディレクトリにない場合、アセットバンドルを公開します。 | yii\web\AssetBundle |
register() |
ビューにこのアセットバンドルを登録します。 | yii\web\AssetBundle |
registerAssetFiles() |
指定されたビューにCSSとJSファイルを登録します。 | yii\web\AssetBundle |
プロパティの詳細
メソッドの詳細
定義元: yii\base\BaseObject::__call()
クラスメソッドではない、指定されたメソッドを呼び出します。
これはPHPのマジックメソッドであり、不明なメソッドが呼び出された際に暗黙的に呼び出されるため、直接呼び出さないでください。
public mixed __call ( $name , $params ) | ||
$name |
string |
メソッド名 |
$params |
array |
メソッドパラメータ |
戻り値 | mixed |
メソッドの戻り値 |
---|---|---|
例外 | yii\base\UnknownMethodException |
未知のメソッド呼び出し時 |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
定義位置: yii\base\BaseObject::__construct()
コンストラクタ。
デフォルトの実装では、以下の2つの処理を行います。
- 与えられた設定 `$config` を用いてオブジェクトを初期化します。
- init() を呼び出します。
このメソッドを子クラスでオーバーライドする場合は、
- コンストラクタの最後の引数を、ここで示すように `$config` のような設定配列にすることを推奨します。
- コンストラクタの最後に親の実装を呼び出してください。
public void __construct ( $config = [] ) | ||
$config | array |
オブジェクトのプロパティを初期化するために使用される、名前と値のペア |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定義位置: yii\base\BaseObject::__get()
オブジェクトプロパティの値を返します。
`$value = $object->property;` を実行した際に暗黙的に呼び出されるPHPのマジックメソッドであるため、直接このメソッドを呼び出さないでください。
__set() も参照してください。
public mixed __get ( $name ) | ||
$name |
string |
プロパティ名 |
戻り値 | mixed |
プロパティ値 |
---|---|---|
例外 | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
例外 | yii\base\InvalidCallException |
プロパティが書き込み専用の場合 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
定義位置: yii\base\BaseObject::__isset()
プロパティが設定されているか(定義されていてnullでないか)を確認します。
`isset($object->property)` を実行した際に暗黙的に呼び出されるPHPのマジックメソッドであるため、直接このメソッドを呼び出さないでください。
プロパティが定義されていない場合は、falseが返されることに注意してください。
public boolean __isset ( $name ) | ||
$name |
string |
プロパティ名またはイベント名 |
戻り値 | boolean |
指定されたプロパティが設定されているかどうか(nullではない)。 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
定義位置: yii\base\BaseObject::__set()
オブジェクトプロパティの値を設定します。
`$object->property = $value;` を実行した際に暗黙的に呼び出されるPHPのマジックメソッドであるため、直接このメソッドを呼び出さないでください。
__get() も参照してください。
public void __set ( $name, $value ) | ||
$name |
string |
プロパティ名またはイベント名 |
$value | mixed |
プロパティ値 |
例外 | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
---|---|---|
例外 | yii\base\InvalidCallException |
プロパティが読み取り専用の場合 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
定義位置: yii\base\BaseObject::__unset()
オブジェクトプロパティをnullに設定します。
`unset($object->property)` を実行した際に暗黙的に呼び出されるPHPのマジックメソッドであるため、直接このメソッドを呼び出さないでください。
プロパティが定義されていない場合は、このメソッドは何もしません。プロパティが読み取り専用の場合は、例外をスローします。
public void __unset ( $name ) | ||
$name |
string |
プロパティ名 |
例外 | yii\base\InvalidCallException |
プロパティが読み取り専用の場合。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
定義位置: yii\base\BaseObject::canGetProperty()
プロパティを読み取ることができるかどうかを示す値を返します。
プロパティは、以下の場合に読み取り可能です。
- クラスが、指定された名前に関連付けられたゲッターメソッドを持つ場合(この場合、プロパティ名はケースインセンシティブです)。
- クラスが、指定された名前のメンバ変数を持つ場合(`$checkVars` が true の場合)。
canSetProperty() も参照してください。
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name |
string |
プロパティ名 |
$checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
戻り値 | boolean |
プロパティを読み取ることができるかどうか |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
定義位置: yii\base\BaseObject::canSetProperty()
プロパティを設定できるかどうかを示す値を返します。
プロパティは、以下の場合に書き込み可能です。
- クラスが、指定された名前に関連付けられたセッターメソッドを持つ場合(この場合、プロパティ名はケースインセンシティブです)。
- クラスが、指定された名前のメンバ変数を持つ場合(`$checkVars` が true の場合)。
canGetProperty() も参照してください。
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name |
string |
プロパティ名 |
$checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
戻り値 | boolean |
プロパティに書き込むことができるかどうか |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
定義位置: yii\base\BaseObject::className()
このクラスの完全修飾名を返します。
public static string className ( ) | ||
戻り値 | string |
このクラスの完全修飾名。 |
---|
public static function className()
{
return get_called_class();
}
定義位置: yii\base\BaseObject::hasMethod()
メソッドが定義されているかどうかを示す値を返します。
デフォルトの実装は、PHP関数 `method_exists()` の呼び出しです。PHPのマジックメソッド `__call()` を実装した場合は、このメソッドをオーバーライドできます。
public boolean hasMethod ( $name ) | ||
$name |
string |
メソッド名 |
戻り値 | boolean |
メソッドが定義されているかどうか |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
定義先: yii\base\BaseObject::hasProperty()
プロパティが定義されているかどうかを示す値を返します。
プロパティは、以下の場合に定義済みとされます。
- 指定された名前と関連付けられたゲッターまたはセッターメソッドがクラスに存在する場合(この場合、プロパティ名は大小文字を区別しません)。
- クラスが、指定された名前のメンバ変数を持つ場合(`$checkVars` が true の場合)。
参照
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name |
string |
プロパティ名 |
$checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
戻り値 | boolean |
プロパティが定義されているかどうか |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
public void init ( ) |
public function init()
{
if ($this->sourcePath !== null) {
$this->sourcePath = rtrim(Yii::getAlias($this->sourcePath), '/\\');
}
if ($this->basePath !== null) {
$this->basePath = rtrim(Yii::getAlias($this->basePath), '/\\');
}
if ($this->baseUrl !== null) {
$this->baseUrl = rtrim(Yii::getAlias($this->baseUrl), '/');
}
}
定義先: yii\web\AssetBundle::publish()
ソースコードがWebからアクセス可能なディレクトリにない場合、アセットバンドルを公開します。
また、アセットコンバーター を使用して、CSSまたはJSファイル以外のファイル(LESS、Sassなど)を対応するCSSまたはJSファイルに変換しようとします。
public void publish ( $am ) | ||
$am | yii\web\AssetManager |
アセットの公開を実行するアセットマネージャー |
public function publish($am)
{
if ($this->sourcePath !== null && !isset($this->basePath, $this->baseUrl)) {
list($this->basePath, $this->baseUrl) = $am->publish($this->sourcePath, $this->publishOptions);
}
if (isset($this->basePath, $this->baseUrl) && ($converter = $am->getConverter()) !== null) {
foreach ($this->js as $i => $js) {
if (is_array($js)) {
$file = array_shift($js);
if (Url::isRelative($file)) {
$js = ArrayHelper::merge($this->jsOptions, $js);
array_unshift($js, $converter->convert($file, $this->basePath));
$this->js[$i] = $js;
}
} elseif (Url::isRelative($js)) {
$this->js[$i] = $converter->convert($js, $this->basePath);
}
}
foreach ($this->css as $i => $css) {
if (is_array($css)) {
$file = array_shift($css);
if (Url::isRelative($file)) {
$css = ArrayHelper::merge($this->cssOptions, $css);
array_unshift($css, $converter->convert($file, $this->basePath));
$this->css[$i] = $css;
}
} elseif (Url::isRelative($css)) {
$this->css[$i] = $converter->convert($css, $this->basePath);
}
}
}
}
定義先: yii\web\AssetBundle::register()
ビューにこのアセットバンドルを登録します。
public static static register ( $view ) | ||
$view | yii\web\View |
登録先のビュー |
戻り値 | yii\web\AssetBundle |
登録されたアセットバンドルインスタンス |
---|
public static function register($view)
{
return $view->registerAssetBundle(get_called_class());
}
定義先: yii\web\AssetBundle::registerAssetFiles()
指定されたビューにCSSとJSファイルを登録します。
public void registerAssetFiles ( $view ) | ||
$view | yii\web\View |
アセットファイルを登録するビュー。 |
public function registerAssetFiles($view)
{
$manager = $view->getAssetManager();
foreach ($this->js as $js) {
if (is_array($js)) {
$file = array_shift($js);
$options = ArrayHelper::merge($this->jsOptions, $js);
$view->registerJsFile($manager->getAssetUrl($this, $file, ArrayHelper::getValue($options, 'appendTimestamp')), $options);
} elseif ($js !== null) {
$view->registerJsFile($manager->getAssetUrl($this, $js), $this->jsOptions);
}
}
foreach ($this->css as $css) {
if (is_array($css)) {
$file = array_shift($css);
$options = ArrayHelper::merge($this->cssOptions, $css);
$view->registerCssFile($manager->getAssetUrl($this, $file, ArrayHelper::getValue($options, 'appendTimestamp')), $options);
} elseif ($css !== null) {
$view->registerCssFile($manager->getAssetUrl($this, $css), $this->cssOptions);
}
}
}
サインアップ または ログイン してコメントしてください。