MailingList Class Reference

Inheritance diagram for MailingList:

List of all members.

Public Member Functions
	MailingList ($data)
	getId ()
	getName ()
	isPublic ()
	getRules ()
	create ()
	update ()
	delete ()
	toArray ()
	exists ()
	getCacheId ()
Static Public Member Functions
static	newFromId ($id)
static	newFromName ($name)
static	getAllMailingLists ()
static	getThreads ($project_name)
static	getMessages ($project_id, $thread)
static	getPublicLists ()
static	getPersonLists ($person)
static	getPersonListsByRules ($person)
static	listLists ()
static	subscribeAll ($person)
static	subscribe ($project, $person, &$out="")
static	unsubscribeAll ($person)
static	unsubscribe ($project, $person, &$out="")
static	isSubscribed ($project, $person)
static	listMembers ($project)
static	manuallyUnsubscribe ($project, $person)
static	hasUnsubbed ($project, $person)
static	listName ($project)
static	createMailingList ($project)
static	removeMailingList ($project)
Public Attributes
	$id
	$name
	$public
	$rules = null
Static Public Attributes
static	$allMailingLists = array()
static	$cache = array()
static	$black_list
static	$lists = array()
static	$membershipCache = array()
static	$unsubCache = array()
static	$threadCache = array()

---

Member Function Documentation

MailingList::create

(

)

Creates a new record in the DB for this BackboneModel

Returns:

boolean Returns whether or not the creation was successful or not

Reimplemented from BackboneModel.

MailingList::delete

(

)

Deletes the record in the DB for this BackboneModel

Returns:

boolean Returns whether or not the deletion was successful or not

Reimplemented from BackboneModel.

MailingList::exists

(

)

Returns whether or not this BackboneModel exists or not

Returns:

boolean Returns whether or not this BackboneModel exists or not

Reimplemented from BackboneModel.

MailingList::getCacheId

(

)

Returns the id of this BackboneModel's cache

Returns:

string Returns the id of this BackboneModel's cache

Reimplemented from BackboneModel.

MailingList::getId

(

)

Returns:

int Returns the id of this BackboneModel

Reimplemented from BackboneModel.

static MailingList::getPersonLists

(

$

person

)

[static]

Returns the lists that the given person is on

Parameters:

Person

$person The Person to get the lists for

Returns:

array Returns the array of mailing lists

static MailingList::getPersonListsByRules

(

$

person

)

[static]

Returns the lists that the given person should be on

Parameters:

Person

$person The Person to get the lists for

Returns:

array Returns the array of mailing lists

static MailingList::hasUnsubbed	(	$	project,
		$	person
	)			[static]

Returns whether this Person has manually unsubscribed from the given mailing list or not

Parameters:

	Project	$project The Project to check
	Person	$person The Person to check

Returns:

boolean Returns true if the Person has unsubscribed from the mailing list and false if not

static MailingList::isSubscribed	(	$	project,
		$	person
	)			[static]

Returns whether the Person is subscribed to the given mailing list or not (This is potentially slow if ran on all lists since it needs to do a system call)

Parameters:

	Project	$project The Project to check
	Person	$person The Person to check

Returns:

boolean Returns true if the Person is subscribed to the given mailing list and false if not

static MailingList::listLists

(

)

[static]

Returns all the lists in the system

Returns:

array Returns the array of mailing lists

static MailingList::listMembers

(

$

project

)

[static]

Returns an array of email addresses who are subscribed to the given mailing list

Parameters:

Project

$project The Project to check

Returns:

array An array of email addresses

static MailingList::listName

(

$

project

)

[static]

Returns a list name for the given string or Project

Parameters:

mixed

$project The string or Project

Returns:

string The list name

static MailingList::subscribe	(	$	project,
		$	person,
		&$	out = ""
	)			[static]

Subscribes the given Person to the given Project

Parameters:

	Project	$project The Project to subscribe to
	Person	$person The Person to subscribe
	string	$out The output string for the command output

Returns:

int Returns 1 on success, and 0 on failure

static MailingList::subscribeAll

(

$

person

)

[static]

Subscribes the given Person to all the mailing lists that the Person should be in based on the mailing list rules

Parameters:

Person

$person The Person to subscribe

MailingList::toArray

(

)

Generates and returns an array version of this BackboneModel

Returns:

array Returns an array version of this BackboneModel

Reimplemented from BackboneModel.

static MailingList::unsubscribe	(	$	project,
		$	person,
		&$	out = ""
	)			[static]

Unsubscribes the given Person from the given Project

Parameters:

	Project	$project The Project to unsubscribe from
	Person	$person The Person to unsubscribe
	string	$out The output string for the command output

Returns:

int Returns 1 on success, and 0 on failure

static MailingList::unsubscribeAll

(

$

person

)

[static]

Unsubscribes the given Person from all the mailing lists that the Person should be in based on the mailing list rules

Parameters:

Person

$person The Person to subscribe

MailingList::update

(

)

Updates the record in the DB for this BackboneModel

Returns:

boolean Returns whether or not the update was successful or not

Reimplemented from BackboneModel.

---

Member Data Documentation

MailingList::$black_list [static]

Initial value:

 array('grand',
                               'administrator',
                               'mailman')

---

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

• extensions/GrandObjects/MailingList.php