Référence de la classe FOFController

Graphe d'héritage de FOFController:

Fonctions membres publiques
	__construct ($config=array())
	addViewPath ($path)
	authorise ($task)
	execute ($task)
	display ($cachable=false, $urlparams=false, $tpl=null)
	browse ()
	read ()
	add ()
	edit ()
	apply ()
	copy ()
	save ()
	savenew ()
	cancel ()
	loadhistory ()
	accesspublic ()
	accessregistered ()
	accessspecial ()
	publish ()
	unpublish ()
	archive ()
	trash ()
	saveorder ()
	orderdown ()
	orderup ()
	remove ()
	redirect ()
	hasRedirect ()
	registerDefaultTask ($method)
	registerTask ($task, $method)
	unregisterTask ($task)
	setMessage ($text, $type='message')
	setRedirect ($url, $msg=null, $type=null)
	getThisModel ($config=array())
	getModel ($name='', $prefix='', $config=array())
	getThisView ($config=array())
	getName ()
	getTask ()
	getTasks ()
	getView ($name='', $type='', $prefix='', $config=array())
	setThisViewName ($viewName)
	setThisModelName ($modelName)
	getItemidURLSuffix ()
Fonctions membres publiques hérités de FOFUtilsObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)

Fonctions membres publiques statiques
static &	getAnInstance ($option=null, $view=null, $config=array())
static &	getTmpInstance ($option=null, $view=null, $config=array())
static	addModelPath ($path, $prefix='')

Fonctions membres protégées
	addPath ($type, $path)
	setPath ($type, $path)
	setstate ($state=0)
	setaccess ($level=0)
	createModel ($name, $prefix='', $config=array())
&	_createModel ($name, $prefix='', $config=array())
	createView ($name, $prefix='', $type='', $config=array())
&	_createView ($name, $prefix='', $type='', $config=array())
	checkACL ($area)
	onBeforeGenericTask ($task)
	onBeforeApplySave (&$data)
	onAfterApplySave ()
	onBeforeAccesspublic ()
	onBeforeAccessregistered ()
	onBeforeAccessspecial ()
	onBeforeAdd ()
	onBeforeApply ()
	onBeforeBrowse ()
	onBeforeCancel ()
	onBeforeEdit ()
	onBeforeOrderdown ()
	onBeforeOrderup ()
	onBeforePublish ()
	onBeforeRemove ()
	onBeforeSave ()
	onBeforeSavenew ()
	onBeforeSaveorder ()
	onBeforeUnpublish ()
	_csrfProtection ()

Fonctions membres protégées statiques
static	createFileName ($type, $parts=array())

Attributs protégés
	$autoRouting = 0
	$bareComponent = 'foobar'
	$basePath
	$cacheableTasks = array('browse', 'read')
	$component = 'com_foobar'
	$config = array()
	$configProvider = null
	$csrfProtection = 2
	$default_view
	$doTask
	$input = array()
	$message
	$messageType
	$layout = null
	$methods
	$model_prefix
	$modelName = null
	$paths
	$redirect
	$task
	$taskMap
	$name
	$view = ''
	$viewName = null
	$viewsCache = array()
	$hasForm = false
Attributs protégés hérités de FOFUtilsObject
	$_errors = array()

Fonctions membres privées
	applySave ()

Attributs privés
	$_viewObject = null
	$_modelObject = null

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = array()

)

Public constructor of the Controller class

Paramètres

array

$config

Optional configuration parameters

Références $basePath, $config, $input, $r, elseif, FOFInflector\explode(), FOFPlatform\getInstance(), name, null, FOFInflector\singularize(), et view.

Documentation des fonctions membres

_createModel()

& _createModel (   $name,   $prefix = '',   $config = array()  )

protected

Method to load and return a model object.

Paramètres

string	$name	The name of the model.
string	$prefix	Optional model prefix.
array	$config	Configuration array for the model. Optional.

Renvoie

mixed Model object on success; otherwise null

Références $config, $name, $prefix, et FOFPlatform\getInstance().

_createView()

& _createView (   $name,   $prefix = '',   $type = '',   $config = array()  )

protected

Deprecated function to create a View object instance

Paramètres

string	$name	The name of the view, e.g. 'Items'
string	$prefix	The prefix of the view, e.g. 'FoobarView'
string	$type	The view type, e.g. 'html'
array	$config	The configuration array for the view

Renvoie

FOFView

Voir également

FOFController::createView

Obsolète:

since version 2.0

Références $config, $name, $prefix, $type, et FOFPlatform\getInstance().

_csrfProtection()

_csrfProtection ( )

protected

