Attribute dependency callbacks - Revision history

Wayneh at 19:23, 23 March 2011

2011-03-23T19:23:11Z

@@ Line 96: / Line 96: @@
 $node = $modifier->getNode();
 $mode = $modifier->getMode();
 </syntaxhighlight>

Wayneh at 11:18, 16 March 2011

2011-03-16T11:18:55Z

@@ Line 88: / Line 88: @@
    ");
 });
 </syntaxhighlight>

Bjorn: /* Show / hide attributes of a relation */

2010-09-30T14:56:58Z

Show / hide attributes of a relation

← Older revision		Revision as of 14:56, 30 September 2010
Line 63:		Line 63:
	$record = $modifier->getRecord();		$record = $modifier->getRecord();
	if ($record['type'] == 'other') {		if ($record['type'] == 'other') {
	$modifier->getNode()->getAttribute('contracts')->getDestination->getAttribute('salary')->addFlag(AF_HIDE_LIST);		$modifier->getNode()
			->getAttribute('contracts')
			->getDestination
			->getAttribute('salary')
			->addFlag(AF_HIDE_LIST);
	} else {		} else {
	$modifier->getNode()->getAttribute('contracts')->getDestination->getAttribute('salary')->removeFlag(AF_HIDE_LIST);		$modifier->getNode()
			->getAttribute('contracts')
			->getDestination
			->getAttribute('salary')
			->removeFlag(AF_HIDE_LIST);
	}		}
	$modifier->refreshAttribute('contracts');		$modifier->refreshAttribute('contracts');

Bjorn at 14:14, 30 September 2010

2010-09-30T14:14:59Z

@@ Line 52: / Line 52: @@
 </syntaxhighlight>
 In this example we will be refreshing the contact and contract attributes when another customer is selected. Assuming these attributes have a filter which is based on the currently selected customer, this means you can now only select contacts and contracts for the newly selected customer.
 == Custom JavaScript ==

bahtiar at 14:03, 3 February 2010

2010-02-03T14:03:44Z

← Older revision		Revision as of 14:03, 3 February 2010
Line 5:		Line 5:
	Dependency callbacks will be called for the initial form setup and if the value of an attribute changes. The mechanism is supported by all attributes which implement an on-change handler (most attributes and relations). At the moment dependency callbacks can easily hide, show and refresh attributes by using simple PHP code (no JavaScript needed), more features might be added in the future.		Dependency callbacks will be called for the initial form setup and if the value of an attribute changes. The mechanism is supported by all attributes which implement an on-change handler (most attributes and relations). At the moment dependency callbacks can easily hide, show and refresh attributes by using simple PHP code (no JavaScript needed), more features might be added in the future.

	~~The~~ examples below use a PHP 5.3 closures, but you can use other types of callbacks (everything for which is_callable returns true) too.		Most examples below use a PHP 5.3 closures, but you can use other types of callbacks (everything for which is_callable returns true) too.

	== Show / hide ==		== Show / hide ==

bahtiar: /* Show / hide */

2010-02-03T14:03:23Z

Show / hide

@@ Line 8: / Line 8: @@
 == Show / hide ==
-An example:
+An example using a callback function in the node:
 <syntaxhighlight lang="php">
 $this->getAttribute('type')->addDependency(function(atkEditFormModifier $modifier) {

bahtiar at 13:58, 3 February 2010

2010-02-03T13:58:06Z

← Older revision		Revision as of 13:58, 3 February 2010
Line 5:		Line 5:
	Dependency callbacks will be called for the initial form setup and if the value of an attribute changes. The mechanism is supported by all attributes which implement an on-change handler (most attributes and relations). At the moment dependency callbacks can easily hide, show and refresh attributes by using simple PHP code (no JavaScript needed), more features might be added in the future.		Dependency callbacks will be called for the initial form setup and if the value of an attribute changes. The mechanism is supported by all attributes which implement an on-change handler (most attributes and relations). At the moment dependency callbacks can easily hide, show and refresh attributes by using simple PHP code (no JavaScript needed), more features might be added in the future.

	The ~~exampless~~ below use a PHP 5.3 closures, but you can use other types of callbacks (everything for which is_callable returns true) too.		The examples below use a PHP 5.3 closures, but you can use other types of callbacks (everything for which is_callable returns true) too.

	== Show / hide ==		== Show / hide ==

bahtiar at 13:57, 3 February 2010

2010-02-03T13:57:20Z

← Older revision		Revision as of 13:57, 3 February 2010
Line 1:		Line 1:
			{{Howto\|Intermediate\|[[Peter C. Verhage]] <peter@achievo.org>}}

	As of ATK 6.5, ATK supports registering attribute dependency callbacks. This powerful mechanism replaces the older atkAttribute::addDependee mechanism, which is now deprecated (but still works and uses the new dependency mechanism internally).		As of ATK 6.5, ATK supports registering attribute dependency callbacks. This powerful mechanism replaces the older atkAttribute::addDependee mechanism, which is now deprecated (but still works and uses the new dependency mechanism internally).

Peter: moved Dependencies to Attribute dependency callbacks

2010-02-03T13:44:55Z

moved Dependencies to Attribute dependency callbacks

← Older revision	Revision as of 13:44, 3 February 2010
(No difference)

Peter: Created page with 'As of ATK 6.5, ATK supports registering attribute dependency callbacks. This powerful mechanism replaces the older atkAttribute::addDependee mechanism, which is now deprecated (b…'

2010-02-03T13:43:44Z

Created page with 'As of ATK 6.5, ATK supports registering attribute dependency callbacks. This powerful mechanism replaces the older atkAttribute::addDependee mechanism, which is now deprecated (b…'

New page

As of ATK 6.5, ATK supports registering attribute dependency callbacks. This powerful mechanism replaces the older atkAttribute::addDependee mechanism, which is now deprecated (but still works and uses the new dependency mechanism internally).

Dependency callbacks will be called for the initial form setup and if the value of an attribute changes. The mechanism is supported by all attributes which implement an on-change handler (most attributes and relations). At the moment dependency callbacks can easily hide, show and refresh attributes by using simple PHP code (no JavaScript needed), more features might be added in the future.

The exampless below use a PHP 5.3 closures, but you can use other types of callbacks (everything for which is_callable returns true) too.

== Show / hide ==
An example:
<syntaxhighlight lang="php">
$this->getAttribute('type')->addDependency(function(atkEditFormModifier $modifier) {
$record = $modifier->getRecord();
if ($record['type'] == 'other') {
$modifier->showAttribute('description');
} else {
$modifier->hideAttribute('description');
}
});
</syntaxhighlight>
In the example above we only show the description attribute when the value of the type attribute is "other". Because the dependency is already evaluated upon initial form setup the description field might already be hidden before the user gets to see the form (depending on the default value of type). After the user changes the type in the form an Ajax callback is used to re-evaluate the dependency and hide/show the description field using some JavaScript code (which you don't need to know about).

== Refresh ==
Another example:
<syntaxhighlight lang="php">
$this->getAttribute('customer')->addDependency(function(atkEditFormModifier $modifier) {
$modifier->refreshAttribute('contact');
$modifier->refreshAttribute('contract');
});
</syntaxhighlight>
In this example we will be refreshing the contact and contract attributes when another customer is selected. Assuming these attributes have a filter which is based on the currently selected customer, this means you can now only select contacts and contracts for the newly selected customer.

== Custom JavaScript ==
You can also execute custom JavaScript using the scriptCode method, this makes it possible to do any kind of manipulation you can think of:
<syntaxhighlight lang="php">
$this->getAttribute('type')->addDependency(function(atkEditFormModifier $modifier) {
$modifier->scriptCode("
alert('Nice, huh?');
");
});
</syntaxhighlight>