API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsConfigOptionHandler Class Reference
Inheritance diagram for XoopsConfigOptionHandler:
Collaboration diagram for XoopsConfigOptionHandler:

Public Member Functions

 create ($isNew=true)
 
 get ($id)
 
 insert (XoopsObject $confoption)
 
 delete (XoopsObject $confoption)
 
 getObjects (CriteriaElement $criteria=null, $id_as_key=false)
 
 getCount (CriteriaElement $criteria=null)
 
- Public Member Functions inherited from XoopsObjectHandler
 __construct (XoopsDatabase $db)
 
 XoopsObjectHandler ($db)
 
 create ()
 
 get ($id)
 
 insert (XoopsObject $object)
 
 delete (XoopsObject $object)
 

Additional Inherited Members

- Data Fields inherited from XoopsObjectHandler
 $db
 

Member Function Documentation

◆ create()

create (   $isNew = true)

Create a new option

Parameters
bool$isNewFlag the option as "new"?
Returns
XoopsConfigOption XoopsConfigOption

◆ delete()

delete ( XoopsObject  $confoption)

Delete a XoopsConfigOption

Parameters
XoopsObject | XoopsConfigOption$confoptiona XoopsConfigOption object
Returns
bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

◆ get()

get (   $id)

Get an option from the database

Parameters
int$idID of the option
Returns
XoopsConfigOption reference to the XoopsConfigOption, FALSE on fail

Reimplemented from XoopsObjectHandler.

◆ getCount()

getCount ( CriteriaElement  $criteria = null)

get count of matching configoption rows

Parameters
CriteriaElement$criteria
Returns
int Count of matching XoopsConfigOption

◆ getObjects()

getObjects ( CriteriaElement  $criteria = null,
  $id_as_key = false 
)

Get some XoopsConfigOptions

Parameters
CriteriaElement | CriteriaCompo$criteriaCriteriaElement
bool$id_as_keyUse the IDs as array-keys?
Returns
array Array of XoopsConfigOptions

◆ insert()

insert ( XoopsObject  $confoption)

Insert a new XoopsConfigOption

Parameters
XoopsObject | XoopsConfigOption$confoptiona XoopsConfigOption object
Returns
bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

Here is the call graph for this function:

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