Applies CSRF protection by means of a standard Joomla! token (nonce) check. Raises a 403 Access Forbidden error through the platform if the check fails.

TODO Move this check inside the platform

@return  boolean  True if the CSRF check is successful

@throws Exception

Références elseif, FOFPlatform\getInstance(), et null.

accesspublic()

accesspublic

(

)

Sets the access to public. Joomla! 1.5 compatibility.

Renvoie

bool

Obsolète:

since 2.0

accessregistered()

accessregistered

(

)

Sets the access to registered. Joomla! 1.5 compatibility.

Renvoie

bool

Obsolète:

since 2.0

accessspecial()

accessspecial

(

)

Sets the access to special. Joomla! 1.5 compatibility.

Renvoie

bool

Obsolète:

since 2.0

add()

add

(

)

Single record add. The form layout is used to present a blank page.

Renvoie

false|void

Références $form, et $item.

addModelPath()

static addModelPath (   $path,   $prefix = ''  )

static

Adds to the stack of model paths in LIFO order.

Paramètres

mixed	$path	The directory (string) , or list of directories (array) to add.
string	$prefix	A prefix for models

Renvoie

void

Références $path, $prefix, et FOFModel\addIncludePath().

addPath()

addPath (   $type,   $path  )

protected

Adds to the search path for templates and resources.

Paramètres

string	$type	The path type (e.g. 'model', 'view').
mixed	$path	The directory string or stream array to search.

Renvoie

FOFController A FOFController object to support chaining.

Références $path, $type, et FOFPlatform\getInstance().

addViewPath()

addViewPath

(

$path

)

Add one or more view paths to the controller's stack, in LIFO order.

Paramètres

mixed

$path

The directory (string) or list of directories (array) to add.

Renvoie

FOFController This object to support chaining.

Références $path.

apply()

apply

(

)

Save the incoming data and then return to the Edit task

Renvoie

bool

Références $id, $url, et view.

applySave()

applySave ( )

private

Common method to handle apply and save tasks

Renvoie

boolean Returns true on success

Références $data, $id, $url, elseif, FOFPlatform\getInstance(), null, et view.

archive()

archive

(

)

Archive (set enabled = 2) an item.

Renvoie

bool

authorise()

authorise

(

$task

)

Authorisation check

Paramètres

string

$task

The ACO Section Value to check access on.

Renvoie

boolean True if authorised

Obsolète:

2.0 Use JAccess instead.

Références FOFPlatform\getInstance().

browse()

browse

(

)

Implements a default browse task, i.e. read a bunch of records and send them to the browser.

Renvoie

boolean

Références $form, et $layout.

cancel()

cancel

(

)

Cancel the edit, check in the record and return to the Browse task

Renvoie

bool

Références $url, null, FOFInflector\pluralize(), et view.

checkACL()

checkACL (   $area )

protected

Checks if the current user has enough privileges for the requested ACL area.

Paramètres

string

$area

The ACL area, e.g. core.manage.

Renvoie

boolean True if the user has the ACL privilege specified

Références $asset, $id, elseif, FOFPlatform\getInstance(), if, null, FOFInflector\singularize(), et view.

copy()

copy

(

)

Duplicates selected items

Renvoie

bool

Références $url, FOFPlatform\getInstance(), FOFInflector\pluralize(), et view.

createFileName()

static createFileName (   $type,   $parts = array()  )

staticprotected

Create the filename for a resource.

Paramètres

string	$type	The resource type to create the filename for.
array	$parts	An associative array of filename information. Optional.

Renvoie

string The filename.

Références $parts, et $type.

createModel()

createModel (   $name,   $prefix = '',   $config = array()  )

protected

Creates a new model object

Paramètres

string	$name	The name of the model class, e.g. Items
string	$prefix	The prefix of the model class, e.g. FoobarModel
array	$config	The configuration parameters for the model class

Renvoie

FOFModel The model object

Références $config, $name, $prefix, elseif, FOFModel\getAnInstance(), et null.

createView()

createView (   $name,   $prefix = '',   $type = '',   $config = array()  )

protected

Creates a View object instance and returns it

Paramètres

string	$name	The name of the view, e.g. Items
string	$prefix	The prefix of the view, e.g. FoobarView
string	$type	The type of the view, usually one of Html, Raw, Json or Csv
array	$config	The configuration variables to use for creating the view

Renvoie

FOFView

Some administrative templates force format=utf (yeah, I know, what the heck, right?) when a format URL parameter does not exist in the URL. Of course there is no such thing as FOFViewUtf (why the heck would it be, there is no such thing as a format=utf in Joomla! for crying out loud) which causes a Fatal Error. So we have to detect that and force $type='html'...

