oxUtilsObject Class Reference

Inheritance diagram for oxUtilsObject:

Collaboration diagram for oxUtilsObject:

List of all members.

Public Member Functions
	oxNew ($sClassName)
	oxNewArticle ($sOxID, $aProperties=array())
	resetInstanceCache ($sClassName=null)
	generateUId ()
	getClassName ($sClassName)
	isModuleActive ($sClassName, $sModuleName)
Static Public Member Functions
static	getInstance ()
Protected Member Functions
	_getObject ($sClassName, $iArgCnt, $aParams)
	_getActiveModuleChain ($aClassChain)
	_disableModule ($sModule)
Protected Attributes
	$_aClassNameCache = array()
Static Protected Attributes
static	$_aLoadedArticles = array()
static	$_aInstanceCache = array()
Private Member Functions
	_makeSafeModuleClassParents ($aClassChain, $sBaseModule)
Static Private Attributes
static	$_instance = null

---

Detailed Description

object manipulation class

Definition at line 6 of file oxutilsobject.php.

---

Member Function Documentation

oxUtilsObject._disableModule

(

$

sModule

)

[protected]

Disables module, adds to aDisabledModules config.

Parameters:

array

$sModule Module name

Returns:

null

Definition at line 328 of file oxutilsobject.php.

oxUtilsObject._getActiveModuleChain

(

$

aClassChain

)

[protected]

Checks if module is disabled, added to aDisabledModules config.

Parameters:

array

$aClassChain Module names

Returns:

array

Definition at line 298 of file oxutilsobject.php.

oxUtilsObject._getObject	(	$	sClassName,
		$	iArgCnt,
		$	aParams
	)			[protected]

Creates object with dynamic constructor parameters. If parameter count > 5 - exception is thrown

Parameters:

	string	$sClassName class name
	int	$iArgCnt argument count
	array	$aParams constructor parameters

Exceptions:

oxSystemComponentException

in case parameters count > 5

Returns:

mixed

Definition at line 123 of file oxutilsobject.php.

oxUtilsObject._makeSafeModuleClassParents	(	$	aClassChain,
		$	sBaseModule
	)			[private]

Creates middle classes if needed.

Parameters:

	array	$aClassChain Module names
	string	$sBaseModule Oxid base class

Exceptions:

oxSystemComponentException

missing system component exception

Returns:

string

Definition at line 345 of file oxutilsobject.php.

oxUtilsObject.generateUId

(

)

Returns generated unique ID.

Returns:

string

Definition at line 213 of file oxutilsobject.php.

oxUtilsObject.getClassName

(

$

sClassName

)

Returns name of class file, according to class name.

Parameters:

string

$sClassName Class name

Returns:

string

Definition at line 227 of file oxutilsobject.php.

static oxUtilsObject.getInstance

(

)

[static]

Returns object instance

Returns:

oxutilsobject

Definition at line 41 of file oxutilsobject.php.

oxUtilsObject.isModuleActive	(	$	sClassName,
		$	sModuleName
	)

Returns if modul exists.

Parameters:

	string	$sClassName Class name
	string	$sModuleName Modul name

Deprecated:

in 4.6.0, since 2012-03-28; use oxModule.isActive()

Returns:

bool

Definition at line 272 of file oxutilsobject.php.

oxUtilsObject.oxNew

(

$

sClassName

)

Creates and returns new object. If creation is not available, dies and outputs error message.

Parameters:

string

$sClassName Name of class

Exceptions:

oxSystemComponentException

in case that class does not exists

Returns:

object

Definition at line 71 of file oxutilsobject.php.

oxUtilsObject.oxNewArticle	(	$	sOxID,
		$	aProperties = array()
	)

Creates and returns oxarticle (or subclass) object.

Parameters:

	string	$sOxID ID to load subclass type from database
	array	$aProperties array of properties to assign

Returns:

object

Definition at line 165 of file oxutilsobject.php.

oxUtilsObject.resetInstanceCache

(

$

sClassName = null

)

Resests instance cache

Parameters:

string

$sClassName class name in the cache

Returns:

null;

Definition at line 191 of file oxutilsobject.php.

---

Member Data Documentation

oxUtilsObject.$_aClassNameCache = array() [protected]

Definition at line 13 of file oxutilsobject.php.

oxUtilsObject.$_aInstanceCache = array() [static, protected]

Definition at line 27 of file oxutilsobject.php.

oxUtilsObject.$_aLoadedArticles = array() [static, protected]

Definition at line 20 of file oxutilsobject.php.

oxUtilsObject.$_instance = null [static, private]

Definition at line 34 of file oxutilsobject.php.

---

The documentation for this class was generated from the following file:

• core/oxutilsobject.php