Class QDataRepeater

The QDataRepeater is a generic html base object for creating an object that contains a list of items tied to the database. To specify how to draw the items, you can either create a template file, override the GetItemHtml method, override the GetItemInnerHtml and GetItemAttributes methods, or specify corresponding callbacks for those methods.

The callbacks below can be specified as either a string, or an array. If a string, it should be the name of a public method in the parent form. If an array, it should be a PHP Callable array. If your callback is a method in a form, do NOT pass the form object in to the array, but rather just pass the name of the method as a string. (This is due to a problem PHP has with serializing recursive objects.) If its a method in a control, pass an array with the control and method name, i.e. [$objControl, 'RenderMethod']

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QPaginatedControl uses QDataBinder

QDataRepeater

Package: Controls
Located at includes/base_controls/QDataRepeater.class.php

Methods summary
`public`	# `ParsePostData( )` ParsePostData parses the value of this control from FormState ParsePostData parses the value of this control from FormState This abstract method must be implemented by all controls. When utilizing formgen, the programmer should never access form variables directly (e.g. via the $_FORM array). It can be assumed that at ANY given time, a control's values/properties will be "up to date" with whatever the webuser has entered in. When a Form is Created via Form::Create(string), the form will go through to check and see if it is a first-run of a form, or if it is a post-back. If it is a postback, it will go through its own private array of controls and call ParsePostData on EVERY control it has. Each control is responsible for "knowing" how to parse the $_POST data to update its own values/properties based on what was returned to via the postback.
`protected string`	# `GetItemHtml( $objItem )` Returns the html corresponding to a given item. You have many ways of rendering an item: - Specify a template that will get evaluated for each item. See EvaluateTemplate for more info. - Specify a HtmlCallback callable to be called for each item to get the html for the item. - Override this routine. - Specify the item's tag name, and then use the helper functions or callbacks to return just the attributes and/or inner html of the object. Returns the html corresponding to a given item. You have many ways of rendering an item: - Specify a template that will get evaluated for each item. See EvaluateTemplate for more info. - Specify a HtmlCallback callable to be called for each item to get the html for the item. - Override this routine. - Specify the item's tag name, and then use the helper functions or callbacks to return just the attributes and/or inner html of the object. Parameters `$objItem` Returns string Throws `QCallerException`
`protected array`	# `GetItemAttributes( $objItem )` Return the attributes that go in the item tag, as an array of key=>value pairs. Values will be escaped for you. If you define AttributesCallback, it will be used to determine the attributes. Return the attributes that go in the item tag, as an array of key=>value pairs. Values will be escaped for you. If you define AttributesCallback, it will be used to determine the attributes. Parameters `$objItem` Returns array
`protected mixed`	# `GetItemInnerHtml( $objItem )` Returns the HTML between the item tags. Uses __toString on the object by default. Will use the InnerHtmlCallback if provided. Returns the HTML between the item tags. Uses __toString on the object by default. Will use the InnerHtmlCallback if provided. Parameters `$objItem` Returns mixed
`protected string`	# `GetControlHtml( )` Returns the HTML for the control. Returns the HTML for the control. Returns string
`public integer\|mixed\|string`	# `__get( string $strName )` PHP magic method PHP magic method Parameters `$strName` Name of the property Returns integer\|mixed\|string Throws Exception\|`QCallerException` Overrides `QPaginatedControl::__get()`
`public mixed\|`	# `__set( string $strName, string $mixValue )` PHP magic method PHP magic method Parameters `$strName` Property name `$mixValue` Property value Returns mixed\| Throws Exception\|`QCallerException`\|`QInvalidCastException` Overrides `QPaginatedControl::__set()`

Methods inherited from QPaginatedControl
`DataBind(), Validate(), __construct()`

