Class: QueryTemplatesSyntaxGenerators

Source Location: /home/bob/workspace/QueryTemplates/src/QueryTemplatesSyntaxGenerators.php

Class Overview

phpQueryObject
   |
   --QueryTemplatesSyntaxDOM
      |
      --QueryTemplatesSyntaxValues
         |
         --QueryTemplatesSyntaxCode
            |
            --QueryTemplatesSyntaxConditions
               |
               --QueryTemplatesSyntaxVars
                  |
                  --QueryTemplatesSyntaxGenerators

Class extending phpQueryObject with templating methods.

Author(s):

Tobiasz Cudnik <tobiasz.cudnik/gmail.com>

Methods

Child classes:

QueryTemplatesSyntax: Class extending phpQueryObject with templating methods.

Inherited Variables

Class: phpQueryObject

phpQueryObject::$charset
phpQueryObject::$current
phpQueryObject::$document
phpQueryObject::$documentFragment
phpQueryObject::$documentID
phpQueryObject::$documentWrapper
phpQueryObject::$elements
phpQueryObject::$elementsBackup
phpQueryObject::$elementsInterator
phpQueryObject::$previous
phpQueryObject::$root
phpQueryObject::$valid
phpQueryObject::$xpath

Inherited Methods

Class: QueryTemplatesSyntaxVars

QueryTemplatesSyntaxVars::loop()
QueryTemplatesSyntaxVars::loopOne()
QueryTemplatesSyntaxVars::loopSeparate()
QueryTemplatesSyntaxVars::valuesToSelector(): Injects markup from $values' content (rows or attributes) into nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::valuesToSelectorAfter(): Injects markup from $values' content (rows or attributes) after nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::valuesToSelectorAppend(): Injects markup from $values' content (rows or attributes) at the end of nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::valuesToSelectorAttr(): Injects markup from $values' content (rows or attributes) as attribute of nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::valuesToSelectorBefore(): Injects markup from $values' content (rows or attributes) before nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::valuesToSelectorPrepend(): Injects markup from $values' content (rows or attributes) at the beggining of nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::valuesToSelectorReplace(): Injects markup from $values' content (rows or attributes) replacing nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::varPrint(): Prints variable $varName as matched elements' content.
QueryTemplatesSyntaxVars::varPrintAfter(): Prints variable $varName after matched elements.
QueryTemplatesSyntaxVars::varPrintAppend(): Prints variable $varName on the end of matched elements.
QueryTemplatesSyntaxVars::varPrintAttr(): Prints variable $varName as attribute $attr of matched elements.
QueryTemplatesSyntaxVars::varPrintBefore(): Prints variable $varName before matched elements.
QueryTemplatesSyntaxVars::varPrintPrepend(): Prints variable $varName on beggining of matched elements.
QueryTemplatesSyntaxVars::varPrintReplace(): Prints variable $varName replacing matched elements.
QueryTemplatesSyntaxVars::varsToForm(): Injects executable code which toggles form fields values and selection states according to value of variable $varName.
QueryTemplatesSyntaxVars::varsToLoop(): Wraps selected elements with executable code iterating $varName as $rowName.
QueryTemplatesSyntaxVars::varsToLoopFirst(): Wraps selected elements with executable code iterating $varName as $rowName.
QueryTemplatesSyntaxVars::varsToLoopSeparate(): Wraps selected elements with executable code iterating $varName as $rowName.
QueryTemplatesSyntaxVars::varsToSelector(): Injects executable code printing variable's fields inside nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::varsToSelectorAfter(): Injects executable code printing variable's fields after nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::varsToSelectorAppend(): Injects executable code printing variable's fields at the end of nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::varsToSelectorAttr(): Injects executable code printing variable's fields as attribute of nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::varsToSelectorBefore(): Injects executable code printing variable's fields before nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::varsToSelectorPrepend(): Injects executable code printing variable's fields at the beggining of nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::varsToSelectorReplace(): Injects executable code printing variable's fields replacing nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxVars::varsToStack(): Injects executable code printing variable's fields inside actually matched nodes. Second param needs to be wrapped with array_keys for non-assosiative arrays.
QueryTemplatesSyntaxVars::varsToStackAfter(): Injects executable code printing variable's fields after actually matched nodes. Second param needs to be wrapped with array_keys for non-assosiative arrays.
QueryTemplatesSyntaxVars::varsToStackAppend(): Injects executable code printing variable's fields at the end of actually matched nodes. Second param needs to be wrapped with array_keys for non-assosiative arrays.
QueryTemplatesSyntaxVars::varsToStackAttr(): Injects executable code printing variable's fields as attribute of actually matched nodes. Second param needs to be wrapped with array_keys for non-assosiative arrays.
QueryTemplatesSyntaxVars::varsToStackBefore(): Injects executable code printing variable's fields before actually matched nodes. Second param needs to be wrapped with array_keys for non-assosiative arrays.
QueryTemplatesSyntaxVars::varsToStackPrepend(): Injects executable code printing variable's fields at the beggining of actually matched nodes. Second param needs to be wrapped with array_keys for non-assosiative arrays.
QueryTemplatesSyntaxVars::varsToStackReplace(): Injects executable code printing variable's fields replacing actually matched nodes. Second param needs to be wrapped with array_keys for non-assosiative arrays.
QueryTemplatesSyntaxVars::_valuesToSelector()
QueryTemplatesSyntaxVars::_varPrint()
QueryTemplatesSyntaxVars::_varsParseFields()
QueryTemplatesSyntaxVars::_varsToLoop()
QueryTemplatesSyntaxVars::_varsToSelector(): Internal method.
QueryTemplatesSyntaxVars::_varsToStack()

