Class JControllerForm
Controller tailored to suit most form-based admin operations.
-
JObject
-
JControllerLegacy
-
JControllerForm
Methods summary
public
|
#
__construct( array $config = array() )
Constructor.
Parameters
- $config
array - $config An optional associative array of configuration settings. Throws
Since
1.6
See
Overrides
|
public
boolean
|
#
add( )
Method to add a new record.
Method to add a new record.
Returns
boolean - True if the record can be added, false if not.
Since
1.6
|
protected
boolean
|
#
allowAdd( array $data = array() )
Method to check if you can add a new record.
Method to check if you can add a new record.
Extended classes can override this if necessary.
Parameters
- $data
array - $data An array of input data. Returns
boolean
Since
1.6
|
protected
boolean
|
#
allowEdit( array $data = array(), string $key = 'id' )
Method to check if you can edit an existing record.
Method to check if you can edit an existing record.
Extended classes can override this if necessary.
Parameters
- $data
array - $data An array of input data.- $key
string - $key The name of the key for the primary key; default is id. Returns
boolean
Since
1.6
|
protected
boolean
|
#
allowSave( array $data, string $key = 'id' )
Method to check if you can save a new or existing record.
Method to check if you can save a new or existing record.
Extended classes can override this if necessary.
Parameters
- $data
array - $data An array of input data.- $key
string - $key The name of the key for the primary key. Returns
boolean
Since
1.6
|
public
boolean
|
#
batch( JModelLegacy $model )
Method to run batch operations.
Method to run batch operations.
Parameters
- $model
JModelLegacy Returns
boolean - True if successful, false otherwise and internal error is set.
Since
1.7
|
public
boolean
|
#
cancel( string $key = null )
Method to cancel an edit.
Method to cancel an edit.
Parameters
- $key
string - $key The name of the primary key of the URL variable. Returns
boolean - True if access level checks pass, false otherwise.
Since
1.6
|
public
boolean
|
#
edit( string $key = null, string $urlVar = null )
Method to edit an existing record.
Method to edit an existing record.
Parameters
- $key
string - $key The name of the primary key of the URL variable.- $urlVar
string - $urlVar The name of the URL variable if different from the primary key
(sometimes required to avoid router collisions). Returns
boolean - True if access level check and checkout passes, false otherwise.
Since
1.6
|
public
JModelLegacy
|
#
getModel( string $name = '', string $prefix = '', array $config = array('ignore_request' => true) )
Method to get a model object, loading it if required.
Method to get a model object, loading it if required.
Parameters
- $name
string - $name The model name. Optional.- $prefix
string - $prefix The class prefix. Optional.- $config
array - $config Configuration array for model. Optional. Returns
Since
1.6
Overrides
|
protected
string
|
#
getRedirectToItemAppend( integer $recordId = null, string $urlVar = 'id' )
Gets the URL arguments to append to an item redirect.
Gets the URL arguments to append to an item redirect.
Parameters
- $recordId
integer - $recordId The primary key id for the item.- $urlVar
string - $urlVar The name of the URL variable for the id. Returns
string - The arguments to append to the redirect URL.
Since
1.6
|
protected
string
|
#
getRedirectToListAppend( )
Gets the URL arguments to append to a list redirect.
Gets the URL arguments to append to a list redirect.
Returns
string - The arguments to append to the redirect URL.
Since
1.6
|
protected
|
#
postSaveHook( JModelLegacy $model, array $validData = array() )
Function that allows child controller access to model data after the data has
been saved.
Function that allows child controller access to model data after the data has
been saved.
Parameters
- $model
JModelLegacy- $validData
array - $validData The validated data. Since
1.6
|
public
mixed
|
#
loadhistory( )
Method to load a row from version history
Method to load a row from version history
Returns
mixed - True if the record can be added, an error object if not.
Since
3.2
|
public
boolean
|
#
save( string $key = null, string $urlVar = null )
Method to save a record.
Parameters
- $key
string - $key The name of the primary key of the URL variable.- $urlVar
string - $urlVar The name of the URL variable if different from the primary key
(sometimes required to avoid router collisions). Returns
boolean - True if successful, false otherwise.
Since
1.6
|
addModelPath(),
addPath(),
addViewPath(),
authorise(),
checkEditId(),
checkToken(),
createFileName(),
createModel(),
createView(),
display(),
execute(),
getInstance(),
getName(),
getTask(),
getTasks(),
getView(),
holdEditId(),
redirect(),
registerDefaultTask(),
registerTask(),
releaseEditId(),
setMessage(),
setPath(),
setRedirect(),
unregisterTask()
Methods inherited from JObject
__toString(),
def(),
get(),
getError(),
getErrors(),
getProperties(),
set(),
setError(),
setProperties()
Magic methods summary
Properties summary
protected
string
|
$context
|
#
The context for storing internal data, e.g. record.
The context for storing internal data, e.g. record.
Since
1.6
|
protected
string
|
$option
|
#
The URL option for the component.
The URL option for the component.
Since
1.6
|
protected
string
|
$view_item
|
#
The URL view item variable.
The URL view item variable.
Since
1.6
|
protected
string
|
$view_list
|
#
The URL view list variable.
The URL view list variable.
Since
1.6
|
protected
string
|
$text_prefix
|
#
The prefix to use with controller messages.
The prefix to use with controller messages.
Since
1.6
|
$basePath,
$default_view,
$doTask,
$input,
$instance,
$message,
$messageType,
$methods,
$model_prefix,
$name,
$paths,
$redirect,
$task,
$taskMap,
$views
Properties inherited from JObject
$_errors
