Class lispa\amos\projectmanagement\models\ItemWorkPlanDataProvider

Inheritancelispa\amos\projectmanagement\models\ItemWorkPlanDataProvider » yii\data\BaseDataProvider » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable, yii\data\DataProviderInterface

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$checkOwner boolean - set to true if you need to select activities/tasks owned by the logged user (responsible for the tasks) lispa\amos\projectmanagement\models\ItemWorkPlanDataProvider
$count integer The number of data models in the current page. yii\data\BaseDataProvider
$id string An ID that uniquely identifies the data provider among all data providers. yii\data\BaseDataProvider
$keys array The list of key values corresponding to $models. yii\data\BaseDataProvider
$models array The list of data models in the current page. yii\data\BaseDataProvider
$pagination yii\data\Pagination|false The pagination object. yii\data\BaseDataProvider
$projectId integer Id of the project to inspect lispa\amos\projectmanagement\models\ItemWorkPlanDataProvider
$sort yii\data\Sort|boolean The sorting object. yii\data\BaseDataProvider
$taskInSelection array - if $taskInSelection is not empty, add task to data provider if is an element of the array. lispa\amos\projectmanagement\models\ItemWorkPlanDataProvider
$totalCount integer Total number of possible data models. yii\data\BaseDataProvider

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
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
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
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
getCount() Returns the number of data models in the current page. yii\data\BaseDataProvider
getKeys() Returns the key values associated with the data models. yii\data\BaseDataProvider
getModels() Returns the data models in the current page. yii\data\BaseDataProvider
getPagination() Returns the pagination object used by this data provider. yii\data\BaseDataProvider
getSort() Returns the sorting object used by this data provider. yii\data\BaseDataProvider
getTotalCount() Returns the total number of data models. yii\data\BaseDataProvider
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\projectmanagement\models\ItemWorkPlanDataProvider
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
prepare() Prepares the data models and keys. yii\data\BaseDataProvider
refresh() Refreshes the data provider. yii\data\BaseDataProvider
setKeys() Sets the key values associated with the data models. yii\data\BaseDataProvider
setModels() Sets the data models in the current page. yii\data\BaseDataProvider
setPagination() Sets the pagination for this data provider. yii\data\BaseDataProvider
setSort() Sets the sort definition for this data provider. yii\data\BaseDataProvider
setTotalCount() Sets the total number of data models. yii\data\BaseDataProvider
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
prepareKeys() Prepares the keys associated with the currently available data models. lispa\amos\projectmanagement\models\ItemWorkPlanDataProvider
prepareModels() Prepares the data models that will be made available in the current page. lispa\amos\projectmanagement\models\ItemWorkPlanDataProvider
prepareTotalCount() Returns a value indicating the total number of data models in this data provider. lispa\amos\projectmanagement\models\ItemWorkPlanDataProvider

Property Details

$checkOwner public property
  • set to true if you need to select activities/tasks owned by the logged user (responsible for the tasks)
public boolean $checkOwner false
$projectId public property

Id of the project to inspect

public integer $projectId null
$taskInSelection public property
  • if $taskInSelection is not empty, add task to data provider if is an element of the array.
public array $taskInSelection = []

Method Details

init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )
prepareKeys() protected method

Prepares the keys associated with the currently available data models.

protected array prepareKeys ( $models )
$models array

The available data models

return array

The keys

prepareModels() protected method

Prepares the data models that will be made available in the current page.

protected array prepareModels ( )
return array

The available data models

prepareTotalCount() protected method

Returns a value indicating the total number of data models in this data provider.

protected integer prepareTotalCount ( )
return integer

Total number of data models in this data provider.