Class: QueryTemplatesSyntaxConditions

QueryTemplatesSyntaxConditions::elseIfCode()
QueryTemplatesSyntaxConditions::elseIfNotVar(): Wraps selected tag with PHP "else if" statement checking if $var evaluates to FALSE. $var must be available inside template's scope.
QueryTemplatesSyntaxConditions::elseIfPHP(): Wraps selected tag with PHP "else if" statement containing $code as condition.
QueryTemplatesSyntaxConditions::elseIfVar(): Wraps selected tag with PHP "else if" statement checking if $var evaluates to true. $var must be available inside template's scope.
QueryTemplatesSyntaxConditions::elsePHP(): Wraps selected tag with PHP "else" statement.
QueryTemplatesSyntaxConditions::elseStatement(): TODO description
QueryTemplatesSyntaxConditions::endOnly(): TODO docs
QueryTemplatesSyntaxConditions::ifCode(): TODO doc
QueryTemplatesSyntaxConditions::ifNotVar(): Wraps selected tag with PHP "if" statement checking if $var evaluates to FALSE. $var must be available inside template's scope.
QueryTemplatesSyntaxConditions::ifPHP(): Wraps selected tag with PHP "if" statement containing $code as condition.
QueryTemplatesSyntaxConditions::ifVar(): Wraps selected tag with PHP "if" statement checking if $var evaluates to TRUE. $var must be available inside template's scope.
QueryTemplatesSyntaxConditions::onlyIf(): TODO docs
QueryTemplatesSyntaxConditions::onlyIfNot(): TODO docs
QueryTemplatesSyntaxConditions::onlyJS(): TODO Move to jsCode plugin.
QueryTemplatesSyntaxConditions::onlyPHP(): Honors code between onlyPHP and endOnly, only for PHP templates.
QueryTemplatesSyntaxConditions::tagToElseIfNotVar(): Replaces selected tag with PHP "else if" statement checking if $var evaluates to FALSE. $var must be available inside template's scope.
QueryTemplatesSyntaxConditions::tagToElseIfPHP(): Replaces selected tag with PHP "else if" statement containing $code as condition.
QueryTemplatesSyntaxConditions::tagToElseIfVar(): Replaces selected tag with PHP "else if" statement checking if $var evaluates to TRUE. $var must be available inside template's scope.
QueryTemplatesSyntaxConditions::tagToElsePHP()
QueryTemplatesSyntaxConditions::tagToElseStatement()
QueryTemplatesSyntaxConditions::tagToIfNotVar(): Replaces selected tag with PHP "if" statement checking if $var evaluates to FALSE. $var must be available inside template's scope.
QueryTemplatesSyntaxConditions::tagToIfPHP(): Replaces selected tag with PHP "if" statement containing $code as condition.
QueryTemplatesSyntaxConditions::tagToIfVar(): Replaces selected tag with PHP "if" statement checking if $var evaluates to TRUE. $var must be available inside template's scope.
QueryTemplatesSyntaxConditions::_if()
QueryTemplatesSyntaxConditions::_tagToElse()

