HumHub Documentation (unofficial)

AlertBlock extends AlertBlock
in package

yii2

widgets

Alert block widget that groups multiple `\kartik\widget\Alert` or `kartik\widget\Growl` widgets as one single block.

You can choose to automatically read and display session flash messages (which is the default setting) or setup your own block of custom alerts.

Constants

EVENT_AFTER_RUN = 'afterRun'
EVENT_BEFORE_RUN = 'beforeRun'
EVENT_INIT = 'init'
TYPE_ALERT = 'alert': Default bootstrap alert style
TYPE_GROWL = 'growl': Bootstrap growl plugin alert style

Properties

$alertSettings : array<string|int, mixed>
$autoIdPrefix : string
$behaviors : array<string|int, Behavior>
$bsColCssPrefixes : array<string|int, mixed>
$bsCssMap : array<string|int, mixed>
$bsVersion : int|string
$closeButton : array<string|int, mixed>
$defaultOptions : array<string|int, mixed>
$defaultPluginOptions : array<string|int, mixed>
$delay : int
$hashVarLoadPosition : int
$i18n : array<string|int, mixed>
$id : string|null
$moduleId : string
$options : array<string|int, mixed>
$pjaxContainerId : string
$pjaxDuplicationFix : bool
$pluginDestroyJs : string
$pluginEvents : array<string|int, mixed>
$pluginName : string
$pluginOptions : array<string|int, mixed>
$sourcePath : string
$type : string
$useSessionFlash : bool
$view : View
$viewPath : string
$_bsVer : int
$_dataVar : string
$_defaultBtnCss : string
$_defaultIconPrefix : string
$_encOptions : string
$_hashVar : string
$_isBs4 : bool
$_msgCat : string
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_id : mixed
$_view : mixed

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
addCssClass() : Widget|mixed: Adds bootstrap CSS class to options by parsing the bootstrap version for the specified Bootstrap CSS type.
afterRun() : mixed: This method is invoked right after a widget is executed.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
beforeRun() : bool: This method is invoked right before the widget is executed.
begin() : static: Begins a widget.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
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.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
end() : static: Ends a widget.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
getBaseSourcePath() : string|false: Get parsed base source path based on [[sourcePath]] setting. If [[sourcePath]] is not set, it will return the current working directory of this widget class.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getBSClass() : mixed: Gets the respective Bootstrap class based on currently configured bootstrap version.
getBsVer() : int: Gets the current set bootstrap version number.
getCssClass() : string: Gets bootstrap css class by parsing the bootstrap version for the specified BS CSS type.
getDefaultBtnCss() : string: Gets the default button CSS
getDefaultIconPrefix() : string: Gets the default icon css prefix
getDropdownClass() : string: Gets the respective bootstrap dropdown class name based on currently configured bootstrap version.
getId() : string|null: Returns the ID of the widget.
getView() : View: Returns the view object that can be used to render views or view files.
getViewPath() : string: Returns the directory containing the view files for this widget.
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes the object.
initI18N() : mixed: Yii i18n messages configuration for generating translations
isBs() : bool: Validate Bootstrap version
isBs4() : bool: Validate if Bootstrap 4.x version.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
registerWidgetJs() : mixed: Registers a JS code block for the widget.
removeCssClass() : Widget|mixed: Removes bootstrap CSS class from options by parsing the bootstrap version for the specified Bootstrap CSS type.
render() : string: Renders a view.
renderAlerts() : mixed: Renders manually set alerts
renderFile() : string: Renders a view file.
renderFlashAlerts() : mixed: Renders alerts from session flash settings.
run() : string|void: Executes the widget.
setId() : mixed: Sets the ID of the widget.
setView() : mixed: Sets the view object to be used by this widget.
trigger() : mixed: Triggers an event.
widget() : string: Creates a widget instance and runs it.
addAsset() : mixed: Adds an asset to the view.
configureBsVersion() : int: Configures the bootstrap version settings
fixPjaxDuplication() : mixed: Fix for weird PJAX container duplication behavior on pressing browser back and forward buttons.
getBsExtBasename() : string: The yii2-bootstrap extension base name.
getPluginScript() : string: Returns the plugin registration script.
hashPluginOptions() : mixed: Generates a hashed variable to store the pluginOptions.
initBsVersion() : mixed: Initializes bootstrap versions for the widgets and asset bundles.
initDestroyJs() : mixed: Generates the `pluginDestroyJs` script if it is not set.
initOptions() : mixed: Initializes widget options and settings.
isSameVersion() : bool: Compares two versions and checks if they are of the same major BS version.
mergeDefaultOptions() : mixed: Merge default options
parseVer() : int: Parses and returns the major BS version
registerPlugin() : mixed: Registers a specific plugin and the related events
registerPluginOptions() : mixed: Registers plugin options by storing within a uniquely generated javascript variable.
renderCloseButton() : string: Renders the close button.
setDataVar() : mixed: Sets a HTML5 data variable.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

