[ Index ]
 

Code source de XOOPS 2.0.17.1

Accédez au Source d'autres logiciels libres

title

Body

[fermer]

/htdocs/kernel/ -> object.php (sommaire)

(pas de description)

Copyright: copyright © 2000 XOOPS.org
Poids: 685 lignes (22 kb)
Inclus ou requis: 1 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 2 classes

XoopsObject:: (23 méthodes):
  XoopsObject()
  setNew()
  unsetNew()
  isNew()
  setDirty()
  unsetDirty()
  isDirty()
  initVar()
  assignVar()
  assignVars()
  setVar()
  setVars()
  setFormVars()
  getVars()
  getValues()
  getVar()
  cleanVars()
  registerFilter()
  _loadFilters()
  xoopsClone()
  setErrors()
  getErrors()
  getHtmlErrors()

XoopsObjectHandler:: (5 méthodes):
  XoopsObjectHandler()
  create()
  get()
  insert()
  delete()


Classe: XoopsObject  - X-Ref

Base class for all objects in the Xoops kernel (and beyond)

XoopsObject()   X-Ref
constructor

normally, this is called from child classes only

setNew()   X-Ref
Pas de description

unsetNew()   X-Ref
Pas de description

isNew()   X-Ref
Pas de description

setDirty()   X-Ref
Pas de description

unsetDirty()   X-Ref
Pas de description

isDirty()   X-Ref
Pas de description

initVar($key, $data_type, $value = null, $required = false, $maxlength = null, $options = '')   X-Ref
initialize variables for the object

param: string $key
param: int $data_type  set to one of XOBJ_DTYPE_XXX constants (set to XOBJ_DTYPE_OTHER if no data type ckecking nor text sanitizing is required)
param: mixed
param: bool $required  require html form input?
param: int $maxlength  for XOBJ_DTYPE_TXTBOX type only
param: string $option  does this data have any select options?

assignVar($key, $value)   X-Ref
assign a value to a variable

param: string $key name of the variable to assign
param: mixed $value value to assign

assignVars($var_arr)   X-Ref
assign values to multiple variables in a batch

param: array $var_array associative array of values to assign

setVar($key, $value, $not_gpc = false)   X-Ref
assign a value to a variable

param: string $key name of the variable to assign
param: mixed $value value to assign
param: bool $not_gpc

setVars($var_arr, $not_gpc = false)   X-Ref
assign values to multiple variables in a batch

param: array $var_arr associative array of values to assign
param: bool $not_gpc

setFormVars($var_arr=null, $pref='xo_', $not_gpc=false)   X-Ref
Assign values to multiple variables in a batch

Meant for a CGI contenxt:
- prefixed CGI args are considered save
- avoids polluting of namespace with CGI args

param: array $var_arr associative array of values to assign
param: string $pref prefix (only keys starting with the prefix will be set)

getVars()   X-Ref
returns all variables for the object

return: array associative array of key->value pairs

getValues( $keys = null, $format = 's', $maxDepth = 1 )   X-Ref
Returns the values of the specified variables

param: mixed $keys An array containing the names of the keys to retrieve, or null to get all of them
param: string $format Format to use (see getVar)
param: int $maxDepth Maximum level of recursion to use if some vars are objects themselves
return: array associative array of key->value pairs

getVar($key, $format = 's')   X-Ref
returns a specific variable for the object in a proper format

param: string $key key of the object's variable to be returned
param: string $format format to use for the output
return: mixed formatted value of the variable

cleanVars()   X-Ref
clean values of all variables of the object for storage.
also add slashes whereever needed

return: bool true if successful

registerFilter($filtername)   X-Ref
dynamically register additional filter for the object

param: string $filtername name of the filter

_loadFilters()   X-Ref
load all additional filters that have been registered to the object


xoopsClone()   X-Ref
create a clone(copy) of the current object

return: object clone

setErrors($err_str)   X-Ref
add an error

param: string $value error to add

getErrors()   X-Ref
return the errors for this object as an array

return: array an array of errors

getHtmlErrors()   X-Ref
return the errors for this object as html

return: string html listing the errors

Classe: XoopsObjectHandler  - X-Ref

XOOPS object handler class.
This class is an abstract class of handler classes that are responsible for providing
data access mechanisms to the data source of its corresponsing data objects

XoopsObjectHandler(&$db)   X-Ref
called from child classes only

param: object $db reference to the {@link XoopsDatabase} object

create()   X-Ref
creates a new object


get($int_id)   X-Ref
gets a value object

param: int $int_id

insert(&$object)   X-Ref
insert/update object

param: object $object

delete(&$object)   X-Ref
delete obejct from database

param: object $object



Généré le : Sun Nov 25 11:44:32 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics