Class lispa\amos\core\forms\PublishedByWidget

All Classes | Properties | Methods | Events

Inheritance	lispa\amos\core\forms\PublishedByWidget » yii\base\Widget » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable, yii\base\ViewContextInterface

Class PublishedByWidget

shows the entities name publishing the content and the selected publication rule

The layout determines how different sections of the list view should be organized. The following tokens will be replaced with the corresponding section contents:

{publisher}: publisher user. See renderPublisher().
{publisherAdv}: publisher user info with validator info. See renderPublisherAdv().
{publishingRules}: publisher user info with validator info. See \lispa\amos\core\forms\renderPublisherRules().
{target}: the target. See renderTarget().
{targetAdv}: the target. See renderTargetAdv().
{category}: the category of current model. See renderCategory().
{status}: the status of current model. See renderStatus().
{pubblicationdates}: the publication date begin and end of current model. See renderPubblicationDates().
{pubblishedfrom}: the publication date begin of current model. See renderPublishedFrom().
{pubblishedat}: the publication date end of current model. See renderPublishedAt().

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
$counter	integer	A counter used to generate $id for widgets.	yii\base\Widget
$emptyText	string		lispa\amos\core\forms\PublishedByWidget
$id	string	ID of the widget.	yii\base\Widget
$isTooltip	boolean	If true convert the widget into an info tooltip	lispa\amos\core\forms\PublishedByWidget
$layout			lispa\amos\core\forms\PublishedByWidget
$model	yii\base\Model	The current model processed	lispa\amos\core\forms\PublishedByWidget
$modelContext	yii\base\Model	Context	lispa\amos\core\forms\PublishedByWidget
$options	array	The HTML attributes for the container tag of the list view.	lispa\amos\core\forms\PublishedByWidget
$renderSections	array		lispa\amos\core\forms\PublishedByWidget
$sectionOptions	string		lispa\amos\core\forms\PublishedByWidget
$sectionTag	string		lispa\amos\core\forms\PublishedByWidget
$separatorText	string		lispa\amos\core\forms\PublishedByWidget
$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
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
getNodesAsString()		lispa\amos\core\forms\PublishedByWidget
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 widget.	lispa\amos\core\forms\PublishedByWidget
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
renderCategory()		lispa\amos\core\forms\PublishedByWidget
renderCategorySection()		lispa\amos\core\forms\PublishedByWidget
renderCreatedAt()	This method render the created at date.	lispa\amos\core\forms\PublishedByWidget
renderFile()	Renders a view file.	yii\base\Widget
renderPubblicationDates()	This method render the publication dates	lispa\amos\core\forms\PublishedByWidget
renderPubblicationDatesSection()	This method render the publication dates	lispa\amos\core\forms\PublishedByWidget
renderPublishedAt()	This method render the published at date.	lispa\amos\core\forms\PublishedByWidget
renderPublishedAtSection()	This method render the published at date.	lispa\amos\core\forms\PublishedByWidget
renderPublishedFrom()	This method render the published from date.	lispa\amos\core\forms\PublishedByWidget
renderPublishedFromSection()	This method render the published from date.	lispa\amos\core\forms\PublishedByWidget
renderPublisher()		lispa\amos\core\forms\PublishedByWidget
renderPublisherAdv()		lispa\amos\core\forms\PublishedByWidget
renderPublisherSection()		lispa\amos\core\forms\PublishedByWidget
renderPublishingRules()		lispa\amos\core\forms\PublishedByWidget
renderSection()	Renders a section of the specified name.	lispa\amos\core\forms\PublishedByWidget
renderStatus()		lispa\amos\core\forms\PublishedByWidget
renderStatusSection()		lispa\amos\core\forms\PublishedByWidget
renderTarget()		lispa\amos\core\forms\PublishedByWidget
renderTargetAdv()		lispa\amos\core\forms\PublishedByWidget
renderTargetAdvSection()		lispa\amos\core\forms\PublishedByWidget
run()	Runs the widget.	lispa\amos\core\forms\PublishedByWidget
setId()	Sets the ID of the widget.	yii\base\Widget
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

Method	Description	Defined By
findNode()		lispa\amos\core\forms\PublishedByWidget

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

$emptyText public property

public string $emptyText = null

$isTooltip public property

If true convert the widget into an info tooltip

public boolean $isTooltip = false

$layout public property

public $layout = "{targetAdv}"

$model public property

The current model processed

public yii\base\Model $model = null

$modelContext public property

Context

public yii\base\Model $modelContext = null

$options public property

The HTML attributes for the container tag of the list view. The "tag" element specifies the tag name of the container element and defaults to "div".

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $options = ['class' => 'published-by']

$renderSections public property

public array $renderSections = []

$sectionOptions public property

public string $sectionOptions = ['class' => 'item']

$sectionTag public property

public string $sectionTag = 'div'

$separatorText public property

public string $separatorText = null

Method Details

findNode() protected method

protected mixed findNode ( $Target )
$Target	array
throws	yii\base\InvalidConfigException

getNodesAsString() public method

public string getNodesAsString ( $nodes )
$nodes
throws	yii\base\InvalidConfigException

init() public method

Initializes the widget.

public void init ( )

renderCategory() public method

public string renderCategory ( )
return	string	The rendering result

renderCategorySection() public method

public string renderCategorySection ( )
return	string	The rendering result

renderCreatedAt() public method

This method render the created at date.

public string renderCreatedAt ( )

renderPubblicationDates() public method

This method render the publication dates

public string renderPubblicationDates ( )

renderPubblicationDatesSection() public method

This method render the publication dates

public string renderPubblicationDatesSection ( )

renderPublishedAt() public method

This method render the published at date.

public string renderPublishedAt ( )

renderPublishedAtSection() public method

This method render the published at date.

public string renderPublishedAtSection ( )

renderPublishedFrom() public method

This method render the published from date.

public string renderPublishedFrom ( )

renderPublishedFromSection() public method

This method render the published from date.

public string renderPublishedFromSection ( )

renderPublisher() public method

public string renderPublisher ( $onlyContent = false )
$onlyContent	boolean

renderPublisherAdv() public method

public string renderPublisherAdv ( )
return	string	The rendering result
throws	yii\base\InvalidConfigException

renderPublisherSection() public method

public string renderPublisherSection ( $onlyContent = false )
$onlyContent	boolean

renderPublishingRules() public method

public string renderPublishingRules ( )
return	string	The rendering result

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., `{publisher}`, `{publisherAdv}`.
return	string\|boolean	The rendering result of the section, or false if the named section is not supported.
throws	yii\base\InvalidConfigException

renderStatus() public method

public string renderStatus ( )
return	string	The rendering result

renderStatusSection() public method

public string renderStatusSection ( )
return	string	The rendering result

renderTarget() public method

public string renderTarget ( )
return	string	The rendering result
throws	yii\base\InvalidConfigException

renderTargetAdv() public method

public string renderTargetAdv ( )
return	string	The rendering result
throws	yii\base\InvalidConfigException

renderTargetAdvSection() public method

public string renderTargetAdvSection ( )
return	string	The rendering result
throws	yii\base\InvalidConfigException

run() public method

Runs the widget.

public void run ( )