API - XOOPS 2.5.11 Beta 2
By monxoops.fr
|
Public Member Functions | |
__construct (XoopsDatabase $db) | |
insert (XoopsObject $obj, $force=true) | |
& | getObjects (CriteriaElement $criteria=null, $id_as_key=false, $as_object=true) |
getAllBlocksByGroup ($groupid, $asobject=true, $side=null, $visible=null, $orderby='b.weight, b.bid', $isactive=1) | |
getBlockByPerm ($groupid) | |
getAllByGroupModule ($groupid, $module_id=0, $toponlyblock=false, $visible=null, $orderby='b.weight, m.block_id', $isactive=1) | |
getNonGroupedBlocks ($module_id=0, $toponlyblock=false, $visible=null, $orderby='b.weight, m.block_id', $isactive=1) | |
countSimilarBlocks ($moduleId, $funcNum, $showFunc=null) | |
Public Member Functions inherited from XoopsPersistableObjectHandler | |
__construct (XoopsDatabase $db=null, $table='', $className='', $keyName='', $identifierName='') | |
XoopsPersistableObjectHandler (XoopsDatabase $db=null, $table='', $className='', $keyName='', $identifierName='') | |
setHandler ($handler=null, $args=null, $path=null) | |
loadHandler ($name, $args=null) | |
__call ($name, $args) | |
create ($isNew=true) | |
get ($id=null, $fields=null) | |
insert (XoopsObject $object, $force=true) | |
delete (XoopsObject $object, $force=false) | |
deleteAll (CriteriaElement $criteria=null, $force=true, $asObject=false) | |
updateAll ($fieldname, $fieldvalue, CriteriaElement $criteria=null, $force=false) | |
& | getObjects (CriteriaElement $criteria=null, $id_as_key=false, $as_object=true) |
& | getAll (CriteriaElement $criteria=null, $fields=null, $asObject=true, $id_as_key=true) |
getList (CriteriaElement $criteria=null, $limit=0, $start=0) | |
& | getIds (CriteriaElement $criteria=null) |
& | getByLimit ($limit=0, $start=0, CriteriaElement $criteria=null, $fields=null, $asObject=true) |
getCount (CriteriaElement $criteria=null) | |
getCounts (CriteriaElement $criteria=null) | |
& | getByLink (CriteriaElement $criteria=null, $fields=null, $asObject=true, $field_link=null, $field_object=null) |
getCountByLink (CriteriaElement $criteria=null) | |
getCountsByLink (CriteriaElement $criteria=null) | |
updateByLink ($data, CriteriaElement $criteria=null) | |
deleteByLink (CriteriaElement $criteria=null) | |
cleanOrphan ($table_link='', $field_link='', $field_object='') | |
synchronization () | |
convertResultSet ($result, $id_as_key=false, $as_object=true) | |
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 XoopsPersistableObjectHandler | |
$handler | |
$handlers = array('read' => null, 'stats' => null, 'joint' => null, 'write' => null, 'sync' => null) | |
$table | |
$keyName | |
$className | |
$identifierName | |
$field_link | |
$field_object | |
Data Fields inherited from XoopsObjectHandler | |
$db | |
__construct | ( | XoopsDatabase | $db | ) |
null | XoopsDatabase | $db |
Reimplemented from XoopsObjectHandler.
countSimilarBlocks | ( | $moduleId, | |
$funcNum, | |||
$showFunc = null |
|||
) |
XoopsBlock::countSimilarBlocks()
mixed | $moduleId | |
mixed | $funcNum | |
mixed | $showFunc |
getAllBlocksByGroup | ( | $groupid, | |
$asobject = true , |
|||
$side = null , |
|||
$visible = null , |
|||
$orderby = 'b.weight , |
|||
b.bid' | , | ||
$isactive = 1 |
|||
) |
get all the blocks that match the supplied parameters
int | int[] | $groupid | groupid (can be an array) |
bool | $asobject | |
int | string | $side | 0: sideblock - left 1: sideblock - right 2: sideblock - left and right 3: centerblock - left 4: centerblock - right 5: centerblock - center 6: centerblock - left, right, center |
$visible | 0: not visible 1: visible | |
string | $orderby | order of the blocks |
int | $isactive |
getAllByGroupModule | ( | $groupid, | |
$module_id = 0 , |
|||
$toponlyblock = false , |
|||
$visible = null , |
|||
$orderby = 'b.weight , |
|||
m.block_id' | , | ||
$isactive = 1 |
|||
) |
$groupid | ||
int | $module_id | |
bool | $toponlyblock | |
null | $visible | |
string | $orderby | |
int | $isactive |
getBlockByPerm | ( | $groupid | ) |
$groupid |
getNonGroupedBlocks | ( | $module_id = 0 , |
|
$toponlyblock = false , |
|||
$visible = null , |
|||
$orderby = 'b.weight , |
|||
m.block_id' | , | ||
$isactive = 1 |
|||
) |
int | $module_id | |
bool | $toponlyblock | |
null | $visible | |
string | $orderby | |
int | $isactive |
& getObjects | ( | CriteriaElement | $criteria = null , |
$id_as_key = false , |
|||
$as_object = true |
|||
) |
retrieve array of XoopsBlock
s meeting certain conditions
CriteriaElement | CriteriaCompo | $criteria | CriteriaElement with conditions for the blocks |
bool | $id_as_key | should the blocks' bid be the key for the returned array? |
bool | $as_object | return an array of objects |
XoopsBlock
s matching the conditions Reimplemented from XoopsPersistableObjectHandler.
insert | ( | XoopsObject | $obj, |
$force = true |
|||
) |
XoopsObject | SystemBlock | $obj |
Reimplemented from XoopsPersistableObjectHandler.