AtkDummyAttribute - Revision history

bahtiar: /* Advanced usage */

2008-08-18T21:47:35Z

Advanced usage

← Older revision		Revision as of 21:47, 18 August 2008
Line 17:		Line 17:
	= Advanced usage =		= Advanced usage =

	~~it is possible to~~ use ~~this attribute among other things to give a dynamic non edit field.~~ a ~~none dynamic string from other attributes should use~~ [[~~atkParserAttribute~~]] ~~instead~~.		If the contents of the dummy attribute depends on the currently edited record, and the [[atkParserAttribute]] isn't flexible enough, then you can use an atkDummyAttribute in combination with a [[display override]] to add arbitrary content to a screen.

	~~for~~ example:		In the below example, we use this principle to hide both the 'first_name' and 'last_name' columnts, and instead show a dummy attribute that provides a concatenated version of the full name.

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
Line 41:		Line 41:
	</syntaxhighlight>		</syntaxhighlight>

	Note the AF_FORCE_LOAD without it the fields ~~wont~~ be in the ~~returned result~~ if ~~AF_HIDE_LIST is used~~		Note the AF_FORCE_LOAD flag; without it the fields won't be in the SQL query for this screen. Since we need them anyway in the display override, we apply AF_FORCE_LOAD to make sure the values are always loaded even if they are hidden.

	~~from a table of:~~		= FAQ =
	~~{\| border~~=1
	\|-
	~~\| John~~
	~~\| Doe~~
	\|-
	~~\| Jane~~
	\|
	\|-
	\|}

	~~This should produce:~~		== Where are the attribute labels? ==

	~~Doe, John~~

	~~Jane~~

	==~~= FAQ ===~~

	~~<strong>~~Where are the attribute labels?~~</strong>~~

	The atkDummyAttribute defaults to no label. If you wish to reinstate the label, configure it as follows:		The atkDummyAttribute defaults to no label. If you wish to reinstate the label, configure it as follows:
Line 74:		Line 57:
	(Do not attempt to set the flag using the third argument to add(), and do not attempt to remove the label afterwards; it must be passed through to the atkDummyAttribute constructor, as above.)		(Do not attempt to set the flag using the third argument to add(), and do not attempt to remove the label afterwards; it must be passed through to the atkDummyAttribute constructor, as above.)

	=== See Also ===		= See Also =

	* [[Usage without DB I/O Polymorphism]] - prevent an attribute from attempting to access the database; useful if you want to create a dummy "structured" attribute, such as a date attribute		* [[Usage without DB I/O Polymorphism]] - prevent an attribute from attempting to access the database; useful if you want to create a dummy "structured" attribute, such as a date attribute
	* [[AtkExpressionAttribute]] - value is an SQL expression		* [[AtkExpressionAttribute]] - value is an SQL expression
	* [[AtkParserAttribute]] - value is derived from other attributes		* [[AtkParserAttribute]] - value is derived from other attributes

bahtiar at 21:42, 18 August 2008

2008-08-18T21:42:39Z

