BitNewsletter Class Reference

Inheritance diagram for BitNewsletter:

[legend]List of all members.

Public Member Functions
	BitNewsletter ($pNlId=NULL, $pContentId=NULL)
	expunge ()
	getDisplayUrl ($pNewsletterId=NULL)
	getEditions ($pNewsletterId=NULL)
	getList (&$pListHash)
	getSubscriberInfo ($pLookup)
	getSubscribers ($pAll=FALSE)
	getUserSubscriptions ($pUserId, $pEmail)
	isValid ()
	load ($pUserId=NULL)
	loadEditions ()
	removeSubscription ($email, $notify=FALSE, $del_record=FALSE)
	store (&$pParamHash)
	subscribe ($pSubscribeHash)
	unsubscribe ($pMixed, $notify=TRUE)
	verify (&$pParamHash)

---

Detailed Description

Definition at line 33 of file BitNewsletter.php.

---

Member Function Documentation

BitNewsletter::BitNewsletter	(	$	pNlId = NULL,
		$	pContentId = NULL
	)

Definition at line 34 of file BitNewsletter.php.

References mContentId, LibertyContent::registerContentType(), and BitBase::verifyId().

Here is the call graph for this function:

BitNewsletter::expunge

(

)

Delete content object and all related records

Reimplemented from LibertyContent.

Definition at line 344 of file BitNewsletter.php.

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

Here is the call graph for this function:

BitNewsletter::getDisplayUrl

(

$

pNewsletterId = NULL

)

Generate a valid url for the Newsletter

Parameters:

object

$pNewsletterId of the item to use

Returns:

object Url String

Definition at line 376 of file BitNewsletter.php.

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

Referenced by getList().

Here is the call graph for this function:

BitNewsletter::getEditions

(

$

pNewsletterId = NULL

)

Definition at line 395 of file BitNewsletter.php.

References $listHash, $ret, BitNewsletterEdition::getList(), and BitBase::verifyId().

Referenced by loadEditions().

Here is the call graph for this function:

BitNewsletter::getList

(

&$

pListHash

)

Definition at line 276 of file BitNewsletter.php.

References $gBitDb, $mid, $pParamHash, $query, $res, $result, $ret, getDisplayUrl(), BitBase::prepGetList(), and BitBase::verifyId().

Here is the call graph for this function:

BitNewsletter::getSubscriberInfo

(

$

pLookup

)

Definition at line 122 of file BitNewsletter.php.

References $query, $res, $ret, isValid(), and mDb.

Here is the call graph for this function:

BitNewsletter::getSubscribers

(

$

pAll = FALSE

)

Definition at line 144 of file BitNewsletter.php.

References $query, $res, $ret, isValid(), mContentId, and mDb.

Referenced by subscribe().

Here is the call graph for this function:

BitNewsletter::getUserSubscriptions	(	$	pUserId,
		$	pEmail
	)

Definition at line 409 of file BitNewsletter.php.

References $gBitDb, $query, and $ret.

BitNewsletter::isValid

(

)

Check mContentId to establish if the object has been loaded with a valid record

Reimplemented from LibertyContent.

Definition at line 365 of file BitNewsletter.php.

References BitBase::verifyId().

Referenced by expunge(), getSubscriberInfo(), getSubscribers(), loadEditions(), and subscribe().

Here is the call graph for this function:

BitNewsletter::load

(

$

pContentId = NULL

)

Assume a derived class has joined on the liberty_content table, and loaded it's columns already.

Reimplemented from LibertyContent.

Definition at line 54 of file BitNewsletter.php.

References $gBitSystem, $query, $result, LibertyContent::getServicesSql(), mContentId, mDb, mInfo, and BitBase::verifyId().

Referenced by unsubscribe().

Here is the call graph for this function:

BitNewsletter::loadEditions

(

)

Definition at line 86 of file BitNewsletter.php.

References getEditions(), and isValid().

Here is the call graph for this function:

BitNewsletter::removeSubscription	(	$	email,
		$	notify = FALSE,
		$	del_record = FALSE
	)

Definition at line 156 of file BitNewsletter.php.

References $email, mContentId, mDb, and unsubscribe().

Here is the call graph for this function:

BitNewsletter::store

(

&$

pParamHash

)

Create a new content object or update an existing one

Parameters:

array

Array of content data to be stored See verify for details of the values required

Reimplemented from LibertyContent.

Definition at line 92 of file BitNewsletter.php.

References $pParamHash, $result, mDb, and verify().

Here is the call graph for this function:

BitNewsletter::subscribe

(

$

pSubscribeHash

)

Definition at line 165 of file BitNewsletter.php.

References $email, $gBitSmarty, $gBitSystem, $gBitUser, $mail_data, $now, $query, $result, $ret, date, FALSE, BitUser::genPass(), BitBase::getField(), getSubscribers(), information, isValid(), mContentId, mDb, tra(), and BitBase::verifyId().

Here is the call graph for this function:

BitNewsletter::unsubscribe	(	$	pMixed,
		$	notify = TRUE
	)

Definition at line 212 of file BitNewsletter.php.

References $gBitSmarty, $gBitSystem, $gBitUser, $mail_data, $now, $query, $res, $result, $ret, date, FALSE, load(), mContentId, mDb, and tra().

Referenced by removeSubscription().

Here is the call graph for this function:

BitNewsletter::verify

(

&$

pParamHash

)

Verify the core class data required to update the liberty_content table entries

Verify will build an array [content_store] with all of the required values and populate it with the relevent data to create/update the liberty_content table record

Parameters:

array

Array of content data to be stored [pParamHash] content_id user_id modifier_user_id created last_modified content_type_guid format_guid last_hit event_time hits lang_code title ip edit

Returns:

integer Count of the number of errors ( 0 for success )
[pParamHash] will be extended to include array [content_store] populated with the require values for LibertyContent::store()

Reimplemented from LibertyContent.

Definition at line 110 of file BitNewsletter.php.

References $pParamHash.

Referenced by store().

---

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

• BitNewsletter.php

---