Class yii\rest\ViewAction

Inheritanceyii\rest\ViewAction » yii\rest\Action » yii\base\Action » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/rest/ViewAction.php

ViewAction implements the API endpoint for returning the detailed information about a model.

For more details and usage information on ViewAction, see the guide article on rest controllers.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$checkAccess 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. yii\rest\Action
$controller yii\base\Controller|yii\web\Controller The controller that owns this action yii\base\Action
$findModel callable A PHP callable that will be called to return the model corresponding to the specified primary key value. yii\rest\Action
$id string ID of the action yii\base\Action
$modelClass string Class name of the model which will be handled by this action. yii\rest\Action
$uniqueId string The unique ID of this action among the whole application. yii\base\Action

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Object
__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 an object property. yii\base\Object
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Object
__set() Sets value of an object property. yii\base\Object
__unset() Sets an object property to null. yii\base\Object
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\Object
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Object
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
findModel() Returns the data model based on the primary key given. yii\rest\Action
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\Object
hasProperty() Returns a value indicating whether a property is defined. yii\base\Object
init() Initializes the object. yii\rest\Action
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
run() Displays a model. yii\rest\ViewAction
runWithParams() Runs this action with the specified parameters. yii\base\Action
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined 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

Method Details

run() public method

Displays a model.

public yii\db\ActiveRecordInterface run ( $id )
$id string

The primary key of the model.

return yii\db\ActiveRecordInterface

The model being displayed