Références $component, $config, $input, $name, $path, $prefix, $style, $suffix, $type, $view, elseif, FOFPlatform\getInstance(), FOFInflector\isPlural(), null, FOFInflector\pluralize(), et FOFInflector\singularize().

display()

display	(		$cachable = false,
			$urlparams = false,
			$tpl = null
	)

Default task. Assigns a model to the view and asks the view to render itself.

YOU MUST NOT USETHIS TASK DIRECTLY IN A URL. It is supposed to be used ONLY inside your code. In the URL, use task=browse instead.

Paramètres

bool	$cachable	Is this view cacheable?
bool	$urlparams	Add your safe URL parameters (see further down in the code)
string	$tpl	The name of the template file to parse

Renvoie

bool

Références $app, $document, $doTask, $groups, $key, $option, $user, $value, $view, FOFPlatform\getInstance(), et null.

edit()

edit

(

)

Single record edit. The ID set in the request is passed to the model, then the form layout is used to edit the result.

Renvoie

bool

Références $form, $item, $url, FOFInflector\pluralize(), et view.

execute()

execute

(

$task

)

Executes a given controller task. The onBefore<task> and onAfter<task> methods are called automatically if they exist.

Paramètres

string

$task

The task to execute, e.g. "browse"

Exceptions

Exception

Exception thrown if the onBefore<task> returns false

Renvoie

null|bool False on execution failure

Références $doTask, $task, FOFInflector\camelize(), elseif, FOFPlatform\getInstance(), null, task, et view.

getAnInstance()

static& getAnInstance (   $option = null,   $view = null,   $config = array()  )

static

Gets a static (Singleton) instance of a controller class. It loads the relevant controller file from the component's directory or, if it doesn't exist, creates a new controller object out of thin air.

Paramètres

string	$option	Component name, e.g. com_foobar
string	$view	The view name, also used for the controller name
array	$config	Configuration parameters

Renvoie

FOFController

Références $config, $hash, $option, $view, et elseif.

getItemidURLSuffix()

getItemidURLSuffix

(

)

Gets a URL suffix with the Itemid parameter. If it's not the front-end of the site, or if there is no Itemid set it returns an empty string.

Renvoie

string The &Itemid=123 URL suffix, or an empty string if Itemid is not applicable

Références FOFPlatform\getInstance().

getModel()

getModel	(		$name = '',
			$prefix = '',
			$config = array()
	)

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

Paramètres

string	$name	The model name. Optional.
string	$prefix	The class prefix. Optional.
array	$config	Configuration array for model. Optional.

Renvoie

object The model.

Références $app, $config, $item, $menu, $name, $params, $prefix, elseif, FOFPlatform\getInstance(), et task.

getName()

getName

(

)

Method to get the controller name

The dispatcher name is set by default parsed using the classname, or it can be set by passing a $config['name'] in the class constructor

Exceptions

Exception

Renvoie

string The name of the dispatcher

Références $name, $r, name, et null.

getTask()

getTask

(

)

Get the last task that is being performed or was most recently performed.

Renvoie

string The task that is being performed or was most recently performed.

Références $task.

getTasks()

getTasks

(

)

Gets the available tasks in the controller.

Renvoie

array Array[i] of task names.

getThisModel()

getThisModel (   $config = array() )

final

Returns the default model associated with the current view

Paramètres

array

$config

Configuration variables for the model

Renvoie

FOFModel The global instance of the model (singleton)

Références $config, $input, $parts, $prefix, elseif, FOFInflector\explode(), FOFInflector\implode(), FOFInflector\pluralize(), et view.

getThisView()

getThisView (   $config = array() )

final

Returns current view object

Paramètres

array

$config

Configuration variables for the model

Renvoie

FOFView The global instance of the view object (singleton)

Références $config, $document, $input, $parts, $prefix, elseif, FOFInflector\explode(), FOFPlatform\getInstance(), FOFInflector\implode(), null, et view.

getTmpInstance()

static& getTmpInstance (   $option = null,   $view = null,   $config = array()  )

static

Gets a temporary instance of a controller object. A temporary instance is not a Singleton and can be disposed off after use.

Paramètres

string	$option	The component name, e.g. com_foobar
string	$view	The view name, e.g. cpanel
array	$config	Configuration parameters

Renvoie

A disposable class instance

Try to find the path to this file. First try to find the format-specific controller file, e.g. foobar.json.php for format=json, then the regular one-size-fits-all controller

Références $className, $config, $format, $input, $option, $path, $suffix, $view, elseif, FOFConfigProvider\get(), FOFPlatform\getInstance(), null, FOFInflector\pluralize(), et FOFInflector\singularize().

