AtkExtendableShuttleRelation - Revision history

bahtiar at 21:52, 18 August 2008

2008-08-18T21:52:56Z

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

	'''The extendableShuttleRelation is a many-to-many relation which can be extended with so called controls. These controls are AJAX-components which can, for example, be used to show information about the current available/selected items or to filter these items.'''		'''The extendableShuttleRelation is a many-to-many relation which can be extended with so called controls. These controls are AJAX-components which can, for example, be used to show information about the current available/selected items or to filter these items.'''

Tjeerd at 15:17, 28 June 2007

2007-06-28T15:17:34Z

← Older revision		Revision as of 15:17, 28 June 2007
Line 140:		Line 140:
	</syntaxhighlight>		</syntaxhighlight>

	This will result into ~~similair like this~~:		This will result into:

	[[Image:shuttle.jpg]]		[[Image:shuttle.jpg]]

	[[Category:Relations]]		[[Category:Relations]]

Tjeerd at 15:16, 28 June 2007

2007-06-28T15:16:06Z

← Older revision		Revision as of 15:16, 28 June 2007
Line 139:		Line 139:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			This will result into similair like this:

			[[Image:shuttle.jpg]]

	[[Category:Relations]]		[[Category:Relations]]

Tjeerd at 14:56, 28 June 2007

2007-06-28T14:56:17Z

← Older revision		Revision as of 14:56, 28 June 2007
Line 117:		Line 117:
	</syntaxhighlight>		</syntaxhighlight>
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	class ~~selectedCountControl~~ extends atkShuttleControl		class selectedCounterControl extends atkShuttleControl
	{		{
	public function needsRefresh($type, $record)		public function needsRefresh($type, $record)
Line 134:		Line 134:
	{		{
	return '		return '
	<div id="'.$this->getFormName($prefix).'">{$this->m_name}: '.count($record[$this->m_shuttle->fieldName()]['selected']).'</div>		<div id="'.$this->getFormName($prefix).'">'.$this->m_name.': '.count($record[$this->m_shuttle->fieldName()]['selected']).'</div>
	';		';
	}		}

Tjeerd at 14:49, 28 June 2007

2007-06-28T14:49:10Z

← Older revision		Revision as of 14:49, 28 June 2007
Line 32:		Line 32:
	For the atkShuttleFilter you need to implement one more function:		For the atkShuttleFilter you need to implement one more function:

			<syntaxhighlight lang="php">
	/**		/**
	* Returns a filter clause for this filter's current value.		* Returns a filter clause for this filter's current value.
Line 40:		Line 41:
	*/		*/
	public abstract function getFilter($record);		public abstract function getFilter($record);
			</syntaxhighlight>

	Optionally, you can implement this function:		Optionally, you can implement this function:

			<syntaxhighlight lang="php">
	/**		/**
	* Called if a filter or selection event has occured. And allows the control to		* Called if a filter or selection event has occured. And allows the control to
Line 53:		Line 56:
	*/		*/
	public function needsRefresh($type, $record)		public function needsRefresh($type, $record)
			</syntaxhighlight>

	Controls can be added to the relation as follows:		Controls can be added to the relation as follows:
Line 61:		Line 65:

	Example:		Example:
	<~~pre~~>		<syntaxhighlight lang="php">
	userelation("atkextendableshuttlerelation");		userelation("atkextendableshuttlerelation");
	atkimport("controls/class.selectedcountercontrol.inc");		atkimport("controls/class.selectedcountercontrol.inc");
Line 87:		Line 91:
	}		}
	}		}
	</~~pre~~>		</syntaxhighlight>
	<~~pre~~>		<syntaxhighlight lang="php">
	class searchFilter extends atkShuttleFilter		class searchFilter extends atkShuttleFilter
	{		{
Line 111:		Line 115:
	}		}
	}		}
	</~~pre~~>		</syntaxhighlight>
	<~~pre~~>		<syntaxhighlight lang="php">
	class selectedCountControl extends atkShuttleControl		class selectedCountControl extends atkShuttleControl
	{		{
Line 134:		Line 138:
	}		}
	}		}
	</~~pre~~>		</syntaxhighlight>

	[[Category:Relations]]		[[Category:Relations]]

