Combu Server  3.1.1
PHP API Documentation
Public Member Functions | Static Public Member Functions | Data Fields
Newsletter Class Reference
Inheritance diagram for Newsletter:
DataClass

Public Member Functions

 __construct ($src=null, $stripSlashes=false)
 
 Save ()
 
 Delete ()
 
 Send ()
 
- Public Member Functions inherited from DataClass
 Save ()
 
 Delete ()
 
 ToJson ()
 
 ToArray ()
 

Static Public Member Functions

static Load ($idApp=0, $limit=null, $offset=null, &$count=null, $returnArray=false)
 
static Prune ()
 
- Static Public Member Functions inherited from DataClass
static GetTableName ($class)
 
static LoadRecords ($query, $returnedClass="")
 
static CountRecords ($tableName, $filter=null)
 
static TruncateTable ($tableName)
 
static TruncateClass ($class)
 

Data Fields

const TABLE_NAME = "Newsletter"
 
 $Id = 0
 
 $IdAccount = 0
 
 $IdApp = 0
 
 $Subject = ""
 
 $Body = ""
 
 $IsHtml = 1
 
 $DateCreation = ""
 
 $DateSent = ""
 
 $Status = NEWSLETTER_STATUS_READY
 
 $LogMessage = ""
 

Additional Inherited Members

- Protected Member Functions inherited from DataClass
 _loadFilter ($tableName, $filter)
 
 _loadByRow ($row, $stripSlashes=false, $callbackOnExists=false)
 
 _Delete ($tableName, $filter=null)
 
- Static Protected Member Functions inherited from DataClass
static _count ($tableName, $filter=null)
 
static _load ($tableName, $returnedClass="", $where="", $order=null, $limit=null, $offset=null, &$count=null)
 
static _loadEx ($select, $from, $returnedClass="", $where="", $order=null, $limit=null, $offset=null, &$count=null, $debug=false)
 
static _loadQuery ($query, $returnedClass="")
 

Detailed Description

Class to handle Newsletter

Author
Skared Creations

Definition at line 13 of file Newsletter.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $src = null,
  $stripSlashes = false 
)

Contructor

Definition at line 31 of file Newsletter.php.

Member Function Documentation

◆ Delete()

Delete ( )

Delete the record from the database

Returns
bool Returns TRUE on success

Definition at line 105 of file Newsletter.php.

◆ Load()

static Load (   $idApp = 0,
  $limit = null,
  $offset = null,
$count = null,
  $returnArray = false 
)
static

Get the registered inventory items

Parameters
string$idAppFilter IdApp
int$limitMax number of results (for paged results)
int$offsetOffset number of results (for paged results)
int$countWill be set to the total count of results
boolean$returnArrayIf TRUE then it will return associative arrays else objects
Returns
Newsletter[] Returns the array of records

Definition at line 54 of file Newsletter.php.

◆ Prune()

static Prune ( )
static

Delete all records associated to this class

Definition at line 116 of file Newsletter.php.

◆ Save()

Save ( )

Save the record in the database

Returns
bool Returns TRUE on success

Definition at line 67 of file Newsletter.php.

◆ Send()

Send ( )

Send this Newsletter to all players

Returns
boolean Returns TRUE on success

Definition at line 126 of file Newsletter.php.

Field Documentation

◆ $Body

$Body = ""

Definition at line 21 of file Newsletter.php.

◆ $DateCreation

$DateCreation = ""

Definition at line 23 of file Newsletter.php.

◆ $DateSent

$DateSent = ""

Definition at line 24 of file Newsletter.php.

◆ $Id

$Id = 0

Definition at line 17 of file Newsletter.php.

◆ $IdAccount

$IdAccount = 0

Definition at line 18 of file Newsletter.php.

◆ $IdApp

$IdApp = 0

Definition at line 19 of file Newsletter.php.

◆ $IsHtml

$IsHtml = 1

Definition at line 22 of file Newsletter.php.

◆ $LogMessage

$LogMessage = ""

Definition at line 26 of file Newsletter.php.

◆ $Status

Definition at line 25 of file Newsletter.php.

◆ $Subject

$Subject = ""

Definition at line 20 of file Newsletter.php.

◆ TABLE_NAME

const TABLE_NAME = "Newsletter"

Definition at line 15 of file Newsletter.php.