類別 yii\grid\GridViewAsset
繼承 | yii\grid\GridViewAsset » yii\web\AssetBundle » yii\base\BaseObject |
---|---|
實作 | yii\base\Configurable |
自版本起可用 | 2.0 |
原始碼 | https://github.com/yiisoft/yii2/blob/master/framework/grid/GridViewAsset.php |
此資源包為 yii\grid\GridView 小部件提供 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 | yii\grid\GridViewAsset | ||
$js | yii\grid\GridViewAsset | ||
$jsOptions | array | 當在此套件中註冊 JS 檔案時,將會傳遞給 yii\web\View::registerJsFile() 的選項。 | yii\web\AssetBundle |
$publishOptions | array | 當發佈 asset bundle 時,將會傳遞給 yii\web\AssetManager::publish() 的選項。 | yii\web\AssetBundle |
$sourcePath | yii\grid\GridViewAsset |
公開方法
方法 | 描述 | 定義於 |
---|---|---|
__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() | 如果 asset bundle 的原始碼不在 Web 可存取的目錄下,則發佈該套件。 | yii\web\AssetBundle |
register() | 向 view 註冊此 asset bundle。 | yii\web\AssetBundle |
registerAssetFiles() | 向指定的 view 註冊 CSS 和 JS 檔案。 | yii\web\AssetBundle |
屬性詳情
方法詳情
public mixed __call ( $name, $params ) | ||
$name | string |
方法名稱 |
$params | array |
方法參數 |
return | mixed |
方法回傳值 |
---|---|---|
throws | yii\base\UnknownMethodException |
當呼叫未知方法時 |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
定義於: yii\base\BaseObject::__construct()
建構子。
預設實作會做兩件事
- 使用給定的組態
$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()
回傳物件屬性的值。
請勿直接呼叫此方法,因為它是 PHP 的魔術方法,當執行 $value = $object->property;
時會被隱式呼叫。
另請參閱 __set()。
public mixed __get ( $name ) | ||
$name | string |
屬性名稱 |
return | mixed |
屬性值 |
---|---|---|
throws | yii\base\UnknownPropertyException |
如果屬性未定義 |
throws | 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。
請勿直接呼叫此方法,因為它是 PHP 的魔術方法,當執行 isset($object->property)
時會被隱式呼叫。
請注意,如果屬性未定義,將回傳 false。
public boolean __isset ( $name ) | ||
$name | string |
屬性名稱或事件名稱 |
return | boolean |
具名屬性是否已設定 (非 null)。 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
定義於: yii\base\BaseObject::__set()
設定物件屬性的值。
請勿直接呼叫此方法,因為它是 PHP 的魔術方法,當執行 $object->property = $value;
時會被隱式呼叫。
另請參閱 __get()。
public void __set ( $name, $value ) | ||
$name | string |
屬性名稱或事件名稱 |
$value | mixed |
屬性值 |
throws | yii\base\UnknownPropertyException |
如果屬性未定義 |
---|---|---|
throws | 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。
請勿直接呼叫此方法,因為它是 PHP 的魔術方法,當執行 unset($object->property)
時會被隱式呼叫。
請注意,如果屬性未定義,此方法將不會執行任何操作。如果屬性為唯讀,則會拋出例外。
public void __unset ( $name ) | ||
$name | string |
屬性名稱 |
throws | 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()
回傳一個值,指示屬性是否可讀取。
如果屬性可讀取:
- 類別具有與指定名稱關聯的 getter 方法(在此情況下,屬性名稱不區分大小寫);
- 類別具有帶有指定名稱的成員變數(當
$checkVars
為 true 時);
另請參閱 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
return | boolean |
屬性是否可讀取 |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
定義於: yii\base\BaseObject::canSetProperty()
回傳一個值,指示屬性是否可設定。
如果屬性可寫入:
- 類別具有與指定名稱關聯的 setter 方法(在此情況下,屬性名稱不區分大小寫);
- 類別具有帶有指定名稱的成員變數(當
$checkVars
為 true 時);
另請參閱 canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
return | boolean |
屬性是否可寫入 |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class
。
定義於: yii\base\BaseObject::className()
回傳此類別的完整限定名稱。
public static string className ( ) | ||
return | string |
此類別的完整限定名稱。 |
---|
public static function className()
{
return get_called_class();
}
定義於: yii\base\BaseObject::hasMethod()
回傳一個值,指示方法是否已定義。
預設實作是對 php 函數 method_exists()
的呼叫。當您實作了 php 魔術方法 __call()
時,您可以覆寫此方法。
public boolean hasMethod ( $name ) | ||
$name | string |
方法名稱 |
return | boolean |
方法是否已定義 |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
定義於: yii\base\BaseObject::hasProperty()
回傳一個值,指示屬性是否已定義。
如果滿足以下任一條件,則屬性已定義:
- 類別具有與指定名稱關聯的 getter 或 setter 方法(在此情況下,屬性名稱不區分大小寫);
- 類別具有帶有指定名稱的成員變數(當
$checkVars
為 true 時);
另請參閱
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
return | 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()
如果 asset bundle 的原始碼不在 Web 可存取的目錄下,則發佈該套件。
它也會嘗試使用 asset converter 將非 CSS 或 JS 檔案(例如 LESS、Sass)轉換為對應的 CSS 或 JS 檔案。
public void publish ( $am ) | ||
$am | yii\web\AssetManager |
執行 asset 發佈的 asset manager |
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()
向 view 註冊此 asset bundle。
public static static register ( $view ) | ||
$view | yii\web\View |
要註冊的 view |
return | yii\web\AssetBundle |
已註冊的 asset bundle 實例 |
---|
public static function register($view)
{
return $view->registerAssetBundle(get_called_class());
}
定義於: yii\web\AssetBundle::registerAssetFiles()
向指定的 view 註冊 CSS 和 JS 檔案。
public void registerAssetFiles ( $view ) | ||
$view | yii\web\View |
要註冊 asset 檔案的 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);
}
}
}
註冊 或 登入 以發表評論。