AtkDocumentAttribute - Revision history

bahtiar: /* References */

2010-02-12T10:39:54Z

References

← Older revision		Revision as of 10:39, 12 February 2010
Line 64:		Line 64:

	== References ==		== References ==
	[http://www.~~achievo~~.~~org/atk~~/demo/ ATK Demo Application - Lesson 8]		[http://www.atk-framework.com/demo/ ATK Demo Application - Lesson 8]

	~~[http://www.achievo.org/docs/atk/latest/ ATK API Documentation]~~
	~~Look for atkDocumentAttribute and atkDocumentHandler~~

	[[Category:Attributes]]		[[Category:Attributes]]

bahtiar: /* Constructor Code */

2010-02-12T10:38:43Z

Constructor Code

← Older revision		Revision as of 10:38, 12 February 2010
Line 32:		Line 32:
	public function __construct()		public function __construct()
	{		{
	parent::__construct("samplenode);		parent::__construct("samplenode");

	$this->add(new atkDocumentAttribute("documents"));		$this->add(new atkDocumentAttribute("documents"));

bahtiar: /* Constructor Code */

2010-02-12T10:38:33Z

Constructor Code

← Older revision		Revision as of 10:38, 12 February 2010
Line 27:		Line 27:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	<?php		<?php
	~~//use the relevant include function for all other required attributes and relations here~~
	~~useattrib("atkdocumentattribute");~~		class samplenode extends atkNode
	class samplenode extends atkNode		{
	{		public function __construct()
	function ~~samplenode~~()
	{		{
	~~$this->atkNode~~("samplenode~~", NF_ADD_LINK\|NF_TRACK_CHANGES\|NF_MRA~~);		parent::__construct("samplenode);
	~~//include all other required attributes and relations within the constructor~~
	$this->add(new ~~atkdocumentAttribute~~("~~OpenDocument~~"));		$this->add(new atkDocumentAttribute("documents"));
	}		}
	}		}
	?>		?>
			</syntaxhighlight>

			When using atkMetaNodes, use the following:

			<syntaxhighlight lang="php">
			class sampleNode extends atkMetaNode
			{
			public function postMeta()
			{
			$this->add(new atkDocumentAttribute("documents"));
			}
			}
	</syntaxhighlight>		</syntaxhighlight>

bahtiar: /* Assign Document Variables */

2010-02-10T06:55:57Z

Assign Document Variables

← Older revision		Revision as of 06:55, 10 February 2010
Line 48:		Line 48:
	All of the above magic happens within the document handler function which is used whenever the document action is requested. The above logic only works for attributes which are within the same node as the Document Attribute and does not work with relationship attributes.		All of the above magic happens within the document handler function which is used whenever the document action is requested. The above logic only works for attributes which are within the same node as the Document Attribute and does not work with relationship attributes.

	In order to obtain data of attributes in a node linked by a m2o or o2m relationship you have to overide a specific function (AssignDocumentVars()). Fortunately the code within the document action allows for an overide of this function to exist within the node class file. The way to overide this function is on the ~~page~~ [[~~Overide AssignDocumentVars Function~~]].		In order to obtain data of attributes in a node linked by a m2o or o2m relationship you have to overide a specific function (AssignDocumentVars()). Fortunately the code within the document action allows for an overide of this function to exist within the node class file. The way to overide this function is on the howto:

			* [[Assigning custom variables to a document template]]

	== References ==		== References ==
	[http://www.achievo.org/atk/demo/ ATK Demo Application - Lesson 8]		[http://www.achievo.org/atk/demo/ ATK Demo Application - Lesson 8]

bahtiar at 17:24, 19 December 2007

2007-12-19T17:24:55Z

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

	== atkDocumentAttribute ==		== atkDocumentAttribute ==
	This page sets out how to use the atkDocumentAttribute. This attribute is a special attribute within ATK as it does not relate to any database field. This attribute is used to create a document (currently in the open document format - odt) which uses the data within the nodes other attributes to fill a template of the desired document.		This page sets out how to use the atkDocumentAttribute. This attribute is a special attribute within ATK as it does not relate to any database field. This attribute is used to create a document (currently in the open document format - odt) which uses the data within the nodes other attributes to fill a template of the desired document.

Jamiet: /* Configuration */

2007-01-13T14:21:29Z

Configuration

← Older revision		Revision as of 14:21, 13 January 2007
Line 4:		Line 4:
	== Configuration ==		== Configuration ==
	The following text is straight out of the ATK 5.5.0 configuration file located in the root directory of the atk demo application.		The following text is straight out of the ATK 5.5.0 configuration file located in the root directory of the atk demo application.
			<syntaxhighlight lang="php">
	// -------------- DOCUMENT WRITER CONFIGURATION ---------------		// -------------- DOCUMENT WRITER CONFIGURATION ---------------
	// For document attributes, ATK automatically searches for template		// For document attributes, ATK automatically searches for template
Line 19:		Line 19:
	// "doctemplates/modulename/nodename/".		// "doctemplates/modulename/nodename/".
	$config_doctemplatedir = "doctemplates/";		$config_doctemplatedir = "doctemplates/";
			</syntaxhighlight>

	== Constructor Code ==		== Constructor Code ==

Jamiet: /* Constructor Code */

2007-01-13T14:20:55Z

Constructor Code

← Older revision		Revision as of 14:20, 13 January 2007
Line 22:		Line 22:
	== Constructor Code ==		== Constructor Code ==
	To include a document attribute within your node then add the following code to the constructor function of the node class file:		To include a document attribute within your node then add the following code to the constructor function of the node class file:
			<syntaxhighlight lang="php">
	<?php		<?php
	//use the relevant include function for all other required attributes and relations here		//use the relevant include function for all other required attributes and relations here
Line 36:		Line 36:
	}		}
	?>		?>
			</syntaxhighlight>

	When you load this node in the webpage you will now see an extra column named the same as the attribute name (in the example "Open Document". In addition the attribute will have looked in the directory "doctemplates/samplemodule/samplenode/" for any suitable template documents and include them in a dropdown list with an "open" button alongside the list box.		When you load this node in the webpage you will now see an extra column named the same as the attribute name (in the example "Open Document". In addition the attribute will have looked in the directory "doctemplates/samplemodule/samplenode/" for any suitable template documents and include them in a dropdown list with an "open" button alongside the list box.

bahtiar at 10:24, 28 December 2006

2006-12-28T10:24:37Z

← Older revision		Revision as of 10:24, 28 December 2006
Line 51:		Line 51:
	Look for atkDocumentAttribute and atkDocumentHandler		Look for atkDocumentAttribute and atkDocumentHandler

	--[[~~User~~:~~Jamiet\|Jamiet~~]] ~~22:21, 11 June 2006 (CEST)~~		[[Category:Attributes]]

Jamiet: /* References */

2006-06-12T19:20:39Z

References

← Older revision		Revision as of 19:20, 12 June 2006
Line 47:		Line 47:
	== References ==		== References ==
	[http://www.achievo.org/atk/demo/ ATK Demo Application - Lesson 8]		[http://www.achievo.org/atk/demo/ ATK Demo Application - Lesson 8]

	[http://www.achievo.org/docs/atk/latest/ ATK API Documentation]		[http://www.achievo.org/docs/atk/latest/ ATK API Documentation]
	Look for atkDocumentAttribute and atkDocumentHandler		Look for atkDocumentAttribute and atkDocumentHandler

	--[[User:Jamiet\|Jamiet]] 22:21, 11 June 2006 (CEST)		--[[User:Jamiet\|Jamiet]] 22:21, 11 June 2006 (CEST)

Jamiet at 19:20, 12 June 2006

2006-06-12T19:20:03Z

← Older revision		Revision as of 19:20, 12 June 2006
Line 45:		Line 45:

	In order to obtain data of attributes in a node linked by a m2o or o2m relationship you have to overide a specific function (AssignDocumentVars()). Fortunately the code within the document action allows for an overide of this function to exist within the node class file. The way to overide this function is on the page [[Overide AssignDocumentVars Function]].		In order to obtain data of attributes in a node linked by a m2o or o2m relationship you have to overide a specific function (AssignDocumentVars()). Fortunately the code within the document action allows for an overide of this function to exist within the node class file. The way to overide this function is on the page [[Overide AssignDocumentVars Function]].
			== References ==
			[http://www.achievo.org/atk/demo/ ATK Demo Application - Lesson 8]
			[http://www.achievo.org/docs/atk/latest/ ATK API Documentation]
			Look for atkDocumentAttribute and atkDocumentHandler

	--[[User:Jamiet\|Jamiet]] 22:21, 11 June 2006 (CEST)		--[[User:Jamiet\|Jamiet]] 22:21, 11 June 2006 (CEST)