Class ContentControllerArticle

Description

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

JObject
   |
   --JController
      |
      --JControllerForm
         |
         --ContentControllerArticle
Variable Summary
mixed $view_item
mixed $view_list
Method Summary
boolean 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 ([int $recordId = null], [string $urlVar = 'a_id'])
string getReturnPage ()
void postSaveHook (JModel &$model, array $validData, JModel $model)
Boolean save ([string $key = null], [string $urlVar = 'a_id'])
void vote ()
Variables
Methods
add (line 34)

Method to add a new record.

  • return: True if the article can be added, false if not.
  • since: 1.6
  • access: public
boolean add ()

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

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 80)

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.

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

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 144)

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 162)

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 178)

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 ([int $recordId = null], [string $urlVar = 'a_id'])
  • int $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 227)

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 248)

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

  • since: 1.6
  • access: protected
void postSaveHook (JModel &$model, array $validData, JModel $model)
  • JModel $model: The data model object.
  • array $validData: The validated data.
  • JModel &$model

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

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 287)

Method to save a vote.

  • since: 1.6.1
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::postSaveHook()
JControllerForm::save()

Inherited From JController

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

Inherited From JObject

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

Documentation generated on Mon, 25 Jun 2012 13:52:17 -0500 by phpDocumentor 1.4.4