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

Public Member Functions

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

Static Public Member Functions

static GetApp ($appId, $appSecret)
 
static Load ($limit=null, $offset=null, &$count=null, $returnArray=false)
 
- 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 = "AppId"
 
 $Id = 0
 
 $AppId = ""
 
 $Secret = ""
 
 $DateCreated = ""
 
 $Name = ""
 
 $Description = ""
 
 $Active = 0
 

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 App Ids

Author
Skared Creations

Definition at line 10 of file AppId.php.

Constructor & Destructor Documentation

◆ __construct()

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

Contructor Database $Database

Definition at line 26 of file AppId.php.

Member Function Documentation

◆ Delete()

Delete ( )

Delete the record from the database Database $Database

Returns
bool Returns TRUE on success

Definition at line 148 of file AppId.php.

◆ Exists()

Exists ( )

Check if the current Name already exists Database $Database

Returns
boolean Returns TRUE if Name exists

Definition at line 48 of file AppId.php.

◆ GetApp()

static GetApp (   $appId,
  $appSecret 
)
static

Get an app by Id and Secret key (or NULL if invalid Id/Secret)

Parameters
string$appIdApp identifier
string$appSecretApp secret key Database $Database
Returns
self

Definition at line 79 of file AppId.php.

◆ IsActive()

IsActive ( )

Definition at line 64 of file AppId.php.

◆ IsValid()

IsValid ( )

Definition at line 68 of file AppId.php.

◆ Load()

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

Get the registered news

Parameters
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
array Returns the array of records

Definition at line 102 of file AppId.php.

◆ Save()

Save ( )

Save the record in the database Database $Database

Returns
bool Returns TRUE on success

Definition at line 111 of file AppId.php.

Field Documentation

◆ $Active

$Active = 0

Definition at line 20 of file AppId.php.

◆ $AppId

$AppId = ""

Definition at line 15 of file AppId.php.

◆ $DateCreated

$DateCreated = ""

Definition at line 17 of file AppId.php.

◆ $Description

$Description = ""

Definition at line 19 of file AppId.php.

◆ $Id

$Id = 0

Definition at line 14 of file AppId.php.

◆ $Name

$Name = ""

Definition at line 18 of file AppId.php.

◆ $Secret

$Secret = ""

Definition at line 16 of file AppId.php.

◆ TABLE_NAME

const TABLE_NAME = "AppId"

Definition at line 12 of file AppId.php.