Tjeerd at 14:39, 28 June 2007

2007-06-28T14:39:18Z

← Older revision		Revision as of 14:39, 28 June 2007
Line 13:		Line 13:
	If you want to use a control or filter, you have to extend the atkShuttleControl class or the atkShuttleFilter class and at least implement the following function:		If you want to use a control or filter, you have to extend the atkShuttleControl class or the atkShuttleFilter class and at least implement the following function:

			<syntaxhighlight lang="php">
	/**		/**
	* Renders the control. Returns a piece of HTML that is used in the shuttle		* Renders the control. Returns a piece of HTML that is used in the shuttle
Line 27:		Line 28:
	*/		*/
	public abstract function render($record, $mode, $prefix);		public abstract function render($record, $mode, $prefix);
			</syntaxhighlight>

	For the atkShuttleFilter you need to implement one more function:		For the atkShuttleFilter you need to implement one more function:

Tjeerd at 13:54, 28 June 2007

2007-06-28T13:54:56Z

← Older revision		Revision as of 13:54, 28 June 2007
Line 115:		Line 115:
	public function needsRefresh($type, $record)		public function needsRefresh($type, $record)
	{		{
	if ($this->getValue($record)!==count($this->m_shuttle->~~_getSelectedFields~~(~~$record~~)))		if ($this->getValue($record)!==count($record[$this->m_shuttle->fieldName()]['selected']))
	{		{
	return true;		return true;

Patrick at 13:48, 28 June 2007

2007-06-28T13:48:31Z

← Older revision		Revision as of 13:48, 28 June 2007
Line 16:		Line 16:
	* Renders the control. Returns a piece of HTML that is used in the shuttle		* Renders the control. Returns a piece of HTML that is used in the shuttle
	* to represent this control. If this control has input elements then the		* to represent this control. If this control has input elements then the
	* getFormName ~~function~~ can be used to retrieve the base name for the input		* getFormName method can be used to retrieve the base name for the input
	* elements. The getValue ~~function~~ can be used to retrieve this controls value(s)		* elements. The getValue method can be used to retrieve this controls value(s)
	* for the given record.		* for the given record.
	*		*

Patrick at 13:40, 28 June 2007

2007-06-28T13:40:26Z

Tjeerd at 13:15, 28 June 2007

2007-06-28T13:15:02Z

← Older revision		Revision as of 13:15, 28 June 2007
Line 4:		Line 4:

	function atkExtendableShuttleRelation ($name, $link, $destination, $flags=0)		function atkExtendableShuttleRelation ($name, $link, $destination, $flags=0)
	String $name The name of the relation.		String $name The name of the relation.
	String $link The full name of the node that is used as intermediairy node.		String $link The full name of the node that is used as intermediairy node.
	String $destination The full name of the node that is the other end of the relation.		String $destination The full name of the node that is the other end of the relation.
	int $flags Flags for the relation.		int $flags Flags for the relation.

	As said, the relation can be extended with controls of more specific, filters. The difference between a control and a filter is that a control is readonly (e.g. a counter for selectable records) and a filter is more dynamic (e.g. a filter which limits selectable records to records ending with '1'). Multiple filters can even be dependent of each other.		As said, the relation can be extended with controls of more specific, filters. The difference between a control and a filter is that a control is readonly (e.g. a counter for selectable records) and a filter is more dynamic (e.g. a filter which limits selectable records to records ending with '1'). Multiple filters can even be dependent of each other.
Line 55:		Line 55:

	atkExtendableShuttleRelation::addControl($name, $section)		atkExtendableShuttleRelation::addControl($name, $section)
	String $name The name of the control		String $name The name of the control
	String $section Either atkShuttleControl::AVAILABLE or atkShuttleControl::SELECTABLE. This tells the relation on which side you want to add the control.		String $section Either atkShuttleControl::AVAILABLE or atkShuttleControl::SELECTABLE. This tells the relation on which side you want to add the control.

	Example:		Example:

← Older revision		Revision as of 13:40, 28 June 2007
Line 1:		Line 1:
	'''The extendableShuttleRelation is a many-to-many relation which can be extended with so called controls. These controls are AJAX-components which can, for example, be used to show information about the current available/selected items or to filter these items.'''		'''The extendableShuttleRelation is a many-to-many relation which can be extended with so called controls. These controls are AJAX-components which can, for example, be used to show information about the current available/selected items or to filter these items.'''

	The extendableShuttleRelation is based on the atkShuttleRelation: This implies that its core functionality is the same as the shuttleRelation and therefore can be a substitute for the ordinary shuttleRelation, and ~~maybe~~, in time, completely replace the current shuttleRelation.		The extendableShuttleRelation is based on the atkShuttleRelation: This implies that its core functionality is the same as the shuttleRelation and therefore can be a substitute for the ordinary shuttleRelation, and might, in time, completely replace the current shuttleRelation.

	function atkExtendableShuttleRelation ($name, $link, $destination, $flags=0)		function atkExtendableShuttleRelation ($name, $link, $destination, $flags=0)
Line 9:		Line 9:
	int $flags Flags for the relation.		int $flags Flags for the relation.

	As said, the relation can be extended with controls of more specific, filters. The difference between a control and a filter is that a control is readonly (e.g. a counter for selectable records) and a filter ~~is more dynamic~~ (e.g. a filter which limits selectable records to records ending with '1'). Multiple filters can even ~~be dependent of~~ each other.		As said, the relation can be extended with controls, or more specific, filters. The difference between a control and a filter is that a control is readonly (e.g. a counter for selectable records) and a filter influences the entries in the shuttle lists (e.g. a filter which limits selectable records to records ending with '1'). Multiple filters can even depend on each other.

	If you want to use a control or filter, you have to extend the atkShuttleControl class or the atkShuttleFilter class and at least implement the following ~~method~~:		If you want to use a control or filter, you have to extend the atkShuttleControl class or the atkShuttleFilter class and at least implement the following function:

	/**		/**
	* Renders the control. Returns a piece of HTML that is used in the shuttle		* Renders the control. Returns a piece of HTML that is used in the shuttle
	* to represent this control. If this control has input elements then the		* to represent this control. If this control has input elements then the
	* getFormName ~~method~~ can be used to retrieve the base name for the input		* getFormName function can be used to retrieve the base name for the input
	* elements. The getValue ~~method~~ can be used to retrieve this controls value(s)		* elements. The getValue function can be used to retrieve this controls value(s)
	* for the given record.		* for the given record.
	*		*
Line 28:		Line 28:
	public abstract function render($record, $mode, $prefix);		public abstract function render($record, $mode, $prefix);

	For the atkShuttleFilter you need to implement one more ~~method~~:		For the atkShuttleFilter you need to implement one more function:

	/**		/**
	* Returns a filter clause for this filter's current value.		* Returns a filter clause for this filter's current value.
	* The current value can be retrieved from the record using		* The current value can be retrieved from the record using
	* the getValue ~~method~~.		* the getValue function.
	*		*
	* @param array $record full record		* @param array $record full record
Line 39:		Line 39:
	public abstract function getFilter($record);		public abstract function getFilter($record);

	Optionally you can implement:		Optionally, you can implement this function:

	/**		/**
Line 56:		Line 56:
	atkExtendableShuttleRelation::addControl($name, $section)		atkExtendableShuttleRelation::addControl($name, $section)
	String $name The name of the control		String $name The name of the control
	String $section Either atkShuttleControl::AVAILABLE or atkShuttleControl::SELECTABLE. This tells the relation on which ~~side~~ you want to add the control.		String $section Either atkShuttleControl::AVAILABLE or atkShuttleControl::SELECTABLE. This tells the relation on which shuttle list you want to add the control.

	Example:		Example: