Docs For Class JControllerForm

JControllerForm

Description

Controller tailored to suit most form-based admin operations.

todo: Add ability to set redirect manually to better cope with frontend usage.
since: 12.2

Located in /libraries/legacy/controller/form.php (line 20)

JObject
   |
   --JControllerLegacy
      |
      --JControllerForm

Direct descendents

Class	Description
AdminControllerProfile	User profile controller class.
BannersControllerBanner	Banner controller class.
BannersControllerClient	Client controller class.
CategoriesControllerCategory	The Category Controller
ContactControllerContact
ContentControllerArticle
FinderControllerFilter	Indexer controller class for Finder.
LanguagesControllerLanguage	Languages list actions controller.
LanguagesControllerOverride	Languages Override Controller
MenusControllerItem	The Menu Item Controller
MenusControllerMenu	The Menu Type Controller
MessagesControllerMessage	Messages Component Message Model
ModulesControllerModule	Module controller class.
NewsfeedsControllerNewsfeed	Newsfeed controller class.
PluginsControllerPlugin	Plugin controller class.
RedirectControllerLink	Redirect link controller class.
TagsControllerTag	The Tag Controller
TemplatesControllerStyle	Template style controller class.
UsersControllerGroup	User view level controller class.
UsersControllerLevel	User view level controller class.
UsersControllerNote	User note controller class.
UsersControllerUser	User controller class.
WeblinksControllerWeblink

Variable Summary

string $context

string $option

string $text_prefix

string $view_item

string $view_list

Method Summary

JControllerForm __construct ([array $config = array()])

mixed add ()

boolean allowAdd ([array $data = array()])

boolean allowEdit ([array $data = array()], [string $key = 'id'])

boolean allowSave (array $data, [string $key = 'id'])

boolean batch (JModelLegacy $model)

boolean cancel ([string $key = null])

boolean edit ([string $key = null], [string $urlVar = null])

object The getModel ([string $name = ''], [string $prefix = ''], [array $config = array('ignore_request' => true)])

string getRedirectToItemAppend ([integer $recordId = null], [string $urlVar = 'id'])

string getRedirectToListAppend ()

mixed loadhistory ()

void postSaveHook (JModelLegacy $model, [array $validData = array()])

boolean save ([string $key = null], [string $urlVar = null])

Variables

string $context (line 28)

The context for storing internal data, e.g. record.

since: 12.2
access: protected

string $option (line 36)

The URL option for the component.

since: 12.2
access: protected

string $text_prefix (line 60)

The prefix to use with controller messages.

since: 12.2
access: protected

Redefined in descendants as:

BannersControllerBanner::$text_prefix
BannersControllerClient::$text_prefix
TemplatesControllerStyle::$text_prefix
UsersControllerGroup::$text_prefix
UsersControllerLevel::$text_prefix
UsersControllerNote::$text_prefix : The prefix to use with controller messages.
UsersControllerUser::$text_prefix

string $view_item (line 44)

The URL view item variable.

since: 12.2
access: protected

Redefined in descendants as:

ContentControllerArticle::$view_item : The URL view item variable.
WeblinksControllerWeblink::$view_item

string $view_list (line 52)

The URL view list variable.

since: 12.2
access: protected

Redefined in descendants as:

ContentControllerArticle::$view_list : The URL view list variable.
WeblinksControllerWeblink::$view_list

Inherited Variables

Inherited from JControllerLegacy

JControllerLegacy::$basePath
JControllerLegacy::$default_view
JControllerLegacy::$doTask
JControllerLegacy::$input
JControllerLegacy::$instance
JControllerLegacy::$message
JControllerLegacy::$messageType
JControllerLegacy::$methods
JControllerLegacy::$model_prefix
JControllerLegacy::$name
JControllerLegacy::$paths
JControllerLegacy::$redirect
JControllerLegacy::$task
JControllerLegacy::$taskMap

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 71)

Constructor.

see: JControllerLegacy
throws: Exception
since: 12.2
access: public

JControllerForm __construct ([array $config = array()])

array $config: An optional associative array of configuration settings.

Redefinition of:

JControllerLegacy::__construct(): Constructor.

Redefined in descendants as:

CategoriesControllerCategory::__construct() : Constructor.

add (line 144)

Method to add a new record.

return: True if the record can be added, a error object if not.
since: 12.2
access: public

mixed add ()

Redefined in descendants as:

