AtkTagAttribute - Revision history

bahtiar at 17:26, 19 December 2007

2007-12-19T17:26:10Z

← Older revision		Revision as of 17:26, 19 December 2007
Line 1:		Line 1:
			{{attribute}}

	= Description =		= Description =
	The tag attribute allows users to assign tags (tags as in 'keywords' and 'tagcloud') to records of an atkNode. The inputfield is probably familiair: there is a textfield where you can type several tags (comma seperated) and a list of already used keywords above it. In fact, this attribute should be a relation, because in the database the tagAttribute is just like a m2m relation with a different way of entering the values.		The tag attribute allows users to assign tags (tags as in 'keywords' and 'tagcloud') to records of an atkNode. The inputfield is probably familiair: there is a textfield where you can type several tags (comma seperated) and a list of already used keywords above it. In fact, this attribute should be a relation, because in the database the tagAttribute is just like a m2m relation with a different way of entering the values.

Harrie: /* Examples */

2007-11-16T14:56:03Z

Examples

← Older revision		Revision as of 14:56, 16 November 2007
Line 56:		Line 56:
	*''tags'' (PK) (Must be called tags, same type as the primary key field in the destinationnode)		*''tags'' (PK) (Must be called tags, same type as the primary key field in the destinationnode)

	'''tags'''		'''tags''' (Destination node, containing all tags available)
	*''id'' (PK)		*''id'' (PK)
	*tagname		*tagname

Harrie: /* Examples */

2007-11-16T14:55:35Z

Examples

← Older revision		Revision as of 14:55, 16 November 2007
Line 62:		Line 62:
	To make the atkTagAttribute work, now add the following line to the constructor of the owner node:		To make the atkTagAttribute work, now add the following line to the constructor of the owner node:

	$this->add(new atkTagAttribute("myowntagattribute","~~module~~.tags","tagname","~~module~~.customers_tags"));		$this->add(new atkTagAttribute("myowntagattribute","modulename.tags","tagname","modulename.customers_tags"));

	Oh and don't forget to add the useattrib('atktagattribute') above your node.		Replace 'modulename' with the name of your module. Oh and don't forget to add the useattrib('atktagattribute') above your node.

Harrie: /* Examples */

2007-11-16T14:54:52Z

Examples

← Older revision		Revision as of 14:54, 16 November 2007
Line 62:		Line 62:
	To make the atkTagAttribute work, now add the following line to the constructor of the owner node:		To make the atkTagAttribute work, now add the following line to the constructor of the owner node:

	$this->add(new atkTagAttribute("~~tags~~","module.tags","tagname","module.customers_tags"));		$this->add(new atkTagAttribute("myowntagattribute","module.tags","tagname","module.customers_tags"));

	Oh and don't forget to add the useattrib('atktagattribute') above your node.		Oh and don't forget to add the useattrib('atktagattribute') above your node.

Harrie: /* Parameters */

2007-11-16T14:53:10Z

Parameters

← Older revision		Revision as of 14:53, 16 November 2007
Line 39:		Line 39:
	* '''Flags''' ''Flag'' (optional)		* '''Flags''' ''Flag'' (optional)

	The common [[~~atkNode~~]] ~~flags~~.		The common [[Attribute_Flags]].

	= Examples =		= Examples =

Harrie: /* Parameters */

2007-11-16T14:52:37Z

Parameters

← Older revision		Revision as of 14:52, 16 November 2007
Line 39:		Line 39:
	* '''Flags''' ''Flag'' (optional)		* '''Flags''' ''Flag'' (optional)

	The common [atkNode] flags.		The common [[atkNode]] flags.

	= Examples =		= Examples =

Harrie: /* Examples */

2007-11-16T14:50:47Z

Examples