EVENT_AFTER_RUN


    public
        mixed
    EVENT_AFTER_RUN
    = 'afterRun'

EVENT_BEFORE_RUN


    public
        mixed
    EVENT_BEFORE_RUN
    = 'beforeRun'

EVENT_INIT


    public
        mixed
    EVENT_INIT
    = 'init'

TYPE_ALERT

Default bootstrap alert style


    public
        mixed
    TYPE_ALERT
    = 'alert'

TYPE_GROWL

Bootstrap growl plugin alert style


    public
        mixed
    TYPE_GROWL
    = 'growl'

$alertSettings


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

the alert types configuration for the alert messages. This array is setup as $alert => $settings, where:

$alert: string, is the name of the session flash variable (e.g. error, success, info, warning).
$settings: array, the [[Alert]] or [[Growl]] widget settings depending on the [[type]] set.

$autoIdPrefix


    public
    static    string
    $autoIdPrefix
     = 'w'

the prefix to the automatically generated widget IDs.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$bsColCssPrefixes


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

the bootstrap grid column css prefixes mapping, the key is the bootstrap versions, and the value is an array containing the sizes and their corresponding grid column css prefixes. The class using this trait, must implement BootstrapInterface. If not set will default to:

[
    3 => [
        self::SIZE_X_SMALL => 'col-xs-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-lg-',
    ],
    4 => [
        self::SIZE_X_SMALL => 'col-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-xl-',
    ],
    5 => [
        self::SIZE_X_SMALL => 'col-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-xl-',
    ],
];

