spunQ_DeleteQuery Class Reference

A generic delete query. More...

Inheritance diagram for spunQ_DeleteQuery:

List of all members.

Public Member Functions
	execute ($parameters=array(), $connection=NULL)
	Executes this query on given database connection.
	__call ($functionName, $arguments)
	Overloaded to provide automatic getters and setters.
	__sleep ()
	Replaces $_type with the type's name.
	_verifyMembers ($omittedMembers=array(), $throwException=true)
	Verifies that all members are valid.
	_getMember ($name)
	Gets the value of a member of this object.
	_setMember ($name, $value)
	Sets the value of a member of this object.
	_getType ($throwException=true)
	Gets the type of this object.
Static Public Member Functions
static	valueByProperty ($value, $path)
	Transforms a value using a property path.
static	propertyOfValue ($value, $property)
	Gets a single property of a value.
Protected Member Functions
	handleGetUntranslated ($memberName, $arguments, $functionName)
	Needed by __call().
	handleGet ($memberName, $arguments, $functionName)
	Needed by __call().
	initLocalizedMember ($memberName)
	Makes sure a localized member contains a spunQ_Map.
	handleGetFromArray ($memberName, $arguments, $functionName)
	Needed by __call().
	handleSet ($memberName, $arguments, $functionName)
	Needed by __call().
	handleAdd ($memberName, $arguments, $functionName)
	Needed by __call().
	handleRemove ($memberName, $arguments, $functionName)
	Needed by __call().