Référencé par FOFDispatcher\dispatch().

getView()

getView	(		$name = '',
			$type = '',
			$prefix = '',
			$config = array()
	)

Method to get a reference to the current view and load it if necessary.

Paramètres

string	$name	The view name. Optional, defaults to the controller name.
string	$type	The view type. Optional.
string	$prefix	The class prefix. Optional.
array	$config	Configuration array for view. Optional.

Exceptions

Exception

Renvoie

FOFView Reference to the view or an error.

Références $config, $name, $prefix, $type, $view, et elseif.

hasRedirect()

hasRedirect

(

)

Returns true if there is a redirect set in the controller

Renvoie

boolean

loadhistory()

loadhistory

(

)

Method to load a row from version history

Renvoie

boolean True if the content history is reverted, false otherwise

Depuis

2.2

Références $app, $key, $lang, $url, $view, null, FOFInflector\pluralize(), FOFInflector\singularize(), et view.

onAfterApplySave()

onAfterApplySave ( )

protected

Execute something after applySave has run.

Renvoie

boolean True to allow normal return, false to cause a 403 error

onBeforeAccesspublic()

onBeforeAccesspublic ( )

protected

ACL check before changing the access level; override to customise

Renvoie

boolean True to allow accesspublic() to run

Références FOFInflector\singularize(), et view.

onBeforeAccessregistered()

onBeforeAccessregistered ( )

protected

ACL check before changing the access level; override to customise

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

onBeforeAccessspecial()

onBeforeAccessspecial ( )

protected

ACL check before changing the access level; override to customise

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

onBeforeAdd()

onBeforeAdd ( )

protected

ACL check before adding a new record; override to customise

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

onBeforeApply()

onBeforeApply ( )

protected

ACL check before saving a new/modified record; override to customise

Renvoie

boolean True to allow the method to run

Références $id, FOFInflector\singularize(), et view.

onBeforeApplySave()

onBeforeApplySave ( &  $data )

protected

Execute something before applySave is called. Return false to prevent applySave from executing.

Paramètres

array

&$data

The data upon which applySave will act

Renvoie

boolean True to allow applySave to run

onBeforeBrowse()

onBeforeBrowse ( )

protected

ACL check before allowing someone to browse

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

onBeforeCancel()

onBeforeCancel ( )

protected

ACL check before cancelling an edit

Renvoie

boolean True to allow the method to run

Références $id, FOFInflector\singularize(), et view.

onBeforeEdit()

onBeforeEdit ( )

protected

ACL check before editing a record; override to customise

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

onBeforeGenericTask()

onBeforeGenericTask (   $task )

protected

A catch-all method for all tasks without a corresponding onBefore method. Applies the ACL preferences defined in fof.xml.

Paramètres

string

$task

The task being executed

Renvoie

boolean True to allow execution of the task

Références $task, FOFInflector\singularize(), et view.

onBeforeOrderdown()

onBeforeOrderdown ( )

protected

ACL check before changing the ordering of a record; override to customise

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

onBeforeOrderup()

onBeforeOrderup ( )

protected

ACL check before changing the ordering of a record; override to customise

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

onBeforePublish()

onBeforePublish ( )

protected

ACL check before changing the publish status of a record; override to customise

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

onBeforeRemove()

onBeforeRemove ( )

protected

ACL check before removing a record; override to customise

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

onBeforeSave()

onBeforeSave ( )

protected

ACL check before saving a new/modified record; override to customise

Renvoie

boolean True to allow the method to run

Références $id, FOFInflector\singularize(), et view.

onBeforeSavenew()

onBeforeSavenew ( )

protected

ACL check before saving a new/modified record; override to customise

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

onBeforeSaveorder()

onBeforeSaveorder ( )

protected

ACL check before changing the ordering of a record; override to customise

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

onBeforeUnpublish()

onBeforeUnpublish ( )

protected

ACL check before changing the publish status of a record; override to customise

Renvoie

boolean True to allow the method to run

Références FOFInflector\singularize(), et view.

orderdown()

orderdown

(

)

Moves selected items one position down the ordering list

Renvoie

bool

Références $url, FOFInflector\pluralize(), et view.

orderup()

orderup

(

)

Moves selected items one position up the ordering list

Renvoie

bool

Références $url, FOFInflector\pluralize(), et view.

publish()

publish

(

)

Publish (set enabled = 1) an item.

Renvoie

bool

read()

read

(

)

Single record read. The id set in the request is passed to the model and then the item layout is used to render the result.

Renvoie

bool

Références $form, et $item.

redirect()

redirect

(

)

