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

Class: CDMBaseObject

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

Class Overview

XoopsObject
   |
   --CDMBaseObject

Adds row management for all CDM objects


Author(s):

  • Kazumi Ono (AKA onokazu)

Copyright:

  • copyright © 2000 XOOPS.org

Methods


Child classes:

CDMCode
Code object
CDMMeta
CDMMeta Object
CDMSet
CDMSet object

Inherited Variables

Inherited Methods

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 76]
Adds row management for all CDM objects

Although the attributes are declared below in this class the ancestor classes to this will have to deal with them so this is an abstract class

 The following settings of $object->isDirty and $object->isNew
 may be helpful to users. NB operations may involve using the object handler
After Operation isDirty isNew operation returns
----------------- ------- --------- --------------------------
&create FALSE TRUE object or FALSE if failure
&get FALSE FALSE TRUE on success else FALSE
reload FALSE FALSE TRUE on success else FALSE
Data item changed TRUE Undefined TRUE on success else FALSE
Success insert FALSE FALSE TRUE
Fail insert TRUE Undefined FALSE
delete FALSE FALSE TRUE on success else FALSE




Tags:

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


[ Top ]


Class Methods


constructor CDMBaseObject [line 88]

CDMBaseObject CDMBaseObject( )

Constructor

The following variables are set for retrieval with ->getVar()

  1. $this->initVar('row_flag',XOBJ_DTYPE_OTHER,null,TRUE);
  2. $this->initVar('row_uid',XOBJ_DTYPE_INT,null,TRUE);
  3. $this->initVar('row_dt',XOBJ_DTYPE_OTHER,null,TRUE);




[ Top ]

method getCurrentDateTime [line 153]

datatime getCurrentDateTime( )

Return date-time in format for insertion into timestamp field of row_dt



Tags:

return:  format = yyyy-mm-dd hh:mm:ss


[ Top ]

method setActive [line 137]

boolean setActive( )

Make the object Active (default for all new objects)



Tags:

return:  TRUE if status changed else FALSE


[ Top ]

method setDefunct [line 105]

boolean setDefunct( )

Defunct the object (permanent measure to deactivate the object)



Tags:

return:  TRUE if status changed else FALSE


[ Top ]

method setRowInfo [line 189]

void setRowInfo( )

Set the row information prior to an update/insert etc



[ Top ]

method setSuspend [line 121]

boolean setSuspend( )

Suspend the object (usually a temporary measure)



Tags:

return:  TRUE if status changed else FALSE


[ Top ]


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