[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/components/com_content/src/Controller/ -> ArticleController.php (summary)

(no description)

Copyright: (C) 2009 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 428 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ArticleController:: (11 methods):
  add()
  allowAdd()
  allowEdit()
  cancel()
  edit()
  getModel()
  getRedirectToItemAppend()
  getReturnPage()
  save()
  reload()
  vote()


Class: ArticleController  - X-Ref

Content article class.

add()   X-Ref
Method to add a new record.

return: mixed  True if the record can be added, an error object if not.

allowAdd($data = array()   X-Ref
Method override to check if you can add a new record.

param: array  $data  An array of input data.
return: boolean

allowEdit($data = array()   X-Ref
Method override to check if you can edit an existing record.

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

cancel($key = 'a_id')   X-Ref
Method to cancel an edit.

param: string  $key  The name of the primary key of the URL variable.
return: boolean  True if access level checks pass, false otherwise.

edit($key = null, $urlVar = 'a_id')   X-Ref
Method to edit an existing record.

param: string  $key     The name of the primary key of the URL variable.
param: string  $urlVar  The name of the URL variable if different from the primary key
return: boolean  True if access level check and checkout passes, false otherwise.

getModel($name = 'Form', $prefix = 'Site', $config = array('ignore_request' => true)   X-Ref
Method to get a model object, loading it if required.

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

getRedirectToItemAppend($recordId = null, $urlVar = 'a_id')   X-Ref
Gets the URL arguments to append to an item redirect.

param: integer  $recordId  The primary key id for the item.
param: string   $urlVar    The name of the URL variable for the id.
return: string  The arguments to append to the redirect URL.

getReturnPage()   X-Ref
Get the return URL.

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

return: string  The return URL.

save($key = null, $urlVar = 'a_id')   X-Ref
Method to save a record.

param: string  $key     The name of the primary key of the URL variable.
param: string  $urlVar  The name of the URL variable if different from the primary key (sometimes required to avoid router collisions).
return: boolean  True if successful, false otherwise.

reload($key = null, $urlVar = 'a_id')   X-Ref
Method to reload a record.

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

vote()   X-Ref
Method to save a vote.

return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer