Référence de la classe XoopsObject

Graphe d'héritage de XoopsObject:

Fonctions membres publiques
	__construct ()
	XoopsObject ()
	setNew ()
	unsetNew ()
	isNew ()
	setDirty ()
	unsetDirty ()
	isDirty ()
	initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='', $enumerations='')
	assignVar ($key, $value)
	assignVars ($var_arr)
	setVar ($key, $value, $not_gpc=false)
	setVars ($var_arr, $not_gpc=false)
	destroyVars ($var)
	destoryVars ($var)
	setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
&	getVars ()
	getValues ($keys=null, $format='s', $maxDepth=1)
	getVar ($key, $format='s')
	cleanVars ()
	registerFilter ($filtername)
	_loadFilters ()
	loadFilters ($method)
	xoopsClone ()
	__clone ()
	setErrors ($err_str)
	getErrors ()
	getHtmlErrors ()
	toArray ()

Champs de données
	$vars = array()
	$cleanVars = array()
	$_isNew = false
	$_isDirty = false
	$_errors = array()
	$_filters = array()

Description détaillée

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

Documentation des constructeurs et destructeur

__construct()

__construct

(

)

constructor

normally, this is called from child classes only

@access public

Réimplémentée dans XoopsMembership, XoopsCacheModelObject, XoUser, XoopsRank, XoopsConfigItem, XoopsModule, ArtObject, XoopsImagecategory, XoopsNotification, XoopsImageSet, XoopsGroupPerm, XoopsTplfile, XoopsAvatar, XoopsConfigCategory, XoopsTplset, XoopsComment, XoopsConfigOption, XoopsPrivmessage, PmMessage, SystemGroup, XoopsGroup, XoopsImage, XoopsImagesetimg, SystemAvatar, SystemBanner, SystemBannerclient, SystemBannerFinish, SystemSmilies, ProfileCategory, ProfileField, SystemBlock, SystemUserrank, SystemUsers, ProfileRegstep, ProfileVisibility, et SystemBlockLinkModule.

Voici le graphe des appelants de cette fonction :

Documentation des fonctions membres

__clone()

__clone

(

)

Adjust a newly cloned object

Voici le graphe d'appel pour cette fonction :

_loadFilters()

_loadFilters

(

)

load all additional filters that have been registered to the object

@access private

Voici le graphe des appelants de cette fonction :

assignVar()

assignVar	(		$key,
			$value
	)

assign a value to a variable

@access public

Paramètres

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

assignVars()

assignVars

(

$var_arr

)

assign values to multiple variables in a batch

@access private

Paramètres

$var_arr

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

cleanVars()

cleanVars

(

)

clean values of all variables of the object for storage. also add slashes wherever needed

YOU SHOULD NOT USE ANY OF THE UNICODE TYPES, THEY WILL BE REMOVED

Renvoie

bool true if successful @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

destoryVars()

destoryVars

(

$var

)

Paramètres

$var

Renvoie

bool

Obsolète:

use destroyVars() instead, destoryVars() will be removed in the next major release

Voici le graphe d'appel pour cette fonction :

destroyVars()

destroyVars

(

$var

)

unset variable(s) for the object

@access public

Paramètres

mixed

$var

Renvoie

bool

Voici le graphe des appelants de cette fonction :

getErrors()

getErrors

(

)

return the errors for this object as an array

Renvoie

array an array of errors @access public

Voici le graphe des appelants de cette fonction :

getHtmlErrors()

getHtmlErrors

(

)

return the errors for this object as html

Renvoie

string html listing the errors @access public

getValues()

getValues	(		$keys = null,
			$format = 's',
			$maxDepth = 1
	)

Returns the values of the specified variables

Paramètres

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

Renvoie

array associative array of key->value pairs

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getVar()

getVar	(		$key,
			$format = 's'
	)

returns a specific variable for the object in a proper format

YOU SHOULD NOT USE ANY OF THE UNICODE TYPES, THEY WILL BE REMOVED

@access public

Paramètres

string	$key	key of the object's variable to be returned
string	$format	format to use for the output

Renvoie

mixed formatted value of the variable

Réimplémentée dans ProfileField.

Voici le graphe d'appel pour cette fonction :

getVars()

& getVars

(

)

returns all variables for the object

@access public

Renvoie

array associative array of key->value pairs

initVar()

