[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/base/ -> object.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: object.php 14401 2010-01-26 14:10:00Z louis $
File Size: 227 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JObject:: (11 methods):
  JObject()
  __construct()
  get()
  getProperties()
  getError()
  getErrors()
  set()
  setProperties()
  setError()
  toString()
  getPublicProperties()


Class: JObject  - X-Ref

Object class, allowing __construct in PHP4.

JObject()   X-Ref
A hack to support __construct() on PHP 4

Hint: descendant classes have no PHP4 class_name() constructors,
so this constructor gets called first and calls the top-layer __construct()
which (if present) should call parent::__construct()

return: Object

__construct()   X-Ref
Class constructor, overridden in descendant classes.


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 JError objects should return their error message
return: string    Error message

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

return: array    Array of error messages or JErrors

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: $array  mixed Either and associative array or another object
return: boolean

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

param: string $error Error message

toString()   X-Ref
Object-to-string conversion.
Each class can override it as necessary.

return: string This name of this class

getPublicProperties()   X-Ref
Legacy Method, use {@link JObject::getProperties()}  instead




Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1