Class lispa\amos\core\forms\InteractionMenuWidget

All Classes | Properties | Methods | Events
Inheritancelispa\amos\core\forms\InteractionMenuWidget » yii\base\Widget » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable, yii\base\ViewContextInterface

Class InteractionMenuWidget

Widget to display the interaction menu. It has three default buttons: favorite, signal and share. If you want to enable only a certain group of buttons you must set interactionMenuButtons array with only the enabled buttons. If you want to disable only a certain group of buttons you must set interactionMenuButtonsHide array with only the disabled buttons.

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
$counter integer A counter used to generate $id for widgets. yii\base\Widget
$hideInteractionMenu boolean lispa\amos\core\forms\InteractionMenuWidget
$id string ID of the widget. yii\base\Widget
$interactionMenuButtons array lispa\amos\core\forms\InteractionMenuWidget
$interactionMenuButtonsHide array lispa\amos\core\forms\InteractionMenuWidget
$layout string Widget view lispa\amos\core\forms\InteractionMenuWidget
$model lispa\amos\core\record\Record lispa\amos\core\forms\InteractionMenuWidget
$stack yii\base\Widget[] The widgets that are currently being rendered (not ended). yii\base\Widget
$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
getInteractionMenuButtons() lispa\amos\core\forms\InteractionMenuWidget
getInteractionMenuButtonsHide() lispa\amos\core\forms\InteractionMenuWidget
getLayout() lispa\amos\core\forms\InteractionMenuWidget
getModel() lispa\amos\core\forms\InteractionMenuWidget
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() Initializes the object. yii\base\Widget
isHideInteractionMenu() lispa\amos\core\forms\InteractionMenuWidget
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\InteractionMenuWidget
setHideInteractionMenu() lispa\amos\core\forms\InteractionMenuWidget
setId() Sets the ID of the widget. yii\base\Widget
setInteractionMenuButtons() lispa\amos\core\forms\InteractionMenuWidget
setInteractionMenuButtonsHide() lispa\amos\core\forms\InteractionMenuWidget
setModel() lispa\amos\core\forms\InteractionMenuWidget
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

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

Property Details

$hideInteractionMenu public write-only property
public void setHideInteractionMenu ( $hideInteractionMenu )
$interactionMenuButtons public property
public array getInteractionMenuButtons ( )
public void setInteractionMenuButtons ( $interactionMenuButtons )
$interactionMenuButtonsHide public property
public array getInteractionMenuButtonsHide ( )
public void setInteractionMenuButtonsHide ( $interactionMenuButtonsHide )
$layout public read-only property

Widget view

public string getLayout ( )
$model public property
public lispa\amos\core\record\Record getModel ( )
public void setModel ( $model )

Method Details

getInteractionMenuButtons() public method

public array getInteractionMenuButtons ( )
getInteractionMenuButtonsHide() public method

public array getInteractionMenuButtonsHide ( )
getLayout() public method

public string getLayout ( )
getModel() public method

public lispa\amos\core\record\Record getModel ( )
isHideInteractionMenu() public method

public boolean isHideInteractionMenu ( )
run() public method

Executes the widget.

public string run ( )
return string

The result of widget execution to be outputted.
setHideInteractionMenu() public method

public void setHideInteractionMenu ( $hideInteractionMenu )
$hideInteractionMenu boolean
setInteractionMenuButtons() public method

public void setInteractionMenuButtons ( $interactionMenuButtons )
$interactionMenuButtons array
setInteractionMenuButtonsHide() public method

public void setInteractionMenuButtonsHide ( $interactionMenuButtonsHide )
$interactionMenuButtonsHide array
setModel() public method

public void setModel ( $model )
$model lispa\amos\core\record\Record