Abstract Class mosDBTable

Description
Description | Descendents | Vars (details) | Methods (details)

mosDBTable Abstract Class.

  • author: Andrew Eddie <eddieajau@users.sourceforge.net
  • abstract:

Located in /includes/database.php (line 756) 

mosDBAbstractRow
   |
   --mosDBTable
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
class moscomment ensure this file is being included by a parent file
class mosConfig ensure this file is being included by a parent file
class mosCE_Config mosDBTable Abstract Class.
class mosNewsFeed ensure this file is being included by a parent file
class mosPoll
class mosTemplatePosition ensure this file is being included by a parent file
class mosBannerClient ensure this file is being included by a parent file
class mosBanner
class mosContact mosDBTable Abstract Class.
class mosCategory Category database table class
class mosSection Section database table class
class mosContent Module database table class
class mosFrontPage mosDBTable Abstract Class.
class mosMessage ensure this file is being included by a parent file
class mosWeblink Category database table class
class mosComponent Components database table class
class mosTemplate Template database table class
class mosMambot Mambot database table class
class mosModule Modules database table class
class mosMenu Module database table class
class mosUser Users Table Class
class mosSession Session database table class
class mosARO mosDBTable Abstract Class.
class mosAroGroup Utility function for returning groups
Variable Summary
Description | Descendants | Vars (details) | Methods (details)
mosDatabase $_db
Method Summary
Description | Descendants | Vars (details) | Methods (details)
null|string bind ( $array, [ $ignore = ""], array $hash)
void checkin ([ $oid = null])
void checkout ( $who, [ $oid = null])
true delete ([ $oid = null])
void filter ([array $ignoreList = null])
mixed get (string $_property)
string getError ()
array getPublicProperties ()
void hit ([ $oid = null])
any load ([int $oid = null])
void publish_array ([array $cid = null], [integer $publish = 1], [integer $myid = 0])
bool queryTestFailure ()
TRUE save (array $source, string $order_filter)
void set (string $_property, mixed $_value)
null|string store ([boolean $updateNulls = false])
void toXML ([boolean $mapKeysToText = false])
Variables
Description | Descendents | Vars (details) | Methods (details)
mosDatabase $_db = null (line 758)
  • var: Database connector

Inherited Variables

Inherited from mosDBAbstractRow

mosDBAbstractRow::$_error
 mosDBAbstractRow::$_tbl
 mosDBAbstractRow::$_tbl_key
Methods
Description | Descendents | Vars (details) Methods (details)
bind (line 829)

binds a named array/hash to this object

can be overloaded/supplemented by the child class

  • return: null is operation was satisfactory, otherwise returns an error
null|string bind ( $array, [ $ignore = ""], array $hash)
  • array $hash: named array
  • $array
  • $ignore
checkin (line 904)
void checkin ([ $oid = null])
  • $oid
checkout (line 883)
void checkout ( $who, [ $oid = null])
  • $who
  • $oid
delete (line 875)

Default delete method

can be overloaded/supplemented by the child class

  • return: if successful otherwise returns and error message
true delete ([ $oid = null])
  • $oid
Redefined in descendants as:
filter (line 773)

Filters public properties

  • access: protected
void filter ([array $ignoreList = null])
  • array $ignoreList: List of fields to ignore
get (line 794)

Gets the value of the class variable

  • return: The value of the class var (or null if no var of that name exists)
mixed get (string $_property)
  • string $_property: The name of the class variable
getError (line 786)
  • return: Returns the error message
string getError ()
getPublicProperties (line 802)

Returns an array of public properties

array getPublicProperties ()
hit (line 916)
void hit ([ $oid = null])
  • $oid
load (line 841)

binds an array/hash to this object

  • return: result from the database operation
any load ([int $oid = null])
  • int $oid: optional argument, if not specifed then the value of current key is used
Redefined in descendants as:
publish_array (line 960)

Generic Publish/Unpublish function

void publish_array ([array $cid = null], [integer $publish = 1], [integer $myid = 0])
  • array $cid: An array of id numbers
  • integer $publish: 0 if unpublishing, 1 if publishing
  • integer $myid: The id of the user performnig the operation
queryTestFailure (line 763)
  • return: True if DB query failed. Sets the error message
bool queryTestFailure ()
save (line 946)

Generic save function

  • return: if completely successful, FALSE if partially or not succesful.
TRUE save (array $source, string $order_filter)
  • array $source: Source array for binding to class vars
  • string $order_filter: Filter for the order updating
set (line 819)

Set the value of the class variable

void set (string $_property, mixed $_value)
  • string $_property: The name of the class variable
  • mixed $_value: The value to assign to the variable
store (line 858)

Inserts a new row if id is zero or updates an existing row in the database table

Can be overloaded/supplemented by the child class

  • return: null if successful otherwise returns and error message
null|string store ([boolean $updateNulls = false])
  • boolean $updateNulls: If false, null object variables are not updated
Redefined in descendants as:
toXML (line 978)

Export item list to xml

void toXML ([boolean $mapKeysToText = false])
  • boolean $mapKeysToText: Map foreign keys to text values
Redefined in descendants as:

Inherited Methods

Inherited From mosDBAbstractRow

mosDBAbstractRow::mosDBAbstractRow()
mosDBAbstractRow::check()
mosDBAbstractRow::lacks()
mosDBAbstractRow::move()
mosDBAbstractRow::updateOrder()

Documentation generated on Mon, 05 May 2008 16:19:11 +0400 by phpDocumentor 1.4.0