Class: QueryTemplatesSyntaxCode

QueryTemplatesSyntaxCode::codeToSelector(): Injects raw executable code inside nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxCode::codeToSelectorAfter(): Injects raw executable code after nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxCode::codeToSelectorAppend(): Injects raw executable code at the end of nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxCode::codeToSelectorAttr(): Injects raw executable code inside attribute of nodes matched by selector.
QueryTemplatesSyntaxCode::codeToSelectorBefore(): Injects raw executable code before nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxCode::codeToSelectorPrepend(): Injects raw executable code at the beggining of nodes matched by selector.
QueryTemplatesSyntaxCode::codeToSelectorReplace(): Injects raw executable code replacing nodes matched by selector. Method uses actually matched nodes as root for the query.
QueryTemplatesSyntaxCode::codeToStack(): Injects raw executable code inside actually matched nodes.
QueryTemplatesSyntaxCode::codeToStackAfter(): Injects raw executable code after actually matched nodes.
QueryTemplatesSyntaxCode::codeToStackAppend(): Injects raw executable code at the beggining of actually matched nodes.
QueryTemplatesSyntaxCode::codeToStackAttr(): Injects raw executable code inside attribute of actually matched nodes.
QueryTemplatesSyntaxCode::codeToStackBefore(): Injects raw executable code before actually matched nodes.
QueryTemplatesSyntaxCode::codeToStackPrepend(): Injects raw executable code at the end of actually matched nodes.
QueryTemplatesSyntaxCode::codeToStackReplace(): Injects raw executable code replacing actually matched nodes.
QueryTemplatesSyntaxCode::_codeToSelector()
QueryTemplatesSyntaxCode::_codeToStack()

Class: QueryTemplatesSyntaxValues

QueryTemplatesSyntaxValues::valuesToForm(): Toggles form fields values and selection states according to static values from $values.
QueryTemplatesSyntaxValues::valuesToLoop(): Method loops provided $values on actually selected nodes. Each time new row is inserted, provided callback is triggered with $dataRow, $node and $dataIndex.
QueryTemplatesSyntaxValues::valuesToLoopBefore(): Method loops provided $values on actually selected nodes. Each time new row is inserted, provided callback is triggered with $dataRow, $node and $dataIndex.
QueryTemplatesSyntaxValues::valuesToLoopFirst(): Method loops provided $values on actually selected nodes. Each time new row is inserted, provided callback is triggered with $dataRow, $node and $dataIndex.
QueryTemplatesSyntaxValues::valuesToLoopSeparate(): Method loops provided $values on actually selected nodes. Each time new row is inserted, provided callback is triggered with $dataRow, $node and $dataIndex.
QueryTemplatesSyntaxValues::valuesToStack(): Injects markup from $values' content (rows or attributes) inside actually selected nodes.
QueryTemplatesSyntaxValues::valuesToStackAfter(): Injects markup from $values' content (rows or attributes) inside actually selected nodes.
QueryTemplatesSyntaxValues::valuesToStackAppend(): Injects markup from $values' content (rows or attributes) inside actually selected nodes.
QueryTemplatesSyntaxValues::valuesToStackAttr(): Injects markup from $values' content (rows or attributes) inside actually selected nodes.
QueryTemplatesSyntaxValues::valuesToStackBefore(): Injects markup from $values' content (rows or attributes) inside actually selected nodes.
QueryTemplatesSyntaxValues::valuesToStackPrepend(): Injects markup from $values' content (rows or attributes) inside actually selected nodes.
QueryTemplatesSyntaxValues::valuesToStackReplace(): Injects markup from $values' content (rows or attributes) inside actually selected nodes.
QueryTemplatesSyntaxValues::_valuesToLoop()
QueryTemplatesSyntaxValues::_valuesToStack()

Class: QueryTemplatesSyntaxDOM

QueryTemplatesSyntaxDOM::attrAppend()
QueryTemplatesSyntaxDOM::attrPrepend()
QueryTemplatesSyntaxDOM::stackToMethod(): Returns array being result of running $method on all stack elements.
QueryTemplatesSyntaxDOM::unWrap(): Removes selected element and moves it's children into parent node.

Class: phpQueryObject

