| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | (C) 2011 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 466 lines (15 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
IndexModel:: (12 methods):
__construct()
canDelete()
canEditState()
delete()
getListQuery()
getPluginState()
getStoreId()
getTotalIndexed()
getTable()
purge()
populateState()
publish()
Class: IndexModel - X-Ref
Index model class for Finder.| __construct($config = array() X-Ref |
| Constructor. param: array $config An optional associative array of configuration settings. param: MVCFactoryInterface $factory The factory. |
| 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. |
| 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. |
| getListQuery() X-Ref |
| Build an SQL query to load the list data. return: \Joomla\Database\DatabaseQuery |
| getPluginState() X-Ref |
| Method to get the state of the Smart Search Plugins. return: array Array of relevant plugins and whether they are enabled or not. |
| getStoreId($id = '') X-Ref |
| Method to get a store id based on model configuration state. This is necessary because the model is used by the component and different modules that might need different sets of data or different ordering requirements. param: string $id A prefix for the store id. [optional] return: string A store id. |
| getTotalIndexed() X-Ref |
| Gets the total of indexed items. return: integer The total of indexed items. |
| getTable($type = 'Link', $prefix = 'Administrator', $config = array() X-Ref |
| Returns a Table object, always creating it. param: string $type The table type to instantiate. [optional] param: string $prefix A prefix for the table class name. [optional] param: array $config Configuration array for model. [optional] return: \Joomla\CMS\Table\Table A database object |
| purge() X-Ref |
| Method to purge the index, deleting all links. return: boolean True on success, false on failure. |
| populateState($ordering = 'l.title', $direction = 'asc') X-Ref |
| Method to auto-populate the model state. Calling getState in this method will result in recursion. param: string $ordering An optional ordering field. [optional] param: string $direction An optional direction. [optional] 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. [optional] return: boolean True on success. |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |