Open Power Template 2.0

Table of Contents

@ 06.07.2010

User manual

Open Power Template 2.0

Table of Contents

• 1. Preface
• 2. Installation
  • 2.1. Standard installation
  • 2.2. PHAR installation
• 3. Template syntax
  • 3.1. Compiler modes
  • 3.2. CDATA sections
  • 3.3. XML Prolog and DTD
  • 3.4. Entities
  • 3.5. Expressions
    • 3.5.1. Variables
    • 3.5.2. Values
    • 3.5.3. Operators
    • 3.5.4. Functions
    • 3.5.5. Backticks
    • 3.5.6. Objects
    • 3.5.7. HTML escaping
  • 3.6. Function reference
    • 3.6.1. absolute()
    • 3.6.2. autoLink()
    • 3.6.3. average()
    • 3.6.4. capitalize()
    • 3.6.5. contains()
    • 3.6.6. containsKey()
    • 3.6.7. count()
    • 3.6.8. countChars()
    • 3.6.9. countSubstring()
    • 3.6.10. countWords()
    • 3.6.11. cycle()
    • 3.6.12. date()
    • 3.6.13. entity()
    • 3.6.14. firstof()
    • 3.6.15. indent()
    • 3.6.16. isImage()
    • 3.6.17. isUrl()
    • 3.6.18. lower()
    • 3.6.19. money()
    • 3.6.20. nl2br()
    • 3.6.21. number()
    • 3.6.22. pad()
    • 3.6.23. pluralize()
    • 3.6.24. position()
    • 3.6.25. range()
    • 3.6.26. regexReplace()
    • 3.6.27. replace()
    • 3.6.28. scalar()
    • 3.6.29. spacify()
    • 3.6.30. stddev()
    • 3.6.31. strip()
    • 3.6.32. stripTags()
    • 3.6.33. sum()
    • 3.6.34. truncate()
    • 3.6.35. upper()
    • 3.6.36. wordWrap()
  • 3.7. Instructions
    • 3.7.1. opt:attribute
    • 3.7.2. opt:block
    • 3.7.3. opt:capture
    • 3.7.4. opt:component
    • 3.7.5. opt:dtd
    • 3.7.6. opt:dynamic
    • 3.7.7. opt:extend
    • 3.7.8. opt:for
    • 3.7.9. opt:foreach
    • 3.7.10. opt:grid
    • 3.7.11. opt:if
    • 3.7.12. opt:include
    • 3.7.13. opt:insert
    • 3.7.14. opt:literal
    • 3.7.15. opt:prolog
    • 3.7.16. opt:put
    • 3.7.17. opt:repeat
    • 3.7.18. opt:root
    • 3.7.19. opt:section
    • 3.7.20. opt:selector
    • 3.7.21. opt:separator
    • 3.7.22. opt:show
    • 3.7.23. opt:snippet
    • 3.7.24. opt:tag
    • 3.7.25. opt:tree
  • 3.8. OPT attributes
    • 3.8.1. opt:attributes-build
    • 3.8.2. opt:attributes-ignore
    • 3.8.3. opt:capture
    • 3.8.4. opt:content
    • 3.8.5. opt:dynamic
    • 3.8.6. opt:if
    • 3.8.7. opt:on
    • 3.8.8. opt:section
    • 3.8.9. opt:selector
    • 3.8.10. opt:single
    • 3.8.11. opt:use
  • 3.9. Topics
    • 3.9.1. Sections
    • 3.9.2. Blocks
    • 3.9.3. Components
    • 3.9.4. Template modularization
      • 3.9.4.1. Template inclusion
      • 3.9.4.2. Template inheritance
    • 3.9.5. Quirks mode
• 4. Programmer's Guide
  • 4.1. Initialization
    • 4.1.1. List of configuration options
  • 4.2. Working with views
  • 4.3. Working with output systems
  • 4.4. Error handling
  • 4.5. Working with sections
  • 4.6. Data formats
    • 4.6.1. Available data formats
    • 4.6.2. Formats and expressions
  • 4.7. Template inheritance
  • 4.8. Custom escaping functions
  • 4.9. Internationalization
  • 4.10. Components and forms
  • 4.11. Caching