phpQueryObject::__construct(): Enter description here...
phpQueryObject::add(): Enter description here...
phpQueryObject::addClass(): Enter description here...
phpQueryObject::addClassPHP(): Enter description here...
phpQueryObject::after(): Enter description here...
phpQueryObject::afterPHP(): Enter description here...
phpQueryObject::ancestors(): Enter description here...
phpQueryObject::andSelf(): Enter description here...
phpQueryObject::append(): Enter description here...
phpQueryObject::appendPHP(): Enter description here...
phpQueryObject::appendTo(): Enter description here...
phpQueryObject::attr()
phpQueryObject::attrEvents()
phpQueryObject::attrPHP(): Enter description here...
phpQueryObject::before(): Enter description here...
phpQueryObject::beforePHP(): Enter description here...
phpQueryObject::bind(): Binds a handler to one or more events (like click) for each matched element.
phpQueryObject::callback(): Run callback on actual object.
phpQueryObject::change(): Enter description here...
phpQueryObject::children(): Enter description here...
phpQueryObject::click(): Enter description here...
phpQueryObject::contents(): Enter description here...
phpQueryObject::contentsUnwrap(): Enter description here...
phpQueryObject::count()
phpQueryObject::css(): Enter description here...
phpQueryObject::current()
phpQueryObject::debug()
phpQueryObject::documentFragment()
phpQueryObject::dump(): Dump htmlOuter and preserve chain. Usefull for debugging.
phpQueryObject::dumpDie(): Dump htmlOuter and stop script execution. Usefull for debugging.
phpQueryObject::dumpLength()
phpQueryObject::dumpTree()
phpQueryObject::dumpWhois()
phpQueryObject::each(): Enter description here...
phpQueryObject::elementsContainsNode()
phpQueryObject::end(): Enter description here...
phpQueryObject::eq(): Enter description here...
phpQueryObject::extend(): Deprecated, use $pq->plugin() instead.
phpQueryObject::filter(): Enter description here...
phpQueryObject::filterCallback(): Enter description here...
phpQueryObject::find(): Enter description here...
phpQueryObject::get(): Return matched DOM nodes.
phpQueryObject::getDocument(): Returns object with stack set to document root.
phpQueryObject::getDocumentID(): Get object's Document ID.
phpQueryObject::getDocumentIDRef(): Saves object's DocumentID to $var by reference.
phpQueryObject::getDOMDocument()
phpQueryObject::getElementSiblings()
phpQueryObject::getNodeAttrs()
phpQueryObject::getNodeXpath(): Returns node's XPath.
phpQueryObject::getString(): Return matched DOM nodes.
phpQueryObject::getStrings(): Return matched DOM nodes.
phpQueryObject::hasClass(): Enter description here...
phpQueryObject::hide()
phpQueryObject::html(): Enter description here...
phpQueryObject::htmlOuter(): Enter description here...
phpQueryObject::index(): Enter description here...
phpQueryObject::insert(): Internal insert method. Don't use it.
phpQueryObject::insertAfter(): Enter description here...
phpQueryObject::insertBefore(): Enter description here...
phpQueryObject::is(): Enter description here...
phpQueryObject::isChar(): Determines if $char is really a char.
phpQueryObject::isHTML()
phpQueryObject::isRegexp()
phpQueryObject::isRoot()
phpQueryObject::isXHTML()
phpQueryObject::isXML()
phpQueryObject::key()
phpQueryObject::length(): Enter description here...
phpQueryObject::load(): Enter description here...
phpQueryObject::map(): Enter description here...
phpQueryObject::markup(): jQuey difference
phpQueryObject::markupEvents()
phpQueryObject::markupOuter(): jQuey difference
phpQueryObject::markupOuterPHP(): TODO doc
phpQueryObject::markupPHP(): TODO doc
phpQueryObject::matchClasses(): Enter description here...
phpQueryObject::merge()
phpQueryObject::newInstance(): Returns new instance of actual class.
phpQueryObject::next(): Double-function method.
phpQueryObject::nextAll()
phpQueryObject::not(): Enter description here...
phpQueryObject::offsetExists()
phpQueryObject::offsetGet()
phpQueryObject::offsetSet()
phpQueryObject::offsetUnset()
phpQueryObject::parent(): Enter description here...
phpQueryObject::parents(): Enter description here...
phpQueryObject::parseSelector()
phpQueryObject::php(): Just like html(), but returns markup with VALID (dangerous) PHP tags.
phpQueryObject::plugin(): Enter description here...
phpQueryObject::prepend(): Enter description here...
phpQueryObject::prependPHP(): Enter description here...
phpQueryObject::prependTo(): Enter description here...
phpQueryObject::prev(): Enter description here...
phpQueryObject::prevAll()
phpQueryObject::pseudoClasses()
phpQueryObject::remove(): Enter description here...
phpQueryObject::removeAttr(): Enter description here...
phpQueryObject::removeClass(): Enter description here...
phpQueryObject::replaceAll(): Enter description here...
phpQueryObject::replaceWith(): Enter description here...
phpQueryObject::replaceWithPHP(): Enter description here...
phpQueryObject::reverse(): Enter description here...
phpQueryObject::rewind()
phpQueryObject::runQuery()
phpQueryObject::serialize(): Enter description here...
phpQueryObject::serializeArray(): Enter description here...
phpQueryObject::show()
phpQueryObject::siblings(): Enter description here...
phpQueryObject::size(): Enter description here...
phpQueryObject::slice(): Enter description here...
phpQueryObject::stack(): Internal stack iterator.
phpQueryObject::stackIsRoot()
phpQueryObject::submit(): Enter description here...
phpQueryObject::switchWith(): Enter description here...
phpQueryObject::text(): Return joined text content.
phpQueryObject::toggleClass(): Enter description here...
phpQueryObject::toReference(): Saves actual object to $var by reference.
phpQueryObject::toRoot(): Enter description here...
phpQueryObject::trigger(): Trigger a type of event on every matched element.
phpQueryObject::triggerHandler(): This particular method triggers all bound event handlers on an element (for a specific event type) WITHOUT executing the browsers default actions.
phpQueryObject::unbind(): Enter description here...
phpQueryObject::unloadDocument(): Unloads whole document from memory.
phpQueryObject::unQuote()
phpQueryObject::val(): Return form element value.
phpQueryObject::valid()
phpQueryObject::whois()
phpQueryObject::wrap(): Enter description here...
phpQueryObject::wrapAll(): Enter description here...
phpQueryObject::wrapAllOld(): Enter description here...
phpQueryObject::wrapAllPHP(): Enter description here...
phpQueryObject::wrapInner(): Enter description here...
phpQueryObject::wrapInnerPHP(): Enter description here...
phpQueryObject::wrapPHP(): Enter description here...
phpQueryObject::xml()
phpQueryObject::xmlOuter()
phpQueryObject::_clone(): Enter description here...
phpQueryObject::_empty(): Proper name without underscore (just ->empty()) also works.
phpQueryObject::_next(): Safe rename of next().
phpQueryObject::_prev(): Use prev() and next().
phpQueryObject::__call()
phpQueryObject::__get()
phpQueryObject::__loadSuccess()
phpQueryObject::__pseudoClassParam()
phpQueryObject::__toString()
phpQueryObject::___wrapAllCallback()

