PHPDS_tagger Class Reference

Inheritance diagram for PHPDS_tagger:

Public Member Functions
	tag ($object, $name, $target, $value=null)
	tagLookup ($object=null, $name=null, $target=null, $value=null)
	tagList ($name, $object, $target=null)
	tagUser ($name, $target, $value=null)
	tagMe ($name, $value=null)
	tagMenu ($name, $target, $value=null)
	tagHere ($name, $value=null)
	tagRole ($name, $target, $value=null)
	tagGroup ($name, $target, $value=null)
	tagArea ($object, $target, $value=null)
Data Fields
const	tag_user = 'user'
const	tag_menu = 'menu'
const	tag_role = 'role'
const	tag_group = 'group'

---

Member Function Documentation

tag	(	$	object,
		$	name,
		$	target,
		$	value = null
	)

Generic setter/getter for the tags. All parameters must be given explicitly

As a setter, all 4 params must be given (for the [$object;$target] set the tag name $name to value $value) As a getter, don't give the value ; a single value will be returned

Parameters:

string	$object
string	$name
string	$target
string	$value	(optional)

Returns:

string|array|nothing

tagArea	(	$	object,
		$	target,
		$	value = null
	)

This function creates tag list which allows a comma separated list of tags.

Parameters:

string	$object
string	$target
string	$value

Returns:

string|nothing

tagGroup	(	$	name,
		$	target,
		$	value = null
	)

Tag (set/get) the group specified in $target

Parameters:

$name
$target
$value

tagHere	(	$	name,
		$	value = null
	)

Tag (set/get) the current menu

Parameters:

$name
$value

tagList	(	$	name,
		$	object,
		$	target = null
	)

List of [object;target] for the given tag (optionaly restricted to the given $object/$target)

Parameters:

$object
$target

tagLookup	(	$	object = null,
		$	name = null,
		$	target = null,
		$	value = null
	)

Lookup tags based on criterias ; returns an array

Parameters:

string	$object	(optional)
string	$name	(optional)
string	$target	(optional)
string	$value	(optional)

Returns:

string|nothing

Version:

1.0

Author:

greg

Date:

20120105 (v1.0) (greg) added

tagMe	(	$	name,
		$	value = null
	)

Tag (set/get) the current user

Parameters:

$name
$value

tagMenu	(	$	name,
		$	target,
		$	value = null
	)

Tag (set/get) the menu specified in $target

Parameters:

$name
$target
$value

tagRole	(	$	name,
		$	target,
		$	value = null
	)

Tag (set/get) the role specified in $target

Parameters:

$name
$target
$value

tagUser	(	$	name,
		$	target,
		$	value = null
	)

Tag (set/get) the user specified in $target

Parameters:

$name
$target
$value

---

Field Documentation

const tag_group = 'group'

const tag_menu = 'menu'

const tag_role = 'role'

const tag_user = 'user'

---

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

• /home/jason/NetBeansProjects/phpdev/includes/PHPDS_tagger.class.php