Redirects the browser or returns false if no redirect is set.

Renvoie

boolean False if no redirect exists.

Références $app.

registerDefaultTask()

registerDefaultTask

(

$method

)

Register the default task to perform if a mapping is not found.

Paramètres

string

$method

The name of the method in the derived class to perform if a named task is not found.

Renvoie

FOFController A FOFController object to support chaining.

registerTask()

registerTask	(		$task,
			$method
	)

Register (map) a task to a method in the class.

Paramètres

string	$task	The task.
string	$method	The name of the method in the derived class to perform for this task.

Renvoie

FOFController A FOFController object to support chaining.

Références $task.

remove()

remove

(

)

Delete selected item(s)

Renvoie

bool

Références $url, FOFInflector\pluralize(), et view.

save()

save

(

)

Save the incoming data and then return to the Browse task

Renvoie

bool

Références $url, FOFInflector\pluralize(), et view.

savenew()

savenew

(

)

Save the incoming data and then return to the Add task

Renvoie

bool

Références $url, et view.

saveorder()

saveorder

(

)

Saves the order of the items

Renvoie

bool

Références $i, $item, $key, $n, $ordering, $url, FOFInflector\pluralize(), et view.

setaccess()

setaccess (   $level = 0 )

protected

Sets the access level of the selected item(s).

Paramètres

integer

$level

The desired viewing access level ID

Renvoie

bool

Références $id, $item, $key, $url, FOFInflector\pluralize(), et view.

setMessage()

setMessage	(		$text,
			$type = 'message'
	)

Sets the internal message that is passed with a redirect

Paramètres

string	$text	Message to display on redirect.
string	$type	Message type. Optional, defaults to 'message'.

Renvoie

string Previous message

Références $message, $text, et $type.

setPath()

setPath (   $type,   $path  )

protected

Sets an entire array of search paths for resources.

Paramètres

string	$type	The type of path to set, typically 'view' or 'model'.
string	$path	The new set of search paths. If null or false, resets to the current directory only.

Renvoie

void

Références $path, et $type.

setRedirect()

setRedirect	(		$url,
			$msg = null,
			$type = null
	)

Registers a redirection with an optional message. The redirection is carried out when you use the redirect method.

Paramètres

string	$url	The URL to redirect to
string	$msg	The message to be pushed to the application
string	$type	The message type to be pushed to the application, e.g. 'error'

Renvoie

FOFController This object to support chaining

Références $type, $url, elseif, FOFPlatform\getInstance(), et null.

setstate()

setstate (   $state = 0 )

protected

Sets the published state (the enabled field) of the selected item(s)

Paramètres

integer

$state

The desired state. 0 is unpublished, 1 is published.

Renvoie

bool

Références $state, $url, FOFInflector\pluralize(), et view.

setThisModelName()

setThisModelName

(

$modelName

)

Set the name of the model to be used by this Controller

Paramètres

string

$modelName

The name of the model

Renvoie

void

setThisViewName()

setThisViewName

(

$viewName

)

Set the name of the view to be used by this Controller

Paramètres

string

$viewName

The name of the view

Renvoie

void

trash()

trash

(

)

Trash (set enabled = -2) an item.

Renvoie

bool

unpublish()

unpublish

(

)

Unpublish (set enabled = 0) an item.

Renvoie

bool

unregisterTask()

unregisterTask

(

$task

)

Unregister (unmap) a task in the class.

Paramètres

string

$task

The task.

Renvoie

FOFController This object to support chaining.

Références $task.

Documentation des champs

$_modelObject

$_modelObject = null

private

$_viewObject

$_viewObject = null

private

$autoRouting

$autoRouting = 0

protected

$bareComponent

$bareComponent = 'foobar'

protected

$basePath

$basePath

protected

$cacheableTasks

$cacheableTasks = array('browse', 'read')

protected

$component

$component = 'com_foobar'

protected

$config

$config = array()

protected

$configProvider

$configProvider = null

protected

$csrfProtection

$csrfProtection = 2

protected

$default_view

$default_view

protected

$doTask

$doTask

protected

$hasForm

$hasForm = false

protected

$input

$input = array()

protected

$layout

$layout = null

protected

$message

$message

protected

$messageType

$messageType

protected

$methods

$methods

protected

$model_prefix

$model_prefix

protected

$modelName

$modelName = null

protected

$name

$name

protected

$paths

$paths

protected

$redirect

$redirect

protected

$task

$task

protected

$taskMap

$taskMap

protected

$view

$view = ''

protected

$viewName

$viewName = null

protected

$viewsCache

$viewsCache = array()

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• libraries/fof/controller/controller.php