$bsCssMap


    public
    static    array<string|int, mixed>
    $bsCssMap
     = [self::BS_SR_ONLY => ['sr-only', 'sr-only', 'visually-hidden'], self::BS_PANEL => ['panel', 'card'], self::BS_PANEL_HEADING => ['panel-heading', 'card-header'], self::BS_PANEL_TITLE => ['panel-title', 'card-title'], self::BS_PANEL_BODY => ['panel-body', 'card-body'], self::BS_PANEL_FOOTER => ['panel-footer', 'card-footer'], self::BS_PANEL_DEFAULT => ['panel-default', ['bg-light', 'text-dark']], self::BS_PANEL_DARK => ['panel-default', ['bg-dark', 'text-white']], self::BS_PANEL_SECONDARY => ['panel-default', ['bg-secondary', 'text-white']], self::BS_PANEL_PRIMARY => ['panel-primary', ['bg-primary', 'text-white']], self::BS_PANEL_SUCCESS => ['panel-success', ['bg-success', 'text-white']], self::BS_PANEL_INFO => ['panel-info', ['bg-info', 'text-dark']], self::BS_PANEL_WARNING => ['panel-warning', ['bg-warning', 'text-dark']], self::BS_PANEL_DANGER => ['panel-danger', ['bg-danger', 'text-white']], self::BS_LABEL => ['label', 'badge'], self::BS_BADGE => ['badge', ['badge', 'badge-pill'], ['badge', 'rounded-pill']], self::BS_LABEL_DEFAULT => ['label-default', 'badge-secondary', 'bg-secondary'], self::BS_LABEL_LIGHT => ['label-default', ['bg-light', 'text-dark']], self::BS_LABEL_DARK => ['label-default', ['bg-dark', 'text-white']], self::BS_LABEL_PRIMARY => ['label-primary', 'badge-primary', 'bg-primary'], self::BS_LABEL_SUCCESS => ['label-success', 'badge-success', 'bg-success'], self::BS_LABEL_INFO => ['label-info', 'badge-info', ['bg-info', 'text-dark']], self::BS_LABEL_WARNING => ['label-warning', 'badge-warning', ['bg-warning', 'text-dark']], self::BS_LABEL_DANGER => ['label-danger', 'badge-danger', 'bg-danger'], self::BS_TABLE_ACTIVE => ['default', 'table-active'], self::BS_TABLE_PRIMARY => ['primary', 'table-primary'], self::BS_TABLE_SUCCESS => ['success', 'table-success'], self::BS_TABLE_INFO => ['info', 'table-info'], self::BS_TABLE_WARNING => ['warning', 'table-warning'], self::BS_TABLE_DANGER => ['danger', 'table-danger'], self::BS_PROGRESS_BAR_ACTIVE => ['active', 'progress-bar-animated'], self::BS_PROGRESS_BAR_PRIMARY => ['progress-bar-primary', 'bg-primary'], self::BS_PROGRESS_BAR_SUCCESS => ['progress-bar-success', 'bg-success'], self::BS_PROGRESS_BAR_INFO => ['progress-bar-info', 'bg-info'], self::BS_PROGRESS_BAR_WARNING => ['progress-bar-warning', 'bg-warning'], self::BS_PROGRESS_BAR_DANGER => ['progress-bar-danger', 'bg-danger'], self::BS_WELL => ['well', ['card', 'card-body']], self::BS_WELL_SM => ['well-sm', ['card', 'card-body', 'p-2']], self::BS_WELL_LG => ['well-lg', ['card', 'card-body', 'p-4']], self::BS_THUMBNAIL => ['thumbnail', ['card', 'card-body']], self::BS_NAVBAR_DEFAULT => ['navbar-default', 'navbar-light'], self::BS_NAVBAR_TOGGLE => ['navbar-toggle', 'navbar-toggler'], self::BS_NAVBAR_RIGHT => ['navbar-right', 'ml-auto'], self::BS_NAVBAR_BTN => ['navbar-btn', 'nav-item'], self::BS_NAVBAR_FIXTOP => ['navbar-fixed-top', 'fixed-top'], self::BS_NAV_STACKED => ['nav-stacked', 'flex-column'], self::BS_NAV_ITEM => ['', 'nav-item'], self::BS_NAV_LINK => ['', 'nav-link'], self::BS_PAGE_ITEM => ['', 'page-item'], self::BS_PAGE_LINK => ['', 'page-link'], self::BS_LIST_INLINE_ITEM => ['', 'list-inline-item'], self::BS_BTN_DEFAULT => ['btn-default', 'btn-secondary'], self::BS_IMG_RESPONSIVE => ['img-responsive', 'img-fluid'], self::BS_IMG_CIRCLE => ['img-circle', 'rounded-circle'], self::BS_IMG_ROUNDED => ['img-rounded', 'rounded'], self::BS_RADIO => ['radio', 'form-check'], self::BS_CHECKBOX => ['checkbox', 'form-check'], self::BS_INPUT_LG => ['input-lg', 'form-control-lg'], self::BS_INPUT_SM => ['input-sm', 'form-control-sm'], self::BS_CONTROL_LABEL => ['control-label', 'col-form-label'], self::BS_TABLE_CONDENSED => ['table-condensed', 'table-sm'], self::BS_CAROUSEL_ITEM => ['item', 'carousel-item'], self::BS_CAROUSEL_ITEM_NEXT => ['next', 'carousel-item-next'], self::BS_CAROUSEL_ITEM_PREV => ['prev', 'carousel-item-prev'], self::BS_CAROUSEL_ITEM_LEFT => ['left', 'carousel-item-left'], self::BS_CAROUSEL_ITEM_RIGHT => ['right', 'carousel-item-right'], self::BS_CAROUSEL_CONTROL_LEFT => [['carousel-control', 'left'], 'carousel-control-left'], self::BS_CAROUSEL_CONTROL_RIGHT => [['carousel-control', 'right'], 'carousel-control-right'], self::BS_HELP_BLOCK => ['help-block', 'form-text'], self::BS_PULL_RIGHT => ['pull-right', 'float-right', 'float-end'], self::BS_PULL_LEFT => ['pull-left', 'float-left', 'float-start'], self::BS_CENTER_BLOCK => ['center-block', ['mx-auto', 'd-block']], self::BS_HIDE => ['hide', 'd-none'], self::BS_HIDDEN_PRINT => ['hidden-print', 'd-print-none'], self::BS_HIDDEN_XS => ['hidden-xs', ['d-none', 'd-sm-block']], self::BS_HIDDEN_SM => ['hidden-sm', ['d-sm-none', 'd-md-block']], self::BS_HIDDEN_MD => ['hidden-md', ['d-md-none', 'd-lg-block']], self::BS_HIDDEN_LG => ['hidden-lg', ['d-lg-none', 'd-xl-block']], self::BS_VISIBLE_PRINT => ['visible-print-block', ['d-print-block', 'd-none']], self::BS_VISIBLE_XS => ['visible-xs', ['d-block', 'd-sm-none']], self::BS_VISIBLE_SM => ['visible-sm', ['d-none', 'd-sm-block', 'd-md-none']], self::BS_VISIBLE_MD => ['visible-md', ['d-none', 'd-md-block', 'd-lg-none']], self::BS_VISIBLE_LG => ['visible-md', ['d-none', 'd-lg-block', 'd-xl-none']], self::BS_FORM_CONTROL_STATIC => ['form-control-static', 'form-control-plaintext'], self::BS_DROPDOWN_DIVIDER => ['divider', 'dropdown-divider'], self::BS_SHOW => ['in', 'show']]

