BitEvents Class Reference

Inheritance diagram for BitEvents:

[legend]List of all members.

Public Member Functions
	BitEvents ($pEventsId=NULL, $pContentId=NULL)
	expunge ()
	getContentStatus ()
	getDisplayUrl ()
	getList (&$pParamHash)
	getRenderFile ()
	isValid ()
	load ()
	preview (&$pParamHash)
	store (&$pParamHash)
	verify (&$pParamHash)
Public Attributes
	$mEventsId

---

Detailed Description

Definition at line 25 of file BitEvents.php.

---

Member Function Documentation

BitEvents::BitEvents	(	$	pEventsId = NULL,
		$	pContentId = NULL
	)

During initialisation, be sure to call our base constructors

Definition at line 35 of file BitEvents.php.

References $offset, BitDate::get_display_offset(), LibertyAttachable::LibertyAttachable(), mContentId, and LibertyContent::registerContentType().

Here is the call graph for this function:

BitEvents::expunge

(

)

This function removes a events entry

Reimplemented from LibertyContent.

Definition at line 341 of file BitEvents.php.

References $query, $result, $ret, LibertyContent::expunge(), FALSE, isValid(), mContentId, and mDb.

Here is the call graph for this function:

BitEvents::getContentStatus

(

)

Definition at line 460 of file BitEvents.php.

References $gBitSystem, and LibertyContent::getContentStatus().

Here is the call graph for this function:

BitEvents::getDisplayUrl

(

)

Generates the URL to the events page

Parameters:

pExistsHash

the hash that was returned by LibertyContent::pageExists

Returns:

the link to display the page.

Definition at line 451 of file BitEvents.php.

References $ret, and BitBase::verifyId().

Referenced by load().

Here is the call graph for this function:

BitEvents::getList

(

&$

pParamHash

)

This function generates a list of records from the liberty_content database for use in a list page

Definition at line 367 of file BitEvents.php.

References $_REQUEST, $find, $gBitSystem, $gBitUser, $max_records, $offset, $pParamHash, $query, $res, $result, $ret, $sort_mode, LibertyContent::getServicesSql(), mDb, LibertyContent::parseSplit(), BitBase::postGetList(), LibertyContent::prepGetList(), and BitBase::verifyId().

Here is the call graph for this function:

BitEvents::getRenderFile

(

)

Pure virtual function that returns the include file that should render a page of content of this type

Returns:

the fully specified path to file to be included

Reimplemented from LibertyContent.

Definition at line 468 of file BitEvents.php.

BitEvents::isValid

(

)

Make sure events is loaded and valid

Reimplemented from LibertyContent.

Definition at line 360 of file BitEvents.php.

References BitBase::verifyId().

Referenced by expunge(), and verify().

Here is the call graph for this function:

BitEvents::load

(

)

Load the data from the database

Parameters:

pParamHash

be sure to pass by reference in case we need to make modifcations to the hash

Definition at line 61 of file BitEvents.php.

References $gBitSystem, $query, $result, editor, getDisplayUrl(), LibertyContent::getPreference(), LibertyContent::getServicesSql(), LibertyAttachable::load(), mContentId, mDb, mInfo, LibertyContent::parseData(), and BitBase::verifyId().

Referenced by store(), and verify().

Here is the call graph for this function:

BitEvents::preview

(

&$

pParamHash

)

Definition at line 108 of file BitEvents.php.

References $gBitSmarty, $gBitSystem, $pParamHash, LibertyContent::invokeServices(), mInfo, LibertyContent::parseData(), LibertyContent::verify(), LibertyAttachable::verify(), and verify().

Here is the call graph for this function:

BitEvents::store

(

&$

pParamHash

)

Any method named Store inherently implies data will be written to the database

Parameters:

	pParamHash	be sure to pass by reference in case we need to make modifcations to the hash This is the ONLY method that should be called in order to store( create or update )an events! It is very smart and will figure out what to do for you. It should be considered a black box.
	array	pParams hash of values that will be used to store the page

Returns:

bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why

public

Reimplemented from LibertyAttachable.

Definition at line 138 of file BitEvents.php.

References $pParamHash, $result, load(), mDb, LibertyAttachable::store(), LibertyContent::storePreference(), verify(), and BitBase::verifyId().

Here is the call graph for this function:

BitEvents::verify

(

&$

pParamHash

)

Make sure the data is safe to store

Parameters:

	pParamHash	be sure to pass by reference in case we need to make modifcations to the hash This function is responsible for data integrity and validation before any operations are performed with the $pParamHash NOTE: This is a PRIVATE METHOD!!!! do not call outside this class, under penalty of death!
	array	pParams reference to hash of values that will be used to store the page, they will be modified where necessary

Returns:

bool TRUE on success, FALSE if verify failed. If FALSE, $this->mErrors will have reason why

private

Reimplemented from LibertyAttachable.

Definition at line 188 of file BitEvents.php.

References $gBitSystem, $gBitUser, $pParamHash, description, isValid(), load(), mInfo, title, and BitBase::verifyId().

Referenced by preview(), and store().

Here is the call graph for this function:

---

Member Data Documentation

BitEvents::$mEventsId

Primary key for our mythical Events class object & table

Definition at line 30 of file BitEvents.php.

---

The documentation for this class was generated from the following file:

• BitEvents.php

---