PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of FormController.php

Controller tailored to suit most form-based admin operations.

Constructor.

param: array                 $config       An optional associative array of configuration settings.
param: MVCFactoryInterface   $factory      The factory.
param: CMSApplication        $app          The Application for the dispatcher
param: Input                 $input        Input
param: FormFactoryInterface  $formFactory  The form factory.

add() X-Ref

Method to add a new record.

return: boolean True if the record can be added, false if not.

allowAdd($data = []) X-Ref

Method to check if you can add a new record.

Extended classes can override this if necessary.

param: array $data An array of input data.
return: boolean

allowEdit($data = [], $key = 'id') X-Ref

Method to check if you can edit an existing record.

Extended classes can override this if necessary.

param: array $data An array of input data.
param: string $key The name of the key for the primary key; default is id.
return: boolean

allowSave($data, $key = 'id') X-Ref

Method to check if you can save a new or existing record.

Extended classes can override this if necessary.

param: array $data An array of input data.
param: string $key The name of the key for the primary key.
return: boolean

batch($model) X-Ref

Method to run batch operations.

param: BaseDatabaseModel $model The model of the component being processed.
return: boolean True if successful, false otherwise and internal error is set.

cancel($key = null) X-Ref

Method to cancel an edit.

param: string $key The name of the primary key of the URL variable.
return: boolean True if access level checks pass, false otherwise.

edit($key = null, $urlVar = null) X-Ref

Method to edit an existing record.

param: string  $key     The name of the primary key of the URL variable.
param: string  $urlVar  The name of the URL variable if different from the primary key
return: boolean  True if access level check and checkout passes, false otherwise.

getModel($name = '', $prefix = '', $config = array('ignore_request' => true) X-Ref

Method to get a model object, loading it if required.

param: string  $name    The model name. Optional.
param: string  $prefix  The class prefix. Optional.
param: array   $config  Configuration array for model. Optional.
return: BaseDatabaseModel  The model.

getRedirectToItemAppend($recordId = null, $urlVar = 'id') X-Ref

Gets the URL arguments to append to an item redirect.

param: integer  $recordId  The primary key id for the item.
param: string   $urlVar    The name of the URL variable for the id.
return: string  The arguments to append to the redirect URL.

getRedirectToListAppend() X-Ref

Gets the URL arguments to append to a list redirect.

return: string The arguments to append to the redirect URL.

postSaveHook(BaseDatabaseModel $model, $validData = array() X-Ref

Function that allows child controller access to model data
after the data has been saved.

param: BaseDatabaseModel $model The data model object.
param: array $validData The validated data.
return: void

save($key = null, $urlVar = null) X-Ref

Method to save a record.

param: string  $key     The name of the primary key of the URL variable.
param: string  $urlVar  The name of the URL variable if different from the primary key (sometimes required to avoid router collisions).
return: boolean  True if successful, false otherwise.

reload($key = null, $urlVar = null) X-Ref

Method to reload a record.

param: string $key The name of the primary key of the URL variable.
param: string $urlVar The name of the URL variable if different from the primary key (sometimes required to avoid router collisions).
return: void

editAssociations() X-Ref

Load item to edit associations in com_associations

return: void

Copyright:	(C) 2009 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	883 lines (29 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/MVC/Controller/ -> FormController.php (summary)

Defines 1 class