Class constructor. Builds a new JTable object. Sets the table and key field. Redefinition of JObject::__construct(); class constructor; redefined in descendant classes:

JTable __construct(string $table, string $key, JDatabase &$db)

This method adds paths to search for JTable subclasses. $path can be a string or an array of strings.

array addIncludePath([$path = null])

This method binds a subject (normally a record) to the object. For all public properties this method finds a corresponding key or property in $from and binds it to the object. This method can be overloaded or supplemented by the subclass. Redefined in descendants:

boolean bind($from, [$ignore])

This method determines if there are any records linked to the buffered record or, if $oid is specified, the record identified by $oid. $joins identifies linked tables. $joins is an optional two-dimensional array; the inner arrays are associative, and must contain the keys name, idfield, and joinfield. name is the linked table name, idfield is the linked table's primary key, and joinfield is the foreign key in the linked table.

boolean canDelete([$oid = null], [$joins = null])

This method is used to validate the contents of the record buffer. This should be overridden in subclasses. Redefined in descendants:

boolean check()

This method checks in the buffered record or, if $oid is specified, checks in the record identified by $oid. This sets the record's checked_out field to zero and checked_out_time to a null date-time.

boolean checkin([$oid = null])

This method checks out the buffered record or, if #oid is specified, checks out the record identified by $oid. This sets the record's checked_out field to $who and checked_out_time to the current date-time.

boolean checkout($who, [$oid = null])

This method deletes the buffered record or, if $oid is specified, deletes the record identified by $oid. Redefined in descendants:

boolean delete( [$oid = null])

This method returns a reference to the JDatabase connection object.

JDatabase &getDBO()

This method returns a reference to a new JTable subclass object. $type is the name of the file the class resides in and the class name suffix, normally the entity name. $prefix is the class name prefix. Core JTable subclasses use the prefix 'JTable'; third-party JTable classes tend to use the prefix 'Table'.

JTable &getInstance($type, [$prefix = 'JTable'], [$config = array()])

This method returns the name of the primary key field.

string getKeyName()

This method returns the next place available in the current ordering. Using reorder() before using this method will ensure there are no gaps in the ordering.

integer getNextOrder([$where = ''])

This method returns the name of the table.

string getTableName()

This method increases the hit counter of the buffered record or, if $oid is specified, the record identified by $oid.

void hit([$oid = null], [$log = false])

This static method determines if the buffered record is checked out by any user other than the current user. If used statically (both $with and $against must be specified) compares $with to $against.

boolean isCheckedOut($with, [$against = null])

This method resets the record buffer and loads a single record into the buffer. $oid is the value of the record's primary key.

boolean load([$oid = null])

This method moves a record up or down the ordering (the table must have an ordering field). -1 = move up, 1 = move down.

void move($dirn, [$where = ''])

This method sets the publish value of records identified by $cid, an array of record IDs (this only works when the table's primary key is numeric). Although $cid is optional, if it is not specified the method will fail. If the table has a checked_out field, any records that are checked out by other users will not be affected.

boolean publish([$cid = null], [$publish = 1] , [$user_id = 0])

This method removes gaps in ordering.

void reorder([$where = ''])

This method resets the object to the initial class option values.

void reset()

This method binds $source to the object; $source must be an object or an associative array. The method checks the buffer, stores the buffer, checks-in the record, and if $order_filter is specified, uses it to determine which field must be common during the execution of the reorder() method.

boolean save($source, [$order_filter = ''] , [$ignore = = ''])

This method sets the JDatabase connection object.

void setDBO(&$db)

This method saves the record buffer to the database. If the record buffer primary key property is set an UPDATE will be executed, otherwise an INSERT will be executed. Redefined in descendants:

boolean store([$updateNulls = false])

This method returns an XML representation of the buffered record. Redefined in descendants:

string toXML([$mapKeysToText = false])