[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/registry/ -> registry.php (summary)

(no description)

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

Defines 1 class

JRegistry:: (16 methods):
  __construct()
  getInstance()
  makeNameSpace()
  getNameSpaces()
  getValue()
  setValue()
  loadArray()
  loadObject()
  loadFile()
  loadXML()
  loadINI()
  merge()
  toString()
  toArray()
  toObject()
  __clone()


Class: JRegistry  - X-Ref

JRegistry class

__construct($namespace = 'default')   X-Ref
Constructor

param: string    $namespace    Default registry namespace
return: void

getInstance($id, $namespace = 'default')   X-Ref
Returns a reference to a global JRegistry object, only creating it
if it doesn't already exist.

This method must be invoked as:
<pre>$registry =& JRegistry::getInstance($id[, $namespace]);</pre>

param: string    $id            An ID for the registry instance
param: string    $namespace    The default namespace for the registry object [optional]
return: object    The JRegistry object.

makeNameSpace($namespace)   X-Ref
Create a namespace

param: string    $namespace    Name of the namespace to create
return: boolean    True on success

getNameSpaces()   X-Ref
Get the list of namespaces

return: array    List of namespaces

getValue($regpath, $default=null)   X-Ref
Get a registry value

param: string    $regpath    Registry path (e.g. joomla.content.showauthor)
param: mixed    $default    Optional default value
return: mixed    Value of entry or null

setValue($regpath, $value)   X-Ref
Set a registry value

param: string    $regpath     Registry Path (e.g. joomla.content.showauthor)
param: mixed    $value        Value of entry
return: mixed    Value of old value or boolean false if operation failed

loadArray($array, $namespace = null)   X-Ref
Load a associative array of values into the default namespace

param: array    $array        Associative array of value to load
param: string    $namepsace     The name of the namespace
return: boolean    True on success

loadObject(&$object, $namespace = null)   X-Ref
Load the public variables of the object into the default namespace.

param: object    $object        The object holding the public vars to load
param: string    $namespace     Namespace to load the INI string into [optional]
return: boolean    True on success

loadFile($file, $format = 'INI', $namespace = null)   X-Ref
Load the contents of a file into the registry

param: string    $file        Path to file to load
param: string    $format        Format of the file [optional: defaults to INI]
param: string    $namespace    Namespace to load the INI string into [optional]
return: boolean    True on success

loadXML($data, $namespace = null)   X-Ref
Load an XML string into the registry into the given namespace [or default if a namespace is not given]

param: string    $data        XML formatted string to load into the registry
param: string    $namespace    Namespace to load the XML string into [optional]
return: boolean    True on success

loadINI($data, $namespace = null)   X-Ref
Load an INI string into the registry into the given namespace [or default if a namespace is not given]

param: string    $data        INI formatted string to load into the registry
param: string    $namespace    Namespace to load the INI string into [optional]
return: boolean True on success

merge(&$source)   X-Ref
Merge a JRegistry object into this one

param: object    $source    Source JRegistry object ot merge
return: boolean    True on success

toString($format = 'INI', $namespace = null, $params = null)   X-Ref
Get a namespace in a given string format

param: string    $format        Format to return the string in
param: string    $namespace    Namespace to return [optional: null returns the default namespace]
param: mixed    $params        Parameters used by the formatter, see formatters for more info
return: string    Namespace in string format

toArray($namespace = null)   X-Ref
Transforms a namespace to an array

param: string    $namespace    Namespace to return [optional: null returns the default namespace]
return: array    An associative array holding the namespace data

toObject($namespace = null)   X-Ref
Transforms a namespace to an object

param: string    $namespace    Namespace to return [optional: null returns the default namespace]
return: object    An an object holding the namespace data

__clone()   X-Ref
No description



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