ContentControllerArticle::add() : Method to add a new record.
MenusControllerItem::add() : Method to add a new menu item.
ModulesControllerModule::add() : Override parent add method.
WeblinksControllerWeblink::add() : Method to add a new record.

allowAdd (line 191)

Method to check if you can add a new record.

Extended classes can override this if necessary.

since: 12.2
access: protected

boolean allowAdd ([array $data = array()])

array $data: An array of input data.

Redefined in descendants as:

BannersControllerBanner::allowAdd() : Method override to check if you can add a new record.
CategoriesControllerCategory::allowAdd() : Method to check if you can add a new record.
ContentControllerArticle::allowAdd() : Method override to check if you can add a new record.
NewsfeedsControllerNewsfeed::allowAdd() : Method override to check if you can add a new record.
TagsControllerTag::allowAdd() : Method to check if you can add a new record.
WeblinksControllerWeblink::allowAdd() : Method override to check if you can add a new record.

allowEdit (line 209)

Method to check if you can add a new record.

Extended classes can override this if necessary.

since: 12.2
access: protected

boolean allowEdit ([array $data = array()], [string $key = 'id'])

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

Redefined in descendants as:

AdminControllerProfile::allowEdit() : Method to check if you can edit a record.
BannersControllerBanner::allowEdit() : Method override to check if you can edit an existing record.
CategoriesControllerCategory::allowEdit() : Method to check if you can edit a record.
ContentControllerArticle::allowEdit() : Method override to check if you can edit an existing record.
ModulesControllerModule::allowEdit() : Method override to check if you can edit an existing record.
NewsfeedsControllerNewsfeed::allowEdit() : Method to check if you can edit a record.
TagsControllerTag::allowEdit() : Method to check if you can edit a record.
UsersControllerGroup::allowEdit() : Overrides JControllerForm::allowEdit
UsersControllerUser::allowEdit() : Overrides JControllerForm::allowEdit
WeblinksControllerWeblink::allowEdit() : Method to check if you can add a new record.

allowSave (line 226)

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

Extended classes can override this if necessary.

since: 12.2
access: protected

boolean allowSave (array $data, [string $key = 'id'])

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

Redefined in descendants as:

MessagesControllerMessage::allowSave() : Method (override) to check if you can save a new or existing record.
ModulesControllerModule::allowSave() : Override parent allowSave method.
UsersControllerGroup::allowSave() : Method to check if you can save a new or existing record.
UsersControllerLevel::allowSave() : Method to check if you can save a new or existing record.

batch (line 249)

Method to run batch operations.

return: True if successful, false otherwise and internal error is set.
since: 12.2
access: public

boolean batch (JModelLegacy $model)

JModelLegacy $model: The model of the component being processed.

Redefined in descendants as:

BannersControllerBanner::batch() : Method to run batch operations.
CategoriesControllerCategory::batch() : Method to run batch operations.
MenusControllerItem::batch() : Method to run batch operations.
ModulesControllerModule::batch() : Method to run batch operations.
NewsfeedsControllerNewsfeed::batch() : Method to run batch operations.
TagsControllerTag::batch() : Method to run batch operations.
UsersControllerUser::batch() : Method to run batch operations.

cancel (line 294)

Method to cancel an edit.

return: True if access level checks pass, false otherwise.
since: 12.2
access: public

boolean cancel ([string $key = null])

string $key: The name of the primary key of the URL variable.

Redefined in descendants as:

AdminControllerProfile::cancel() : Method to cancel an edit.
ContentControllerArticle::cancel() : Method to cancel an edit.
LanguagesControllerOverride::cancel() : Method to cancel an edit
MenusControllerItem::cancel() : Method to cancel an edit.
ModulesControllerModule::cancel() : Override parent cancel method to reset the add module state.
WeblinksControllerWeblink::cancel() : Method to cancel an edit.

edit (line 359)

Method to edit an existing record.

return: True if access level check and checkout passes, false otherwise.
since: 12.2
access: public

boolean edit ([string $key = null], [string $urlVar = null])

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

Redefined in descendants as:

ContentControllerArticle::edit() : Method to edit an existing record.
LanguagesControllerOverride::edit() : Method to edit an existing override
MenusControllerItem::edit() : Method to edit an existing record.
WeblinksControllerWeblink::edit() : Method to edit an existing record.

getModel (line 443)

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

return: model.
since: 12.2
access: public

