Class lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget

All Classes | Properties | Methods | Events

Inheritance	lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget » yii\base\Widget » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable, yii\base\ViewContextInterface

Class NotifyFrequencyWidget

Public Properties

Hide inherited properties

Property	Type	Description	Defined 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		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
$counter	integer	A counter used to generate $id for widgets.	yii\base\Widget
$defaultValueEmail	null		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
$emailContainerOptions	array		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
$id	string	ID of the widget.	yii\base\Widget
$layout	string	It's permitted to set {emailNotifyFrequency} and {smsNotifyFrequency}.	lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
$model	lispa\amos\admin\models\UserProfile		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
$smsContainerOptions	array		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
$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

Method	Description	Defined 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
emailFrequencySelectorId()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
emailFrequencySelectorName()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
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
getContainerOptions()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
getDefaultValueEmail()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
getEmailContainerOptions()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
getId()	Returns the ID of the widget.	yii\base\Widget
getLayout()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
getModel()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
getSmsContainerOptions()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
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.	lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
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
renderEmailNotifyFrequencySelector()	Render the email notify frequency selector.	lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
renderFile()	Renders a view file.	yii\base\Widget
renderSection()	Renders a section of the specified name.	lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
renderSmsNotifyFrequencySelector()	Render the sms notify frequency selector.	lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
run()	Executes the widget.	lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
setContainerOptions()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
setDefaultValueEmail()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
setEmailContainerOptions()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
setId()	Sets the ID of the widget.	yii\base\Widget
setModel()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
setSmsContainerOptions()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
setView()	Sets the view object to be used by this widget.	yii\base\Widget
smsFrequencySelectorId()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
smsFrequencySelectorName()		lispa\amos\notificationmanager\widgets\NotifyFrequencyWidget
trigger()	Triggers an event.	yii\base\Component
widget()	Creates a widget instance and runs it.	yii\base\Widget

Events

Hide inherited events

Event	Type	Description	Defined 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

$containerOptions public property

public array getContainerOptions ( )
public void setContainerOptions ( $containerOptions )

$defaultValueEmail public property

public null getDefaultValueEmail ( )
public void setDefaultValueEmail ( lispa\amos\notificationmanager\models\NotificationsConfOpt $defaultValueEmail )

$emailContainerOptions public property

public array getEmailContainerOptions ( )
public void setEmailContainerOptions ( $emailContainerOptions )

$layout public read-only property

It's permitted to set {emailNotifyFrequency} and {smsNotifyFrequency}. Default to {emailNotifyFrequency}.

public string getLayout ( )

$model public property

public lispa\amos\admin\models\UserProfile getModel ( )
public void setModel ( $model )

$smsContainerOptions public property

public array getSmsContainerOptions ( )
public void setSmsContainerOptions ( $smsContainerOptions )

Method Details

emailFrequencySelectorId() public static method

public static string emailFrequencySelectorId ( )

emailFrequencySelectorName() public static method

public static string emailFrequencySelectorName ( )

getContainerOptions() public method

public array getContainerOptions ( )

getDefaultValueEmail() public method

public null getDefaultValueEmail ( )

getEmailContainerOptions() public method

public array getEmailContainerOptions ( )

getLayout() public method

public string getLayout ( )

getModel() public method

public lispa\amos\admin\models\UserProfile getModel ( )

getSmsContainerOptions() public method

public array getSmsContainerOptions ( )

init() public method

Initializes the object.

This method is called at the end of the constructor. The default implementation will trigger an EVENT_INIT event.

public void init ( )

renderEmailNotifyFrequencySelector() public method

Render the email notify frequency selector.

public string renderEmailNotifyFrequencySelector ( )

renderSection() public method

Renders a section of the specified name.

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

public string\|boolean renderSection ( $name )
$name	string	The section name, e.g., `{summary}`, `{items}`.
return	string\|boolean	The rendering result of the section, or false if the named section is not supported.

renderSmsNotifyFrequencySelector() public method

Render the sms notify frequency selector.

public string renderSmsNotifyFrequencySelector ( )

run() public method

Executes the widget.

public string run ( )
return	string	The result of widget execution to be outputted.

setContainerOptions() public method

public void setContainerOptions ( $containerOptions )
$containerOptions	array

setDefaultValueEmail() public method

public void setDefaultValueEmail ( lispa\amos\notificationmanager\models\NotificationsConfOpt $defaultValueEmail )
$defaultValueEmail	null

setEmailContainerOptions() public method

public void setEmailContainerOptions ( $emailContainerOptions )
$emailContainerOptions	array

setModel() public method

public void setModel ( $model )
$model	lispa\amos\admin\models\UserProfile

setSmsContainerOptions() public method

public void setSmsContainerOptions ( $smsContainerOptions )
$smsContainerOptions	array

smsFrequencySelectorId() public static method

public static string smsFrequencySelectorId ( )

smsFrequencySelectorName() public static method

public static string smsFrequencySelectorName ( )