← Older revision		Revision as of 14:50, 16 November 2007
Line 42:		Line 42:

	= Examples =		= Examples =

			We have the following nodes:

			'''customers''' (Owner node, the original node you wanted to add the atkTagAttribute to)
			*''id'' (PK)
			*name
			*address
			*city
			*phone

			'''customers_tags''' (Intermediate node, linking the owner node with the destination node)
			*''customers'' (PK) (Note that this field '''has''' to have the same name and type as the databasetable of the ownernode)
			*''tags'' (PK) (Must be called tags, same type as the primary key field in the destinationnode)

			'''tags'''
			*''id'' (PK)
			*tagname

			To make the atkTagAttribute work, now add the following line to the constructor of the owner node:

			$this->add(new atkTagAttribute("tags","module.tags","tagname","module.customers_tags"));

			Oh and don't forget to add the useattrib('atktagattribute') above your node.

Harrie: /* Parameters */

2007-11-16T14:43:07Z

Parameters

← Older revision		Revision as of 14:43, 16 November 2007
Line 7:		Line 7:

	The name of the attribute, can be anything you like. This name will be displayed to the user, but has no effect on the behaviour of the attribute.		The name of the attribute, can be anything you like. This name will be displayed to the user, but has no effect on the behaviour of the attribute.


	* '''Destination''' ''String''		* '''Destination''' ''String''

	The name of the destinationnode in the format "module.node", so this is NOT the in-between node but the target node containing our tags.		The name of the destinationnode in the format "module.node", so this is NOT the in-between node but the target node containing our tags.


	* '''Destinationfield''' ''String''		* '''Destinationfield''' ''String''

	The name of the field in the destinationnode containing the tag names.		The name of the field in the destinationnode containing the tag names.


	* '''Link''' ''String''		* '''Link''' ''String''

	The name of the intermediate node, linking our owner- and destinationnode together.		The name of the intermediate node, linking our owner- and destinationnode together.


	* '''Mode''' ''Flag'' (optional)		* '''Mode''' ''Flag'' (optional)
Line 26:		Line 30:
	When the tag entered already exists, ....		When the tag entered already exists, ....

	TA_ADD (default): ...add the tag.		**TA_ADD (default): ...add the tag.
	TA_ERROR: ...trigger an error.
	TA_IGNORE: ...ignore tag.		**TA_ERROR: ...trigger an error.

			**TA_IGNORE: ...ignore tag.


	* '''Flags''' ''Flag'' (optional)		* '''Flags''' ''Flag'' (optional)

	The common [atkNode] flags.		The common [atkNode] flags.

			= Examples =

Harrie at 14:41, 16 November 2007

2007-11-16T14:41:46Z

← Older revision		Revision as of 14:41, 16 November 2007
Line 3:		Line 3:

	= Parameters =		= Parameters =
	-~~todo~~-
			* '''Name''' ''String''

			The name of the attribute, can be anything you like. This name will be displayed to the user, but has no effect on the behaviour of the attribute.

			* '''Destination''' ''String''

			The name of the destinationnode in the format "module.node", so this is NOT the in-between node but the target node containing our tags.

			* '''Destinationfield''' ''String''

			The name of the field in the destinationnode containing the tag names.

			* '''Link''' ''String''

			The name of the intermediate node, linking our owner- and destinationnode together.

			* '''Mode''' ''Flag'' (optional)

			Indicates the behaviour of the atkTagAttribute when the tag entered already exists. Can have one of the following values:

			When the tag entered already exists, ....

			TA_ADD (default): ...add the tag.
			TA_ERROR: ...trigger an error.
			TA_IGNORE: ...ignore tag.

			* '''Flags''' ''Flag'' (optional)

			The common [atkNode] flags.

Harrie at 14:24, 16 November 2007

2007-11-16T14:24:23Z

New page

= Description =
The tag attribute allows users to assign tags (tags as in 'keywords' and 'tagcloud') to records of an atkNode. The inputfield is probably familiair: there is a textfield where you can type several tags (comma seperated) and a list of already used keywords above it. In fact, this attribute should be a relation, because in the database the tagAttribute is just like a m2m relation with a different way of entering the values.

= Parameters =
-todo-