CSS conversion mappings across bootstrap library versions.

This is set as $key => $value pairs where:

$key: string, is the style type to be configured (one of the constants starting with BS_)
$value: array, consists of 3 rows / items, each of which can be setup either as string (single CSS class) or an array (multiple CSS classes). Each of the row items indicate the following:
- the first item represents the CSS class(es) for Bootstrap 3.x.
- the second item represents the CSS class(es) for Bootstrap 4.x
- the third item represents the CSS class(es) for Bootstrap 5.x (if it does not exist will use bootstrap 4.x setting)

$bsVersion


    public
        int|string
    $bsVersion

the bootstrap library version that you wish to use for this specific extension / widget.

To use with bootstrap 3 - you can set this to any string starting with 3 (e.g. 3 or 3.3.7 or 3.x)
To use with bootstrap 4 - you can set this to any string starting with 4 (e.g. 4 or 4.6.0 or 4.x)
To use with bootstrap 5 - you can set this to any string starting with 5 (e.g. 5 or 5.1.0 or 5.x)

This property can be set up globally in Yii application params in your Yii2 application config file.

For example:

'params' = [
    'bsVersion' => '5.x' // will enable Bootstrap 5.x globally
]

Note that if this property is set as part of this extension class, then the extension setting will override the Yii::$app->params['bsVersion']. This property will default to 3.x (Bootstrap 3.x version) if it is not set anywhere (extension or module or Yii params).

$closeButton


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

the options for rendering the close button tag. This will be overridden by the closeButton setting within the [[alertSettings]] configuration.

$defaultOptions


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

default HTML attributes or other settings for widgets.

$defaultPluginOptions


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

default plugin options for the widget

$delay


    public
        int
    $delay

time in milliseconds to delay the fade out of each alert. If set to 0 or false, alerts will never fade out and will be always displayed. This defaults to 2000 ms for [[TYPE_ALERT]] and 1000 ms for [[TYPE_GROWL]].

$hashVarLoadPosition


    public
        int
    $hashVarLoadPosition
     = \yii\web\View::POS_HEAD

the position where the client JS hash variables for the input widget will be loaded.

Defaults to View::POS_HEAD. This can be set to View::POS_READY for specific scenarios like when rendering the widget via renderAjax.

$i18n


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

the the internalization configuration for this widget.

$id


    public
        string|null
    $id

ID of the widget. Note that the type of this property differs in getter and setter. See [[getId()]] and [[setId()]] for details.

$moduleId


    public
        string
    $moduleId

the module identifier if this widget is part of a module.

