Class lispa\amos\core\views\DataProviderView

All Classes | Properties | Methods | Events

Inheritance	lispa\amos\core\views\DataProviderView » yii\base\Widget » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable, yii\base\ViewContextInterface

Class DataProviderView decorator for every view in amos

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$autoIdPrefix	string	The prefix to the automatically generated widget IDs.	yii\base\Widget
$availableViews			lispa\amos\core\views\DataProviderView
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$calendarView			lispa\amos\core\views\DataProviderView
$counter	integer	A counter used to generate $id for widgets.	yii\base\Widget
$createNewBtnParams			lispa\amos\core\views\DataProviderView
$currentView			lispa\amos\core\views\DataProviderView
$dataProvider			lispa\amos\core\views\DataProviderView
$exportConfig	array	Configurations to export data.	lispa\amos\core\views\DataProviderView
$forceCreateNewButtonWidget			lispa\amos\core\views\DataProviderView
$ganttView			lispa\amos\core\views\DataProviderView
$gridView			lispa\amos\core\views\DataProviderView
$iconView			lispa\amos\core\views\DataProviderView
$id	string	ID of the widget.	yii\base\Widget
$listView			lispa\amos\core\views\DataProviderView
$mapView			lispa\amos\core\views\DataProviderView
$stack	yii\base\Widget[]	The widgets that are currently being rendered (not ended).	yii\base\Widget
$view			lispa\amos\core\views\DataProviderView
$viewCalendarClass			lispa\amos\core\views\DataProviderView
$viewGanttClass			lispa\amos\core\views\DataProviderView
$viewGridClass			lispa\amos\core\views\DataProviderView
$viewIconClass			lispa\amos\core\views\DataProviderView
$viewListClass			lispa\amos\core\views\DataProviderView
$viewMapClass			lispa\amos\core\views\DataProviderView
$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
getCurrentView()		lispa\amos\core\views\DataProviderView
getDataProvider()		lispa\amos\core\views\DataProviderView
getGridView()		lispa\amos\core\views\DataProviderView
getIconView()		lispa\amos\core\views\DataProviderView
getId()	Returns the ID of the widget.	yii\base\Widget
getListView()		lispa\amos\core\views\DataProviderView
getView()	Returns the view object that can be used to render views or view files.	yii\base\Widget
getViewGridClass()		lispa\amos\core\views\DataProviderView
getViewIconClass()		lispa\amos\core\views\DataProviderView
getViewListClass()		lispa\amos\core\views\DataProviderView
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\core\views\DataProviderView
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\views\DataProviderView
setCurrentView()		lispa\amos\core\views\DataProviderView
setDataProvider()		lispa\amos\core\views\DataProviderView
setGridView()		lispa\amos\core\views\DataProviderView
setIconView()		lispa\amos\core\views\DataProviderView
setId()	Sets the ID of the widget.	yii\base\Widget
setListView()		lispa\amos\core\views\DataProviderView
setView()	Sets the view object to be used by this widget.	yii\base\Widget
setViewGridClass()		lispa\amos\core\views\DataProviderView
setViewIconClass()		lispa\amos\core\views\DataProviderView
setViewListClass()		lispa\amos\core\views\DataProviderView
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

$availableViews public property

public $availableViews = []

$calendarView public property

public $calendarView = null

$createNewBtnParams public property

public $createNewBtnParams = null

$currentView public property

public mixed getCurrentView ( )
public void setCurrentView ( $currentView )

$dataProvider public property

public mixed getDataProvider ( )
public void setDataProvider ( $dataProvider )

$exportConfig public property

Configurations to export data. DON'T SET IN Yii::$app->request->queryParams!

public array $exportConfig = null

$forceCreateNewButtonWidget public property

public $forceCreateNewButtonWidget = false

$ganttView public property

public $ganttView = []

$gridView public property

public mixed getGridView ( )
public void setGridView ( $gridView )

$iconView public property

public mixed getIconView ( )
public void setIconView ( $iconView )

$listView public property

public mixed getListView ( )
public void setListView ( $listView )

$mapView public property

public $mapView = null

$view public property

public yii\web\View getView ( )
public void setView ( $view )

$viewCalendarClass public property

public $viewCalendarClass = 'lispa\amos\core\views\CalendarView'

$viewGanttClass public property

public $viewGanttClass = 'lispa\amos\core\views\GanttView'

$viewGridClass public property

public string getViewGridClass ( )
public void setViewGridClass ( $viewGridClass )

$viewIconClass public property

public string getViewIconClass ( )
public void setViewIconClass ( $viewIconClass )

$viewListClass public property

public string getViewListClass ( )
public void setViewListClass ( $viewListClass )

$viewMapClass public property

public $viewMapClass = 'lispa\amos\core\views\MapView'

Method Details

getCurrentView() public method

public mixed getCurrentView ( )

getDataProvider() public method

public mixed getDataProvider ( )

getGridView() public method

public mixed getGridView ( )

getIconView() public method

public mixed getIconView ( )

getListView() public method

public mixed getListView ( )

getViewGridClass() public method

public string getViewGridClass ( )

getViewIconClass() public method

public string getViewIconClass ( )

getViewListClass() public method

public string getViewListClass ( )

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 ( )

run() public method

Executes the widget.

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

setCurrentView() public method

public void setCurrentView ( $currentView )
$currentView	mixed

setDataProvider() public method

public void setDataProvider ( $dataProvider )
$dataProvider	mixed

setGridView() public method

public void setGridView ( $gridView )
$gridView	mixed

setIconView() public method

public void setIconView ( $iconView )
$iconView	mixed

setListView() public method

public void setListView ( $listView )
$listView	mixed

setViewGridClass() public method

public void setViewGridClass ( $viewGridClass )
$viewGridClass	string

setViewIconClass() public method

public void setViewIconClass ( $viewIconClass )
$viewIconClass	string

setViewListClass() public method

public void setViewListClass ( $viewListClass )
$viewListClass	string