Class ContentControllerArticle

Description

Located in /components/com_content/controllers/article.php (line 16)

JObject
   |
   --JControllerLegacy
      |
      --JControllerForm
         |
         --ContentControllerArticle
Variable Summary
 string $urlVar
 string $view_item
 string $view_list
Method Summary
 mixed add ()
 boolean allowAdd ([array $data = array()])
 boolean allowEdit ([array $data = array()], [string $key = 'id'])
 boolean cancel ([string $key = 'a_id'])
 boolean edit ([string $key = null], [string $urlVar = 'a_id'])
 object The getModel ([string $name = 'form'], [string $prefix = ''], [array $config = array('ignore_request' => true)])
 string getRedirectToItemAppend ([integer $recordId = null], [string $urlVar = 'a_id'])
 string getReturnPage ()
 void postSaveHook (JModelLegacy $model, [array $validData = array()])
 boolean save ([string $key = null], [string $urlVar = 'a_id'])
 void vote ()
Variables
string $urlVar = 'a.id' (line 40)

The URL edit variable.

  • since: 3.2
  • access: protected
string $view_item = 'form' (line 24)

The URL view item variable.

  • since: 1.6
  • access: protected

Redefinition of:
JControllerForm::$view_item
The URL view item variable.
string $view_list = 'categories' (line 32)

The URL view list variable.

  • since: 1.6
  • access: protected

Redefinition of:
JControllerForm::$view_list
The URL view list variable.

Inherited Variables

Inherited from JControllerForm

JControllerForm::$context
JControllerForm::$option
JControllerForm::$text_prefix

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
add (line 49)

Method to add a new record.

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

Redefinition of:
JControllerForm::add()
Method to add a new record.
allowAdd (line 67)

Method override 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 100)

Method override to check if you can edit an existing record.

  • since: 1.6
  • 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.

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

Method to cancel an edit.

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

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

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 = 'a_id'])
  • 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.
getModel (line 189)

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

  • return: model.
  • since: 1.5
  • access: public
object The getModel ([string $name = 'form'], [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:
JControllerForm::getModel()
Method to get a model object, loading it if required.
getRedirectToItemAppend (line 206)

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 = 'a_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.
getReturnPage (line 262)

Get the return URL.

If a "return" variable has been passed in the request

  • return: The return URL.
  • since: 1.6
  • access: protected
string getReturnPage ()
postSaveHook (line 286)

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

  • since: 1.6
  • 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.
save (line 301)

Method to save a record.

  • return: True if successful, false otherwise.
  • since: 1.6
  • access: public
boolean save ([string $key = null], [string $urlVar = 'a_id'])
  • 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.
vote (line 321)

Method to save a vote.

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

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:53:54 +0100 by phpDocumentor 1.4.3