Documentation

Helpers

Table of Contents ▼

Presentation

Temma offers a number of objects to help you carry out certain processes. These include controllers (and any associated templates) that you can use directly in your sites, as well as various utility objects.

Most of these objects are there simply to make your life easier, and are therefore completely optional. However, in some cases, Temma uses them for its own purposes (for example, reading the temma.json file uses the Json object, or the dependency injection component derives from the Registry object).

Controllers are placed in the \TemmaControllers namespace, while utility objects are placed in the \Temma\Utils namespace.
Templates are placed in Temma's templates/ directory.

Previous: Command-line interface
Next: Cache commande helper

Table of Contents

  1. Migration : How to upgrade from Temma 1.x to version 2
  2. Installation : Download Temma and install it to start your web project
  3. Configuration : All the configuration directives of the etc/temma.json file and the optional environment variables
  4. External libraries : How to use external function libraries
  5. Routing : Temma's default routing system, and advanced routing
  6. Log : Use of the log system, management by criticality levels
  7. Controllers : Essential parts of your web application
  8. Views : Smarty templates or JSON/CSV/RSS/iCal/INI exports
  9. Dependency injection : The backbone of your application developments
  10. Sessions : Extension of user sessions managed by PHP
  11. Data sources : Unified data access management
  12. Model : How to use DAOs to access databases
  13. Execution flow : How to manage the execution flow, between plugins and the controller
  14. Plugins : How to use plugins, and create your own plugins to modularize your code
  15. Attributes : How to filter access to controllers and actions
  16. Command-line interface : To create executable scripts on the command line, automatically initialized by Temma
  17. Helpers : Items offered by Temma to help you in various circumstances
    • Command-line scripts
      1. Cache : To clear the cache.
      2. User : To manage users.
    • Controller + plugin
      1. Auth : Controller and plugin to manage user authentication
    • Plugins
      1. Api : To manage API access
      2. Cache : To cache the generated HTML pages
      3. Language : Multilingual localization management
    • Attributes
      1. Auth : To restrict access to authenticated users
      2. Method : To manage the authorized HTTP methods
      3. Referer : To filter access by HTTP REFERER
      4. Redirect : To redirect requests automatically
    • Utility objects
      1. ANSI : To format texts written to standard output
      2. BaseConvert : To do digital base conversions
      3. DataFilter : To filter and validate data
      4. Email : To send emails
      5. HTMLCleaner : To clean up an HTML stream coming from a WYSIWYG editor
      6. IniExport : To export data in INI format
      7. Json : To read JSON streams that may contain comments
      8. Lock : To lock access to a file, or the execution of the current PHP script
      9. Registry : To properly store global variables
      10. Smarty : To process Smarty templates outside the view
      11. Term : Terminal management (TTY)
      12. Text : Different treatments on character strings
      13. Timer : To manage stopwatches