| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2010 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 1666 lines (52 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| __construct($config = array() X-Ref |
| Constructor. param: array $config An array of configuration options (name, state, dbo, table_path, ignore_request). param: MVCFactoryInterface $factory The factory. param: FormFactoryInterface $formFactory The form factory. |
| batch($commands, $pks, $contexts) X-Ref |
| Method to perform batch operations on an item or a set of items. param: array $commands An array of commands to perform. param: array $pks An array of item ids. param: array $contexts An array of item contexts. return: boolean Returns true on success, false on failure. |
| batchAccess($value, $pks, $contexts) X-Ref |
| Batch access level changes for a group of rows. param: integer $value The new value matching an Asset Group ID. param: array $pks An array of row IDs. param: array $contexts An array of item contexts. return: boolean True if successful, false otherwise and internal error is set. |
| batchCopy($value, $pks, $contexts) X-Ref |
| Batch copy items to a new category or current. param: integer $value The new category. param: array $pks An array of row IDs. param: array $contexts An array of item contexts. return: array|boolean An array of new IDs on success, boolean false on failure. |
| cleanupPostBatchCopy(TableInterface $table, $newId, $oldId) X-Ref |
| Function that can be overridden to do any data cleanup after batch copying data param: TableInterface $table The table object containing the newly created item param: integer $newId The id of the new item param: integer $oldId The original item id return: void |
| batchLanguage($value, $pks, $contexts) X-Ref |
| Batch language changes for a group of rows. param: string $value The new value matching a language. param: array $pks An array of row IDs. param: array $contexts An array of item contexts. return: boolean True if successful, false otherwise and internal error is set. |
| batchMove($value, $pks, $contexts) X-Ref |
| Batch move items to a new category param: integer $value The new category ID. param: array $pks An array of row IDs. param: array $contexts An array of item contexts. return: boolean True if successful, false otherwise and internal error is set. |
| batchTag($value, $pks, $contexts) X-Ref |
| Batch tag a list of item. param: integer $value The value of the new tag. param: array $pks An array of row IDs. param: array $contexts An array of item contexts. return: boolean True if successful, false otherwise and internal error is set. |
| canDelete($record) X-Ref |
| Method to test whether a record can be deleted. param: object $record A record object. return: boolean True if allowed to delete the record. Defaults to the permission for the component. |
| canEditState($record) X-Ref |
| Method to test whether a record can have its state changed. param: object $record A record object. return: boolean True if allowed to change the state of the record. Defaults to the permission for the component. |
| checkin($pks = array() X-Ref |
| Method override to check-in a record or an array of record param: mixed $pks The ID of the primary key or an array of IDs return: integer|boolean Boolean false if there is an error, otherwise the count of records checked in. |
| checkout($pk = null) X-Ref |
| Method override to check-out a record. param: integer $pk The ID of the primary key. return: boolean True if successful, false if an error occurs. |
| delete(&$pks) X-Ref |
| Method to delete one or more records. param: array &$pks An array of record primary keys. return: boolean True if successful, false if an error occurs. |
| generateNewTitle($categoryId, $alias, $title) X-Ref |
| Method to change the title & alias. param: integer $categoryId The id of the category. param: string $alias The alias. param: string $title The title. return: array Contains the modified title and alias. |
| getItem($pk = null) X-Ref |
| Method to get a single record. param: integer $pk The id of the primary key. return: CMSObject|boolean Object on success, false on failure. |
| getReorderConditions($table) X-Ref |
| A protected method to get a set of ordering conditions. param: Table $table A Table object. return: array An array of conditions to add to ordering queries. |
| populateState() X-Ref |
| Stock method to auto-populate the model state. return: void |
| prepareTable($table) X-Ref |
| Prepare and sanitise the table data prior to saving. param: Table $table A reference to a Table object. return: void |
| publish(&$pks, $value = 1) X-Ref |
| Method to change the published state of one or more records. param: array &$pks A list of the primary keys to change. param: integer $value The value of the published state. return: boolean True on success. |
| reorder($pks, $delta = 0) X-Ref |
| 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. param: integer $pks The ID of the primary key to move. param: integer $delta Increment, usually +1 or -1 return: boolean|null False on failure or error, true on success, null if the $pk is empty (no items selected). |
| save($data) X-Ref |
| Method to save the form data. param: array $data The form data. return: boolean True on success, False on error. |
| saveorder($pks = array() X-Ref |
| Saves the manually set order of records. param: array $pks An array of primary key ids. param: integer $order +1 or -1 return: boolean Boolean true on success, false on failure |
| checkCategoryId($categoryId) X-Ref |
| Method to check the validity of the category ID for batch copy and move param: integer $categoryId The category ID to check return: boolean |
| generateTitle($categoryId, $table) X-Ref |
| A method to preprocess generating a new title in order to allow tables with alternative names for alias and title to use the batch move and copy methods param: integer $categoryId The target category id param: Table $table The Table within which move or copy is taking place return: void |
| initBatch() X-Ref |
| Method to initialize member variables used by batch methods and other methods like saveorder() return: void |
| editAssociations($data) X-Ref |
| Method to load an item in com_associations. param: array $data The form data. return: boolean True if successful, false otherwise. |
| redirectToAssociations($data) X-Ref |
| Method to load an item in com_associations. param: array $data The form data. return: boolean True if successful, false otherwise. |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |