eZ Components 2008.2.1

Getting Started

Components

Archive (1.3.2)
Authentication (1.2.3)
AuthenticationDatabaseTiein (1.1)
Base (1.6.1)
Cache (1.4)
Configuration (1.3.2)
ConsoleTools (1.5)
Database (1.4.3)
DatabaseSchema (1.4.2)
Debug (1.2)
Document (1.1.1)
EventLog (1.3)
EventLogDatabaseTiein (1.0.2)
Execution (1.1.1)
Feed (1.2.1)
File (1.2)
Graph (1.4.1)
GraphDatabaseTiein (1.0.1)
ImageAnalysis (1.1.3)
ImageConversion (1.3.5)
Mail (1.6.1)
MvcTools (1.0)
MvcMailTiein (1.0)
MvcTemplateTiein (1.0)
PersistentObject (1.5)
PersistentObjectDatabaseSchemaTiein (1.2.1)
PhpGenerator (1.0.4)
Search (1.0.3)
SignalSlot (1.1.1)
SystemInformation (1.0.7)
Template (1.3.2)
TemplateTranslationTiein (1.0)
Translation (1.2)
TranslationCacheTiein (1.1.2)
Tree (1.1.2)
TreeDatabaseTiein (1.1.1)
TreePersistentObjectTiein (1.0)
Url (1.2.2)
UserInput (1.4)
Webdav (1.1)
Workflow (1.3.1)
WorkflowDatabaseTiein (1.3)
WorkflowEventLogTiein (1.1)
WorkflowSignalSlotTiein (1.0)

Template: ezcTemplateCustomBlockDefinition

[ Tutorial ] [ EBNF ] [ Functions ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcTemplateCustomBlockDefinition

Contains the definition of a custom block. [source]

Example of use: create a link custom block.

Create a class which implements ezcTemplateCustomBlock and which

will be included in your application (with the autoloading mechanism).

 1.  class htmlBlocks implements ezcTemplateCustomBlock
 2.  {
 3.      public static function getCustomBlockDefinition( $name )
 4.      {
 5.          switch ( $name )
 6.          {
 7.              case "link":
 8.                  $def = new ezcTemplateCustomBlockDefinition();
 9.                  $def->class = __CLASS__;
10.                  $def->method = 'link';
11.                  $def->hasCloseTag = false;
12.                  $def->startExpressionName = 'from';
13.                  $def->requiredParameters = array( 'title' );
14.                  $def->optionalParameters = array( 'from', 'to' );
15.                  return $def;
16.          }
17.          return false;
18.      }
19.  
20.      public static function link( $parameters )
21.      {
22.          $title = "";
23.          if ( isset( $parameters['title'] ) )
24.          {
25.              $title = "title=\"{$parameters['title']}\"";
26.          }
27.          return "<" . "a href=\"{$parameters['to']}\" {$title}>{$parameters['from']}</a>";
28.      }
29.  }

2. Assign the class to the Template configuration in your application.

1.  $config = ezcTemplateConfiguration::getInstance();
2.  $config->addExtension( "htmlBlocks" );

3. Use the custom block in the template.

1.  {link "Google" to "http://www.google.com" title "Google search engine"}

The generated html code for this will be a hyperlink.

Parents

ezcTemplateCustomExtension
   |
   --ezcTemplateCustomBlockDefinition

Member Variables

public string	`$class` Holds the (static) class that implements the function to be executed.
public bool	`$excessParameters = false` When excessParameters is set to true, the custom block accepts any amount of parameters over the required parameters.
public bool	`$hasCloseTag` Specifies whether the class has an open and close tag or only a open tag.
public mixed	`$isStatic = false`
public string	`$method` Holds the (static) method that should be run.
public array(string)	`$optionalParameters = array()` Holds the optional named parameters for this custom block.
public array(string)	`$requiredParameters = array()` Holds the required named parameters for this custom block.
public bool	`$sendTemplateObject = false` Whether or not the Template object is available in the custom block. Be aware that if you change this, your custom block's signature changes as the first argument will then be the template object.
public string	`$startExpressionName` Holds the first parameter of a custom block without a name. If the custom block should have a start expression then this variable specifies a name for it. The name should reappear in either the optionalParameters or the requiredParameters.

Last updated: Mon, 09 Feb 2009

eZ Components

User menu