Newsletterdeveloper's documentation

news_subscriber Class Reference
[DBO Model API]

DBO for news_subscriber entity. More...

List of all members.

Relations

 $categories
 [dbo_bag] Bag for relation categories (news_category).

Basic DBO Methods

 __construct ($no_session=false)
static create ($email, $realname)
 Create new news_subscriber entity.
static get ()
 Get news_subscriber entity from DB.
static try_get ()
 Try to get news_subscriber entity from DB.
static query ($cond=null)
 Query news_subscriber entities from DB limited by some condition.


Detailed Description

DBO for news_subscriber entity.

Newsletter subscriber.

Diagram
inline_dotgraph_4.dot
SQL Code
 CREATE TABLE news_subscribers
 (
   news_subscriber_id SERIAL PRIMARY KEY,
   -- Subscriber's e-mail.
   email TEXT NOT NULL,
   -- Subscriber's real name.
   realname TEXT,
   -- row insertion timestamp
   _insert_time TIMESTAMP DEFAULT current_timestamp NOT NULL,
   -- row update timestamp
   _update_time TIMESTAMP
 );
 CREATE TABLE categories_news_subscriber_news_category
 (
   news_subscriber_id INTEGER NOT NULL,
   news_category_id INTEGER NOT NULL
 );
Entity attributes
Attr. NameTypeCommentOptionalRead-only
emailtextSubscriber's e-mail.nono
realnametextSubscriber's real name.yesno
Entity relations
Bag NameItem TypeCommentOwnedOrderedMin - Max
categoriesnews_categoryCategories subscriber wants to receive.nono0 - unlimited


Constructor & Destructor Documentation

news_subscriber::__construct ( no_session = false  ) 

Reimplemented from dbo.

References get().


Member Function Documentation

static news_subscriber::create ( email,
realname 
) [static]

Create new news_subscriber entity.

Parameters:
email [string] Subscriber's e-mail.
realname [string] Subscriber's real name.
Returns:
[news_subscriber] Entity DBO.
Exceptions:
Exception on error.
Relations
  • categories [news_category] Categories subscriber wants to receive.

static news_subscriber::get (  )  [static]

Get news_subscriber entity from DB.

This method can be used to get single object from database. You can call it in following ways:

  • type::get(1) - get object with given ID
  • type::get('WHERE x = ?', 1) - get object by condition
  • type::get(array('type_id' => 1, '' ...)) - get object from array
Returns:
[news_subscriber] Entity DBO.
Exceptions:
Exception on error.

Reimplemented from dbo.

Referenced by __construct().

static news_subscriber::query ( cond = null  )  [static]

Query news_subscriber entities from DB limited by some condition.

Parameters:
cond [string] Additinal condition appended to 'SELECT * FROM news_subscribers'.
Returns:
[array(news_subscriber)] Array of entity DBOs.

static news_subscriber::try_get (  )  [static]

Try to get news_subscriber entity from DB.

Return NULL on failure.

This method accepts same argumesnts as news_subscriber::get().

Returns:
[news_subscriber|NULL] Entity DBO.


Member Data Documentation

news_subscriber::$categories

[dbo_bag] Bag for relation categories (news_category).

Categories subscriber wants to receive.


The documentation for this class was generated from the following file:
Documentation for Newsletter, Tue Nov 11 07:50:02 2008.