Class CategoriesControllerCategory

Description

The Category Controller

  • since: 1.6

Located in /administrator/components/com_categories/controllers/category.php (line 19)

JObject
   |
   --JControllerLegacy
      |
      --JControllerForm
         |
         --CategoriesControllerCategory
Variable Summary
 string $extension
Method Summary
 CategoriesControllerCategory __construct ([array $config = array()])
 boolean allowAdd ([array $data = array()])
 boolean allowEdit ([array $data = array()], [string $key = 'parent_id'])
 boolean batch ([object $model = null])
 string getRedirectToItemAppend ([integer $recordId = null], [string $urlVar = 'id'])
 void postSaveHook (JModelLegacy $model, [array $validData = array()])
Variables
Methods
Constructor __construct (line 36)

Constructor.

CategoriesControllerCategory __construct ([array $config = array()])
  • array $config: An optional associative array of configuration settings.

Redefinition of:
JControllerForm::__construct()
Constructor.
allowAdd (line 56)

Method to check if you can add a new record.

  • since: 1.6
  • access: protected
boolean allowAdd ([array $data = array()])
  • array $data: An array of input data.

Redefinition of:
JControllerForm::allowAdd()
Method to check if you can add a new record.
allowEdit (line 72)

Method to check if you can edit a record.

  • since: 1.6
  • access: protected
boolean allowEdit ([array $data = array()], [string $key = 'parent_id'])
  • array $data: An array of input data.
  • string $key: The name of the key for the primary key.

Redefinition of:
JControllerForm::allowEdit()
Method to check if you can add a new record.
batch (line 127)

Method to run batch operations.

  • return: True if successful, false otherwise and internal error is set.
  • since: 1.6
  • access: public
boolean batch ([object $model = null])
  • object $model: The model.

Redefinition of:
JControllerForm::batch()
Method to run batch operations.
getRedirectToItemAppend (line 150)

Gets the URL arguments to append to an item redirect.

  • return: The arguments to append to the redirect URL.
  • since: 1.6
  • 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.

Redefinition of:
JControllerForm::getRedirectToItemAppend()
Gets the URL arguments to append to an item redirect.
getRedirectToListAppend (line 165)

Gets the URL arguments to append to a list redirect.

  • return: The arguments to append to the redirect URL.
  • since: 1.6
  • access: protected
string getRedirectToListAppend ()

Redefinition of:
JControllerForm::getRedirectToListAppend()
Gets the URL arguments to append to a list redirect.
postSaveHook (line 183)

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

  • since: 3.1
  • access: protected
void postSaveHook (JModelLegacy $model, [array $validData = array()])
  • JModelLegacy $model: The data model object.
  • array $validData: The validated data.

Redefinition of:
JControllerForm::postSaveHook()
Function that allows child controller access to model data after the data has been saved.

Inherited Methods

Inherited From JControllerForm

 JControllerForm::__construct()
 JControllerForm::add()
 JControllerForm::allowAdd()
 JControllerForm::allowEdit()
 JControllerForm::allowSave()
 JControllerForm::batch()
 JControllerForm::cancel()
 JControllerForm::edit()
 JControllerForm::getModel()
 JControllerForm::getRedirectToItemAppend()
 JControllerForm::getRedirectToListAppend()
 JControllerForm::loadhistory()
 JControllerForm::postSaveHook()
 JControllerForm::save()

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 14:55:29 +0100 by phpDocumentor 1.4.3