blueshoes php application framework and cms            applications_mailinglist
[ class tree: applications_mailinglist ] [ index: applications_mailinglist ] [ all elements ]

Class: Bs_MailingList

Source Location: /applications/mailinglist/Bs_MailingList.class.php

Class Overview

Bs_Object
   |
   --Bs_MailingList



Author(s):

Version:

  • 4.3.$Revision: 1.3 $ $Date: 2003/10/29 17:47:48 $

Copyright:

  • blueshoes.org

Variables

Methods


Inherited Variables

Inherited Methods

Class: Bs_Object

Bs_Object::Bs_Object()
Bs_Object::getErrors()
Basic error handling: Get *all* errors as string array from the global Bs_Error-error stack.
Bs_Object::getLastError()
Basic error handling: Get last error string from the global Bs_Error-error stack.
Bs_Object::getLastErrors()
Basic error handling: Get last errors string array from the global Bs_Error-error stack sinc last call of getLastErrors().
Bs_Object::persist()
Persists this object by serializing it and saving it to a file with unique name.
Bs_Object::setError()
Basic error handling: Push an error string on the global Bs_Error-error stack.
Bs_Object::toHtml()
Dumps the content of this object to a string using PHP's var_dump().
Bs_Object::toString()
Dumps the content of this object to a string using PHP's var_dump().
Bs_Object::unpersist()
Fetches an object that was persisted with persist()

Class Details

[line 7]


Tags:

copyright:  blueshoes.org
version:  4.3.$Revision: 1.3 $ $Date: 2003/10/29 17:47:48 $
author:  Sam Blum <at blueshoes dot org>, andrej arn <andrej at blueshoes dot org>
status:  experimental


[ Top ]


Class Variables

$objP =

[line 15]

object persister


Type:   object


[ Top ]

$_users =

[line 17]


Type:   mixed


[ Top ]



Class Methods


constructor Bs_MailingList [line 20]

Bs_MailingList Bs_MailingList( )



[ Top ]

method getAllUsers [line 88]

array &getAllUsers( [mixed $load = TRUE])



Tags:

throws:  bool FALSE


[ Top ]

method getUser [line 76]

object &getUser( string $email)

returns a reference to an instance of Bs_Ml_User for the given username.

loads the user first if that has not been done before.

example: $user =& $mailingList->getUser('tom@email.com');




Tags:

see:  $this->loadUserByEmail()
throws:  bool FALSE (no such user)
access:  public


Parameters:

string   $email  

[ Top ]

method initObjPersister [line 119]

bool initObjPersister( mixed $objP, [mixed $obj = NULL], object &$objP)



Tags:

return:  TRUE on success; FALSE on error (see getLastError())
access:  public


Parameters:

object   &$objP  

[ Top ]

method loadAllUsers [line 30]

bool loadAllUsers( )

loads all existing users. yep.



Tags:

return:  TRUE on success; FALSE on error (see getLastError()).
access:  public


[ Top ]

method loadUserByEmail [line 50]

mixed loadUserByEmail( string $email)

loads the user specified.



Tags:

return:  (string or int the id of the user, or bool FALSE if it failed.)
see:  Bs_MailingList::getUser(), Bs_MailingList::loadAllUsers()
access:  public


Parameters:

string   $email  

[ Top ]

method setUser [line 97]

void setUser( mixed &$userObj)



[ Top ]

method storeUser [line 107]

bool storeUser( obj &$user)

stores the user specified.



Tags:

return:  TRUE on success; FALSE on error (see getLastError())
access:  public


Parameters:

obj   &$user   (object instance of Bs_Ml_User)

[ Top ]


Documentation generated on Mon, 29 Dec 2003 21:11:46 +0100 by phpDocumentor 1.2.3