Class kartik\depdrop\DepDropAction

All Classes | Properties | Methods

Inheritance	kartik\depdrop\DepDropAction » yii\base\Action » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable
Available since version	1.0.6

Dependent Dropdown action that can be used to generate the dependent option values via ajax response. A typical usage of this action in your controller could look like below:


  //inside the controller

   public function actions()
   {
       return \yii\helpers\ArrayHelper::merge(parent::actions(), [
           'subcategory' => [
               'class' => \kartik\depdrop\DepDropAction::className(),
               'outputCallback' => function ($selectedId, $params) {
                   return [
                       [
                           'id' => 1,
                           'name' => 'Car',
                       ],
                       [
                           'id' => 2,
                           'name' => 'bike',
                       ],
                   ];

                   // with optgroup
                   return [
                       'group1' => [
                           ['id' => '<sub-cat-id-1>', 'name' => '<sub-cat-name1>'],
                           ['id' => '<sub-cat_id_2>', 'name' => '<sub-cat-name2>']
                       ],
                       'group2' => [
                           ['id' => '<sub-cat-id-3>', 'name' => '<sub-cat-name3>'],
                           ['id' => '<sub-cat-id-4>', 'name' => '<sub-cat-name4>']
                       ]
                   ];
               }
           ]
       ]);
   }

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$allowEmpty	boolean	Whether selected value can be empty.	kartik\depdrop\DepDropAction
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component.	yii\base\Component
$controller	yii\base\Controller\|yii\web\Controller\|yii\console\Controller	The controller that owns this action	yii\base\Action
$enableCsrfValidation	boolean	Whether CSRF validation is enabled for this action.	kartik\depdrop\DepDropAction
$id	string	ID of the action	yii\base\Action
$otherParam	string	Other parameter name for the dependent dropdown	kartik\depdrop\DepDropAction
$outputCallback	Closure	The output callback function	kartik\depdrop\DepDropAction
$parentParam	string	Parent parameter name for the dependent dropdown	kartik\depdrop\DepDropAction
$selectedCallback	Closure	The selected callback function	kartik\depdrop\DepDropAction
$uniqueId	string	The unique ID of this action among the whole application.	yii\base\Action

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\BaseObject
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\Action
__get()	Returns the value of an object property.	yii\base\BaseObject
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
__set()	Sets value of an object property.	yii\base\BaseObject
__unset()	Sets an object property to null.	yii\base\BaseObject
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\BaseObject
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\BaseObject
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
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
getUniqueId()	Returns the unique ID of this action among the whole application.	yii\base\Action
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\BaseObject
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\BaseObject
init()	Initializes the object.	kartik\depdrop\DepDropAction
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
run()		kartik\depdrop\DepDropAction
runWithParams()	Runs this action with the specified parameters.	yii\base\Action
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
afterRun()	This method is called right after `run()` is executed.	yii\base\Action
beforeRun()	This method is called right before `run()` is executed.	yii\base\Action
getOutput()	Return select option values output	kartik\depdrop\DepDropAction
getSelected()	Return selected value	kartik\depdrop\DepDropAction
parseCallback()	Parses the callback function name and if callable, executes it to return value	kartik\depdrop\DepDropAction

Property Details

$allowEmpty public property

Whether selected value can be empty. Defaults to false.

public boolean $allowEmpty = false

$enableCsrfValidation public property

Whether CSRF validation is enabled for this action. Defaults to true.

public boolean $enableCsrfValidation = true

$otherParam public property

Other parameter name for the dependent dropdown

public string $otherParam = 'depdrop_params'

$outputCallback public property

The output callback function

public Closure $outputCallback = null

$parentParam public property

Parent parameter name for the dependent dropdown

public string $parentParam = 'depdrop_parents'

$selectedCallback public property

The selected callback function

public Closure $selectedCallback = null

Method Details

getOutput() protected method

Return select option values output

protected mixed getOutput ( $id, $params = [] )
$id	string	The selected value identifier
$params	array	The parameters passed
return	mixed	The option values

getSelected() protected method

Return selected value

protected string getSelected ( $id, $params = [] )
$id	string	The selected value identifier
$params	array	The parameters passed
return	string	The selected value

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

parseCallback() protected method

Parses the callback function name and if callable, executes it to return value

protected mixed parseCallback ( $funcName, $id, $params = [] )
$funcName	string	The function name
$id	string	The selected value identifier
$params	array	The parameters passed
return	mixed	The parsed value

run() public method

public void run ( )