initVar	(		$key,
			$data_type,
			$value = null,
			$required = false,
			$maxlength = null,
			$options = '',
			$enumerations = ''
	)

initialize variables for the object

YOU SHOULD NOT USE THE $enumeration PARAMETER

@access public

Paramètres

string	$key
int	$data_type	set to one of XOBJ_DTYPE_XXX constants (set to XOBJ_DTYPE_OTHER if no data type checking nor text sanitizing is required)
null	$value
bool	$required	require html form input?
int	$maxlength	for XOBJ_DTYPE_TXTBOX type only
string	$options
string	$enumerations

Renvoie

void

Voici le graphe des appelants de cette fonction :

isDirty()

isDirty

(

)

Renvoie

bool

Voici le graphe des appelants de cette fonction :

isNew()

isNew

(

)

Renvoie

bool

Voici le graphe des appelants de cette fonction :

loadFilters()

loadFilters

(

$method

)

load all local filters for the object

Filter distribution: In each module folder there is a folder "filter" containing filter files with, filename: [name_of_target_class][.][function/action_name][.php]; function name: [dirname][_][name_of_target_class][_][function/action_name]; parameter: the target object

Paramètres

string

$method

function or action name

Obsolète:

\XoopsObject::loadFilters is deprecated since XOOPS 2.5.8 and will be removed in the next major release

Voici le graphe d'appel pour cette fonction :

registerFilter()

registerFilter

(

$filtername

)

dynamically register additional filter for the object

Paramètres

string

$filtername

name of the filter

Obsolète:

\XoopsObject::registerFilter is deprecated since XOOPS 2.5.8 and will be removed in the next major release

setDirty()

setDirty

(

)

*#+ mark modified objects as dirty

used for modified objects only

@access public

Voici le graphe des appelants de cette fonction :

setErrors()

setErrors

(

$err_str

)

add an error

Paramètres

$err_str

Voici le graphe des appelants de cette fonction :

setFormVars()

XOOPS x a Bootstrap v4 based do not add br tags on new line characters if text contains HTML Fix error in Group administration causing unrequested Description changes during edit Fix inconsistencies in XoopsMultiMailer Fix broken caching in Smarty xoMemberInfo function Fix corruption of chosen options in Blocks administration Attempt graceful failure on missing theme Fix active hyperlink on space between icons in admin form module script php font and color when focus lost Handle negative ini sizes properly in upload file replace with appropriate Xmf Request geekwright Deprecate setFormVars	(		$var_arr = null,
			$pref = 'xo_',
			$not_gpc = false
	)

Assign values to multiple variables in a batch

Meant for a CGI context:

• prefixed CGI args are considered save
• avoids polluting of namespace with CGI args

Paramètres

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

Renvoie

void

Obsolète:

This method will be removed in the next major XOOPS version

Voici le graphe d'appel pour cette fonction :

setNew()

setNew

(

)

*#+ used for new/clone objects

@access public

Voici le graphe des appelants de cette fonction :

setVar()

setVar	(		$key,
			$value,
			$not_gpc = false
	)

assign a value to a variable

@access public

Paramètres

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

Réimplémentée dans ProfileField.

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

setVars()

setVars	(		$var_arr,
			$not_gpc = false
	)

assign values to multiple variables in a batch

@access private

Paramètres

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

Voici le graphe d'appel pour cette fonction :

toArray()

toArray

(

)

Returns an array representation of the object

Deprecated, use getValues() directly

Renvoie

array

Voici le graphe d'appel pour cette fonction :

unsetDirty()

unsetDirty

(

)

Voici le graphe des appelants de cette fonction :

unsetNew()

unsetNew

(

)

Voici le graphe des appelants de cette fonction :

xoopsClone()

xoopsClone

(

)

create a clone(copy) of the current object

@access public

Renvoie

object clone

XoopsObject()

XoopsObject

(

)

PHP 4 style constructor compatibility shim

Obsolète:

all callers should be using parent::__construct()

Voici le graphe d'appel pour cette fonction :

Documentation des champs

$_errors

$_errors = array()

$_filters

$_filters = array()

additional filters registered dynamically by a child class object

@access private

$_isDirty

$_isDirty = false

$_isNew

$_isNew = false

$cleanVars

$cleanVars = array()

$vars

$vars = array()

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• XoopsCore25-2.5.11-Beta1/htdocs/kernel/object.php
• XoopsCore25-2.5.11-Beta1/docs/changelog.250.txt