| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2014 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 141 lines (4 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Interface: TableInterface - X-Ref
Table class interface.| bind($src, $ignore = array() X-Ref |
| Method to bind an associative array or object to the TableInterface instance. This method only binds properties that are publicly accessible and optionally takes an array of properties to ignore when binding. param: mixed $src An associative array or object to bind to the TableInterface instance. param: mixed $ignore An optional array or space separated list of properties to ignore while binding. return: boolean True on success. |
| check() X-Ref |
| Method to perform sanity checks on the TableInterface instance properties to ensure they are safe to store in the database. Implementations of this interface should use this method to make sure the data they are storing in the database is safe and as expected before storage. return: boolean True if the instance is sane and able to be stored in the database. |
| delete($pk = null) X-Ref |
| Method to delete a record. param: mixed $pk An optional primary key value to delete. If not set the instance property value is used. return: boolean True on success. |
| getDbo() X-Ref |
| Method to get the DatabaseDriver object. return: DatabaseDriver The internal database driver object. |
| getKeyName() X-Ref |
| Method to get the primary key field name for the table. return: string The name of the primary key for the table. |
| load($keys = null, $reset = true) X-Ref |
| Method to load a row from the database by primary key and bind the fields to the TableInterface instance properties. param: mixed $keys An optional primary key value to load the row by, or an array of fields to match. If not param: boolean $reset True to reset the default values before loading the new row. return: boolean True if successful. False if row not found. |
| reset() X-Ref |
| Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties. return: void |
| store($updateNulls = false) X-Ref |
| Method to store a row in the database from the TableInterface instance properties. If a primary key value is set the row with that primary key value will be updated with the instance property values. If no primary key value is set a new row will be inserted into the database with the properties from the TableInterface instance. param: boolean $updateNulls True to update fields even if they are null. return: boolean True on success. |
| getId() X-Ref |
| Returns the identity (primary key) value of this record return: mixed |
| hasField($key) X-Ref |
| Check if the record has a property (applying a column alias if it exists) param: string $key key to be checked return: boolean |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |