User management for the world wide web

GenieGate_Properties_Section Class Reference

Represent a section. More...

List of all members.

Public Member Functions
	GenieGate_Properties_Section (&$pm, $uid, $skey)
	This is an emulated inner class, the preferred way to construct one of these is via GenieGate_Properties::getSection().
	getDescription ($property_key=FALSE)
	Get the textual description of a property or section.
	getUserId ()
	Returns the user ID.
	getSectionKey ()
	Return the section key.
	getPropertyNames ()
	Get a list of all supported properties.
	isProperty ($property)
	Tell if the specified property is supported.
	getProperty ($name)
	Get the specified property.
	setProperty ($name, $value)
	Sets the named property.
	removeAll ()
	Removes all the properties for this section.

---

Detailed Description

Represent a section.

A section provides accessor methods to the individual properties.

Definition at line 9 of file Properties.php.

---

Constructor & Destructor Documentation

GenieGate_Properties_Section (  &$  pm, $  uid, $  skey )

This is an emulated inner class, the preferred way to construct one of these is via GenieGate_Properties::getSection(). See also: GenieGate_Properties::getSection() Definition at line 22 of file Properties.php.

---

Member Function Documentation

getDescription (  $  property_key = FALSE  )

Get the textual description of a property or section. If $property_key is FALSE or ommitted, returns the description of this section, otherwise returns the description of the specified property. Parameters: $property_key  - The property of interest. (Optional) Returns: Textual description. Definition at line 41 of file Properties.php.

getProperty (  $  name  )

Get the specified property. Doesn't return anything if there is no property set. Parameters: $name  - The name of the property. Returns: Property value, or nothing if there is no property set. Definition at line 78 of file Properties.php. Referenced by setProperty().

getPropertyNames (   )

Get a list of all supported properties. Returns: an array of property names that can be used with getProperty() and setProperty() Definition at line 59 of file Properties.php.

getSectionKey (   )

Return the section key. Returns: section ID code. Definition at line 53 of file Properties.php.

getUserId (   )

Returns the user ID. Returns: User ID code. Definition at line 48 of file Properties.php.

isProperty (  $  property  )

Tell if the specified property is supported. This only checks to see if the property name is recognized, it does not tell if the property actually has a value. Parameters: $property  - The name of the property in question. Returns: TRUE of FALSE depending on if $property is recognized. Definition at line 69 of file Properties.php.

removeAll (   )

Removes all the properties for this section. This will delete all the properties in this section, (for the current user) Definition at line 119 of file Properties.php.

setProperty (  $  name, $  value )

Sets the named property. Parameters: $name  - The name of the property to set. $value  - The value to set it to. Definition at line 97 of file Properties.php. References getProperty().

---

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

• Properties.php

---

Documentation generated by DoxyGen