← Older revision		Revision as of 21:42, 18 August 2008
Line 1:		Line 1:
	{{attribute}}		{{attribute}}

			The atkDummyAttribute can be used to add arbitrary text/html to a form. It's called 'dummy' because it's an attribute that is not persisted in the database in any way.

			= Basic usage =

			Using an atkDummyAttribute is fairly easy. Just add it to a node and pass the desired text as the second parameter.

			<syntaxhighlight lang="php">
			$this->add(new atkDummyAttribute("explanation", "Enter your mother's maiden name in the below field only if your mother agrees"));
			</syntaxhighlight>

			Note that dummy attributes by default do not have a label (as its regular usecase normally doesn't require one). In the occasion that you do want the label to be visible, you can add the [[Attribute flags\|attribute flag]] AF_DUMMY_SHOW_LABEL.

			A slightly more sophisticated version of the atkDummyAttribute is the [[atkParserAttribute]]. It has the same api, but features the substitution of template variables in the text.

			= Advanced usage =

	it is possible to use this attribute among other things to give a dynamic non edit field. a none dynamic string from other attributes should use [[atkParserAttribute]] instead.		it is possible to use this attribute among other things to give a dynamic non edit field. a none dynamic string from other attributes should use [[atkParserAttribute]] instead.

Mjs: /* See Also */

2008-08-18T16:57:23Z

Mjs at 09:21, 14 August 2008

2008-08-14T09:21:07Z

@@ Line 43: / Line 43: @@
 Jane
 === See Also ===
 * [[Usage without DB I/O Polymorphism]] - prevent an attribute from attempting to access the database; useful if you want to create a dummy "structured" attribute, such as a date attribute

Mjs at 08:57, 14 August 2008

2008-08-14T08:57:08Z

← Older revision		Revision as of 08:57, 14 August 2008
Line 46:		Line 46:
	=== See Also ===		=== See Also ===

	* [[Usage without DB I/O Polymorphism]] - prevent ~~attributes~~ from ~~accessing~~ the database		* [[Usage without DB I/O Polymorphism]] - prevent an attribute from attempting to access the database; useful if you want to create a dummy "structured" attribute, such as a date attribute

Mjs at 15:15, 12 August 2008

2008-08-12T15:15:51Z

← Older revision		Revision as of 15:15, 12 August 2008
Line 43:		Line 43:

	Jane		Jane

			=== See Also ===

			* [[Usage without DB I/O Polymorphism]] - prevent attributes from accessing the database

bahtiar at 17:25, 19 December 2007

2007-12-19T17:25:09Z

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

	it is possible to use this attribute among other things to give a dynamic non edit field. a none dynamic string from other attributes should use [[atkParserAttribute]] instead.		it is possible to use this attribute among other things to give a dynamic non edit field. a none dynamic string from other attributes should use [[atkParserAttribute]] instead.

bahtiar at 21:27, 17 December 2007

2007-12-17T21:27:51Z

← Older revision		Revision as of 21:27, 17 December 2007
Line 3:		Line 3:
	for example:		for example:

			<syntaxhighlight lang="php">
	$this->add(new atkAttribute("first_name", AF_HIDE_LIST\|AF_FORCE_LOAD));		$this->add(new atkAttribute("first_name", AF_HIDE_LIST\|AF_FORCE_LOAD));
	$this->add(new atkAttribute("last_name", AF_HIDE_LIST\|AF_FORCE_LOAD));		$this->add(new atkAttribute("last_name", AF_HIDE_LIST\|AF_FORCE_LOAD));
	$this->add(new atkDummyAttribute("name_citation"));		$this->add(new atkDummyAttribute("name_citation"));

	function name_citation_display($record) {		function name_citation_display($record)
	if (strlen($record["last_name"]) <> 0) {		{
			if (strlen($record["last_name"]) <> 0)
			{
	$string = $record["last_name"] . ", ". $record["first_name"];		$string = $record["last_name"] . ", ". $record["first_name"];
	} else {		}
			else
			{
	$string = $record["first_name"];		$string = $record["first_name"];
	}		}
Line 16:		Line 21:
	return $string;		return $string;
	}		}
			</syntaxhighlight>

	Note the AF_FORCE_LOAD without it the fields wont be in the returned result if AF_HIDE_LIST is used		Note the AF_FORCE_LOAD without it the fields wont be in the returned result if AF_HIDE_LIST is used

Sams90 at 07:17, 13 December 2007

2007-12-13T07:17:57Z

← Older revision		Revision as of 07:17, 13 December 2007
Line 3:		Line 3:
	for example:		for example:

	$this->add(new atkAttribute("first_name", AF_HIDE_LIST\|AF_FORCE_LOAD));		$this->add(new atkAttribute("first_name", AF_HIDE_LIST\|AF_FORCE_LOAD));
	$this->add(new atkAttribute("last_name", AF_HIDE_LIST\|AF_FORCE_LOAD));		$this->add(new atkAttribute("last_name", AF_HIDE_LIST\|AF_FORCE_LOAD));
	$this->add(new atkDummyAttribute("name_citation"));		$this->add(new atkDummyAttribute("name_citation"));

	function name_citation_display($record) {		function name_citation_display($record) {
	if (strlen($record["last_name"]) <> 0) {		if (strlen($record["last_name"]) <> 0) {
	$string = $record["last_name"] . ", ". $record["first_name"];		$string = $record["last_name"] . ", ". $record["first_name"];
	} else {		} else {
	$string = $record["first_name"];		$string = $record["first_name"];
			}

			return $string;
	}		}

	~~return $string;~~		Note the AF_FORCE_LOAD without it the fields wont be in the returned result if AF_HIDE_LIST is used
	}

	from a table of:		from a table of:
	John \| Doe		{\| border=1
	Jane \|		\|-
			\| John
			\| Doe
			\|-
			\| Jane
			\|
			\|-
			\|}

	This should produce:		This should produce:

	Doe, John		Doe, John

	Jane		Jane

Sams90 at 07:12, 13 December 2007

2007-12-13T07:12:46Z

New page

it is possible to use this attribute among other things to give a dynamic non edit field. a none dynamic string from other attributes should use [[atkParserAttribute]] instead.

for example:

$this->add(new atkAttribute("first_name", AF_HIDE_LIST|AF_FORCE_LOAD));
$this->add(new atkAttribute("last_name", AF_HIDE_LIST|AF_FORCE_LOAD));
$this->add(new atkDummyAttribute("name_citation"));

function name_citation_display($record) {
if (strlen($record["last_name"]) <> 0) {
$string = $record["last_name"] . ", ". $record["first_name"];
} else {
$string = $record["first_name"];
}

return $string;
}

from a table of:
John | Doe
Jane |

This should produce:
Doe, John
Jane

← Older revision		Revision as of 16:57, 18 August 2008
Line 61:		Line 61:

	* [[Usage without DB I/O Polymorphism]] - prevent an attribute from attempting to access the database; useful if you want to create a dummy "structured" attribute, such as a date attribute		* [[Usage without DB I/O Polymorphism]] - prevent an attribute from attempting to access the database; useful if you want to create a dummy "structured" attribute, such as a date attribute
			* [[AtkExpressionAttribute]] - value is an SQL expression
			* [[AtkParserAttribute]] - value is derived from other attributes