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

Class: CDMSet

Source Location: /modules/xbs_cdm/class/class.cdm.base.php

Class Overview

XoopsObject
   |
   --CDMBaseObject
      |
      --CDMSet

CDMSet object


Author(s):

  • Kazumi Ono (AKA onokazu)

Copyright:

  • copyright © 2000 XOOPS.org

Methods


Inherited Variables

Inherited Methods

Class: CDMBaseObject

CDMBaseObject::CDMBaseObject()
Constructor
CDMBaseObject::getCurrentDateTime()
Return date-time in format for insertion into timestamp field of row_dt
CDMBaseObject::setActive()
Make the object Active (default for all new objects)
CDMBaseObject::setDefunct()
Defunct the object (permanent measure to deactivate the object)
CDMBaseObject::setRowInfo()
Set the row information prior to an update/insert etc
CDMBaseObject::setSuspend()
Suspend the object (usually a temporary measure)

Class: XoopsObject

XoopsObject::XoopsObject()
constructor
XoopsObject::assignVar()
assign a value to a variable
XoopsObject::cleanVars()
clean values of all variables of the object for storage.
XoopsObject::getErrors()
return the errors for this object as an array
XoopsObject::getHtmlErrors()
return the errors for this object as html
XoopsObject::getVar()
returns a specific variable for the object in a proper format
XoopsObject::getVars()
returns all variables for the object
XoopsObject::initVar()
initialize variables for the object
XoopsObject::isDirty()
mark modified objects as dirty
XoopsObject::isNew()
used for new/clone objects
XoopsObject::registerFilter()
dynamically register additional filter for the object
XoopsObject::setDirty()
mark modified objects as dirty
XoopsObject::setErrors()
add an error
XoopsObject::setNew()
used for new/clone objects
XoopsObject::setVar()
assign a value to a variable
XoopsObject::unsetDirty()
mark modified objects as dirty
XoopsObject::unsetNew()
used for new/clone objects
XoopsObject::xoopsClone()
create a clone(copy) of the current object

Class Details

[line 421]
CDMSet object

Holds information about a complete code set. To instantiate this object use:

  1. $setHandler =& xoops_getmodulehandler("CDMSet",CDM_DIR);
  2. $setData =& $setHandler->get($id);

There is no insert() method for this object. This is therefore a read-only object. To write a meta set or code back to the database use the CDMMeta and CDMCode object methods.




Tags:

copyright:  copyright © 2000 XOOPS.org
author:  Kazumi Ono (AKA onokazu)


[ Top ]


Class Methods


constructor CDMSet [line 432]

CDMSet CDMSet( )

Constructor

The following variables are instantiated for access via ->getVar()

  1. $this->initVar('meta',XOBJ_DTYPE_OTHER,null);
  2. $this->initVar('code',XOBJ_DTYPE_OTHER,null);
The 'code' variable is an array of code objects




[ Top ]

method getAbrevCodeList [line 492]

array getAbrevCodeList( )

Function getAbrevCodeList() Returns the set of codes as a id, code, code_value, code_description, row_flag array usually to be used in a drop down list box on a form or similar



Tags:

return:  Indexed array of associative arrays containing abbreviated code list $ret[0..n]= array("id"=>,"cd"=>,"cd_value"=>, "cd_desc"=>)


[ Top ]

method getCodeEnum [line 479]

CDMCode getCodeEnum( $enum $enum)

Function getCodeEnum($enum) get the code identified by its array index



Tags:

return:  object else FALSE


Parameters:

$enum   $enum   position in the array of codes

[ Top ]

method getCodes [line 468]

array getCodes( )

Function getCodes() get the set of codes as an enumerated array of CDMCode objects



Tags:

return:  of CDMCode objects


[ Top ]

method getFullCodeList [line 506]

array getFullCodeList( )

Function getFullCodeList



Tags:

return:  The full data set for every code in the set in form of indexed array of associative arrays; $ret[0..n] = array();


[ Top ]

method getMeta [line 446]

CDMMeta getMeta( )

Function getMeta() Get the meta data for the set as a CDMMeta object



Tags:

return:  Object


[ Top ]

method getMetaData [line 455]

associative getMetaData( )

Function getMetaData() return the meta object data as associative array



Tags:

return:  array of values


[ Top ]

method getSelTreeList [line 538]

void getSelTreeList( [string $dispFld = 'cd_value'], [string $prefix = '-'])

Function getSelTreeList



Parameters:

string   $dispFld   name of field to use for displaying select option
string   $prefix  

character used to indent tree hiearchy

Creates and returns an array of the code set in tree order suitable for putting into a selection box


[ Top ]

method getTree [line 524]

XoopsObjectTree getTree( )

Function getCodeTree

Creates a XoopsObjectTree object of a hierarchical code set




[ Top ]


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