AtkMetaNode - Revision history

bahtiar at 09:02, 10 January 2010

2010-01-10T09:02:08Z

← Older revision		Revision as of 09:02, 10 January 2010
Line 3:		Line 3:
	== Description ==		== Description ==

	The atkMetaNode is ~~a derivative of [[atkNode]]~~. ~~Its main feature~~ is the ~~fact that~~ it ~~derives most of its functionality~~ from the database ~~metadata~~.		The atkMetaNode is the single most important class in every ATK application. It is the baseclass for all your business entities. It is called 'meta' because it uses the metadata from the database to implement functionality.

	~~If this~~ is a ~~regular node~~:		Under the hood, atkMetaNode is a derivative of [[atkNode]], which is a more basic implementation that doesn't have as much 'magic' and is typically only used when we don't want any meta magic to happen.

			A typical implementation of an atkMetaNode is:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	~~useattrib("atktextattribute");~~		class project extends atkMetaNode

	class project extends ~~atkNode~~
	{		{
	~~function project()~~
	{
	~~$this->atkNode("project");~~
	~~$this->add(new atkAttribute("id", AF_AUTOKEY));~~
	~~$this->add(new atkAttribute("name"));~~
	~~$this->add(new atkTextAttribute("description"));~~

	~~$this->setTable("project");~~
	}
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	~~Then this would get you exactly the same result:~~		In this example, atkMetaNode would find a table called 'project', look in the database metadata, find out that there's an id and name field, and do the rest automatically. This one line class is all you need to create a CRUD application based on the project table. Of course, you'll want to customize behaviour, but we'll show you how to do that in the rest of this document.

	~~<syntaxhighlight lang="php">~~
	~~class project extends atkMetaNode {}~~
	~~</syntaxhighlight>~~

	In this example, atkMetaNode would find a table called 'project', look in the database metadata, find out that there's an id and name field, and do the rest automatically.

	==atkMetaNode tutorial==		==atkMetaNode tutorial==
Line 40:		Line 25:
	The atkMetaNode supports several properties that can be set to influence behaviour.		The atkMetaNode supports several properties that can be set to influence behaviour.

	An example of this is the property $flags that can be used to define the default flags:		An example of this is the property $flags that can be used to define the default [[flags]]:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
Line 63:		Line 48:
	;securityAlias :security alias for this node		;securityAlias :security alias for this node
	;securityMap :security map for this node (will be added to the existing security map!)		;securityMap :security map for this node (will be added to the existing security map!)
			;compiler :meta compiler, the meta compiler to use ((sub-)class atkMetaCompiler instance)
			;cacheable :control whatever this meta node is cacheable (by default a metanode is cachable if the meta method is defined static or if there is no meta method defined)
			;type :alternative name for the node type
	==Frequently Answered Questions==		==Frequently Answered Questions==

bahtiar: /* Properties */

2008-08-31T15:19:30Z

Properties

← Older revision		Revision as of 15:19, 31 August 2008
Line 50:		Line 50:

	The following properties are available:		The following properties are available:
			;table :table name
	;~~$flags~~:~~To set~~ the [[~~Node Flags~~]].		;sequence :sequence name
	;~~$table~~:~~To set~~ the ~~name~~ of the ~~table~~ to ~~use~~ for ~~its data~~		;db/database :database name or instance
			;policy :meta policy, the meta policy to use ((sub-)class [[atkMetaPolicy]] instance)
			;grammar :meta compiler, the meta compiler to use ((sub-)class [[atkMetaCompiler]] instance)
			;handler :meta handler, handler which needs to be called instead of the default meta method
			;flags :The [[Node Flags]]
			;descriptor :descriptor template for this node
			;order :(default) order to sort fields
			;index :create indexed navigation on a attribute/fieldname
			;filter :filter
			;securityAlias :security alias for this node
			;securityMap :security map for this node (will be added to the existing security map!)

	==Frequently Answered Questions==		==Frequently Answered Questions==

bahtiar: /* atkMetaNode tutorial */

2008-08-31T15:13:46Z

atkMetaNode tutorial

← Older revision		Revision as of 15:13, 31 August 2008
Line 35:		Line 35:

	A comprehensive tutorial on the atkMetaNode can be found in [[Using_the_atkMetaNode\|the atkMetaNode Howto]]		A comprehensive tutorial on the atkMetaNode can be found in [[Using_the_atkMetaNode\|the atkMetaNode Howto]]

			==Properties==

			The atkMetaNode supports several properties that can be set to influence behaviour.

			An example of this is the property $flags that can be used to define the default flags:

			<syntaxhighlight lang="php">
			class project extends atkMetaNode
			{
			protected $flags = array(NF_READONLY);
			}
			</syntaxhighlight>

			The following properties are available:

			;$flags:To set the [[Node Flags]].
			;$table:To set the name of the table to use for its data

	==Frequently Answered Questions==		==Frequently Answered Questions==

bahtiar: /* Description */

2008-08-31T15:08:59Z

Description

← Older revision		Revision as of 15:08, 31 August 2008
Line 7:		Line 7:
	If this is a regular node:		If this is a regular node:

			<syntaxhighlight lang="php">
	useattrib("atktextattribute");		useattrib("atktextattribute");

Line 21:		Line 22:
	}		}
	}		}
			</syntaxhighlight>

	Then this would get you exactly the same result:		Then this would get you exactly the same result:

			<syntaxhighlight lang="php">
	class project extends atkMetaNode {}		class project extends atkMetaNode {}
			</syntaxhighlight>

	In this example, atkMetaNode would find a table called 'project', look in the database metadata, find out that there's an id and name field, and do the rest automatically.		In this example, atkMetaNode would find a table called 'project', look in the database metadata, find out that there's an id and name field, and do the rest automatically.

bahtiar: /* Frequently Answered Questions */

2008-08-31T15:08:34Z

Frequently Answered Questions

← Older revision		Revision as of 15:08, 31 August 2008
Line 38:		Line 38:
	The atkMetaNode is not included by default (to save resources for scripts not using it). In the class where you need it, you can add the following line:		The atkMetaNode is not included by default (to save resources for scripts not using it). In the class where you need it, you can add the following line:

			<syntaxhighlight lang="php">
	atkimport("atk.atkmetanode");		atkimport("atk.atkmetanode");
			</syntaxhighlight>

	If you use it heavily, and don't mind that it's always included, you can put this line in your atk.inc file instead.		If you use it heavily, and don't mind that it's always included, you can put this line in your atk.inc file instead.
Line 55:		Line 57:
	=== How can I set flags on an attribute? ===		=== How can I set flags on an attribute? ===

			<syntaxhighlight lang="php">
	class project extends atkMetaNode		class project extends atkMetaNode
	{		{
Line 62:		Line 65:
	}		}
	}		}
			</syntaxhighlight>

	=== How can I set flags on the node itself? ===		=== How can I set flags on the node itself? ===

			<syntaxhighlight lang="php">
	class project extends atkMetaNode		class project extends atkMetaNode
	{		{
	var $flags = NF_LOCK;		var $flags = NF_LOCK;
	}		}
			</syntaxhighlight>

	This only works for a single flag because PHP won't accept the '\|' symbol in a variable declaration. If you need multiple flags, use:		This only works for a single flag because PHP won't accept the '\|' symbol in a variable declaration. If you need multiple flags, use:

			<syntaxhighlight lang="php">
	class project extends atkMetaNode		class project extends atkMetaNode
	{		{
	var $flags = array(NF_LOCK, NF_EDITAFTERADD);		var $flags = array(NF_LOCK, NF_EDITAFTERADD);
	}		}
			</syntaxhighlight>

	=== How can I change the type of attribute that the metanote has decided to use? ===		=== How can I change the type of attribute that the metanote has decided to use? ===

			<syntaxhighlight lang="php">
	function meta(&$policy)		function meta(&$policy)
	{		{
	$policy->setType("description", "atkFckAttribute");		$policy->setType("description", "atkFckAttribute");
	}		}
			</syntaxhighlight>

	=== How can I use tabs in the atkMetaNode? ===		=== How can I use tabs in the atkMetaNode? ===

			<syntaxhighlight lang="php">
	function meta(&$policy)		function meta(&$policy)
	{		{
	$policy->setTab("description", "advanced");		$policy->setTab("description", "advanced");
	}		}
			</syntaxhighlight>

bahtiar: /* My table is "tbl_project" but my node should be called "project". Can I still use the atkMetaNode? */

2008-08-31T15:07:14Z

My table is "tbl_project" but my node should be called "project". Can I still use the atkMetaNode?

← Older revision		Revision as of 15:07, 31 August 2008
Line 46:		Line 46:
	Yes:		Yes:

			<syntaxhighlight lang="php">
	class project extends atkMetaNode		class project extends atkMetaNode
	{		{
	~~var~~ $table = "tbl_project";		protected $table = "tbl_project";
	}		}
			</syntaxhighlight>

	=== How can I set flags on an attribute? ===		=== How can I set flags on an attribute? ===

bahtiar at 07:35, 31 August 2008

2008-08-31T07:35:23Z

← Older revision		Revision as of 07:35, 31 August 2008
Line 1:		Line 1:
			{{class\|atk}}

	== Description ==		== Description ==

	The atkMetaNode is a derivative of atkNode. Its main feature is the fact that it derives most of its functionality from the database metadata.		The atkMetaNode is a derivative of [[atkNode]]. Its main feature is the fact that it derives most of its functionality from the database metadata.

	If this is a regular node:		If this is a regular node:

bahtiar: fix destruction

2007-06-17T19:28:29Z

fix destruction

@@ Line 53: / Line 53: @@
    class project extends atkMetaNode
+   {
-     function meta(
+     function meta(&$policy)

OcaVn1 at 03:01, 16 June 2007

2007-06-16T03:01:08Z

@@ Line 53: / Line 53: @@
    class project extends atkMetaNode
+   {
-     function meta(&$policy)
+     function meta(

Patrick: typo

2007-01-05T13:12:26Z

typo

← Older revision		Revision as of 13:12, 5 January 2007
Line 24:		Line 24:
	class project extends atkMetaNode {}		class project extends atkMetaNode {}

	In this example, atkMetaNode would find a table called 'project', look in the database ~~matadata~~, find out that there's an id and name field, and do the rest automatically.		In this example, atkMetaNode would find a table called 'project', look in the database metadata, find out that there's an id and name field, and do the rest automatically.

	==atkMetaNode tutorial==		==atkMetaNode tutorial==