HumHub Documentation (unofficial)

TopNavigationAsset extends AssetBundle
in package

AssetBundle represents a collection of asset files, such as CSS, JS, images.

Each asset bundle has a unique name that globally identifies it among all asset bundles used in an application. The name is the fully qualified class name of the class representing it.

An asset bundle can depend on other asset bundles. When registering an asset bundle with a view, all its dependent asset bundles will be automatically registered.

For more details and usage information on AssetBundle, see the guide article on assets.

Table of Contents

Properties

$basePath  : string
$baseUrl  : string
$css  : array<string|int, mixed>
$cssOptions  : array<string|int, mixed>
$depends  : array<string|int, mixed>
$js  : array<string|int, mixed>
$jsOptions  : array<string|int, mixed>
$publishOptions  : array<string|int, mixed>
$sourcePath  : string|null

Methods

__call()  : mixed
Calls the named method which is not a class method.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of an object property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets value of an object property.
__unset()  : mixed
Sets an object property to null.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined.
init()  : mixed
Initializes the bundle.
publish()  : mixed
Publishes the asset bundle if its source code is not under Web-accessible directory.
register()  : static
Registers this asset bundle with a view.
registerAssetFiles()  : mixed
Registers the CSS and JS files with the given view.

Properties

$basePath

public string $basePath = '@webroot-static'

the Web-accessible directory that contains the asset files in this bundle.

If [[sourcePath]] is set, this property will be overwritten by [[AssetManager]] when it publishes the asset files from [[sourcePath]].

You can use either a directory or an alias of the directory.

$baseUrl

public string $baseUrl = '@web-static'

the base URL for the relative asset files listed in [[js]] and [[css]].

If [[sourcePath]] is set, this property will be overwritten by [[AssetManager]] when it publishes the asset files from [[sourcePath]].

You can use either a URL or an alias of the URL.

$css

public array<string|int, mixed> $css = []

list of CSS files that this bundle contains. Each CSS file can be specified in one of the three formats as explained in [[js]].

Note that only a forward slash "/" should be used as directory separator.

$cssOptions

public array<string|int, mixed> $cssOptions = []

the options that will be passed to [[View::registerCssFile()]] when registering the CSS files in this bundle.

$depends

public array<string|int, mixed> $depends = []

list of bundle class names that this bundle depends on.

For example:

public $depends = [
   'yii\web\YiiAsset',
   'yii\bootstrap\BootstrapAsset',
];

$js

public array<string|int, mixed> $js = ['js/humhub/humhub.ui.topNavigation.js']

list of JavaScript files that this bundle contains. Each JavaScript file can be specified in one of the following formats:

  • an absolute URL representing an external asset. For example, https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js or //ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js.
  • a relative path representing a local asset (e.g. js/main.js). The actual file path of a local asset can be determined by prefixing [[basePath]] to the relative path, and the actual URL of the asset can be determined by prefixing [[baseUrl]] to the relative path.
  • an array, with the first entry being the URL or relative path as described before, and a list of key => value pairs that will be used to overwrite [[jsOptions]] settings for this entry. This functionality is available since version 2.0.7.

Note that only a forward slash "/" should be used as directory separator.

Tags
inheritdoc

$jsOptions

public array<string|int, mixed> $jsOptions = ['position' => \yii\web\View::POS_END]

the options that will be passed to [[View::registerJsFile()]] when registering the JS files in this bundle.

$publishOptions

public array<string|int, mixed> $publishOptions = []

the options to be passed to [[AssetManager::publish()]] when the asset bundle is being published. This property is used only when [[sourcePath]] is set.

$sourcePath

public string|null $sourcePath

the directory that contains the source asset files for this asset bundle. A source asset file is a file that is part of your source code repository of your Web application.

You must set this property if the directory containing the source asset files is not Web accessible. By setting this property, [[AssetManager]] will publish the source asset files to a Web-accessible directory automatically when the asset bundle is registered on a page.

If you do not set this property, it means the source asset files are located under [[basePath]].

You can use either a directory or an alias of the directory.

Tags
see
publishOptions

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call [[init()]].

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.

public __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
Return values
mixed —

the property value

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set (not null).

__set()

Sets value of an object property.

public __set(string $name, mixed $value) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__unset()

Sets an object property to null.

public __unset(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ]) : bool

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ]) : bool

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters
$name : string

the method name

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.

public hasProperty(string $name[, bool $checkVars = true ]) : bool

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the bundle.

public init() : mixed

If you override this method, make sure you call the parent implementation in the last.

publish()

Publishes the asset bundle if its source code is not under Web-accessible directory.

public publish(AssetManager $am) : mixed

It will also try to convert non-CSS or JS files (e.g. LESS, Sass) into the corresponding CSS or JS files using [[AssetManager::converter|asset converter]].

Parameters
$am : AssetManager

the asset manager to perform the asset publishing

register()

Registers this asset bundle with a view.

public static register(View $view) : static
Parameters
$view : View

the view to be registered with

Return values
static —

the registered asset bundle instance

registerAssetFiles()

Registers the CSS and JS files with the given view.

public registerAssetFiles(View $view) : mixed
Parameters
$view : View

the view that the asset files are to be registered with.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results