spunQ_ITypeStorage Interface Reference

An object that manages the storage of a type. More...

List of all members.

Public Member Functions
	getParent ()
	The parent storage for this one.
	getTypeName ()
	The type this object is managing.
	addMember (spunQ_Member $member)
	Adds a member to this type.
	getMemberStorage ($name, $throwException=true)
	Will get a single member storage for the member with given name.
	getMemberStorageRecursively ($name, $throwException=true)
	Like getMemberStorage(), but searches parent storages, too.
	getMemberStorages ()
	Gets all MemberStorages for this type, mapped by their member names.
	getMemberStoragesRecursively ()
	Like getMemberStorages(), but returns parent type storages members, too.

---

Detailed Description

An object that manages the storage of a type.

Todo:

Managing type storages is incomplete. There should be a function that forces this type storage to make all necessary adaptions to be able to hold the data of the changed type.

Definition at line 9 of file ITypeStorage.interface.php.

---

Member Function Documentation

spunQ_ITypeStorage::addMember

(

spunQ_Member $

member

)

Adds a member to this type.

Parameters:

$member

The member to add

Returns:

spunQ_ITypememberStorage

spunQ_ITypeStorage::getMemberStorage	(	$	name,
		$	throwException = true
	)

Will get a single member storage for the member with given name.

Parameters:

	$name	The name of the member.
	$throwException	Whether the function should throw an exception if the member was not found. Will return NULL if false and member storage was not found.

Returns:

spunQ_ITypeMemberStorage

Exceptions:

spunQ_DatabaseException

If member storage does not exist.

spunQ_ITypeStorage::getMemberStorageRecursively	(	$	name,
		$	throwException = true
	)

Like getMemberStorage(), but searches parent storages, too.

Parameters:

	$name	The name of the member.
	$throwException	Whether the function should throw an exception if the member was not found. Will return NULL if false and member storage was not found.

Returns:

strg_MysqlTypeMemberStorageV50S10

Exceptions:

spunQ_DatabaseException

If member storage does not exist.

spunQ_ITypeStorage::getMemberStorages

(

)

Gets all MemberStorages for this type, mapped by their member names.

Returns:

map<string,spunQ_ITypeMemberStorage>

spunQ_ITypeStorage::getMemberStoragesRecursively

(

)

Like getMemberStorages(), but returns parent type storages members, too.

Returns:

map<string,spunQ_ITypeMemberStorage>

spunQ_ITypeStorage::getParent

(

)

The parent storage for this one.

Returns:

spunQ_ITypeStorage

spunQ_ITypeStorage::getTypeName

(

)

The type this object is managing.

Returns:

string

---

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

• ITypeStorage.interface.php