Class mdm\admin\controllers\AssignmentController

All Classes | Properties | Methods | Events

Inheritance	mdm\admin\controllers\AssignmentController » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\Object
Implements	yii\base\ViewContextInterface
Available since version	1.0

AssignmentController implements the CRUD actions for Assignment model.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$action	yii\base\Action	The action that is currently being executed.	yii\base\Controller
$actionParams	array	The parameters bound to the current action.	yii\web\Controller
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	mdm\admin\controllers\AssignmentController
$defaultAction	string	The ID of the action that is used when the action ID is not specified in the request.	yii\base\Controller
$enableCsrfValidation	boolean	Whether to enable CSRF validation for the actions in this controller.	yii\web\Controller
$id	string	The ID of this controller.	yii\base\Controller
$idField			mdm\admin\controllers\AssignmentController
$layout	string\|boolean	The name of the layout to be applied to this controller's views.	yii\base\Controller
$module	yii\base\Module	The module that this controller belongs to.	yii\base\Controller
$modules	yii\base\Module[]	All ancestor modules that this controller is located within.	mdm\admin\controllers\AssignmentController
$route	string	The route (module ID, controller ID and action ID) of the current request.	mdm\admin\controllers\AssignmentController
$searchClass			mdm\admin\controllers\AssignmentController
$uniqueId	string	The controller ID that is prefixed with the module ID (if any).	mdm\admin\controllers\AssignmentController
$userClassName			mdm\admin\controllers\AssignmentController
$usernameField			mdm\admin\controllers\AssignmentController
$view	yii\base\View\|yii\web\View	The view object that can be used to render views or view files.	mdm\admin\controllers\AssignmentController
$viewPath	string	The directory containing the view files for this controller.	mdm\admin\controllers\AssignmentController

Public Methods

Hide inherited 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()		yii\base\Controller
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property value is 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
actionAssign()	Assign or revoke assignment to user	mdm\admin\controllers\AssignmentController
actionIndex()	Lists all Assignment models.	mdm\admin\controllers\AssignmentController
actionRoleSearch()	Search roles of user	mdm\admin\controllers\AssignmentController
actionView()	Displays a single Assignment model.	mdm\admin\controllers\AssignmentController
actions()	Declares external actions for the controller.	yii\base\Controller
afterAction()	This method is invoked right after an action is executed.	yii\base\Controller
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
beforeAction()	This method is invoked right before an action is executed.	yii\base\Controller
behaviors()	Returns a list of behaviors that this component should behave as.	mdm\admin\controllers\AssignmentController
bindActionParams()	Binds the parameters to the action.	yii\base\Controller
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\Object
createAction()	Creates an action based on the given action ID.	yii\base\Controller
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
findLayoutFile()	Finds the applicable layout file.	yii\base\Controller
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getModules()	Returns all ancestor modules of this controller.	yii\base\Controller
getRoute()	Returns the route of the current request.	yii\base\Controller
getUniqueId()		yii\base\Controller
getView()	Returns the view object that can be used to render views or view files.	yii\base\Controller
getViewPath()	Returns the directory containing view files for this controller.	yii\base\Controller
goBack()	Redirects the browser to the last visited page.	yii\web\Controller
goHome()	Redirects the browser to the home page.	yii\web\Controller
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.	mdm\admin\controllers\AssignmentController
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
redirect()	Redirects the browser to the specified URL.	yii\web\Controller
refresh()	Refreshes the current page.	yii\web\Controller
render()	Renders a view and applies layout if available.	yii\base\Controller
renderAjax()	Renders a view in response to an AJAX request.	yii\web\Controller
renderFile()	Renders a view file.	yii\base\Controller
renderPartial()	Renders a view.	yii\base\Controller
run()	Runs a request specified in terms of a route.	yii\base\Controller
runAction()	Runs an action within this controller with the specified action ID and parameters.	yii\base\Controller
setView()	Sets the view object to be used by this controller.	yii\base\Controller
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
findModel()	Finds the Assignment model based on its primary key value.	mdm\admin\controllers\AssignmentController

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_ACTION	yii\base\ActionEvent	An event raised right after executing a controller action.	yii\base\Controller
EVENT_BEFORE_ACTION	yii\base\ActionEvent	An event raised right before executing a controller action.	yii\base\Controller

Property Details

$behaviors public read-only property

yii\base\Behavior[] getBehaviors( )

List of behaviors attached to this component

$idField public property

$idField = 'id'

$modules public read-only property

yii\base\Module[] getModules( )

All ancestor modules that this controller is located within.

$route public read-only property

string getRoute( )

The route (module ID, controller ID and action ID) of the current request.

$searchClass public property

$searchClass = null

$uniqueId public read-only property

string getUniqueId( )

The controller ID that is prefixed with the module ID (if any).

$userClassName public property

$userClassName = null

$usernameField public property

$usernameField = 'username'

$view public property

yii\base\View|yii\web\View getView( )
void setView( $view )

The view object that can be used to render views or view files.

$viewPath public read-only property

string getViewPath( )

The directory containing the view files for this controller.

Method Details

actionAssign() public method

Assign or revoke assignment to user

mixed actionAssign( $id, $action )
$id	integer
$action	string

actionIndex() public method

Lists all Assignment models.

mixed actionIndex( )

actionRoleSearch() public method

Search roles of user

string actionRoleSearch( $id, $target, $term = '' )
$id	integer
$target	string
$term	string

actionView() public method

Displays a single Assignment model.

mixed actionView( $id )
$id	integer

behaviors() public method

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from \mdm\admin\controllers\Behavior. Behavior names can be strings or integers. If the former, they uniquely identify the behaviors. If the latter, the corresponding behaviors are anonymous and their properties and methods will NOT be made available via the component (however, the behaviors can still respond to the component's events).

Behaviors declared in this method will be attached to the component automatically (on demand).

array behaviors( )
return	array	The behavior configurations.

findModel() protected method

Finds the Assignment model based on its primary key value.

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

\mdm\admin\models\Assignment findModel( $id )
$id	integer
return	\mdm\admin\models\Assignment	The loaded model
throws	yii\web\NotFoundHttpException	if the model cannot be found

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.

void init( )