Class XoopsObject

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

Direct known subclasses

ArtObject, PmMessage, SystemBlockLinkModule, SystemSmilies, SystemUserrank, XoopsAvatar, XoopsCacheModelObject, XoopsComment, XoopsComments, XoopsConfigCategory, XoopsConfigItem, XoopsConfigOption, ProfileCategory, XoopsGroup, XoopsGroupPerm, XoopsImage, XoopsImagecategory, XoopsImageSet, XoopsImagesetimg, XoopsMembership, XoopsModule, XoopsNotification, XoopsPrivmessage, ProfileField, XoopsRank, XoopsTplfile, XoopsTplset, XoopsUser, ProfileProfile, ProfileRegstep, ProfileVisibility, SystemBanner, SystemBannerclient, SystemBannerFinish

Indirect known subclasses

SystemAvatar, SystemGroup, SystemUsers, XoopsGuestUser, XoUser

Package: kernel
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
Author: Taiwen Jiang phppp@users.sourceforge.net
Located at ernel/object.php

Methods summary
`public`	# `__construct( )` constructor constructor normally, this is called from child classes only
`public`	# `XoopsObject( )` PHP 4 style constructor compatibility shim PHP 4 style constructor compatibility shim Deprecated all callers should be using parent::__construct()
`public`	# `setNew( )` #@+ used for new/clone objects #@+ used for new/clone objects
`public`	# `unsetNew( )`
`public boolean`	# `isNew( )` Returns boolean
`public`	# `setDirty( )` #@+ mark modified objects as dirty #@+ mark modified objects as dirty used for modified objects only
`public`	# `unsetDirty( )`
`public boolean`	# `isDirty( )` Returns boolean
`public`	# `initVar( string $key, integer $data_type, null $value = null, boolean $required = false, integer $maxlength = null, string $options = '', string $enumerations = '' )` initialize variables for the object initialize variables for the object YOU SHOULD NOT USE THE $enumeration PARAMETER Parameters `$key` `$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) `$value` `$required` require html form input? `$maxlength` for XOBJ_DTYPE_TXTBOX type only `$options` `$enumerations`
`public`	# `assignVar( string $key, mixed $value )` assign a value to a variable assign a value to a variable Parameters `$key` name of the variable to assign `$value` value to assign
`public`	# `assignVars( $var_arr )` assign values to multiple variables in a batch assign values to multiple variables in a batch Parameters `$var_arr`
`public`	# `setVar( string $key, mixed $value, boolean $not_gpc = false )` assign a value to a variable assign a value to a variable Parameters `$key` name of the variable to assign `$value` value to assign `$not_gpc`
`public`	# `setVars( array $var_arr, boolean $not_gpc = false )` assign values to multiple variables in a batch assign values to multiple variables in a batch Parameters `$var_arr` associative array of values to assign `$not_gpc`
`public boolean`	# `destroyVars( mixed $var )` unset variable(s) for the object unset variable(s) for the object Parameters `$var` Returns boolean
`public boolean`	# `destoryVars( $var )` Deprecated use destroyVars() instead, destoryVars() will be removed in the next major release Parameters `$var` Returns boolean
`public`	# `setFormVars( array $var_arr = null, string $pref = 'xo_', boolean $not_gpc = false )` Assign values to multiple variables in a batch 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 Parameters `$var_arr` associative array of values to assign `$pref` prefix (only keys starting with the prefix will be set) `$not_gpc`
`public array &`	# `getVars( )` returns all variables for the object returns all variables for the object Returns array associative array of key->value pairs
`public array`	# `getValues( mixed $keys = null, string $format = 's', integer $maxDepth = 1 )` Returns the values of the specified variables Returns the values of the specified variables Parameters `$keys` An array containing the names of the keys to retrieve, or null to get all of them `$format` Format to use (see getVar) `$maxDepth` Maximum level of recursion to use if some vars are objects themselves Returns array associative array of key->value pairs
`public mixed`	# `getVar( string $key, string $format = 's' )` returns a specific variable for the object in a proper format returns a specific variable for the object in a proper format YOU SHOULD NOT USE ANY OF THE UNICODE TYPES, THEY WILL BE REMOVED Parameters `$key` key of the object's variable to be returned `$format` format to use for the output Returns mixed formatted value of the variable
`public boolean`	# `cleanVars( )` clean values of all variables of the object for storage. also add slashes wherever needed 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 Returns boolean true if successful
`public`	# `registerFilter( string $filtername )` dynamically register additional filter for the object dynamically register additional filter for the object Deprecated \XoopsObject::registerFilter is deprecated since XOOPS 2.5.8 and will be removed in the next major release Parameters `$filtername` name of the filter
`public`	# `_loadFilters( )` load all additional filters that have been registered to the object load all additional filters that have been registered to the object
`public`	# `loadFilters( string $method )` load all local filters for the object 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 Deprecated \XoopsObject::loadFilters is deprecated since XOOPS 2.5.8 and will be removed in the next major release Parameters `$method` function or action name
`public object`	# `xoopsClone( )` create a clone(copy) of the current object create a clone(copy) of the current object Returns object clone
`public`	# `__clone( )` Adjust a newly cloned object Adjust a newly cloned object
`public`	# `setErrors( $err_str )` add an error add an error Parameters `$err_str`
`public array`	# `getErrors( )` return the errors for this object as an array return the errors for this object as an array Returns array an array of errors
`public string`	# `getHtmlErrors( )` return the errors for this object as html return the errors for this object as html Returns string html listing the errors
`public array`	# `toArray( )` Returns an array representation of the object Returns an array representation of the object Deprecated, use getValues() directly Returns array

Properties summary
`public array`	`$vars` holds all variables(properties) of an object holds all variables(properties) of an object	# `array()`
`public array`	`$cleanVars` variables cleaned for store in DB variables cleaned for store in DB	# `array()`
`public boolean`	`$_isNew` is it a newly created object? is it a newly created object?	# `false`
`public boolean`	`$_isDirty` has any of the values been modified? has any of the values been modified?	# `false`
`public array`	`$_errors` errors errors	# `array()`
`public array`	`$_filters` additional filters registered dynamically by a child class object additional filters registered dynamically by a child class object	# `array()`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsObject

Direct known subclasses

Indirect known subclasses

Deprecated

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Deprecated

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Deprecated

Parameters

Deprecated

Parameters

Returns

Parameters

Returns

Returns

Returns