Cheetah
Public Member Functions | Public Attributes | List of all members
ChShoutBoxDb Class Reference
Inheritance diagram for ChShoutBoxDb:
ChWsbModuleDb ChWsbDb

Public Member Functions

 __construct (&$oConfig)
 
 getShoutboxObjects ()
 
 clearShoutboxObjectsCache ()
 
 writeMessage ($sObject, $iHandler, $sMessage, $iOwnerId=0, $iIP=0)
 
 getLastMessageId ($sObject, $iHandler)
 
 getMessages ($sObject, $iHandler, $iLastId)
 
 getMessagesCount ($sObject, $iHandler)
 
 getMessageInfo ($sObject, $iHandler, $iMessageId)
 
 deleteMessages ($sObject, $iHandler, $iLimit)
 
 deleteMessage ($sObject, $iHandler, $iMessageId)
 
 deleteMessagesByIp ($sObject, $iHandler, $iIp)
 
 deleteMessagesByProfile ($iProfileId)
 
 deleteOldMessages ($iLifeTime)
 
 getSettingsCategory ($sName)
 
 insertData ($aData)
 
 deleteData ($aData)
 
- Public Member Functions inherited from ChWsbModuleDb
 __construct ($oConfig=null)
 
 getPrefix ()
 
 getModulesBy ($aParams=array())
 
 getModuleById ($iId)
 
 getModuleByUri ($sUri)
 
 isModule ($sUri)
 
 isModuleParamsUsed ($sUri, $sPath, $sPrefixDb, $sPrefixClass)
 
 getModules ()
 
 getDependent ($sUri)
 
 getSettingsCategoryId ($sCatName)
 
- Public Member Functions inherited from ChWsbDb
 setTimezone ($sTimezone)
 
 getLink ()
 
 res ($sQuery, $aBindings=[], $bReplaying=false)
 
 getAll ($sQuery, $aBindings=[], $iFetchType=PDO::FETCH_ASSOC)
 
 getRow ($sQuery, $aBindings=[], $iFetchStyle=PDO::FETCH_ASSOC)
 
 getColumn ($sQuery, $aBindings=[])
 
 getOne ($sQuery, $aBindings=[], $iIndex=0)
 
 getFirstRow ($sQuery, $aBindings=[], $iFetchStyle=PDO::FETCH_ASSOC)
 
 getNextRow ()
 
 getAllWithKey ($sQuery, $sFieldKey, $aBindings=[], $iFetchType=PDO::FETCH_ASSOC)
 
 getPairs ($sQuery, $sFieldKey, $sFieldValue, $aBindings=[])
 
 query ($sQuery, $aBindings=[])
 
 getNumRows ($oStmt=null)
 
 getAffectedRows ($oStmt=null)
 
 fillArray ($oStmt, $iFetchType=PDO::FETCH_ASSOC)
 
 lastId ()
 
 getParam ($sName, $bCache=true)
 
 setParam ($sName, $sValue)
 
 listTables ()
 
 getFields ($sTable)
 
 isFieldExists ($sTable, $sFieldName)
 
 fetchField ($mixedQuery, $iField, $aBindings=[])
 
 getDbCacheObject ()
 
 genDbCacheKey ($sName)
 
 fromCache ($sName, $sFunc)
 
 cleanCache ($sName)
 
fromMemory ($sName, $sFunc)
 
 cleanMemory ($sName)
 
 arrayToSQL ($a, $sDiv=',')
 
 escape ($sText, $bReal=true)
 
 implode_escape ($mixed)
 
 unescape ($mixed)
 

Public Attributes

 $_oConfig
 
 $_aObjects = array()
 
- Public Attributes inherited from ChWsbModuleDb
 $_sPrefix
 
- Public Attributes inherited from ChWsbDb
 $port
 
 $socket
 
 $dbname
 
 $user
 
 $password
 
 $oParams = null
 
 $oDbCacheObject = null
 

Additional Inherited Members

- Static Public Member Functions inherited from ChWsbDb
static getInstance ()
 
- Protected Member Functions inherited from ChWsbDb
 __construct ()
 
 connect ()
 
 disconnect ()
 
- Protected Attributes inherited from ChWsbDb
 $host
 
 $link
 
 $oCurrentStmt
 
 $iCurrentFetchStyle
 
- Static Protected Attributes inherited from ChWsbDb
static $instance
 

Detailed Description

This work, "Cheetah - https://www.cheetahwsb.com", is a derivative of "Dolphin Pro V7.4.2" by BoonEx Pty Limited - https://www.boonex.com/, used under CC-BY. "Cheetah" is licensed under CC-BY by Dean J. Bassett Jr. CC-BY License - http://creativecommons.org/licenses/by/3.0/