object The getModel ([string $name = ''], [string $prefix = ''], [array $config = array('ignore_request' => true)])

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

Redefinition of:

JControllerLegacy::getModel(): Method to get a model object, loading it if required.

Redefined in descendants as:

ContactControllerContact::getModel()
ContentControllerArticle::getModel() : Method to get a model object, loading it if required.
WeblinksControllerWeblink::getModel() : Method to get a model object, loading it if required.

getRedirectToItemAppend (line 463)

Gets the URL arguments to append to an item redirect.

return: The arguments to append to the redirect URL.
since: 12.2
access: protected

string getRedirectToItemAppend ([integer $recordId = null], [string $urlVar = 'id'])

integer $recordId: The primary key id for the item.
string $urlVar: The name of the URL variable for the id.

Redefined in descendants as:

CategoriesControllerCategory::getRedirectToItemAppend() : Gets the URL arguments to append to an item redirect.
ContentControllerArticle::getRedirectToItemAppend() : Gets the URL arguments to append to an item redirect.
LanguagesControllerLanguage::getRedirectToItemAppend() : Gets the URL arguments to append to an item redirect.
UsersControllerNote::getRedirectToItemAppend() : Gets the URL arguments to append to an item redirect.
WeblinksControllerWeblink::getRedirectToItemAppend() : Gets the URL arguments to append to an item redirect.

getRedirectToListAppend (line 495)

Gets the URL arguments to append to a list redirect.

return: The arguments to append to the redirect URL.
since: 12.2
access: protected

string getRedirectToListAppend ()

Redefined in descendants as:

CategoriesControllerCategory::getRedirectToListAppend() : Gets the URL arguments to append to a list redirect.

loadhistory (line 531)

Method to load a row from version history

return: True if the record can be added, a error object if not.
since: 3.2
access: public

mixed loadhistory ()

postSaveHook (line 520)

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

since: 12.2
access: protected

void postSaveHook (JModelLegacy $model, [array $validData = array()])

JModelLegacy $model: The data model object.
array $validData: The validated data.

Redefined in descendants as:

CategoriesControllerCategory::postSaveHook() : Function that allows child controller access to model data after the data has been saved.
ContentControllerArticle::postSaveHook() : Function that allows child controller access to model data after the data has been saved.
ModulesControllerModule::postSaveHook() : Function that allows child controller access to model data after the data has been saved.
NewsfeedsControllerNewsfeed::postSaveHook() : Function that allows child controller access to model data after the data has been saved.
UsersControllerUser::postSaveHook() : Function that allows child controller access to model data after the data has been saved.
WeblinksControllerWeblink::postSaveHook() : Function that allows child controller access to model data after the data has been saved.

save (line 608)

Method to save a record.

return: True if successful, false otherwise.
since: 12.2
access: public

boolean save ([string $key = null], [string $urlVar = null])

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

Redefined in descendants as:

AdminControllerProfile::save() : Overrides parent save method to check the submitted passwords match.
ContentControllerArticle::save() : Method to save a record.
FinderControllerFilter::save() : Method to save a record.
LanguagesControllerOverride::save() : Method to save an override
MenusControllerItem::save() : Method to save a record.
MenusControllerMenu::save() : Method to save a menu item.
TemplatesControllerStyle::save()
WeblinksControllerWeblink::save() : Method to save a record.

Inherited Methods

Inherited From JControllerLegacy

JControllerLegacy::__construct()
JControllerLegacy::addModelPath()
JControllerLegacy::addPath()
JControllerLegacy::addViewPath()
JControllerLegacy::authorise()
JControllerLegacy::checkEditId()
JControllerLegacy::createFileName()
JControllerLegacy::createModel()
JControllerLegacy::createView()
JControllerLegacy::display()
JControllerLegacy::execute()
JControllerLegacy::getInstance()
JControllerLegacy::getModel()
JControllerLegacy::getName()
JControllerLegacy::getTask()
JControllerLegacy::getTasks()
JControllerLegacy::getView()
JControllerLegacy::holdEditId()
JControllerLegacy::redirect()
JControllerLegacy::registerDefaultTask()
JControllerLegacy::registerTask()
JControllerLegacy::releaseEditId()
JControllerLegacy::setMessage()
JControllerLegacy::setPath()
JControllerLegacy::setRedirect()
JControllerLegacy::unregisterTask()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()

Documentation generated on Tue, 19 Nov 2013 15:03:43 +0100 by phpDocumentor 1.4.3