class JModelAdmin extends JModelForm


Located at : UKNOWVA_ROOT/libraries/joomla/application/component/modeladmin.php

Prototype admin model.

Methods

__construct(array $config = array())

Constructor.

string
__toString()

Magic method to convert the object to a string gracefully.

from JObject
mixed
def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

from JObject
mixed
get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

from JObject
array
getProperties(boolean $public = true)

Returns an associative array of object properties.

from JObject
string
getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

from JObject
array
getErrors()

Return all errors, if any.

from JObject
mixed
set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

from JObject
boolean
setProperties(mixed $properties)

Set the object properties based on a named array/hash.

from JObject
void
setError(string $error)

Add an error message.

from JObject
string
toString() deprecated

No description

from JObject
static array
addIncludePath(mixed $path = '', string $prefix = '')

Add a directory where JModel should search for models. You may either pass a string or an array of directories.

from JModel
static void
addTablePath(mixed $path)

Adds to the stack of model table paths in LIFO order.

from JModel
static mixed
getInstance(string $type, string $prefix = '', array $config = array())

Returns a Model object, always creating it

from JModel
getDbo()

Method to get the database connector object

from JModel
string
getName()

Method to get the model name

from JModel
object
getState(string $property = null, mixed $default = null)

Method to get model state variables

from JModel
getTable(string $name = '', string $prefix = 'Table', array $options = array())

Method to get a table object, load it if necessary.

from JModel
void
setDbo(object $db)

Method to set the database connector object

from JModel
mixed
setState(string $property, mixed $value = null)

Method to set model state variables

from JModel
boolean
checkin(mixed $pks = array())

Method override to check-in a record or an array of record

boolean
checkout(integer $pk = null)

Method override to check-out a record.

mixed
getForm(array $data = array(), boolean $loadData = true)

Abstract method for getting the form from the model.

mixed
validate(object $form, array $data, string $group = null)

Method to validate the form data.

boolean
batch(array $commands, array $pks)

Method to perform batch operations on an item or a set of items.

boolean
delete(array $pks)

Method to delete one or more records.

mixed
getItem(integer $pk = null)

Method to get a single record.

boolean
publish(array $pks, integer $value = 1)

Method to change the published state of one or more records.

mixed
reorder(integer $pks, integer $delta)

Method to adjust the ordering of a row.

boolean
save(array $data, bool $returnObject = false)

Method to save the form data.

mixed
saveorder(array $pks = null, integer $order = null)

Saves the manually set order of records.

Details

at line 81
JObject __construct(array $config = array())

Constructor.

Parameters

array $config An array of configuration options (name, state, dbo, tablepath, ignorerequest).

Return Value

JObject

See also

JController

in JObject at line 56
string __toString()

Magic method to convert the object to a string gracefully.

Return Value

string The classname.

in JObject at line 70
mixed def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed

in JObject at line 88
mixed get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed The value of the property.

See also

getProperties()

in JObject at line 107
array getProperties(boolean $public = true)

Returns an associative array of object properties.

Parameters

boolean $public If true, returns only the public properties.

Return Value

array

See also

get()

in JObject at line 133
string getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

Parameters

integer $i Option error index.
boolean $toString Indicates if JError objects should return their error message.

Return Value

string Error message

in JObject at line 165
array getErrors()

Return all errors, if any.

Return Value

array Array of error messages or JErrors.

in JObject at line 180
mixed set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

Parameters

string $property The name of the property.
mixed $value The value of the property to set.

Return Value

mixed Previous value of the property.

in JObject at line 198
boolean setProperties(mixed $properties)

Set the object properties based on a named array/hash.

Parameters

mixed $properties Either an associative array or another object.

Return Value

boolean

See also

set()

in JObject at line 222
void setError(string $error)

Add an error message.

Parameters

string $error Error message.

Return Value

void

in JObject at line 235
string toString() deprecated

deprecated 12.1 Use magic method __toString()

Return Value

string

See also

__toString()

in JModel at line 84
static array addIncludePath(mixed $path = '', string $prefix = '')

Add a directory where JModel should search for models. You may either pass a string or an array of directories.

Parameters

mixed $path A path or array[sting] of paths to search.
string $prefix A prefix for models.