Definition at line 10 of file ChShoutBoxDb.php.

Constructor & Destructor Documentation

◆ __construct()

ChShoutBoxDb::__construct ( $oConfig)

Constructor.

Definition at line 19 of file ChShoutBoxDb.php.

Member Function Documentation

◆ clearShoutboxObjectsCache()

ChShoutBoxDb::clearShoutboxObjectsCache ( )

Definition at line 37 of file ChShoutBoxDb.php.

◆ deleteData()

ChShoutBoxDb::deleteData (   $aData)

Definition at line 277 of file ChShoutBoxDb.php.

◆ deleteMessage()

ChShoutBoxDb::deleteMessage (   $sObject,
  $iHandler,
  $iMessageId 
)

Delete message

Parameters
$sObject(string) - object
$iHandler(string) - handler
$iMessageIdinteger
Returns
integer

Definition at line 185 of file ChShoutBoxDb.php.

◆ deleteMessages()

ChShoutBoxDb::deleteMessages (   $sObject,
  $iHandler,
  $iLimit 
)

Delete messages;

Parameters
:$iLimit(integer) - limit of deleted messages;
Returns
: void;

Definition at line 166 of file ChShoutBoxDb.php.

◆ deleteMessagesByIp()

ChShoutBoxDb::deleteMessagesByIp (   $sObject,
  $iHandler,
  $iIp 
)

Delete messages by IP

Parameters
$sObject(string) - object
$iHandler(string) - handler
$iIpinteger
Returns
void

Definition at line 205 of file ChShoutBoxDb.php.

◆ deleteMessagesByProfile()

ChShoutBoxDb::deleteMessagesByProfile (   $iProfileId)

Delete messages by profile id

Parameters
$iProfileIdinteger
Returns
void

Definition at line 225 of file ChShoutBoxDb.php.

◆ deleteOldMessages()

ChShoutBoxDb::deleteOldMessages (   $iLifeTime)

Function will delete all oldest data;

Parameters
:$iLifeTime(integer);
Returns
: void();

Definition at line 240 of file ChShoutBoxDb.php.

◆ getLastMessageId()

ChShoutBoxDb::getLastMessageId (   $sObject,
  $iHandler 
)

Function will return last message's Id;

Parameters
:$sObject(string) - object;
:$iHandler(string) - handler;
Returns
: (integer) ;

Definition at line 86 of file ChShoutBoxDb.php.

◆ getMessageInfo()

ChShoutBoxDb::getMessageInfo (   $sObject,
  $iHandler,
  $iMessageId 
)

get message info

Parameters
$sObject(string) object;
$iHandler(string) handler;
$iMessageIdinteger
Returns
array

Definition at line 147 of file ChShoutBoxDb.php.

◆ getMessages()

ChShoutBoxDb::getMessages (   $sObject,
  $iHandler,
  $iLastId 
)

Function will return array with messages;

Parameters
:$sObject(string) - object;
:$iHandler(string) - handler;
iLastId (integer) - message's last id; return : array(); [OwnerID] - (integer) message owner's Id; [Message] - (string) message text; [Date] - (string) message creation data;

Definition at line 109 of file ChShoutBoxDb.php.

◆ getMessagesCount()

ChShoutBoxDb::getMessagesCount (   $sObject,
  $iHandler 
)

Function will get count of all messages;

Parameters
:$sObject(string) - object;
:$iHandler(string) - handler;
Returns
: (integer) - number of messages;

Definition at line 128 of file ChShoutBoxDb.php.

◆ getSettingsCategory()

ChShoutBoxDb::getSettingsCategory (   $sName)

Function will return number of global settings category;

Returns
: (integer)

Definition at line 257 of file ChShoutBoxDb.php.

◆ getShoutboxObjects()

ChShoutBoxDb::getShoutboxObjects ( )

Definition at line 27 of file ChShoutBoxDb.php.

◆ insertData()

ChShoutBoxDb::insertData (   $aData)

Definition at line 262 of file ChShoutBoxDb.php.

◆ writeMessage()

ChShoutBoxDb::writeMessage (   $sObject,
  $iHandler,
  $sMessage,
  $iOwnerId = 0,
  $iIP = 0 
)

Function will create new message

Parameters
:$sObject(string) - object;
:$iHandler(string) - handler;
:$sMessage(string) - message;
:$iOwnerId(integer) - message's owner Id;
:$iIPinteger
Returns
: void;

Definition at line 52 of file ChShoutBoxDb.php.

Member Data Documentation

◆ $_aObjects

ChShoutBoxDb::$_aObjects = array()

Definition at line 14 of file ChShoutBoxDb.php.

◆ $_oConfig

ChShoutBoxDb::$_oConfig

Definition at line 12 of file ChShoutBoxDb.php.


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