If not set, the module identifier will be auto derived based on the \yii\base\Module::getInstance method. This can be useful, if you are setting multiple module identifiers for the same module in your Yii configuration file. To specify children or grand children modules you can specify the module identifiers relative to the parent module (e.g. admin/content).

$options


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

HTML attributes or other settings for widgets.

$pjaxContainerId


    public
        string
    $pjaxContainerId

the identifier for the PJAX widget container if the widget is to be rendered inside a PJAX container.

This will ensure the any jQuery plugin using the widget is initialized correctly after a PJAX request is completed. If this is not set, no re-initialization will be done for pjax.

$pjaxDuplicationFix


    public
        bool
    $pjaxDuplicationFix

prevent duplication of pjax containers when browser back & forward buttons are pressed.

If this property is not set, it will be defaulted from Yii::$app->params['pjaxDuplicationFix'].
If Yii::$app->params['pjaxDuplicationFix'] is not set, then this property will default to true.

$pluginDestroyJs


    public
        string
    $pluginDestroyJs

the javascript that will be used to destroy the jQuery plugin

$pluginEvents


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

widget JQuery events.

You must define events in event-name => event-function format. For example:

pluginEvents = [
    'change' => 'function() { log("change"); }',
    'open' => 'function() { log("open"); }',
];

$pluginName


    public
        string
    $pluginName
     = ''

the plugin name

$pluginOptions


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

widget plugin options.

$sourcePath


    public
        string
    $sourcePath

directory path to the original widget source. If not set, will default to the working directory for the current widget's class. Setting this property can be useful in specific cases, like when you are extending the Krajee widget with your own custom namespaced class. In that case, set this property to the original Krajee Widget Base path. Yii path alias parsing is supported (using @ symbols). For example:

// your custom extended widget
namespace myapp\widgets;
class MyDateRangePicker extends kartik\daterange\DateRangePicker {
    // directly set the property to the original Krajee base widget directory
    // you can use Yii path aliases
    public $sourcePath = '@vendor/kartik-v/yii2-date-range/src';
}

// Alternatively you can also override this property while rendering the widget
// view.php: where widget is rendered
use myapp\widgets\MyDateRangePicker;

echo MyDateRangePicker::widget([
    'name' => 'custom',
    'sourcePath' => '@vendor/kartik-v/yii2-date-range/src'
]);

$type


    public
        string
    $type
     = self::TYPE_ALERT

the type of alert to use. Can be one of [[TYPE_ALERT]] or [[TYPE_GROWL]]. Defaults to [[TYPE_ALERT]].

$useSessionFlash


    public
        bool
    $useSessionFlash
     = true

whether to automatically use messages set via Yii::$app->session->setFlash(). Defaults to true. If set to false, you would need to pass the body setting within [[alertSetting]] array.

$view


    public
        View
    $view

The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See [[getView()]] and [[setView()]] for details.

$viewPath read-only


    public
        string
    $viewPath

The directory containing the view files for this widget.

$_bsVer


    protected
        int
    $_bsVer

current bootstrap version number

$_dataVar


    protected
        string
    $_dataVar

the HTML5 data variable name that will be used to store the Json encoded pluginOptions within the element on which the jQuery plugin will be initialized.

$_defaultBtnCss


    protected
        string
    $_defaultBtnCss

default bootstrap button CSS

$_defaultIconPrefix


    protected
        string
    $_defaultIconPrefix

default icon CSS prefix

$_encOptions


    protected
        string
    $_encOptions
     = ''

the JSON encoded plugin options.

$_hashVar


    protected
        string
    $_hashVar

the generated hashed variable name that will store the JSON encoded pluginOptions in [[View::POS_HEAD]].

$_isBs4


    protected
        bool
    $_isBs4

flag to detect whether bootstrap 4.x version is set

This property is deprecated since v3.0.0 and replaced by the more flexible [[_bsVer]] flag.

$_msgCat


    protected
        string
    $_msgCat
     = ''

translation message file category name for i18n.

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

$_id


    private
        mixed
    $_id

$_view


    private
        mixed
    $_view

__call()

Calls the named method which is not a class method.


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

This method will check if any attached behavior has the named method and will execute it if available.

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

Return values

mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.


    public
                    __clone() : mixed

It removes all behaviors because they are attached to the old object.

__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 a component property.


    public
                    __get(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

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

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

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


    public
                    __isset(string $name) : bool

This method will check in the following order and act accordingly:

a property defined by a setter: return whether the property is set
a property of a behavior: return whether the property is set
return false for non existing properties

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

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


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

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

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

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value to be null
a property of a behavior: set the property value to be null

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

Parameters

$name : string: the property name

addCssClass()

Adds bootstrap CSS class to options by parsing the bootstrap version for the specified Bootstrap CSS type.


    public
                    addCssClass(array<string|int, mixed> &$options, string $type) : Widget|mixed

Parameters

$options : array<string|int, mixed>: the HTML attributes for the container element that will be modified
$type : string: the bootstrap CSS class type

Return values

Widget|mixed —

current object instance that uses this trait

afterRun()

This method is invoked right after a widget is executed.


    public
                    afterRun(mixed $result) : mixed

The method will trigger the [[EVENT_AFTER_RUN]] event. The return value of the method will be used as the widget return value.

If you override this method, your code should look like the following:

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}

Parameters

$result : mixed: the widget return result.

Return values

mixed —

the processed widget result.

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

beforeRun()

This method is invoked right before the widget is executed.


    public
                    beforeRun() : bool

The method will trigger the [[EVENT_BEFORE_RUN]] event. The return value of the method will determine whether the widget should continue to run.

When overriding this method, make sure you call the parent implementation like the following:

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}

Return values

bool —

whether the widget should continue to be executed.

begin()

Begins a widget.


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

This method creates an instance of the calling class. It will apply the configuration to the created instance. A matching [[end()]] call should be called later. As some widgets may use output buffering, the [[end()]] call should be made in the same view to avoid breaking the nesting of output buffers.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

Return values

static —

the newly created widget instance

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values

array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.


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

A property can be read 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);
an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

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 $checkBehaviors = true ]) : bool

A property can be written 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);
an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

end()

Ends a widget.


    public
            static        end() : static

Note that the rendering result of the widget is directly echoed out.

Return values

static —

the widget instance that is ended.

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.


    public
                    ensureBehaviors() : mixed

getBaseSourcePath()

Get parsed base source path based on [[sourcePath]] setting. If [[sourcePath]] is not set, it will return the current working directory of this widget class.


    public
                    getBaseSourcePath() : string|false

Return values

string|false

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getBSClass()

Gets the respective Bootstrap class based on currently configured bootstrap version.


    public
                    getBSClass(mixed $className) : mixed

Parameters

$className : mixed

getBsVer()

Gets the current set bootstrap version number.


    public
                    getBsVer() : int

Return values

int

getCssClass()

Gets bootstrap css class by parsing the bootstrap version for the specified BS CSS type.


    public
                    getCssClass(string $type[, bool $asString = true ]) : string

Parameters

$type : string: the bootstrap CSS class type
$asString : bool = true: whether to return classes as a string separated by space

Return values

string

getDefaultBtnCss()

Gets the default button CSS


    public
                    getDefaultBtnCss() : string

Return values

string

getDefaultIconPrefix()

Gets the default icon css prefix


    public
                    getDefaultIconPrefix() : string

Return values

string

getDropdownClass()

Gets the respective bootstrap dropdown class name based on currently configured bootstrap version.


    public
                    getDropdownClass([bool $isBtn = false ]) : string

Parameters

$isBtn : bool = false: whether to get the Button Dropdown widget class

Return values

string

getId()

Returns the ID of the widget.


    public
                    getId([bool $autoGenerate = true ]) : string|null

Parameters

$autoGenerate : bool = true: whether to generate an ID if it is not set previously

Return values

string|null —

ID of the widget.

getView()

Returns the view object that can be used to render views or view files.


    public
                    getView() : View

The [[render()]] and [[renderFile()]] methods will use this view object to implement the actual view rendering. If not set, it will default to the "view" application component.

Return values

View —

the view object that can be used to render views or view files.

getViewPath()

Returns the directory containing the view files for this widget.


    public
                    getViewPath() : string

The default implementation returns the 'views' subdirectory under the directory containing the widget class file.

Return values

string —

the directory containing the view files for this widget.

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

the class has a method with the specified name
an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = 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);
an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