Class Details

[line 11]
Class extending phpQueryObject with templating methods.

Tags:

author:	Tobiasz Cudnik <tobiasz.cudnik/gmail.com>
link:	http://code.google.com/p/querytemplates/
abstract:
license:	MIT License

[ Top ]

Class Methods

static method _formFromVars_CodeValue [line 1348]

static void _formFromVars_CodeValue(

$self, 
$scope)

Tags:

access:

protected

Parameters:

	$self
	$scope

[ Top ]

method formFromValues [line 304]

QueryTemplatesParse formFromValues(
Array
$record, Array
$structure, [Array
$errors = null], [Array
$data = null], [Array|String
$template = null], [Array
$selectors = null], [Array|String|Callback
$fieldCallback = null])

Method formFromVars acts as flexible form helper. It creates customized pure-markup form without the need of suppling a line of markup.

Final form is available right after using this method.

Created form have following features:

shows data from record
shows errors
supports default values
supports radios and checkboxes
supports select elements with optgroups
supports select multiple

Created form can be customized using:

input wrapper template (per field name, per field type and default)
selectors (for input, label and errors)
callbacks (per field)

== Example ==

$structure = array(
'__form' => array('id' => 'myFormId'),
array(
'__label' => 'Fieldset 1 legend',
'default-field' => array( // 'text' is default
'label' => 'default-field label',
'id' => 'default-field-id',
),
'text-field' => array('text',
'label' => 'text-field label',
'id' => 'text-field-id',
),
'hidden-field' => 'hidden',
'checkbox-field' => 'checkbox',
),
array(
'__label' => 'Fieldset 2 legend',
'select-field' => array('select',
'label' => 'select-field label',
),
'radio-field' => array('radio',
'values' => array('possibleValue1', 'possibleValue2')
),
'textarea-field' => 'textarea',
),
);
$data = array(
'select-field' => array(
// no optgroup
'bar1' => 'bar1 label',
'bar2' => 'bar2 label',
'bar3' => 'bar3 label',
),
);
$record = array(
'text-field' => 'value from record',
);
$tempalte->
formFromValues($record, $structure, null, $data)
;

