Docs For Class QueryRecord

Class QueryRecord

Description

Implements interfaces:

URLProperties

Habari QueryRecord Class

Located in /system/classes/queryrecord.php (line 9)

Direct descendents

Class	Description
RewriteRule	Habari RewriteRule Class
Post
Comment	Habari CommentRecord Class
User	Habari UserRecord Class
CronJob	CronJob is a single cron task
LogEntry	Habari LogEntry class Represents a log entry
UserGroup	Habari UserGroup Class
Tag

Variable Summary

mixed $fields

mixed $newfields

mixed $unsetfields

Method Summary

QueryRecord __construct ([array $paramarray = array()])

void delete ()

boolean deleteRecord (string $table, array $updatekeyfields)

void exclude_fields (mixed $fields)

array get_url_args ()

void insert ()

boolean insertRecord (string $table)

array list_excluded_fields ()

array to_array ()

void update ()

boolean updateRecord (string $table, [array $updatekeyfields = array()])

mixed __get (string $name)

boolean __isset (string $name)

mixed __set (string $name, mixed $value)

Variables

mixed $fields = array() (line 11)

access: protected

mixed $newfields = array() (line 12)

access: protected

mixed $unsetfields = array() (line 13)

access: protected

Methods

Constructor __construct (line 21)

constructor __construct Constructor for the QueryRecord class.

access: public

QueryRecord __construct ([array $paramarray = array()])

array $paramarray: an associative array of initial field values.

Redefined in descendants as:

RewriteRule::__construct() : Constructor for the rewrite_rule class.
Post::__construct() : Constructor for the Post class.
Comment::__construct() : constructor __construct Constructor for the Post class.
User::__construct() : Constructor for the User class
CronJob::__construct() : Constructor for the CronJob class.
LogEntry::__construct() : Constructor for the LogEntry class
UserGroup::__construct() : Constructor for the UserGroup class
Tag::__construct() : Constructor for the Tag class.

delete (line 167)

This is the public interface that deletes a record

access: public

void delete ()

Redefined in descendants as:

RewriteRule::delete() : Deletes an existing rule
Post::delete() : function delete
Comment::delete() : function delete
User::delete() : Delete a user account
CronJob::delete() : Deletes an existing cron job.
LogEntry::delete() : function delete
UserGroup::delete() : Delete a UserGroup
Tag::delete() : function delete

deleteRecord (line 177)

function deleteRecord

Deletes a record based on the match array

return: True on success, false if not
access: protected

boolean deleteRecord (string $table, array $updatekeyfields)

string $table: Table to delete from
array $updatekeyfields: An associative array of field data to match

exclude_fields (line 83)

Registers a (list of) fields(s) as being managed exclusively by the database.

access: public

void exclude_fields (mixed $fields)

mixed $fields: A database field name (string) or an array of field names

get_url_args (line 141)

Returns an array with the current field settings

return: The field settings as they would be saved
access: public

array get_url_args ()

Implementation of:

URLProperties::get_url_args()

Redefined in descendants as:

Post::get_url_args() : Returns a set of properties used by URL::get to create URLs
User::get_url_args() : Returns a set of properties used by URL::get to create URLs

insert (line 107)

This is the public interface that inserts a record

access: public

void insert ()

Redefined in descendants as:

RewriteRule::insert() : Saves a new rewrite rule to the rewrite_rules table
Post::insert() : function insert
Comment::insert() : function insert
User::insert() : Save a new user to the users table
CronJob::insert() : Saves a new cron job to the crontab table.
LogEntry::insert() : Insert this LogEntry data into the database
UserGroup::insert() : Save a new UserGroup to the UserGroup table
Tag::insert() : function insert

insertRecord (line 121)

function insertRecord(

Inserts this record's fields as a new row

return: True on success, false if not
access: protected

boolean insertRecord (string $table)

string $table: Table to update

list_excluded_fields (line 99)

returns an array of fields that should not be included in any database insert operation

return: an array of field names
access: public

array list_excluded_fields ()

to_array (line 132)

function to_array

Returns an array with the current field settings

return: The field settings as they would be saved
access: public

array to_array ()

update (line 148)

This is the public interface that updates a record

access: public

void update ()

Redefined in descendants as:

RewriteRule::update() : Updates an existing rule in the rewrite_rules table
Post::update() : function update
Comment::update() : function update
User::update() : Updates an existing user in the users table
CronJob::update() : Updates an existing cron job to the crontab table.
UserGroup::update() : Updates an existing UserGroup in the DB
Tag::update() : function update

updateRecord (line 158)

function updateRecord

Updates this record's fields using the new data

return: True on success, false if not
access: protected

boolean updateRecord (string $table, [array $updatekeyfields = array()])

string $table: Table to update
array $updatekeyfields: An associative array of field data to match

__get (line 38)

function __get

Handles getting virtual properties for this class

return: The set value or NULL if none exists
access: public

mixed __get (string $name)

string $name: Name of the property

Redefined in descendants as:

RewriteRule::__get() : Magic property getter for this class
Post::__get() : function __get
Comment::__get() : function __get
User::__get() : Capture requests for the info object so that it can be initialized properly when the constructor is bypassed (see PDO::FETCH_CLASS pecularities). Passes all other requests to parent.
CronJob::__get() : Magic property getter to get the cronjob properties.
LogEntry::__get() : Overrides QueryRecord __get to implement custom object properties
UserGroup::__get() : function __get

__isset (line 74)

Magic isset for QueryRecord, returns whether a property value is set.

return: True if the value is set, false if not
access: public

boolean __isset (string $name)

string $name: The name of the parameter

__set (line 58)

function __set

Handles setting virtual properties for this class

return: The set value
access: public

mixed __set (string $name, mixed $value)

string $name: Name of the property
mixed $value: Value to set it to

Redefined in descendants as:

Post::__set() : function __set
Comment::__set() : function __set
CronJob::__set() : Magic property setter to set the cronjob properties.
LogEntry::__set() : Overrides QueryRecord __set to implement custom object properties

Documentation generated on Thu, 30 Oct 2008 20:31:24 +0100 by phpDocumentor 1.3.2