XBS_MODGEN
[ class tree: XBS_MODGEN ] [ index: XBS_MODGEN ] [ all elements ]

Class: Xbs_ModgenXBS_MODGENObjectHandler

Source Location: /class/XBS_MODGENObject.php

Class Overview

CDMBaseHandler
   |
   --Xbs_ModgenXBS_MODGENObjectHandler

Object handler for XBS_MODGENObject


Methods



Class Details

[line 71]
Object handler for XBS_MODGENObject



[ Top ]


Class Methods


constructor Xbs_ModgenXBS_MODGENObjectHandler [line 78]

Xbs_ModgenXBS_MODGENObjectHandler Xbs_ModgenXBS_MODGENObjectHandler( xoopsDB &$db)

Constructor



Parameters:

xoopsDB   &$db   Handle to xoopsDb object

[ Top ]

method countAllObjects [line 184]

int countAllObjects( int $modid)

Function: Count the number of Objects belonging to a module



Tags:

return:  number of modules
version:  1


Parameters:

int   $modid   id of parent module

[ Top ]

method countTypeObjects [line 200]

int countTypeObjects( int $modid, string $otype)

Function: Count the number of Objects of a particular belonging to a module



Tags:

return:  number of modules
version:  1


Parameters:

int   $modid   id of parent module
string   $otype   type of object

[ Top ]

method delete [line 171]

bool delete( xbs_modgen_Object &$obj)

Delete object item from the database

OVERIDE ancestor




Tags:

return:  TRUE on success else False


Parameters:

xbs_modgen_Object   $obj   Handle to object object

[ Top ]

method getAllObjects [line 247]

array getAllObjects( int $modid)

Return all object item objects for a module



Tags:

return:  Object objects


Parameters:

int   $modid   Module internal identifier

[ Top ]

method getAllSelectList [line 214]

array getAllSelectList( int $modid)

return an array of Id, objectName pairs for use in a select box



Parameters:

int   $modid   id of parent module

[ Top ]

method getKey [line 119]

int getKey( string $modname, string $objectname)

Get internal identifier (primary key) based on user visible code



Tags:

return:  Internal identifier of module else false on failure


Parameters:

string   $modname   Name of module
string   $objectname   Name of object item

[ Top ]

method getTypeObjects [line 264]

array getTypeObjects( int $modid, string $type)

Return all object item objects of a given type for a module



Tags:

return:  Object objects


Parameters:

int   $modid   Module internal identifier
string   $type  

[ Top ]

method getTypeSelectList [line 231]

array getTypeSelectList( int $modid, string $type)

return an array of Id, objectName pairs for use in a select box for objects of a certain type



Parameters:

int   $modid   id of parent module
string   $type  

[ Top ]

method _get [line 106]

string &_get( int $id, string $row_flag, string $lang)

Returns sql code to get a object data record

OVERIDE ancestor




Tags:

return:  SQL string to get data


Parameters:

int   $id   internal id of the object. Internal code is a unique int value.
string   $row_flag   default null (get all), Option(CDM_RSTAT_ACT, CDM_RSTAT_DEF, CDM_RSTAT_SUS)
string   $lang   default null (get all), Valid LANGUAGE code. Will only return object of that language set

[ Top ]

method _ins_insert [line 142]

string _ins_insert( array $cleanVars)

Function: return sql to insert object to database

OVERIDE ancestor




Tags:

return:  SQL insert string
version:  1


Parameters:

array   $cleanVars   module parameters array

[ Top ]

method _ins_update [line 157]

string _ins_update( array $cleanVars)

Function: return sql to update object to database

OVERIDE ancestor




Tags:

return:  SQL insert string
version:  1


Parameters:

array   $cleanVars   module parameters array

[ Top ]


Documentation generated on Sun, 16 Jul 2006 11:02:47 +0100 by phpDocumentor 1.3.0RC3