=== Result DOM tree ===

form#myFormId
- fieldset
- - input#myFormId_hidden-field[name="hidden-field"][value="new hidden-fiel"]
- - legend
- - - Text:Fieldset 1 lege
- - div.input.text
- - - label
- - - - Text:default-field l
- - - input#default-field-id[name="default-field"]
- - div.input.text
- - - label
- - - - Text:text-field labe
- - - input#text-field-id[name="text-field"][value="new text-field "]
- - - ul.errors
- - - - li
- - - - - Text:text-field erro
- - div.input.checkbox
- - - div
- - - - Text:Checkbox field
- - - label
- - - - Text:Checkbox-field
- - - input#myFormId_checkbox-field[name="checkbox-field"][value="1"][checked]
- fieldset
- - legend
- - - Text:Fieldset 2 lege
- - div.input.select
- - - label
- - - - Text:select-field la
- - - select[name="select-field"]
- - - - option[value="bar1"]
- - - - - Text:bar1 label
- - - - option[value="bar2"]
- - - - - Text:bar2 label
- - - - option[value="bar3"][selected]
- - - - - Text:bar3 label
- - div.input.select
- - - label
- - - - Text:select-field-op
- - - select[name="select-field-optgroups-multiple"]
- - - - optgroup
- - - - - option[value="group1_1"]
- - - - - - Text:group1_1 label
- - - - - option[value="group1_2"]
- - - - - - Text:group1_2 label
- - - - optgroup
- - - - - option[value="group2_1"][selected]
- - - - - - Text:group2_1 label
- - - - - option[value="group2_2"]
- - - - - - Text:group2_2 label
- - - - option[value="bar"][selected]
- - - - - Text:Bar
- - - ul.errors
- - - - li
- - - - - Text:error1
- - - - li
- - - - - Text:error2
- - div.input.radio
- - - label
- - - - Text:Radio-field
- - - input[name="radio-field"][value="possibleValue1"]
- - - input[name="radio-field"][value="possibleValue2"][checked]
- - div.input.textarea
- - - label
- - - - Text:Textarea-field
- - - textarea#myFormId_textarea-field

Tags:

see:	QueryTemplatesPhpQuery::formFromVars()
see:	QueryTemplatesPhpQuery::varsToForm()
see:	QueryTemplatesPhpQuery::valuesToForm()
TODO:	support objects for record and data
TODO:	maybe support callbacks per input type, before/after, maybe for errors too ?
TODO:	fieldCallback __form special field for form callback
TODO:	hidden fields and fieldCallback

Parameters:

Array	$record	TODO doc
Array	$structure	Form structure information. This should be easily fetchable from ORM layer. Possible types: text (default) password hidden checkbox radio textarea Convention: 'fieldName' => array( 'fieldType', $fieldOptions ) Where $fieldOptions can be (`key => value` pairs): label id multiple (only select) values (only radio, MANDATORY) value (only checkbox, optional) There can be special field `__form`, which represents form element, as an array. All values from it will be pushed as form attributes. If you wrap fields' array within another array, it will represent fieldsets, which value with index `__label` will be used as legend (optional).
Array	$errors	TODO doc
Array	$data	Additional data for fields. For now it's only used for populating select boxes. Example: $defaultData = array( 'select-field-optgroups' => array( array( // 1st optgroup '__label' => 'optgroup 1 label', 'group1_1' => 'group1_1 label', 'group1_2' => 'group1_2 label', ), array( // 2nd optgroup '__label' => 'optgroup 2 label', 'group2_1' => 'group2_1 label', 'group2_2' => 'group2_2 label', ), 'bar' => 'Bar', // no optgroup ), );
Array\|String	$template	Input wrapper template. This template will be used for each field. Use array to per field template, '__default' means default. All types allowed in $structure can be used as per-type default template when indexed like '__$type' ex '__checkbox'. To each input wrapper will be added a class which is field's type. Example: $templates['__checkbox'] = ' <div class="input"> <div>Checkbox field below</div> <label/> <input/> </div>'; Default template is: <div class="input"> <label/> <input/> <ul class="errors"> <li/> </ul> </div>
Array	$selectors	Array of selectors indexed by it's type. Allows to customize lookups inside inputs wrapper. Possible values are: error - selects field's error wrapper dafault value is '.errors' label - selects field's label node (can be div, span, etc) default value is 'label:first' use array to per field name selector, '__default' means default input - selects field's input node: input, textarea or select default value is 'input:first' use array to per field name selector, '__default' means default %t is replaced by field node type (use it with customized per field $template)
Array\|String\|Callback	$fieldCallback	Callback triggered after preparation of each field.

