[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Object/ -> CMSObject.php (summary)

Joomla! Content Management System

Copyright: (C) 2005 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 230 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CMSObject:: (10 methods):
  __construct()
  __toString()
  def()
  get()
  getProperties()
  getError()
  getErrors()
  set()
  setProperties()
  setError()


Class: CMSObject  - X-Ref

Joomla Platform Object Class

This class allows for simple but smart objects with get and set methods
and an internal error handler.

__construct($properties = null)   X-Ref
Class constructor, overridden in descendant classes.

param: mixed  $properties  Either and associative array or another

__toString()   X-Ref
Magic method to convert the object to a string gracefully.

return: string  The classname.

def($property, $default = null)   X-Ref
Sets a default value if not already assigned

param: string  $property  The name of the property.
param: mixed   $default   The default value.
return: mixed

get($property, $default = null)   X-Ref
Returns a property of the object or the default value if the property is not set.

param: string  $property  The name of the property.
param: mixed   $default   The default value.
return: mixed    The value of the property.

getProperties($public = true)   X-Ref
Returns an associative array of object properties.

param: boolean  $public  If true, returns only the public properties.
return: array

getError($i = null, $toString = true)   X-Ref
Get the most recent error message.

param: integer  $i         Option error index.
param: boolean  $toString  Indicates if Exception objects should return their error message.
return: string   Error message

getErrors()   X-Ref
Return all errors, if any.

return: array  Array of error messages.

set($property, $value = null)   X-Ref
Modifies a property of the object, creating it if it does not already exist.

param: string  $property  The name of the property.
param: mixed   $value     The value of the property to set.
return: mixed  Previous value of the property.

setProperties($properties)   X-Ref
Set the object properties based on a named array/hash.

param: mixed  $properties  Either an associative array or another object.
return: boolean

setError($error)   X-Ref
Add an error message.

param: string  $error  Error message.
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer