Conditional Validates - Revision history

bahtiar at 14:02, 12 February 2010

2010-02-12T14:02:38Z

← Older revision		Revision as of 14:02, 12 February 2010
Line 23:		Line 23:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	function validate(&$record, $mode, $ignoreList = array())		public function validate(&$record, $mode, $ignoreList = array())
	{		{
	// Evaluate a condition		// Evaluate a condition
	if ($record["identification_method"]=='passport')		if ($record["identification_method"]=='passport') {
	{
	// Retrieve the passport id attribute		// Retrieve the passport id attribute
	$passportAttr = &$this->getAttribute("passport_number");		$passportAttr = &$this->getAttribute("passport_number");

	// Make the passport number obligatory		// Make the passport number obligatory
	$passportAttr->addFlag(AF_OBLIGATORY);		$passportAttr->addFlag(AF_OBLIGATORY);
	}		}

	// Call the original validate method		// Call the original validate method
	return parent::validate($record, $mode, $ignoreList);		return parent::validate($record, $mode, $ignoreList);
	}		}
	</syntaxhighlight>		</syntaxhighlight>

Leon: Fix destruction

2007-06-15T06:47:37Z

Fix destruction

← Older revision		Revision as of 06:47, 15 June 2007
Line 23:		Line 23:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	function validate(</syntaxhighlight>		function validate(&$record, $mode, $ignoreList = array())
			{
			// Evaluate a condition
			if ($record["identification_method"]=='passport')
			{
			// Retrieve the passport id attribute
			$passportAttr = &$this->getAttribute("passport_number");

			// Make the passport number obligatory
			$passportAttr->addFlag(AF_OBLIGATORY);
			}

			// Call the original validate method
			return parent::validate($record, $mode, $ignoreList);
			}
			</syntaxhighlight>

			The last line is very important: the original validate method is called to perform the actual validation.

			Note how we don't validate the data itself. Instead, we evaluate the condition, and if we want the field to be required, we add the AF_OBLIGATORY flag. We could have written our own validation here, but this approach is much easier. Complex attributes have different ways of validating if a value is considered empty or not. By only manipulating the flag, we let the framework handle the gory details of checking whether values are actually empty.

Oy8Ipn at 14:19, 14 June 2007

2007-06-14T14:19:41Z

← Older revision		Revision as of 14:19, 14 June 2007
Line 23:		Line 23:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	function validate(~~&$record, $mode, $ignoreList = array())~~		function validate(</syntaxhighlight>
	{
	~~// Evaluate a condition~~
	~~if ($record["identification_method"]=='passport')~~
	{
	~~// Retrieve the passport id attribute~~
	~~$passportAttr = &$this->getAttribute("passport_number");~~

	~~// Make the passport number obligatory~~
	~~$passportAttr->addFlag(AF_OBLIGATORY);~~
	}

	~~// Call the original validate method~~
	~~return parent::validate($record, $mode, $ignoreList);~~
	}
	</syntaxhighlight>

	~~The last line is very important: the original validate method is called to perform the actual validation.~~

	Note how we don't validate the data itself. Instead, we evaluate the condition, and if we want the field to be required, we add the AF_OBLIGATORY flag. We could have written our own validation here, but this approach is much easier. Complex attributes have different ways of validating if a value is considered empty or not. By only manipulating the flag, we let the framework handle the gory details of checking whether values are actually empty.

bahtiar: fix destruction

2007-04-11T21:58:59Z

fix destruction

← Older revision		Revision as of 21:58, 11 April 2007
Line 23:		Line 23:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	function validate(</syntaxhighlight>		function validate(&$record, $mode, $ignoreList = array())
			{
			// Evaluate a condition
			if ($record["identification_method"]=='passport')
			{
			// Retrieve the passport id attribute
			$passportAttr = &$this->getAttribute("passport_number");

			// Make the passport number obligatory
			$passportAttr->addFlag(AF_OBLIGATORY);
			}

			// Call the original validate method
			return parent::validate($record, $mode, $ignoreList);
			}
			</syntaxhighlight>

			The last line is very important: the original validate method is called to perform the actual validation.

			Note how we don't validate the data itself. Instead, we evaluate the condition, and if we want the field to be required, we add the AF_OBLIGATORY flag. We could have written our own validation here, but this approach is much easier. Complex attributes have different ways of validating if a value is considered empty or not. By only manipulating the flag, we let the framework handle the gory details of checking whether values are actually empty.

LzeJ9l at 18:09, 11 April 2007

2007-04-11T18:09:22Z

← Older revision		Revision as of 18:09, 11 April 2007
Line 23:		Line 23:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	function validate(~~&$record, $mode, $ignoreList = array())~~		function validate(</syntaxhighlight>
	{
	~~// Evaluate a condition~~
	~~if ($record["identification_method"]=='passport')~~
	{
	~~// Retrieve the passport id attribute~~
	~~$passportAttr = &$this->getAttribute("passport_number");~~

	~~// Make the passport number obligatory~~
	~~$passportAttr->addFlag(AF_OBLIGATORY);~~
	}

	~~// Call the original validate method~~
	~~return parent::validate($record, $mode, $ignoreList);~~
	}
	</syntaxhighlight>

	~~The last line is very important: the original validate method is called to perform the actual validation.~~

	Note how we don't validate the data itself. Instead, we evaluate the condition, and if we want the field to be required, we add the AF_OBLIGATORY flag. We could have written our own validation here, but this approach is much easier. Complex attributes have different ways of validating if a value is considered empty or not. By only manipulating the flag, we let the framework handle the gory details of checking whether values are actually empty.

bahtiar at 15:12, 14 January 2007

2007-01-14T15:12:14Z

← Older revision		Revision as of 15:12, 14 January 2007
Line 22:		Line 22:
	Let's take an example. Say, for example, that you have a node for entering employees, and users can select an 'identification method' from a dropdown box. They can also enter a 'passport number'. But they only need to fill in the passport number, if 'identification method' is set to 'passport'. Here's what the validate() method would look like in this case:		Let's take an example. Say, for example, that you have a node for entering employees, and users can select an 'identification method' from a dropdown box. They can also enter a 'passport number'. But they only need to fill in the passport number, if 'identification method' is set to 'passport'. Here's what the validate() method would look like in this case:

			<syntaxhighlight lang="php">
	function validate(&$record, $mode, $ignoreList = array())		function validate(&$record, $mode, $ignoreList = array())
	{		{
Line 37:		Line 38:
	return parent::validate($record, $mode, $ignoreList);		return parent::validate($record, $mode, $ignoreList);
	}		}
			</syntaxhighlight>

	The last line is very important: the original validate method is called to perform the actual validation.		The last line is very important: the original validate method is called to perform the actual validation.

	Note how we don't validate the data itself. Instead, we evaluate the condition, and if we want the field to be required, we add the AF_OBLIGATORY flag. We could have written our own validation here, but this approach is much easier. Complex attributes have different ways of validating if a value is considered empty or not. By only manipulating the flag, we let the framework handle the gory details of checking whether values are actually empty.		Note how we don't validate the data itself. Instead, we evaluate the condition, and if we want the field to be required, we add the AF_OBLIGATORY flag. We could have written our own validation here, but this approach is much easier. Complex attributes have different ways of validating if a value is considered empty or not. By only manipulating the flag, we let the framework handle the gory details of checking whether values are actually empty.

bahtiar: /* Writing the code */

2006-07-21T18:26:41Z

Writing the code

← Older revision		Revision as of 18:26, 21 July 2006
Line 31:		Line 31:

	// Make the passport number obligatory		// Make the passport number obligatory
	$passportAttr->~~m_flags \|=~~ AF_OBLIGATORY;		$passportAttr->addFlag(AF_OBLIGATORY);
	}		}

bahtiar at 21:57, 8 June 2006

2006-06-08T21:57:53Z

← Older revision		Revision as of 21:57, 8 June 2006
Line 1:		Line 1:
	{{howto\|Easy\|[[Ivo Jansch]] <ivo@achievo.org>}}		{{howto\|Easy\|[[Ivo Jansch]] <ivo@achievo.org>}}

			== Intro ==

			If you've worked with ATK a bit, you surely know when and how to use the AF_OBLIGATORY flag.

			If you're developing a larger application in ATK, you might at some point in time get a situation where a field is required, but only in specific situations. For example, field B is only required if field A has a certain value.

			This can be accomplished with only a small amount of code. This howto explains how to accomplish this.

			== Writing the code ==

			Usually, you add an AF_OBLIGATORY flag directly to the attribute, to make it a required field. However, if you do that, it will be required at all times.

			The solution comes down to overriding an atkNode method in your own node. By adding the AF_OBLIGATORY flag before the validation happens, but with the record in memory, we can add conditions for when to apply AF_OBLIGATORY and when not.

			The method that is called on your node by the framework when validating data, is validate().
			The default implementation of this method validates if obligatory fields are filled in, if fields are unique, etc.

			Overriding this method is a matter of copying its signature to your node, and adding your own implementation.

			Let's take an example. Say, for example, that you have a node for entering employees, and users can select an 'identification method' from a dropdown box. They can also enter a 'passport number'. But they only need to fill in the passport number, if 'identification method' is set to 'passport'. Here's what the validate() method would look like in this case:

			function validate(&$record, $mode, $ignoreList = array())
			{
			// Evaluate a condition
			if ($record["identification_method"]=='passport')
			{
			// Retrieve the passport id attribute
			$passportAttr = &$this->getAttribute("passport_number");

			// Make the passport number obligatory
			$passportAttr->m_flags \|= AF_OBLIGATORY;
			}

			// Call the original validate method
			return parent::validate($record, $mode, $ignoreList);
			}


			The last line is very important: the original validate method is called to perform the actual validation.

			Note how we don't validate the data itself. Instead, we evaluate the condition, and if we want the field to be required, we add the AF_OBLIGATORY flag. We could have written our own validation here, but this approach is much easier. Complex attributes have different ways of validating if a value is considered empty or not. By only manipulating the flag, we let the framework handle the gory details of checking whether values are actually empty.

bahtiar at 21:47, 8 June 2006

2006-06-08T21:47:31Z

← Older revision		Revision as of 21:47, 8 June 2006
Line 1:		Line 1:
	{{~~Howto~~\|Easy}}		{{howto\|Easy\|[[Ivo Jansch]] <ivo@achievo.org>}}

bahtiar at 21:43, 8 June 2006

2006-06-08T21:43:08Z

New page