Class yii\rest\CreateAction
| Inheritance | yii\rest\CreateAction » yii\rest\Action » yii\base\Action » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/rest/CreateAction.php |
CreateAction implements the API endpoint for creating a new model from the given data.
For more details and usage information on CreateAction, see the guide article on rest controllers.
Public Properties
| Property | Type | Description | Defined 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|yii\console\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 |
| $scenario | string | The scenario to be assigned to the new model before it is validated and saved. | yii\rest\CreateAction |
| $uniqueId | string | The unique ID of this action among the whole application. | yii\base\Action |
| $viewAction | string | The name of the view action. | yii\rest\CreateAction |
Public 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\Action |
| __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\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 |
| 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\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| 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() | Creates a new model. | yii\rest\CreateAction |
| runWithParams() | Runs this action with the specified parameters. | yii\base\Action |
| trigger() | Triggers an event. | yii\base\Component |
Protected 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 |
Property Details
The scenario to be assigned to the new model before it is validated and saved.
The name of the view action. This property is needed to create the URL when the model is successfully created.
Method Details
Creates a new model.
| public yii\db\ActiveRecordInterface run ( ) | ||
| return | yii\db\ActiveRecordInterface | The model newly created |
|---|---|---|
| throws | yii\web\ServerErrorHttpException | if there is any error when creating the model |