[ Top ]

method formFromVars [line 762]

QueryTemplatesParse formFromVars(
String|Array
$varNames, Array
$structure, [Array
$defaultRecord = null], [Array
$defaultData = null], [Array|String
$template = null], [Array
$selectors = null], [Array|String|Callback
$fieldCallback = null])

EXPERIMENTAL - works, but not for production code

Method formFromVars acts as flexible form helper. It creates customized exacutable form without the need of suppling a line of markup.

Form code is executed during template-execution and creates final form using record from variable.

Created form have following features:

shows data from record (array or object)
shows errors
supports default values
supports radios and checkboxes
supports select elements with optgroups
overloadable $defaultData
overloadable $defaultRecord

Created form can be customized using:

input wrapper template (per field name, per field type and default)
selectors (for input, label and errors)
callbacks (per field)

== Example ==

$structure = array(
'__form' => array('id' => 'myFormId'),
array(
'__label' => 'Fieldset 1 legend',
'default-field' => array( // 'text' is default
'label' => 'default-field label',
'id' => 'default-field-id',
),
'text-field' => array('text',
'label' => 'text-field label',
'id' => 'text-field-id',
),
'hidden-field' => 'hidden',
'checkbox-field' => 'checkbox',
),
array(
'__label' => 'Fieldset 2 legend',
'select-field' => array('select',
'label' => 'select-field label',
),
'select-field-optgroups-multiple' => array('select',
'label' => 'select-field-optgroups label',
),
'radio-field' => array('radio',
'values' => array('possibleValue1', 'possibleValue2')
),
'textarea-field' => 'textarea',
),
);

Tags:

see:	QueryTemplatesPhpQuery::varsToForm()
see:	QueryTemplatesPhpQuery::valuesToForm()
see:	QueryTemplatesPhpQuery::formFromValues()
TODO:	move radio values to data
TODO:	support objects for record and data
TODO:	move checkbox values to data
TODO:	select[multiple]
TODO:	write methods used here as part of syntax classes
TODO:	hidden fields and fieldCallback
TODO:	maybe support callbacks per input type, before/after, maybe for errors too ?
TODO:	make checkbox and radios like select

Parameters:

