Hooks - Revision history

Wayneh: /* rowColor */

2012-05-29T21:11:48Z

rowColor

← Older revision		Revision as of 21:11, 29 May 2012
Line 144:		Line 144:

	The $record variable will contain only the record showed in the list. If you used AF_HIDE_LIST or AF_HIDE and if you want to use it in rowColor then you need to add the AF_FORCE_LOAD flag to the attribute.		The $record variable will contain only the record showed in the list. If you used AF_HIDE_LIST or AF_HIDE and if you want to use it in rowColor then you need to add the AF_FORCE_LOAD flag to the attribute.

			NOTE FROM class.atkdglist.inc and class.atkrecordlist.inc -

			/* Special rowColor method makes it possible to change the row color based on the record data.
			* the method can return a simple value (which will be used for the normal row color), or can be
			* an array, in which case the first element will be the normal row color, and the second the mouseover
			* row color, example: function rowColor(&$record, $num) { return array('red', 'blue'); }
			*/

	== Database related ==		== Database related ==

Wayneh: /* _display */

2012-05-21T05:21:07Z

_display

← Older revision		Revision as of 05:21, 21 May 2012
Line 73:		Line 73:
	</syntaxhighlight>		</syntaxhighlight>

	Where $record is the record that is being displayed, and $mode is either "list" or "view", depending on the context in which a value needs to be displayed (useful if you only want to override display in list mode).		Where $record is the record that is being displayed, and $mode is either "list" or "view" depending on the context in which a value needs to be displayed (useful if you only want to override display in list mode).

			ADDITION: Mode can also be "csv" when exporting
			Suspect that mode can also be "add", "edit" for read-only fields on on those pages

	=== <attribname>_edit ===		=== <attribname>_edit ===

Agx: /* rowColor */

2011-05-12T21:18:25Z

rowColor

← Older revision		Revision as of 21:18, 12 May 2011
Line 139:		Line 139:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			The $record variable will contain only the record showed in the list. If you used AF_HIDE_LIST or AF_HIDE and if you want to use it in rowColor then you need to add the AF_FORCE_LOAD flag to the attribute.

	== Database related ==		== Database related ==

bahtiar: /* List of ATK Magic Methods */

2011-03-29T14:24:03Z

List of ATK Magic Methods

← Older revision		Revision as of 14:24, 29 March 2011
Line 87:		Line 87:
	Override the search box. The example below makes a custom search output for both extended and regular search.		Override the search box. The example below makes a custom search output for both extended and regular search.

	<~~code~~>		<syntaxhighlight lang="php">
	public function name_search($record=array(), $extended=false, $fieldprefix="", atkDataGrid $grid=null)		public function name_search($record=array(), $extended=false, $fieldprefix="", atkDataGrid $grid=null)
	{		{
Line 93:		Line 93:
	return "CUSTOM SEARCH WIDGET";		return "CUSTOM SEARCH WIDGET";
	}		}
	</~~code~~>		</syntaxhighlight>

	=== General ===		=== General ===

bahtiar: /* _search */

2011-03-29T14:23:36Z

_search

← Older revision		Revision as of 14:23, 29 March 2011
Line 85:		Line 85:
	=== <attribname>_search ===		=== <attribname>_search ===

	Override the search box.		Override the search box. The example below makes a custom search output for both extended and regular search.

			<code>
			public function name_search($record=array(), $extended=false, $fieldprefix="", atkDataGrid $grid=null)
			{
			if ($extended) return "SUPER EXTENSIVE SEARCH WIDGET CUSTOM THINGEE";
			return "CUSTOM SEARCH WIDGET";
			}
			</code>

	=== General ===		=== General ===

bahtiar: /* Attribute related */

2011-03-29T14:22:25Z

Attribute related

← Older revision		Revision as of 14:22, 29 March 2011
Line 83:		Line 83:
	Todo: show api and example		Todo: show api and example

			=== <attribname>_search ===

			Override the search box.

			=== General ===
			See atk/attributes/class.atkattributes.inc for the original implementations of the display/search/edit methods and their parameters.

	== Action related ==		== Action related ==

bahtiar: /* Introduction */

