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

Class: Xbs_CdmCDMSetHandler

Source Location: /modules/xbs_cdm/class/CDMSet.php

Class Overview

XoopsObjectHandler
   |
   --CDMBaseHandler
      |
      --Xbs_CdmCDMSetHandler

Object handler for CDMSet


Author(s):

Copyright:

  • copyright © 2000 The XOOPS Project

Methods


Inherited Variables

Inherited Methods

Class: CDMBaseHandler

CDMBaseHandler::CDMBaseHandler()
Constructor
CDMBaseHandler::create()
Create a new object
CDMBaseHandler::delete()
Delete object from the database
CDMBaseHandler::errno()
Return last error number
CDMBaseHandler::error()
Return last error message
CDMBaseHandler::get()
Get safe data from database.
CDMBaseHandler::getall()
Get all data for object given id.
CDMBaseHandler::getError()
return last error number and message
CDMBaseHandler::getKey()
Get internal identifier (primary key) based on user visible code
CDMBaseHandler::insert()
Write an object back to the database
CDMBaseHandler::reload()
Reload object from database
CDMBaseHandler::setError()
Set error information
CDMBaseHandler::_create()
Must be overidden in ancestor to return a new object of the required kind (descendent of CDMBase)
CDMBaseHandler::_get()
Get data from the database and create a new object with it
CDMBaseHandler::_ins_insert()
OVERIDE in ancestor to provide an INSERT string for insert function
CDMBaseHandler::_ins_update()
OVERIDE in ancestor to provide an UPDATE string for insert function
CDMBaseHandler::_reload()
Return SQL string to reload an object from database

Class: XoopsObjectHandler

XoopsObjectHandler::XoopsObjectHandler()
called from child classes only
XoopsObjectHandler::create()
creates a new object
XoopsObjectHandler::delete()
delete obejct from database
XoopsObjectHandler::get()
gets a value object
XoopsObjectHandler::insert()
insert/update object

Class Details

[line 62]
Object handler for CDMSet



Tags:

copyright:  copyright © 2000 The XOOPS Project
author:  Kazumi Ono <onokazu@xoops.org>


[ Top ]


Class Methods


constructor Xbs_CdmCDMSetHandler [line 69]

Xbs_CdmCDMSetHandler Xbs_CdmCDMSetHandler( xoopsDB &$db)

Constructor



Parameters:

xoopsDB   &$db   Handle to xoopsDb object

[ Top ]

method countSets [line 188]

int countSets( )

Function: countSets

Count the number of Code Sets




Tags:

return:  number of sets
version:  1


[ Top ]

method delList [line 353]

boolean delList( mixed $setName, [string $lang = CDM_DEF_LANG], string $setName.)

Function: Delete a cached code->codevalue array list

To speed up html selector list retreival, we save a precompiled list to the database. This function deletes all lists for a code set from the database




Tags:

return:  True if successful else false
version:  1


Parameters:

string   $setName.   Name of set to look for
string   $lang   code set language to use

[ Top ]

method get [line 150]

void &get( string $set, [string $lang = CDM_DEF_LANG])

Safe data get



Overrides CDMBaseHandler::get() (Get safe data from database.)

Parameters:

string   $set   name of code set to retrieve
string   $lang   language set to use. Default CDM_DEF_LANG

[ Top ]

method getall [line 98]

Object &getall( string $set, [string $meta_row_flag = null], [string $code_row_flag = null], [mixed $lang = null])

Retrieve a set of data

Although you can use this method, it is better to use get() as it ensures you only retrieve 'Active' data.




Tags:

return:  CDMSet if OK, else FALSE on failure


Overrides CDMBaseHandler::getall() (Get all data for object given id.)

Parameters:

string   $set   The code set to load
string   $meta_row_flag   Option(CDM_RSTAT_ACT, ..SUS, ..DEF) Applies only to the meta data
string   $code_row_flag   Option(CDM_RSTAT_ACT, ..SUS, ..DEF) Applies to the code data

[ Top ]

method getAvailLanguage [line 245]

array getAvailLanguage( string $set)

Function: Return available languages for the set

Interrogates the code set to see what languages are defined for the set




Tags:

return:  array of language codes (langCode => Language Name)
version:  1


Parameters:

string   $set   name of set

[ Top ]

method getkey [line 154]

void &getkey( mixed $set, [mixed $lang = CDM_DEF_LANG])



[ Top ]

method getList [line 305]

mixed getList( mixed $setName, [mixed $fldName = 'cd_value'], [boolean $isAll = False], [boolean $isTree = False], [string $lang = CDM_DEF_LANG], string $setName., string $fldName.)

Function: Retrieve saved cache list

To speed up html selector list retreival, we save a precompiled list to the database. This function returns it to caller




Tags:

return:  array of code values if successful else false
version:  1


Parameters:

string   $setName.   Name of set to look for
string   $fldName.   Name of field being used for code display value
boolean   $isAll   If true then retrieve the complete code list else just the active data
boolean   $isTree   If true then the list a tree format selector, else it is an ordinary list
string   $lang   code set language to use

[ Top ]

method getSelectList [line 226]

array getSelectList( )

return an array of Active Setname, Setname pairs for use in a end user form select box



[ Top ]

method getSelectListAll [line 201]

array getSelectListAll( )

return an array of All Setname,Setname pairs for use in an admin user form select box



[ Top ]

method insert [line 176]

FALSE insert( )

Function insert - Does nothing. Use getCode and getMeta to instantiate CDM objects and then insert (save) them individually



Overrides CDMBaseHandler::insert() (Write an object back to the database)

[ Top ]

method isListLoaded [line 280]

boolean isListLoaded( mixed $setName, [mixed $fldName = 'cd_value'], [boolean $isAll = False], [boolean $isTree = False], [string $lang = CDM_DEF_LANG], string $setName., string $fldName.)

Function: Determine if a saved list of code-codevalue pairs has been saved todatabase

To speed up html selector list retreival, we save a precompiled list to the database. This function looks to see if one is available.




Tags:

return:  True if list exists else false
version:  1


Parameters:

string   $setName.   Name of set to look for
string   $fldName.   Name of field being used for code display value
boolean   $isAll   If true then retrieve the complete code list else just the active data
boolean   $isTree   If true then the list a tree format selector, else it is an ordinary list
string   $lang   code set language to use

[ Top ]

method reload [line 165]

FALSE reload( )

Function reload - overwrite ancestor. Does nothing



Overrides CDMBaseHandler::reload() (Reload object from database)

[ Top ]

method saveList [line 330]

boolean saveList( mixed $list, mixed $setName, [mixed $fldName = 'cd_value'], [boolean $isAll = False], [boolean $isTree = False], [string $lang = CDM_DEF_LANG], array $list., string $setName., string $fldName.)

Function: Save a code-codevalue array list to the database cache

To speed up html selector list retreival, we save a precompiled list to the database. This function saves the list to the database




Tags:

return:  True if successful else false
version:  1


Parameters:

array   $list.   array of code=>code value pairs to save
string   $setName.   Name of set to look for
string   $fldName.   Name of field being used for code display value
boolean   $isAll   If true then retrieve the complete code list else just the active data
boolean   $isTree   If true then the list a tree format selector, else it is an ordinary list
string   $lang   code set language to use

[ Top ]


Documentation generated on Fri, 03 Mar 2006 08:55:51 +0000 by phpDocumentor 1.3.0RC3