String\|Array	$varNames	Array of names of following vars: record [0] Represents actual record as array of fields. errors [1] Represents actual errors as array of fields. Field can also be an array. data [2] Overloads $defaultData during template's execution. Names should be without dollar signs. Ex: array('row', 'errors.row', 'data'); $errors['row'] = array( 'field1' => 'one error', 'field2' => array('first error', 'second error') );
Array	$structure	Form structure information. This should be easily fetchable from ORM layer. Possible types: text (default) password hidden checkbox radio textarea Convention: 'fieldName' => array( 'fieldType', $fieldOptions ) Where $fieldOptions can be (`key => value` pairs): label id multiple (only select) // TODO values (only radio, MANDATORY) value (only checkbox, optional) There can be special field `__form`, which represents form element, as an array. All values from it will be pushed as form attributes. If you wrap fields' array within another array, it will represent fieldsets, which value with index `__label` will be used as legend (optional).
Array	$defaultRecord	Default field's value. Used when field isn't present within supplied record. Ex: $defaultRecord = array( 'text-field' => 'text-field default value', 'select-field' => 'bar2', 'select-field-optgroups-multiple' => array('group2_1', 'group2_2'), 'checkbox-field' => false, );
Array	$defaultData	Additional data for fields. For now it's only used for populating select boxes. Example: $defaultData = array( 'select-field-optgroups' => array( array( // 1st optgroup '__label' => 'optgroup 1 label', 'group1_1' => 'group1_1 label', 'group1_2' => 'group1_2 label', ), array( // 2nd optgroup '__label' => 'optgroup 2 label', 'group2_1' => 'group2_1 label', 'group2_2' => 'group2_2 label', ), 'bar' => 'Bar', // no optgroup ), );
Array\|String	$template	Input wrapper template. This template will be used for each field. Use array to per field template, '__default' means default. All types allowed in $structure can be used as per-type default template when indexed like '__$type' ex '__checkbox'. To each input wrapper will be added a class which is field's type. Example: $templates['__checkbox'] = ' <div class="input"> <div>Checkbox field below</div> <label/> <input/> </div>'; Default template is: <div class="input"> <label/> <input/> <ul class="errors"> <li/> </ul> </div>
Array	$selectors	Array of selectors indexed by it's type. Allows to customize lookups inside inputs wrapper. Possible values are: error - selects field's error wrapper dafault value is '.errors' label - selects field's label node (can be div, span, etc) default value is 'label:first' use array to per field name selector, '__default' means default input - selects field's input node: input, textarea or select default value is 'input:first' use array to per field name selector, '__default' means default %t is replaced by field node type (use it with customized per field $template)
Array\|String\|Callback	$fieldCallback	Callback triggered after preparation of each field.

[ Top ]

method inputsFromValues [line 51]

QueryTemplatesParse|QueryTemplatesPhpQuery inputsFromValues(
$data
$data, [$type
$type = 'hidden'])

Creates markup with INPUT tags and prepends it to form.

If selected element isn't a FORM then find('form') is executed.

Method doesn't change selected elements stack.

== Example ==

=== Markup ===

<form>
<input name='was-here-before'>
</form>

=== Data ===

$data = array('field1' => 'foo', 'field2' => 'bar');

=== `QueryTemplates` formula ===

$template->inputsFromValues($data);

=== Template ===

<form>
<input name='field1' value='foo'>
<input name='field2' value='bar'>
<input name='was-here-before'>
</form>

Tags:

see:	QueryTemplatesPhpQuery::formFromValues()
access:	public

Parameters:

$data	$data
$type	$type

[ Top ]

method saveAsVar [line 1443]

void saveAsVar(

$name)

Tags:

deprecated:
access:	public

Parameters:

$name

[ Top ]

method saveTextAsVar [line 1449]

void saveTextAsVar(

$name)

Tags:

deprecated:
access:	public

Parameters:

$name

[ Top ]

method valuesToVars [line 1421]

void valuesToVars(

$varsArray)

Tags:

deprecated:
access:	public

Parameters:

$varsArray

[ Top ]

method varsFromStack [line 1433]

void varsFromStack(
String
$name)

Saves markupOuter() as value of variable $var avaible in template scope.

Tags:

TODO:	support second $method param
TODO:	user self::parent for storing vars
access:	public

Parameters:

String

$name

New variable name.

[ Top ]

method varsFromStackText [line 1460]

void varsFromStackText(
String
$name)

Saves text() as value of variable $var avaible in template scope.

Tags:

TODO:	user self::parent for storing vars
access:	public

Parameters:

String

$name

New variable name.

[ Top ]

method varsFromValues [line 1413]

QueryTemplatesParse|QueryTemplatesPhpQuery varsFromValues(
array
$varsArray)

Behaves as var_export, dumps variables from $varsArray as $key = value for later use during template execution. Variables are prepended into selected elemets.

Method doesn't change selected elements stack.

== Example ==

=== Markup ===

<node1>
<node2></node2>
</node1>

=== Data ===

$values = array('<foo/>', '<bar/>');

=== `QueryTemplates` formula ===

$template['node1']->
varsFromValues($values)
;

=== Template ===

<node1><?php $0 = '<foo/>';
$1 = '<bar/>'; ?><node2></node2></node1>

=== Template tree before ===

node1
- node2

=== Template tree after ===

node1
- PHP
- node2

Tags:

access:

public

Parameters:

array

$varsArray

[ Top ]

Documentation generated on Sat, 07 Mar 2009 12:08:31 +0100 by phpDocumentor 1.4.2