2010-02-10T07:13:35Z

Introduction

← Older revision		Revision as of 07:13, 10 February 2010
Line 3:		Line 3:
	The usual way of overriding method behaviour in an object oriented context, is to override them in derived classes.		The usual way of overriding method behaviour in an object oriented context, is to override them in derived classes.

	Magic methods in ATK are methods that are similar. The difference is that these are not overrides, because these methods are not present in the base class. The reason is that these methods are dynamic in nature. ATK checks whether these methods exist, and if so, calls them.		Magic methods in ATK are methods that are similar. The difference is that these are not overrides, because these methods are not present in the base class. The reason is that these methods are dynamic in nature. ATK checks whether these methods exist, and if so, calls them. This is why we call them 'Hooks'.

	This concept might be confusing, but is best explained with an example. Add this method to your node:		This concept might be confusing, but is best explained with an example. Add this method to your node:

bahtiar: /* Introduction */

2010-02-10T07:12:58Z

Introduction

← Older revision		Revision as of 07:12, 10 February 2010
Line 7:		Line 7:
	This concept might be confusing, but is best explained with an example. Add this method to your node:		This concept might be confusing, but is best explained with an example. Add this method to your node:

	function name_display($record)		<syntaxhighlight lang="php">
			public function name_display($record)
	{		{
	return "Hello World";		return "Hello World";
	}		}
			</syntaxhighlight>

	'name' refers to an attribute of your node. If this magic method exists, ATK will call name_display every time it want to display a value from the 'name' attribute, instead of its usual display logic. If you try this code, you'll see that the 'name' column of a recordlist will now only contain 'hello world' entries.		'name' refers to an attribute of your node. If this magic method exists, ATK will call name_display every time it want to display a value from the 'name' attribute, instead of its usual display logic. If you try this code, you'll see that the 'name' column of a recordlist will now only contain 'hello world' entries.

bahtiar at 07:12, 10 February 2010

2010-02-10T07:12:36Z

← Older revision		Revision as of 07:12, 10 February 2010
Line 41:		Line 41:
	public function content_display($record, $mode)		public function content_display($record, $mode)
	{		{
	$attribute = &$this->getAttribute("content");		$attribute = $this->getAttribute("content");
	$original = $attribute->display($record, $mode);		$original = $attribute->display($record, $mode);

Line 62:		Line 62:
	=== <attribname>_display ===		=== <attribname>_display ===

	~~Todo~~: ~~show api~~ and ~~example~~		Signature:

			<syntaxhighlight lang="php">
			public function <attribname>_display($record, $mode)
			{
			return "string to display";
			}
			</syntaxhighlight>

			Where $record is the record that is being displayed, and $mode is either "list" or "view", depending on the context in which a value needs to be displayed (useful if you only want to override display in list mode).

	=== <attribname>_edit ===		=== <attribname>_edit ===

bahtiar: /* A practical example */

2010-02-10T07:10:18Z

A practical example

← Older revision		Revision as of 07:10, 10 February 2010
Line 38:		Line 38:
	The most commonly used magic method is <attribname>_display. It is used to alter the output of attribute values. The safest way to do this is to call the original display behaviour, and alter its output, as in the following example, which makes the text of a column bold if it contains the word 'atk':		The most commonly used magic method is <attribname>_display. It is used to alter the output of attribute values. The safest way to do this is to call the original display behaviour, and alter its output, as in the following example, which makes the text of a column bold if it contains the word 'atk':

	function content_display($record, $mode)		<syntaxhighlight lang="php">
			public function content_display($record, $mode)
	{		{
	$attribute = &$this->getAttribute("content");		$attribute = &$this->getAttribute("content");
Line 50:		Line 51:
	return $original;		return $original;
	}		}
			</syntaxhighlight>

	In this case, the $mode parameter is used to change the behaviour only in 'list' mode (recordlists, such as the admin page).		In this case, the $mode parameter is used to change the behaviour only in 'list' mode (recordlists, such as the admin page).

	What parameters a magic method has, depends on the method. These are documented below.		What parameters a magic method has, depends on the method. These are documented below.


	= List of ATK Magic Methods =		= List of ATK Magic Methods =