Class lispa\amos\core\forms\CreatedUpdatedWidget

Inheritancelispa\amos\core\forms\CreatedUpdatedWidget » yii\base\Widget » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable, yii\base\ViewContextInterface

Class CreatedUpdatedWidget

The widget requires only one parameter: the model

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$autoIdPrefix string The prefix to the automatically generated widget IDs. yii\base\Widget
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$containerOptions array Default to [] lispa\amos\core\forms\CreatedUpdatedWidget
$counter integer A counter used to generate $id for widgets. yii\base\Widget
$createdSectionOptions array Default to [] lispa\amos\core\forms\CreatedUpdatedWidget
$id string ID of the widget. yii\base\Widget
$isTooltip boolean If true convert the widget into an info tooltip lispa\amos\core\forms\CreatedUpdatedWidget
$layout string Widget layout lispa\amos\core\forms\CreatedUpdatedWidget
$model yii\db\ActiveRecord lispa\amos\core\forms\CreatedUpdatedWidget
$stack yii\base\Widget[] The widgets that are currently being rendered (not ended). yii\base\Widget
$updatedSectionOptions array Default to [] lispa\amos\core\forms\CreatedUpdatedWidget
$view yii\web\View The view object that can be used to render views or view files. yii\base\Widget
$viewPath string The directory containing the view files for this widget. yii\base\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\Object
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
afterRun() This method is invoked right after a widget is executed. yii\base\Widget
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeRun() This method is invoked right before the widget is executed. yii\base\Widget
begin() Begins a widget. yii\base\Widget
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\Object
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
end() Ends a widget. yii\base\Widget
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getId() Returns the ID of the widget. yii\base\Widget
getLayout() lispa\amos\core\forms\CreatedUpdatedWidget
getModel() lispa\amos\core\forms\CreatedUpdatedWidget
getView() Returns the view object that can be used to render views or view files. yii\base\Widget
getViewPath() Returns the directory containing the view files for this widget. yii\base\Widget
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() lispa\amos\core\forms\CreatedUpdatedWidget
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
render() Renders a view. yii\base\Widget
renderFile() Renders a view file. yii\base\Widget
run() Executes the widget. lispa\amos\core\forms\CreatedUpdatedWidget
setId() Sets the ID of the widget. yii\base\Widget
setModel() lispa\amos\core\forms\CreatedUpdatedWidget
setView() Sets the view object to be used by this widget. yii\base\Widget
trigger() Triggers an event. yii\base\Component
widget() Creates a widget instance and runs it. yii\base\Widget

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
renderBeginContainerSection() This method render the beginning part of the container. lispa\amos\core\forms\CreatedUpdatedWidget
renderCreatedSection() This method render the created section. lispa\amos\core\forms\CreatedUpdatedWidget
renderEndContainerSection() This method render the end part of the container. lispa\amos\core\forms\CreatedUpdatedWidget
renderSection() Renders a section of the specified name. lispa\amos\core\forms\CreatedUpdatedWidget
renderUpdatedSection() This method render the updated section. lispa\amos\core\forms\CreatedUpdatedWidget

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_RUN yii\base\WidgetEvent An event raised right after executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent An event raised right before executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) yii\base\Widget

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
CREATED_TYPE 'created' lispa\amos\core\forms\CreatedUpdatedWidget
UPDATED_TYPE 'updated' lispa\amos\core\forms\CreatedUpdatedWidget

Property Details

$containerOptions public property

Default to []

$createdSectionOptions public property

Default to []

$isTooltip public property

If true convert the widget into an info tooltip

public boolean $isTooltip false
$layout public read-only property

Widget layout

public string getLayout ( )
$model public property
public yii\db\ActiveRecord getModel ( )
public void setModel ( $model )
$updatedSectionOptions public property

Default to []

Method Details

getLayout() public method

public string getLayout ( )
getModel() public method

public yii\db\ActiveRecord getModel ( )
init() public method

public void init ( )
throws Exception
renderBeginContainerSection() protected method

This method render the beginning part of the container.

protected string renderBeginContainerSection ( )
renderCreatedSection() protected method

This method render the created section.

protected string renderCreatedSection ( )
renderEndContainerSection() protected method

This method render the end part of the container.

protected string renderEndContainerSection ( )
renderSection() protected method

Renders a section of the specified name.

If the named section is not supported, false will be returned.

protected string|boolean renderSection ( $name, $params = [] )
$name string

The section name, e.g., {summary}, {items}.

$params
return string|boolean

The rendering result of the section, or false if the named section is not supported.

renderUpdatedSection() protected method

This method render the updated section.

protected string renderUpdatedSection ( )
run() public method

Executes the widget.

public string run ( )
return string

The result of widget execution to be outputted.

setModel() public method

public void setModel ( $model )
$model yii\db\ActiveRecord