Methods inherited from QControlBase
AddAction(), AddActionArray(), AddAttributeScript(), AddChildControl(), AddCssFile(), AddJavascriptFile(), AddPluginCssFile(), AddPluginJavascriptFile(), AddWrapperCssClass(), Blink(), EvaluateTemplate(), Focus(), ForgetState(), GetAllActions(), GetAttributes(), GetChildControl(), GetChildControls(), GetControlFromHierarchyByMethodName(), GetCustomAttribute(), GetCustomAttributes(), GetCustomStyle(), GetEndHtml(), GetEndScript(), GetForm(), GetJavaScriptForEvent(), GetJqControlId(), GetModelConnectorParams(), GetNonWrappedHtml(), GetState(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ProcessActionParameters(), PutState(), Refresh(), RemoveAllActions(), RemoveChildControl(), RemoveChildControls(), RemoveCustomAttribute(), RemoveCustomStyle(), RemoveWrapperCssClass(), Render(), RenderActionScripts(), RenderAjax(), RenderAttributeScripts(), RenderChildren(), RenderComment(), RenderCssStyles(), RenderExtensionRenderer(), RenderHelper(), RenderHtmlAttributes(), RenderOutput(), RenderWithError(), RenderWithName(), RenderWrappedOutput(), ResetFlags(), ResetOnPageStatus(), SetCustomAttribute(), SetCustomStyle(), SetFocus(), SetForm(), SetParentControl(), Sleep(), SleepHelper(), ValidateControlAndChildren(), ValidationReset(), VarExport(), Wakeup(), WakeupHelper(), Watch(), _CallActionMethod(), _ProcessActionParams(), _ReadState(), _WriteState()

Methods inherited from QHtmlAttributeManagerBase
`AddCssClass(), GetCssStyle(), GetDataAttribute(), GetHtmlAttribute(), GetHtmlAttributes(), HasCssClass(), HasCssStyle(), HasHtmlAttribute(), Override(), RemoveCssClass(), RemoveCssClassesByPrefix(), RemoveCssStyle(), RemoveDataAttribute(), RemoveHtmlAttribute(), RenderTag(), SetCssBoxValue(), SetCssClass(), SetCssStyle(), SetDataAttribute(), SetHtmlAttribute()`

Methods inherited from QBaseClass
`OverrideAttributes(), __call()`

Methods used from QDataBinder
`CallDataBinder(), GetForm(), HasDataBinder(), SetDataBinder(), Sleep(), Wakeup()`

Constants inherited from QControlBase
`CommentEnd, CommentStart`

Properties summary
`protected string`	`$strTemplate`	# `null`
`protected integer`	`$intCurrentItemIndex`	# `null`
`protected string`	`$strTagName`	# `'div'`
`protected string`	`$strItemTagName`	# `'div'`
`protected Callable`	`$itemHtmlCallback` \| string \| string	#
`protected Callable`	`$itemAttributesCallback` \| string \| string	#
`protected Callable`	`$itemInnerHtmlCallback` \| string \| string	#

Properties inherited from QPaginatedControl
`$blnIsBlockElement, $blnUseAjax, $objDataSource, $objPaginator, $objPaginatorAlternate, $strNoun, $strNounPlural`

Properties inherited from QControlBase
$blnActionsMustTerminate, $blnAutoRender, $blnDisplay, $blnMinimize, $blnModified, $blnOnPage, $blnRendered, $blnRendering, $blnRequired, $blnSaveState, $blnScriptsOnly, $blnUseWrapper, $blnVisible, $blnWrapLabel, $blnWrapperModified, $mixActionParameter, $mixCausesValidation, $objActionArray, $objChildControlArray, $objDraggable, $objDroppable, $objForm, $objLinkedNode, $objParentControl, $objResizable, $objWatcher, $objWrapperStyler, $strAttributeScripts, $strControlId, $strCssClass, $strCustomAttributeArray, $strCustomStyleArray, $strFormAttributes, $strHtmlAfter, $strHtmlBefore, $strInstructions, $strJavaScripts, $strName, $strPreferredRenderMethod, $strRenderMethod, $strStyleSheets, $strValidationError, $strWarning

Properties inherited from QHtmlAttributeManagerBase
`$attributes, $styles`

Properties used from QDataBinder
`$objDataBinder`

Magic properties summary
`public string`	`$TagName` The tag name to be used as the main object
`public string`	`$ItemTagName` The tag name to used for each item (if Template is not defined)
`public string`	`$Template` A php template file that will be evaluated for each item. The template will have $_ITEM as the item in the DataSource array, $_CONTROL as this control, and $_FORM as the form object. If you provide a template, the callbacks will not be used.
`public read-only integer`	`$CurrentItemIndex` The zero-based index of the item being drawn.
`public write-only string`	`$ItemHtmlCallback` A Callable which will be called to get the html for each item. Parameters passed are the item from the DataSource array, and the index of the item being drawn. The callback should return the entire html for the item. If you provide this callback, the ItemAttributesCallback and ItemInnerHtmlCallback will not be used.
`public write-only string`	`$ItemAttributesCallback` A Callable which will be called to get the attributes for each item. Use this with the ItemInnerHtmlCallback and the ItemTagName. The callback will be passed the item and the index of the item. It should return key/value pairs which will be used as the attributes for the item's tag. Use only if you are not using a Template or the ItemHtmlCallback.
`public write-only string`	`$ItemInnerHtmlCallback` A Callable which will be called to get the inner html for each item. Use this with the ItemAttributesCallback and the ItemTagName. The callback will be passed the item and the index of the item. It should return the complete text to appear inside the open and close tags for the item. *

Magic properties inherited from QPaginatedControl
`$DataSource, $ItemCount, $ItemsOffset, $ItemsPerPage, $LimitClause, $LimitInfo, $Noun, $NounPlural, $PageCount, $PageNumber, $Paginator, $PaginatorAlternate, $TotalItemCount, $UseAjax`

Magic properties inherited from QControlBase
`$ActionParameter, $ActionsMustTerminate, $AutoRender, $CausesValidation, $ControlId, $Form, $FormAttributes, $HtmlAfter, $HtmlBefore, $Instructions, $JavaScripts, $LinkedNode, $Minimize, $Modified, $Moveable, $Name, $OnPage, $ParentControl, $PreferredRenderMethod, $RenderMethod, $Rendered, $Rendering, $Required, $Resizable, $SaveState, $ScriptsOnly, $StyleSheets, $UseWrapper, $ValidationError, $Visible, $Warning, $WrapLabel, $WrapperCssClass, $WrapperModified`

Magic properties inherited from QHtmlAttributeManagerBase
`$AccessKey, $AltText, $BackColor, $BorderCollapse, $BorderColor, $BorderStyle, $BorderWidth, $CssClass, $Cursor, $Data, $Display, $DisplayStyle, $Enabled, $FontBold, $FontItalic, $FontNames, $FontOverline, $FontSize, $FontStrikeout, $FontUnderline, $ForeColor, $Height, $HorizontalAlign, $Left, $Margin, $NoWrap, $Opacity, $OrderedListType, $Overflow, $Padding, $Position, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $VerticalAlign, $Width`

Packages

Classes

Traits

Exceptions

Functions

Class QDataRepeater

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides