Method to perform batch operations on an item or a set of items.
boolean
batch
(array $commands, array $pks, array $contexts)
-
array
$commands: An array of commands to perform.
-
array
$pks: An array of item ids.
-
array
$contexts: An array of item contexts.
Redefinition of:
- JModelAdmin::batch()
- Method to perform batch operations on an item or a set of items.
Batch copy menu items to a new menu or parent.
mixed
batchCopy
(integer $value, array $pks, array $contexts)
-
integer
$value: The new menu or sub-item.
-
array
$pks: An array of row IDs.
-
array
$contexts: An array of item contexts.
Redefinition of:
- JModelAdmin::batchCopy()
- Batch copy items to a new category or current.
Batch move menu items to a new menu or parent.
boolean
batchMove
(integer $value, array $pks, array $contexts)
-
integer
$value: The new menu or sub-item.
-
array
$pks: An array of row IDs.
-
array
$contexts: An array of item contexts.
Redefinition of:
- JModelAdmin::batchMove()
- Batch move items to a new category
Method to test whether a record can be deleted.
boolean
canDelete
(object A $record)
-
object A
$record: record object.
Redefinition of:
- JModelAdmin::canDelete()
- Method to test whether a record can be deleted.
Method to test whether a record can have its state edited.
boolean
canEditState
(object A $record)
-
object A
$record: record object.
Redefinition of:
- JModelAdmin::canEditState()
- Method to test whether a record can be deleted.
Method to check if you can save a record.
boolean
canSave
([array $data = array()], [string $key = 'id'])
-
array
$data: An array of input data.
-
string
$key: The name of the key for the primary key.
Custom clean cache method
void
cleanCache
([ $group = null], [ $client_id = 0])
Redefinition of:
- JModel::cleanCache()
- Clean the cache
Method to change the title & alias.
array
generateNewTitle
(integer $parent_id, string $alias, string $title)
-
integer
$parent_id: The id of the parent.
-
string
$alias: The alias.
-
string
$title: The title.
Redefinition of:
- JModelAdmin::generateNewTitle()
- Method to change the title & alias.
Method to get the row form.
mixed
getForm
([array $data = array()], [boolean $loadData = true])
-
array
$data: Data for the form.
-
boolean
$loadData: True if the form is to load its own data (default case), false if not.
Redefinition of:
- JModelForm::getForm()
- Abstract method for getting the form from the model.
Get the necessary data to load an item help screen.
object An
getHelp
()
Method to get a menu item.
mixed
getItem
([integer $pk = null])
-
integer
$pk: An optional id of the object to get, otherwise the id from the model state is used.
Redefinition of:
- JModelAdmin::getItem()
- Method to get a single record.
Get the list of modules not in trash.
mixed
getModules
()
A protected method to get the where clause for the reorder This ensures that the row will be moved relative to a row with the same menutype
Redefinition of:
- JModelAdmin::getReorderConditions()
- A protected method to get a set of ordering conditions.
Returns a Table object, always creating it
JTable
getTable
([
type $type =
'Menu'], [
string $prefix =
'MenusTable'], [
array $config =
array()])
-
type
$type: The table type to instantiate
-
string
$prefix: A prefix for the table class name. Optional.
-
array
$config: Configuration array for model. Optional.
Redefinition of:
- JModel::getTable()
- Method to get a table object, load it if necessary.
Method to get the data that should be injected in the form.
mixed
loadFormData
()
Redefinition of:
- JModelForm::loadFormData()
- Method to get the data that should be injected in the form.
Auto-populate the model state.
Note. Calling getState in this method will result in recursion.
void
populateState
()
Redefinition of:
- JModelAdmin::populateState()
- Stock method to auto-populate the model state.
void
preprocessForm
(JForm $form, mixed $data, [ $group = 'content'])
-
object
$form: A form object.
-
mixed
$data: The data expected for the form.
-
$group
Redefinition of:
- JModelForm::preprocessForm()
- Method to allow derived classes to preprocess the form.
Method to change the published state of one or more records.
boolean
publish
( &$pks, [int $value = 1], array $pks)
-
array
$pks: A list of the primary keys to change.
-
int
$value: The value of the published state.
-
&$pks
Redefinition of:
- JModelAdmin::publish()
- Method to change the published state of one or more records.
Method rebuild the entire nested set tree.
boolean
rebuild
()
Method to save the form data.
boolean
save
(array $data)
-
array
$data: The form data.
Redefinition of:
- JModelAdmin::save()
- Method to save the form data.
Method to save the reordered nested set tree.
First we save the new order values in the lft values of the changed ids. Then we invoke the table rebuild to implement the new ordering.
boolean
saveorder
([array $idArray = null], [array $lft_array = null])
-
array
$idArray: id's of rows to be reordered
-
array
$lft_array: lft values of rows to be reordered
Redefinition of:
- JModelAdmin::saveorder()
- Saves the manually set order of records.
Method to change the home state of one or more items.
boolean
setHome
( &$pks, [int $value = 1], array $pks)
-
array
$pks: A list of the primary keys to change.
-
int
$value: The value of the home state.
-
&$pks
Inherited Methods
Inherited From JModelAdmin
JModelAdmin::__construct()
JModelAdmin::batch()
JModelAdmin::batchAccess()
JModelAdmin::batchCopy()
JModelAdmin::batchLanguage()
JModelAdmin::batchMove()
JModelAdmin::canDelete()
JModelAdmin::canEditState()
JModelAdmin::checkin()
JModelAdmin::checkout()
JModelAdmin::delete()
JModelAdmin::generateNewTitle()
JModelAdmin::getItem()
JModelAdmin::getReorderConditions()
JModelAdmin::populateState()
JModelAdmin::prepareTable()
JModelAdmin::publish()
JModelAdmin::reorder()
JModelAdmin::save()
JModelAdmin::saveorder()
Inherited From JModelForm
JModelForm::checkin()
JModelForm::checkout()
JModelForm::getForm()
JModelForm::loadForm()
JModelForm::loadFormData()
JModelForm::preprocessForm()
JModelForm::validate()
Inherited From JModel
JModel::__construct()
JModel::addIncludePath()
JModel::addTablePath()
JModel::cleanCache()
JModel::getDbo()
JModel::getInstance()
JModel::getName()
JModel::getState()
JModel::getTable()
JModel::populateState()
JModel::setDbo()
JModel::setState()
JModel::_createFileName()
JModel::_createTable()
JModel::_getList()
JModel::_getListCount()
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()