Return Value

array An array with directory elements. If prefix is equal to '', all directories are returned.

in JModel at line 123
static void addTablePath(mixed $path)

Adds to the stack of model table paths in LIFO order.

Parameters

mixed $path The directory as a string or directories as an array to add.

Return Value

void

in JModel at line 161
static mixed getInstance(string $type, string $prefix = '', array $config = array())

Returns a Model object, always creating it

Parameters

string $type The model type to instantiate
string $prefix Prefix for the model class name. Optional.
array $config Configuration array for model. Optional.

Return Value

mixed A model object or false on failure

in JModel at line 327
JDatabase getDbo()

Method to get the database connector object

Return Value

JDatabase JDatabase connector object

in JModel at line 341
string getName()

Method to get the model name

The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor

Return Value

string The name of the model

in JModel at line 365
object getState(string $property = null, mixed $default = null)

Method to get model state variables

Parameters

string $property Optional parameter name
mixed $default Optional default value

Return Value

object The property where specified, the state object where omitted

in JModel at line 388
JTable getTable(string $name = '', string $prefix = 'Table', array $options = array())

Method to get a table object, load it if necessary.

Parameters

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

Return Value

JTable A JTable object

in JModel at line 427
void setDbo(object $db)

Method to set the database connector object

Parameters

object $db &$db A JDatabase based object

Return Value

void

in JModel at line 441
mixed setState(string $property, mixed $value = null)

Method to set model state variables

Parameters

string $property The name of the property.
mixed $value The value of the property to set or null.

Return Value

mixed The previous value of the property or null if not set.

at line 520
boolean checkin(mixed $pks = array())

Method override to check-in a record or an array of record

Parameters

mixed $pks The ID of the primary key or an array of IDs

Return Value

boolean False on failure or error, true otherwise.

at line 562
boolean checkout(integer $pk = null)

Method override to check-out a record.

Parameters

integer $pk The numeric id of the primary key.

Return Value

boolean False on failure or error, true otherwise.

in JModelForm at line 119
abstract mixed getForm(array $data = array(), boolean $loadData = true)

Abstract method for getting the form from the model.

Parameters

array $data Data for the form.
boolean $loadData True if the form is to load its own data (default case), false if not.

Return Value

mixed A JForm object on success, false on failure

in JModelForm at line 240
mixed validate(object $form, array $data, string $group = null)

Method to validate the form data.

Parameters

object $form The form to validate against.
array $data The data to validate.
string $group The name of the field group to validate.

Return Value

mixed Array of filtered data if valid, false otherwise.

See also

JFormRule
JFilterInput

at line 132
boolean batch(array $commands, array $pks)

Method to perform batch operations on an item or a set of items.

Parameters

array $commands An array of commands to perform.
array $pks An array of item ids.

Return Value

boolean Returns true on success, false on failure.

at line 578
boolean delete(array $pks)

Method to delete one or more records.

Parameters

array $pks An array of record primary keys.

Return Value

boolean True if successful, false if an error occurs.

at line 679
mixed getItem(integer $pk = null)

Method to get a single record.

Parameters

integer $pk The id of the primary key.

Return Value

mixed Object on success, false on failure.

at line 766
boolean publish(array $pks, integer $value = 1)

Method to change the published state of one or more records.

Parameters

array $pks A list of the primary keys to change.
integer $value The value of the published state.

Return Value

boolean True on success.

at line 825
mixed reorder(integer $pks, integer $delta)

Method to adjust the ordering of a row.

Returns NULL if the user did not have edit privileges for any of the selected primary keys.

Parameters

integer $pks The ID of the primary key to move.
integer $delta Increment, usually +1 or -1

Return Value

mixed False on failure or error, true on success, null if the $pk is empty (no items selected).

at line 887
boolean save(array $data, bool $returnObject = false)

Method to save the form data.

Parameters

array $data The form data.
bool $returnObject If set to true, then the table object shall be returned, this was added in 2.5.1 onwards

Return Value

boolean True on success, False on error.

at line 969
mixed saveorder(array $pks = null, integer $order = null)

Saves the manually set order of records.

Parameters

array $pks An array of primary key ids.
integer $order +1 or -1

Return Value

mixed