Class vB_DataManager_RSSFeed

Description

Class to do data save/delete operations for RSS Feeds

  • version: $Revision: 23864 $
  • date: $Date: 2007-09-18 08:57:22 -0500 (Tue, 18 Sep 2007) $

Located in /includes/class_dm_rssfeed.php (line 25)

vB_DataManager
   |
   --vB_DataManager_RSSFeed
Variable Summary
Method Summary
 vB_DataManager_RSSFeed vB_DataManager_RSSFeed (vB_Registry &$registry, [integer $errtype = ERRTYPE_STANDARD])
 void post_delete ([boolean $doquery = true])
 void post_save_each ([boolean $doquery = true])
 boolean pre_save ([boolean $doquery = true])
 boolean set_user_by_name (string $username)
 boolean verify_forumid (integer &$forumid)
 boolean verify_itemtype (string &$itemtype)
 boolean verify_ttl (integer &$ttl)
 boolean verify_userid (integer &$userid)
Variables
array $bitfields = array('options' => 'bf_misc_feedoptions') (line 58)

Array of field names that are bitfields, together with the name of the variable in the registry with the definitions.


Redefinition of:
vB_DataManager::$bitfields
Array of field names that are bitfields, together with the name of the variable in the registry with the definitions.
array $condition_construct = array('rssfeedid = %1$d', 'rssfeedid') (line 72)

Condition for update query


Redefinition of:
vB_DataManager::$condition_construct
Condition template for update query This is for use with sprintf(). First key is the where clause, further keys are the field names of the data to be used.
string $table = 'rssfeed' (line 65)

The main table this class deals with


Redefinition of:
vB_DataManager::$table
Default table to be used in queries
array $validfields = array(
'rssfeedid' => array(TYPE_UINT, REQ_INCR, 'return ($data > 0);'),'title'=>array(TYPE_STR,REQ_YES),'url'=>array(TYPE_STR,REQ_YES),'ttl'=>array(TYPE_UINT,REQ_YES,VF_METHOD),'maxresults'=>array(TYPE_UINT,REQ_NO),'userid'=>array(TYPE_UINT,REQ_YES,VF_METHOD),'forumid'=>array(TYPE_UINT,REQ_YES,VF_METHOD),'iconid'=>array(TYPE_UINT,REQ_NO),'titletemplate'=>array(TYPE_STR,REQ_YES),'bodytemplate'=>array(TYPE_STR,REQ_YES),'searchwords'=>array(TYPE_STR,REQ_NO),'itemtype'=>array(TYPE_STR,REQ_YES,VF_METHOD),'threadactiondelay'=>array(TYPE_UINT,REQ_NO),'endannouncement'=>array(TYPE_UINT,REQ_NO),'searchwords'=>array(TYPE_STR,REQ_NO),'lastrun'=>array(TYPE_UINT,REQ_AUTO),'options'=>array(TYPE_NOCLEAN,REQ_NO),'prefixid'=>array(TYPE_NOHTML,REQ_NO))
(line 32)

Array of recognised and required fields for RSS feeds, and their types


Redefinition of:
vB_DataManager::$validfields
Array of field names that are valid for this data object

Inherited Variables

Inherited from vB_DataManager

vB_DataManager::$condition
vB_DataManager::$dbobject
vB_DataManager::$errors
vB_DataManager::$error_handler
vB_DataManager::$existing
vB_DataManager::$failure_callback
vB_DataManager::$info
vB_DataManager::$lamda
vB_DataManager::$presave_called
vB_DataManager::$rawfields
vB_DataManager::$registry
vB_DataManager::$setfields
Methods
Constructor vB_DataManager_RSSFeed (line 80)

Constructor - checks that the registry object has been passed correctly.

vB_DataManager_RSSFeed vB_DataManager_RSSFeed (vB_Registry &$registry, [integer $errtype = ERRTYPE_STANDARD])
  • vB_Registry &$registry: Instance of the vBulletin data registry object - expected to have the database object as one of its $this->db member.
  • integer $errtype: One of the ERRTYPE_x constants