initI18N()

Yii i18n messages configuration for generating translations


    public
                    initI18N([string $dir = '' ][, string $cat = '' ]) : mixed

Parameters

$dir : string = '': the directory path where translation files will exist
$cat : string = '': the message category

isBs()

Validate Bootstrap version


    public
                    isBs(int $ver) : bool

Parameters

$ver : int

Return values

bool

isBs4()

Validate if Bootstrap 4.x version.


    public
                    isBs4() : bool

This property is deprecated since v3.0.0 and replaced by the [[isBs]] method.

Return values

bool

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].
$append : bool = true: whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

registerWidgetJs()

Registers a JS code block for the widget.


    public
                    registerWidgetJs(string $js[, int $pos = View::POS_READY ][, string $key = null ]) : mixed

Parameters

$js : string

the JS code block to be registered

$pos : int = View::POS_READY

the position at which the JS script tag should be inserted in a page. The possible values are:

[[View::POS_HEAD]]: in the head section
[[View::POS_BEGIN]]: at the beginning of the body section
[[View::POS_END]]: at the end of the body section
[[View::POS_LOAD]]: enclosed within jQuery(window).load(). Note that by using this position, the method will automatically register the jQuery js file.
[[View::POS_READY]]: enclosed within jQuery(document).ready(). This is the default value. Note that by using this position, the method will automatically register the jQuery js file.

$key : string = null

the key that identifies the JS code block. If null, it will use $js as the key. If two JS code blocks are registered with the same key, the latter will overwrite the former.

removeCssClass()

Removes bootstrap CSS class from options by parsing the bootstrap version for the specified Bootstrap CSS type.


    public
                    removeCssClass(array<string|int, mixed> &$options, string $type) : Widget|mixed

Parameters

$options : array<string|int, mixed>: the HTML attributes for the container element that will be modified
$type : string: the bootstrap CSS class type

Return values

Widget|mixed —

current object instance that uses this trait

render()

Renders a view.


    public
                    render(string $view[, array<string|int, mixed> $params = [] ]) : string

The view to be rendered can be specified in one of the following formats:

path alias (e.g. "@app/views/site/index");
absolute path within application (e.g. "//site/index"): the view name starts with double slashes. The actual view file will be looked for under the [[Application::viewPath|view path]] of the application.
absolute path within module (e.g. "/site/index"): the view name starts with a single slash. The actual view file will be looked for under the [[Module::viewPath|view path]] of the currently active module.
relative path (e.g. "index"): the actual view file will be looked for under [[viewPath]].

If the view name does not contain a file extension, it will use the default one .php.

Parameters

$view : string: the view name.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) that should be made available in the view.

Return values

string —

the rendering result.

renderAlerts()

Renders manually set alerts


    public
                    renderAlerts() : mixed

renderFile()

Renders a view file.


    public
                    renderFile(string $file[, array<string|int, mixed> $params = [] ]) : string

Parameters

$file : string: the view file to be rendered. This can be either a file path or a path alias.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) that should be made available in the view.

Return values

string —

the rendering result.

renderFlashAlerts()

Renders alerts from session flash settings.


    public
                    renderFlashAlerts() : mixed

run()

Executes the widget.


    public
                    run() : string|void

Return values

string|void —

the rendering result may be directly "echoed" or returned as a string

setId()

Sets the ID of the widget.


    public
                    setId(string $value) : mixed

Parameters

$value : string: id of the widget.

setView()

Sets the view object to be used by this widget.


    public
                    setView(View $view) : mixed

Parameters

$view : View: the view object that can be used to render views or view files.

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

widget()

Creates a widget instance and runs it.


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

The widget rendering result is returned by this method.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

Return values

string —

the rendering result of the widget.

addAsset()

Adds an asset to the view.


    protected
                    addAsset(View $view, string $file, string $type, string $class) : mixed

Parameters

$view : View: the View object
$file : string: the asset file name
$type : string: the asset file type (css or js)
$class : string: the class name of the AssetBundle

configureBsVersion()

Configures the bootstrap version settings


    protected
                    configureBsVersion() : int

Return values

int —

the bootstrap lib parsed version number (defaults to 3)

fixPjaxDuplication()

