Class MenusControllerItem

Description

The Menu Item Controller

  • since: 1.6

Located in /administrator/components/com_menus/controllers/item.php (line 19)

JObject
   |
   --JControllerLegacy
      |
      --JControllerForm
         |
         --MenusControllerItem
Method Summary
 mixed add ()
 boolean batch ([object $model = null])
 boolean cancel ([string $key = null])
 boolean edit ([string $key = null], [string $urlVar = null])
 void getParentItem ()
 boolean save ([string $key = null], [string $urlVar = null])
 void setType ()
Variables
Methods
add (line 28)

Method to add a new menu item.

  • return: True if the record can be added, a JError object if not.
  • since: 1.6
  • access: public
mixed add ()

Redefinition of:
JControllerForm::add()
Method to add a new record.
batch (line 56)

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.
cancel (line 77)

Method to cancel an edit.

  • return: True if access level checks pass, false otherwise.
  • since: 1.6
  • access: public
boolean cancel ([string $key = null])
  • string $key: The name of the primary key of the URL variable.

Redefinition of:
JControllerForm::cancel()
Method to cancel an edit.
edit (line 104)

Method to edit an existing record.

  • return: True if access level check and checkout passes, false otherwise.
  • since: 1.6
  • 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).

Redefinition of:
JControllerForm::edit()
Method to edit an existing record.
getParentItem (line 393)

Gets the parent items of the menu location currently.

  • since: 3.2
void getParentItem ()
save (line 129)

Method to save a record.

  • return: True if successful, false otherwise.
  • since: 1.6
  • 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).

Redefinition of:
JControllerForm::save()
Method to save a record.
setType (line 335)

Sets the type of the menu item currently being edited.

  • since: 1.6
  • access: public
void setType ()

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 15:05:59 +0100 by phpDocumentor 1.4.3