post_delete (line 242)

Additional data to update after a delete call (such as denormalized values in other tables).

void post_delete ([boolean $doquery = true])
  • boolean $doquery: Do the query?

Redefinition of:
vB_DataManager::post_delete()
Additional data to update after a delete call (such as denormalized values in other tables).
post_save_each (line 230)

Additional data to update after a save call (such as denormalized values in other tables).

In batch updates, is executed for each record updated.

void post_save_each ([boolean $doquery = true])
  • boolean $doquery: Do the query?

Redefinition of:
vB_DataManager::post_save_each()
Additional data to update after a save call (such as denormalized values in other tables).
pre_save (line 210)

Any checks to run immediately before saving. If returning false, the save will not take place.

  • return: True on success; false if an error occurred
boolean pre_save ([boolean $doquery = true])
  • boolean $doquery: Do the query?

Redefinition of:
vB_DataManager::pre_save()
Any checks to run immediately before saving. If returning false, the save will not take place.
set_user_by_name (line 119)

Accepts a username and converts it into the appropriate user id

boolean set_user_by_name (string $username)
  • string $username: Username
verify_forumid (line 94)

Verifies that the specified forumid is valid

boolean verify_forumid (integer &$forumid)
  • integer &$forumid: Forum ID (allow -1 = all forums)
verify_itemtype (line 189)

Ensures that the given itemtype is acceptable

boolean verify_itemtype (string &$itemtype)
  • string &$itemtype: Item Type
verify_ttl (line 160)

Ensures that the given TTL (time to live) value is sane

boolean verify_ttl (integer &$ttl)
  • integer &$ttl: TTL in seconds
verify_userid (line 140)

Verifies that a user id is valid and exists

boolean verify_userid (integer &$userid)
  • integer &$userid: User ID

Redefinition of:
vB_DataManager::verify_userid()
Verifies that the specified user exists

Inherited Methods

Inherited From vB_DataManager

 vB_DataManager::vB_DataManager()
 vB_DataManager::check_required()
 vB_DataManager::db_delete()
 vB_DataManager::db_insert()
 vB_DataManager::db_insert_ignore()
 vB_DataManager::db_update()
 vB_DataManager::delete()
 vB_DataManager::do_set()
 vB_DataManager::do_unset()
 vB_DataManager::error()
 vB_DataManager::fetch_field()
 vB_DataManager::fetch_insert_sql()
 vB_DataManager::fetch_update_sql()
 vB_DataManager::has_errors()
 vB_DataManager::post_delete()
 vB_DataManager::post_save_each()
 vB_DataManager::post_save_once()
 vB_DataManager::pre_delete()
 vB_DataManager::pre_save()
 vB_DataManager::save()
 vB_DataManager::set()
 vB_DataManager::setr()
 vB_DataManager::setr_info()
 vB_DataManager::set_bitfield()
 vB_DataManager::set_condition()
 vB_DataManager::set_error_handler()
 vB_DataManager::set_existing()
 vB_DataManager::set_failure_callback()
 vB_DataManager::set_info()
 vB_DataManager::strip_empty_bbcode()
 vB_DataManager::strip_empty_bbcode_callback()
 vB_DataManager::verify()
 vB_DataManager::verify_commalist()
 vB_DataManager::verify_date_array()
 vB_DataManager::verify_email()
 vB_DataManager::verify_image_count()
 vB_DataManager::verify_ipaddress()
 vB_DataManager::verify_link()
 vB_DataManager::verify_list()
 vB_DataManager::verify_md5()
 vB_DataManager::verify_nonempty()
 vB_DataManager::verify_nonzero()
 vB_DataManager::verify_pagetext()
 vB_DataManager::verify_serialized()
 vB_DataManager::verify_spacelist()
 vB_DataManager::verify_userid()
 vB_DataManager::verify_username()

Documentation generated on Fri, 09 May 2008 09:01:04 -0500 by phpDocumentor 1.4.1