Class: QueryTemplatesSource

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

Class Overview

phpQueryObject
   |
   --QueryTemplatesSource

Class handling template source use.

Author(s):

Tobiasz Cudnik <tobiasz.cudnik/gmail.com>

Implements interfaces:

IQueryTemplatesParseChain

Variables

$parent

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: 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 13]
Class handling template source use.

Tags:

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

[ Top ]

Class Variables

$parent =

[line 21]

Parent template.

Tags:

access:

public

Type:

QueryTemplatesParse

[ Top ]

Class Methods

constructor __construct [line 22]

QueryTemplatesSource __construct(

$parent, [
$src = null])

Tags:

access:

public

Overrides phpQueryObject::__construct() (Enter description here...)

Parameters:

	$parent
	$src

[ Top ]

method free [line 47]

QueryTemplatesParse free(
)

Free source DOM from memory and returns parent template.

No more source pickups is possible after this operation.

Tags:

access:

public

[ Top ]

method returnAfter [line 96]

QueryTemplatesParse returnAfter(
[string
$cssSelector = null])

Returns actual source stack inserting it after template's stack or nodes matched by optional $cssSelector executed agains template's stack.

Tags:

return:	Parent template.
access:	public

Parameters:

string

$cssSelector

[ Top ]

method returnAppend [line 86]

QueryTemplatesParse returnAppend(
[string
$cssSelector = null])

Returns actual source stack appending it to template's stack or nodes matched by optional $cssSelector executed agains template's stack.

Tags:

return:	Parent template.
access:	public

Parameters:

string

$cssSelector

[ Top ]

method returnBefore [line 106]

QueryTemplatesParse returnBefore(
[string
$cssSelector = null])

Returns actual source stack inserting it before template's stack or nodes matched by optional $cssSelector executed agains template's stack.

Tags:

return:	Parent template.
access:	public

Parameters:

string

$cssSelector

[ Top ]

method returnPrepend [line 76]

QueryTemplatesParse returnPrepend(
[string
$cssSelector = null])

Returns actual source stack prepending it to template's stack or nodes matched by optional $cssSelector executed agains template's stack.

Tags:

return:	Parent template.
access:	public

Parameters:

string

$cssSelector

[ Top ]

method returnReplace [line 58]

QueryTemplatesParse returnReplace(
[unknown_type
$cssSelector = null])

Returns actual source stack as a replacement for templates stack or nodes matched by optional $cssSelector executed agains templates stack.

Tags:

access:

public

Parameters:

unknown_type

$cssSelector

[ Top ]

method save [line 145]

string save(
[
$unloadDocument = true])

Saves template and returns file path ready to include.

Tags:

see:	QueryTemplatesParse::save()
access:	public

Implementation of:

IQueryTemplatesParseChain::save()

Parameters:

$unloadDocument

[ Top ]

method saveAsVar [line 132]

QueryTemplatesParse saveAsVar(
string
$name, string
$cssSelector)

Saves actual stack using markupOuter() as value of variable named $var.

New variable is available in template's scope.

Tags:

return:	Parent template.
TODO:	customizable method (markupOuter)
access:	public

Parameters:

string	$name
string	$cssSelector

[ Top ]

method templateCache [line 152]

QueryTemplatesSource templateCache(
[
$state = null])

Tags:

see:	QueryTemplatesTemplate::templateCache()
access:	public

Implementation of:

IQueryTemplatesTemplateChain::templateCache()

Parameters:

$state

[ Top ]

method templateName [line 160]

QueryTemplatesSourceQuery templateName(
[
$newName = null])

Tags:

see:	QueryTemplatesTemplate::templateName()
access:	public

Implementation of:

IQueryTemplatesTemplateChain::templateName()

Parameters:

$newName

[ Top ]

method _returnInsert [line 109]

void _returnInsert(

$cssSelector, 
$method)

Tags:

access:

protected

Parameters:

	$cssSelector
	$method

[ Top ]

method __toString [line 136]

void __toString(
)

Tags:

access:

public

Overrides phpQueryObject::__toString() (parent method not documented)

[ Top ]

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