Class rootlocal\crud\actions\ViewAction

All Classes | Properties | Methods

Inheritance	rootlocal\crud\actions\ViewAction » rootlocal\crud\components\Action » yii\base\Action » yii\base\Component » yii\base\BaseObject
Implements	rootlocal\crud\components\ActionInterface, yii\base\Configurable

Class ViewAction Displays a single yii\db\ActiveRecord model

examples:

// lambda function:
public function actions()
{
     'view' => [
         'class' => ViewAction::class,
         'model' => function ($id) {
             return Book::find()->where(['id' => $id])->active()->one();
         }
     ]
}

// string:
public function actions()
{
     'view' => [
         'class' => ViewAction::class,
         'model' => Book::class
     ]
}

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$checkAccess	Closure\|array	Callable a PHP callable that will be called when running an action to determine if the current user has the permission to execute the action.	rootlocal\crud\components\Action
$controller	yii\base\Controller\|yii\web\Controller\|yii\console\Controller	The controller that owns this action	yii\base\Action
$id	string	ID of the action	yii\base\Action
$model	Closure\|string\|array	ActiveRecord Model	rootlocal\crud\actions\ViewAction
$uniqueId	string	The unique ID of this action among the whole application.	yii\base\Action
$view	string	The view name.	rootlocal\crud\actions\ViewAction

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
getModel()	Get model	rootlocal\crud\actions\ViewAction
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.	yii\base\BaseObject
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
run()	Runs the action.	rootlocal\crud\actions\ViewAction
runWithParams()	Runs this action with the specified parameters.	yii\base\Action
setModel()	Set model	rootlocal\crud\actions\ViewAction
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
findModel()	Finds the Alias model based on its primary key value.	rootlocal\crud\actions\ViewAction

Property Details

$model public property

ActiveRecord Model

public Closure|string|array getModel ( )
public void setModel ( $model )

$view public property

The view name.

public string $view = 'view'

Method Details

findModel() protected method

Finds the Alias model based on its primary key value.

If the model is not found, a 404 HTTP exception will be thrown.

protected yii\db\ActiveRecord findModel ( $id )
$id	integer	Primary key
return	yii\db\ActiveRecord	The loaded model
throws	\yii\web\NotFoundHttpException	if the model cannot be found

getModel() public method

Get model

public Closure\|string\|array getModel ( )
return	Closure\|string\|array	ActiveRecord Model
throws	yii\base\ErrorException	if Model not specified (not set)

run() public method

Runs the action.

public string run ( $id )
$id	integer	Primary key
return	string	Response

setModel() public method

Set model

public void setModel ( $model )
$model	Closure\|string\|array	ActiveRecord Model