CreateAction

API reference › yii › rest › CreateAction

class	`yii\rest\CreateAction`
Extends	`Action` » `yii\base\Action` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`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.

Properties

Property	Type	Description	Defined by
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$checkAccess`	`callable\|null`	A PHP callable that will be called when running an action to determine if the current user has the permission to execute the action. Default: `null`.	`Action`
`$controller`	`yii\base\T\|null`	The controller that owns this action, or `null` when the action runs standalone. via `Module::$actionMap` Default: `null`.	`yii\base\Action`
`$findModel`	`callable\|null`	A PHP callable that will be called to return the model corresponding to the specified primary key value. Default: `null`.	`Action`
`$id`	`string\|null`	ID of the action; `null` between construction and dispatcher post-assignment for standalone actions resolved through `Module::$actionMap` or `Module::$actionNamespace`. Default: `null`.	`yii\base\Action`
`$modelClass`	`string`	Class name of the model which will be handled by this action. Default: `null`.	`Action`
`$module`	`yii\base\Module\|null`	The owning module, or `null` if neither a module nor a controller is attached. Available since 22.0.	`yii\base\Action`
`$scenario`	`string`	The scenario to be assigned to the new model before it is validated and saved. Default: `\yii\base\Model::SCENARIO_DEFAULT`.	`CreateAction`
`$uniqueId` read-only	`string`	The unique ID of this action among the whole application.	`yii\base\Action`
`$viewAction`	`string`	The name of the view action. Default: `'view'`.	`CreateAction`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\Action`
`__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`
`__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()` static	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.	`Action`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getModule()`	Returns the module that owns this action when invoked standalone.	`yii\base\Action`
`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.	`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.	`CreateAction`
`runWithParams()`	Runs this action with the specified parameters.	`yii\base\Action`
`setModule()`	Sets the module that owns this action when invoked standalone.	`yii\base\Action`
`trigger()`	Triggers an event.	`yii\base\Component`
`afterRun()` protected	This method is called right after `run()` is executed.	`yii\base\Action`
`beforeRun()` protected	This method is called right before `run()` is executed.	`yii\base\Action`
`resolveStandaloneParams()` protected	Resolves typed parameters of `run()` when the action is invoked without a hosting controller.	`yii\base\Action`

Property details

$viewAction

public string $viewAction = 'view'

The name of the view action.

This property is needed to create the URL when the model is successfully created.

Method details

run()

public function run(): yii\db\ActiveRecordInterface

Creates a new model.

Returns

yii\db\ActiveRecordInterface: The model newly created

Throws

yii\web\ServerErrorHttpException: if there is any error when creating the model