• 5. Extending OPT
  • 5.1. Introduction to plugins
  • 5.2. New functions
  • 5.3. New blocks
  • 5.4. New components
  • 5.5. New output systems
  • 5.6. New caching systems
  • 5.7. New data formats
    • 5.7.1. Variables
    • 5.7.2. Container items
    • 5.7.3. Sections
    • 5.7.4. Format plugins
  • 5.8. New instructions
    • 5.8.1. Processor overview
    • 5.8.2. Generating PHP code
    • 5.8.3. Parsing attributes
    • 5.8.4. XML manipulations
    • 5.8.5. $system special variable
    • 5.8.6. Using the data formats
    • 5.8.7. Node and compiler variables
    • 5.8.8. Tips and tricks
    • 5.8.9. Instruction plugins
• 6. Migration
  • 6.1. OPT 1.x
  • 6.2. PHP
  • 6.3. Smarty™
• 7. API Reference
  • 7.1. Opt_Class class
    • 7.1.1. getBufferState()
    • 7.1.2. getCache()
    • 7.1.3. getCompiler()
    • 7.1.4. getTranslationInterface()
    • 7.1.5. loadConfig()
    • 7.1.6. register()
    • 7.1.7. setBufferState()
    • 7.1.8. setCache()
    • 7.1.9. setTranslationInterface()
    • 7.1.10. setup()
  • 7.2. Opt_View class
    • 7.2.1. __construct()
    • 7.2.2. __get()
    • 7.2.3. __isset()
    • 7.2.4. __set()
    • 7.2.5. __unset()
    • 7.2.6. assign()
    • 7.2.7. assignGlobal()
    • 7.2.8. assignGroup()
    • 7.2.9. assignGroupGlobal()
    • 7.2.10. assignRef()
    • 7.2.11. assignRefGlobal()
    • 7.2.12. clear()
    • 7.2.13. defined()
    • 7.2.14. definedGlobal()
    • 7.2.15. get()
    • 7.2.16. getBranch()
    • 7.2.17. getCache()
    • 7.2.18. getGlobal()
    • 7.2.19. getOutputBuffers()
    • 7.2.20. getTemplate()
    • 7.2.21. getTime()
    • 7.2.22. hasDynamicContent()
    • 7.2.23. inherit()
    • 7.2.24. remove()
    • 7.2.25. removeGlobal()
    • 7.2.26. setBranch()
    • 7.2.27. setCache()
    • 7.2.28. setFormat()
    • 7.2.29. setFormatGlobal()
    • 7.2.30. setTemplate()
  • 7.3. Opt_Output_Http class
    • 7.3.1. getHeaders()
    • 7.3.2. render()
    • 7.3.3. sendHeaders()
    • 7.3.4. setContentType()
    • 7.3.5. setHeader()
  • 7.4. Opt_Output_Return class
  • 7.5. Opt_Compiler_Class class
    • 7.5.1. __construct()
    • 7.5.2. addDependantTemplate()
    • 7.5.3. block()
    • 7.5.4. cleanCompiler()
    • 7.5.5. compile()
    • 7.5.6. compileExpression()
    • 7.5.7. component()
    • 7.5.8. convert()
    • 7.5.9. createFormat()
    • 7.5.10. escape()
    • 7.5.11. get()
    • 7.5.12. getCurrentTemplate()
    • 7.5.13. getFormat()
    • 7.5.14. importDependencies()
    • 7.5.15. inherits()
    • 7.5.16. isBlock()
    • 7.5.17. isClass()
    • 7.5.18. isComponent()
    • 7.5.19. isFunction()
    • 7.5.20. isIdentifier()
    • 7.5.21. isInstruction()
    • 7.5.22. isNamespace()
    • 7.5.23. isOptAttribute()
    • 7.5.24. isProcessor()
    • 7.5.25. parseEntities()
    • 7.5.26. parseShortEntities()
    • 7.5.27. processor()
    • 7.5.28. set()
    • 7.5.29. setConversion()
    • 7.5.30. setFormatList()
    • 7.5.31. setInheritance()
    • 7.5.32. unsetConversion()
  • 7.6. Opt_Compiler_Format class
    • 7.6.1. __construct()
    • 7.6.2. _build()
    • 7.6.3. _getVar()
    • 7.6.4. action()
    • 7.6.5. assign()
    • 7.6.6. decorate()
    • 7.6.7. defined()
    • 7.6.8. get()
    • 7.6.9. getName()
    • 7.6.10. isDecorating()
    • 7.6.11. property()
    • 7.6.12. resetVars()
    • 7.6.13. supports()
  • 7.7. Opt_Compiler_Processor class
    • 7.7.1. __construct()
    • 7.7.2. _addAttributes()
    • 7.7.3. _addInstructions()
    • 7.7.4. _enqueue()
    • 7.7.5. _extractAttributes()
    • 7.7.6. _process()
    • 7.7.7. configure()
    • 7.7.8. getName()
    • 7.7.9. postprocessAttribute()
    • 7.7.10. postprocessNode()
    • 7.7.11. processAttribute()
    • 7.7.12. processNode()
    • 7.7.13. processSystemVar()
    • 7.7.14. reset()
  • 7.8. Opt_Xml_Attribute class
    • 7.8.1. __construct()
    • 7.8.2. getName()
    • 7.8.3. getNamespace()
    • 7.8.4. getValue()
    • 7.8.5. getXmlName()
    • 7.8.6. setName()
    • 7.8.7. setNamespace()
    • 7.8.8. setValue()
  • 7.9. Opt_Xml_Buffer class
    • 7.9.1. addAfter()
    • 7.9.2. addBefore()
    • 7.9.3. bufferSize()
    • 7.9.4. buildCode()
    • 7.9.5. clear()
    • 7.9.6. copyBuffer()
    • 7.9.7. get()
    • 7.9.8. getBuffer()
    • 7.9.9. set()
  • 7.10. Opt_Xml_Cdata class
    • 7.10.1. appendData()
    • 7.10.2. deleteData()
    • 7.10.3. insertData()
    • 7.10.4. length()
    • 7.10.5. replaceData()
    • 7.10.6. substringData()
  • 7.11. Opt_Xml_Comment class
  • 7.12. Opt_Xml_Dtd class
  • 7.13. Opt_Xml_Element class
    • 7.13.1. addAttribute()
    • 7.13.2. countAttributes()
    • 7.13.3. getAttribute()
    • 7.13.4. getAttributes()
    • 7.13.5. getName()
    • 7.13.6. getNamespace()
    • 7.13.7. getXmlName()
    • 7.13.8. hasAttributes()
    • 7.13.9. removeAttribute()
    • 7.13.10. setName()
    • 7.13.11. setNamespace()
  • 7.14. Opt_Xml_Expression class
    • 7.14.1. __construct()
    • 7.14.2. getExpression()
    • 7.14.3. setExpression()
  • 7.15. Opt_Xml_Node class
    • 7.15.1. dispose()
    • 7.15.2. getParent()
    • 7.15.3. getType()
    • 7.15.4. setParent()
  • 7.16. Opt_Xml_Prolog class
  • 7.17. Opt_Xml_Root class
    • 7.17.1. getDtd()
    • 7.17.2. getProlog()
    • 7.17.3. hasDtd()
    • 7.17.4. hasProlog()
    • 7.17.5. setDtd()
    • 7.17.6. setProlog()
  • 7.18. Opt_Xml_Scannable class
    • 7.18.1. _testNode()
    • 7.18.2. appendChild()
    • 7.18.3. bringToEnd()
    • 7.18.4. countChildren()
    • 7.18.5. getChildren()
    • 7.18.6. getElementsByTagName()
    • 7.18.7. getElementsByTagNameNS()
    • 7.18.8. getElementsExt()
    • 7.18.9. getLastChild()
    • 7.18.10. hasChildren()
    • 7.18.11. insertBefore()
    • 7.18.12. moveChildren()
    • 7.18.13. removeChild()
    • 7.18.14. removeChildren()
    • 7.18.15. replaceChild()
    • 7.18.16. sort()
  • 7.19. Opt_Xml_Text class
    • 7.19.1. __construct()
    • 7.19.2. appendData()
  • 7.20. Opt_Block_Interface
    • 7.20.1. onClose()
    • 7.20.2. onOpen()
    • 7.20.3. onSingle()
    • 7.20.4. setView()
  • 7.21. Opt_Caching_Interface
    • 7.21.1. templateCacheStart()
    • 7.21.2. templateCacheStop()
  • 7.22. Opt_Component_Interface
    • 7.22.1. __construct()
    • 7.22.2. defined()
    • 7.22.3. display()
    • 7.22.4. get()
    • 7.22.5. manageAttributes()
    • 7.22.6. processEvent()
    • 7.22.7. set()
    • 7.22.8. setDatasource()
    • 7.22.9. setView()
  • 7.23. Opt_Generator_Interface
    • 7.23.1. generate()
  • 7.24. Opt_Output_Interface class
    • 7.24.1. getName()
    • 7.24.2. render()
• 8. Appendix
  • A. Resources
  • B. Error messages
  • C. Possible problems
  • D. Support
  • E. Reporting bugs
  • F. Authors and license

Copyright © Invenzzia Group 2008-2009

Available under the terms of license: GNU Free Documentation License 1.2

Generated by TypeFriendly 0.1.4 by Invenzzia