Protected Attributes
	$type
	The name of the type this query is for.
	$conditions = array()
	Conditions to this query (i.e.
	$returnAffectedIds = false
	Whether the query should return the affected ids upon execution.
	$_type
	The actual type of this object.

---

Detailed Description

A generic delete query.

Definition at line 6 of file DeleteQuery.type.php.

---

Member Function Documentation

spunQ_DataObject::__call	(	$	functionName,
		$	arguments
	)			[inherited]

Overloaded to provide automatic getters and setters.

Parameters:

	$functionName	The function that was called.
	$arguments	Array containing the arguments that were passed to the function.

Exceptions:

spunQ_BadArgumentCountError

Definition at line 148 of file DataObject.type.php.

spunQ_DataObject::__sleep

(

)

[inherited]

Replaces $_type with the type's name.

Returns:

array<string>

Reimplemented in spunQ_ArrayType, spunQ_MapType, and spunQ_SetType.

Definition at line 178 of file DataObject.type.php.

spunQ_DataObject::_getMember

(

$

name

)

[inherited]

Gets the value of a member of this object.

Will check if the object has a getter for the member and will use that method for getting the value. Otherwise, the value of the object member is returned.

Parameters:

$name

The name of the member.

Returns:

any Whatever type the member has.

Definition at line 478 of file DataObject.type.php.

spunQ_DataObject::_getType

(

$

throwException = true

)

[inherited]

Gets the type of this object.

Returns:

spunQ_Type

Definition at line 507 of file DataObject.type.php.

spunQ_DataObject::_setMember	(	$	name,
		$	value
	)			[inherited]

Sets the value of a member of this object.

Will check if the object has a setter for the member and will use that method for setting the value. Otherwise, the object member is set directly.

Parameters:

	$name	The name of the member.
	$value	The value to set it to.

Returns:

spunQ_DataObject $this

Definition at line 495 of file DataObject.type.php.

spunQ_DataObject::_verifyMembers	(	$	omittedMembers = array(),
		$	throwException = true
	)			[inherited]

Verifies that all members are valid.

This function is called from various modules prior to critical actions requiring a complete object - like inserting into a database.

Parameters:

	$omittedMembers	Do not perform checks on these member names.
	$throwException	Whether an exception should be thrown if a member does not have a valid value.

Returns:

boolean

Exceptions:

spunQ_IllegalValueException

Definition at line 458 of file DataObject.type.php.

spunQ_DeleteQuery::execute	(	$	parameters = array(),
		$	connection = NULL
	)

Executes this query on given database connection.

Parameters:

$connection

The connection to issue this query on.

Returns:

any If $this->returnAffectedIds is true, this will return an array of integers representing the ids of the affected objects. Otherwise the return value will be NULL.

Definition at line 36 of file DeleteQuery.type.php.

spunQ_DataObject::handleAdd	(	$	memberName,
		$	arguments,
		$	functionName
	)			[protected, inherited]

Needed by __call().

Will take care of function calls starting with 'add'.

Parameters:

	$memberName	The name of the member that is possibly being appended to. Merely the name of the function without the leading 'add', with a lower-case first letter.
	$arguments	Array containing the arguments that were passed to the function.
	$functionName	The function that was called.

Returns:

spunQ_DataObject $this

Exceptions:

	spunQ_BadArgumentCountError
	spunQ_InvalidArgumentError

Reimplemented in spunQ_StorableObject.

Definition at line 327 of file DataObject.type.php.

spunQ_DataObject::handleGet	(	$	memberName,
		$	arguments,
		$	functionName
	)			[protected, inherited]

Needed by __call().

Will take care of function calls starting with 'get'.

Todo:

spunQ_CollectionType instead of spunQ_ArrayType(?)

Parameters:

	$memberName	The name of the member that was possibly requested. Merely the name of the function without the leading 'get', with a lower-case first letter.
	$arguments	Array containing the arguments that were passed to the function.
	$functionName	The name of the function that was called.

Returns:

any Whatever type the member has.

Reimplemented in spunQ_StorableObject.

Definition at line 217 of file DataObject.type.php.

spunQ_DataObject::handleGetFromArray	(	$	memberName,
		$	arguments,
		$	functionName
	)			[protected, inherited]

Needed by __call().

Will take care of getter functions, where the member has an array type.

See also:

handleGet()

Parameters:

	$memberName	The name of the member that was possibly requested. Merely the name of the function without the leading 'set', with a lower-case first letter.
	$arguments	Array containing the arguments that were passed to the function.
	$functionName	The function that was called.

Returns:

array

Reimplemented in spunQ_StorableObject.

Definition at line 264 of file DataObject.type.php.

spunQ_DataObject::handleGetUntranslated	(	$	memberName,
		$	arguments,
		$	functionName
	)			[protected, inherited]

Needed by __call().

Will take care of functions requesting all translations available for a member.

Parameters:

	$memberName	The name of the member that was possibly requested.
	$arguments	Array containing the arguments that were passed to the function.
	$functionName	The name of the function that was called.

Returns:

map<spunQ_Locale,any> Mapping locales to whatever type the member has. Note that not every locale needs to be present in this map.

Reimplemented in spunQ_StorableObject.

Definition at line 198 of file DataObject.type.php.

spunQ_DataObject::handleRemove	(	$	memberName,
		$	arguments,
		$	functionName
	)			[protected, inherited]

Needed by __call().

Will take care of function calls starting with 'remove'.

Parameters:

	$memberName	The name of the member that is possibly being removed from. Merely the name of the function without the leading 'remove', with a lower-case first letter.
	$arguments	Array containing the arguments that were passed to the function.
	$functionName	The function that was called.

Returns:

spunQ_DataObject $this

Exceptions:

	spunQ_BadArgumentCountError
	spunQ_InvalidArgumentError

Reimplemented in spunQ_StorableObject.

Definition at line 399 of file DataObject.type.php.

spunQ_DataObject::handleSet	(	$	memberName,
		$	arguments,
		$	functionName
	)			[protected, inherited]

Needed by __call().

Will take care of function calls starting with 'set'.

Parameters:

	$memberName	The name of the member that is possibly being set. Merely the name of the function without the leading 'set', with a lower-case first letter.
	$arguments	Array containing the arguments that were passed to the function.
	$functionName	The function that was called.

Returns:

spunQ_DataObject $this

Reimplemented in spunQ_StorableObject.

Definition at line 292 of file DataObject.type.php.

spunQ_DataObject::initLocalizedMember

(

$

memberName

)

[protected, inherited]

Makes sure a localized member contains a spunQ_Map.

Parameters:

$memberName

The name of the member. This member must have the option 'localized'.

Returns:

void

Definition at line 245 of file DataObject.type.php.

static spunQ_DataObject::propertyOfValue	(	$	value,
		$	property
	)			[static, inherited]

Gets a single property of a value.

See also:

valueByProperty()

Parameters:

	$value	The value to fetch property for.
	$property	The property to fetch.

Returns:

any

Definition at line 74 of file DataObject.type.php.

static spunQ_DataObject::valueByProperty	(	$	value,
		$	path
	)			[static, inherited]

Transforms a value using a property path.

Some types are considered to have properties within spunQ. These properties can be referred to using property path definitions. The most simple case for properties is the user type, for which every member is considered a property. Concatenations of these paths with dots as separators are called property path. The list of all users in the primary group of a given user can be described using this method in a string: 'primaryGroup.users'.
Different types have different properties:

• UserType: As already mentioned, every member of a user type is a property of an object of that type.
• Map:
  • _keys: An array of the keys of the map.
  • _values: An array of the values of the map. Note that _keys and _values are guaranteed to return arrays where the index of a key matches the index of its value in the according result.
  • _key: The first entry of the _keys property. This is handy for referencing the key of single key/value pairs.
  • _value: The first entry of the _values property.
  • _count: The amount of items in the map.
• Array:
  • _keys: The array of keys of the array. Note that the difference between arrays and maps in spunQ is that arrays are always numerically indexed! So this will always return an array containing a range of integers.
  • _values: Array of values in this array. This essentially returns the array as-is and is a NOOP.
  • _key: The first entry of the _keys property.
  • _value: The first entry of the _values property.
  • _count: The amount of items in the array.
• String:
  • _length: The length of the string.

Parameters:

	$value	The value to transform
	$path	The property path to use for the transformation. This can either be a string as described, or an array, each entry holding a property name.

Returns:

any The described value.

Todo:

refactor

Definition at line 54 of file DataObject.type.php.

---

Member Data Documentation

spunQ_DataObject::$_type [protected, inherited]

The actual type of this object.

Type:

spunQ.Type

Definition at line 129 of file DataObject.type.php.

spunQ_DeleteQuery::$conditions = array() [protected]

Conditions to this query (i.e.

WHERE-constraints). Array of PL strings. All conditions will be grouped with AND.

Type:

array<string>

Definition at line 20 of file DeleteQuery.type.php.

spunQ_DeleteQuery::$returnAffectedIds = false [protected]

Whether the query should return the affected ids upon execution.

Type:

boolean

Definition at line 26 of file DeleteQuery.type.php.

spunQ_DeleteQuery::$type [protected]

The name of the type this query is for.

Type:

string

Definition at line 12 of file DeleteQuery.type.php.

---

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

• DeleteQuery.type.php