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

Class: CDMCode

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

Class Overview

XoopsObject
   |
   --CDMBaseObject
      |
      --CDMCode

Code object


Author(s):

  • Kazumi Ono (AKA onokazu)

Copyright:

  • copyright © 2000 XOOPS.org

Methods


Child classes:

EUVat
VAT object

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 208]
Code object

A code is a single item in a code set. To instantiate this object use:

  1. $codeHandler =& xoops_getmodulehandler("CDMCode",CDM_DIR);
  2. $codeData =& $codeHandler->get($id);




Tags:

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


[ Top ]


Class Methods


constructor CDMCode [line 230]

CDMCode CDMCode( )

Constructor

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

  1. $this->initVar('id',XOBJ_DTYPE_INT,null,TRUE);
  2. $this->initVar('cd_set',XOBJ_DTYPE_TXTBOX,null,TRUE,10);
  3. $this->initVar('cd_lang',XOBJ_DTYPE_TXTBOX,null,TRUE,10);
  4. $this->initVar('cd',XOBJ_DTYPE_TXTBOX,null,TRUE,10);
  5. $this->initVar('cd_prnt',XOBJ_DTYPE_TXTBOX,null,FALSE,10);
  6. $this->initVar('cd_value',XOBJ_DTYPE_TXTBOX,null,TRUE,50);
  7. $this->initVar('cd_desc',XOBJ_DTYPE_TXTAREA,null,FALSE,255);
  8. $this->initVar('cd_param',XOBJ_DTYPE_TXTAREA,null,FALSE,255);
  9. $this->initVar('_kidsint',XOBJ_DTYPE_OTHER,null);
  10. $this->initVar('_kidscode',XOBJ_DTYPE_OTHER,null);
  11. $this->initVar('_cd_type',XOBJ_DTYPE_OTHER,null);//code data type
  12. $this->initVar('_cd_len',XOBJ_DTYPE_OTHER,null);//code data lenth
  13. $this->initVar('_val_type',XOBJ_DTYPE_OTHER,null);//value data type
  14. $this->initVar('_val_len',XOBJ_DTYPE_OTHER,null);




[ Top ]

method getKidsHtml [line 346]

string getKidsHtml( )

Return an html string of the list of child codes with hyperlinks to edit the child code.

Codes are displayed in rows of 5 codes per line




Tags:

return:  html string


[ Top ]

method getVar [line 260]

mixed &getVar( string $key, [string $format = 's'])

Function: Overide of ancestor getVar

Checks for cd and cd_value and converts to correct data type




Tags:

return:  formatted value of variable
version:  1


Overrides XoopsObject::getVar() (returns a specific variable for the object in a proper format)

Parameters:

string   $key   key of objects variable to be retrieved
string   $format   format to use for the output (see XoopsObject::getVar for details)

[ Top ]

method get_kidscodes [line 329]

string get_kidscodes( )

Returns child codes (kids) as a comma seperated string list of codes



[ Top ]

method get_kidsinternal [line 315]

string get_kidsinternal( )

Returns child codes (kids) as a comma seperated string list of internal identifiers



[ Top ]


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