Fix for weird PJAX container duplication behavior on pressing browser back and forward buttons.


    protected
                    fixPjaxDuplication(View $view) : mixed

Parameters

$view : View

getBsExtBasename()

The yii2-bootstrap extension base name.


    protected
                    getBsExtBasename() : string

Based on the currently set bootstrap version (3, 4, or 5), returns one of bootstrap, bootstrap4 or bootstrap5.

Return values

string

getPluginScript()

Returns the plugin registration script.


    protected
                    getPluginScript(string $name[, string $element = null ][, string $callback = null ][, string $callbackCon = null ]) : string

Parameters

$name : string: the name of the plugin
$element : string = null: the plugin target element
$callback : string = null: the javascript callback function to be called after plugin loads
$callbackCon : string = null: the javascript callback function to be passed to the plugin constructor

Return values

string —

the generated plugin script

hashPluginOptions()

Generates a hashed variable to store the pluginOptions.


    protected
                    hashPluginOptions(string $name) : mixed

The following special data attributes will also be setup for the input widget, that can be accessed through javascript :

data-krajee-{name} will store the hashed variable storing the plugin options. The {name} token will be replaced with the plugin name (e.g. select2, typeahead etc.).

Parameters

$name : string: the name of the plugin

initBsVersion()

Initializes bootstrap versions for the widgets and asset bundles.


    protected
                    initBsVersion() : mixed

Sets the [[_bsVer]] flag by parsing [[bsVersion]].

initDestroyJs()

Generates the `pluginDestroyJs` script if it is not set.


    protected
                    initDestroyJs() : mixed

initOptions()

Initializes widget options and settings.


    protected
                    initOptions() : mixed

isSameVersion()

Compares two versions and checks if they are of the same major BS version.


    protected
            static        isSameVersion(int|string $ver1, int|string $ver2) : bool

Parameters

$ver1 : int|string: first version
$ver2 : int|string: second version

Return values

bool —

whether major versions are equal

mergeDefaultOptions()

Merge default options


    protected
                    mergeDefaultOptions() : mixed

parseVer()

Parses and returns the major BS version


    protected
            static        parseVer(string $ver) : int

Parameters

$ver : string

Return values

int

registerPlugin()

Registers a specific plugin and the related events


    protected
                    registerPlugin(string $name[, string $element = null ][, string $callback = null ][, string $callbackCon = null ]) : mixed

Parameters

$name : string: the name of the plugin
$element : string = null: the plugin target element
$callback : string = null: the javascript callback function to be called after plugin loads
$callbackCon : string = null: the javascript callback function to be passed to the plugin constructor

registerPluginOptions()

Registers plugin options by storing within a uniquely generated javascript variable.


    protected
                    registerPluginOptions(string $name) : mixed

Parameters

$name : string: the plugin name

renderCloseButton()

Renders the close button.


    protected
                    renderCloseButton() : string

Return values

string —

the rendering result

setDataVar()

Sets a HTML5 data variable.


    protected
                    setDataVar(string $name) : mixed

Parameters

$name : string: the plugin name

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

AlertBlock extends AlertBlock in package yii2 widgets

Tags

Table of Contents

Constants

Properties

Methods

Constants

EVENT_AFTER_RUN

Tags

EVENT_BEFORE_RUN

Tags

EVENT_INIT

Tags

TYPE_ALERT

TYPE_GROWL

Properties

$alertSettings

$autoIdPrefix

Tags

$behaviors read-only

$bsColCssPrefixes

$bsCssMap

$bsVersion

$closeButton

$defaultOptions

$defaultPluginOptions

$delay

$hashVarLoadPosition

$i18n

Tags

$id

$moduleId

$options

$pjaxContainerId

$pjaxDuplicationFix

$pluginDestroyJs

$pluginEvents

$pluginName

$pluginOptions

$sourcePath

$type

$useSessionFlash

$view

$viewPath read-only

$_bsVer

$_dataVar

$_defaultBtnCss

$_defaultIconPrefix

$_encOptions

$_hashVar

$_isBs4

Tags

$_msgCat

Tags

$_behaviors

$_events

$_eventWildcards

Tags

$_id

$_view

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

AlertBlock extends AlertBlock
in package

yii2

widgets