Apache Zeta Components - high quality PHP components

Tutorial
API

Apache Zeta Components Manual :: Docs For Class ezcTemplateTranslationStringExtracter

TemplateTranslationTiein::ezcTemplateTranslationStringExtracter

Class ezcTemplateTranslationStringExtracter

A visiter that can be used to extract translatable strings from a template.

Implements the ezcTemplateTstNodeVisiter interface for visiting the nodes and extracting translatable strings from them. It can be used like:

<?php
$file = dirname( __FILE__ ) . '/test_files/test.ezt';
$source = new ezcTemplateSourceCode( $file, $file );
$source->load();
$parser = new ezcTemplateParser( $source, new ezcTemplate() );
$tst = $parser->parseIntoNodeTree();
$et = new ezcTemplateTranslationStringExtracter( $parser );
$eted = $tst->accept( $et );
$tr = $et->getTranslation();
?>

Source for this file: /TemplateTranslationTiein/src/visitors/string_extracter.php

ezcTemplateTstWalker
   |
   --ezcTemplateTranslationStringExtracter

Version:

//autogen//

Member Variables

protected array(string=>array(ezcTranslationData)	`$strings` Contans an array of arrays, where the key is the context, and the value an array of ezcTranslationData elements.
public string	`$translationContext` Contains the active default translation context

Method Summary

public ezcTemplateTranslationStringExtracter	`__construct( $parser )` Initialize the transformer, after this send this object to the accept() method on a node.
public array(string=>array(ezcTranslationData))	`getStrings( )` Returns an array of translation objects indexed by context
public array(string=>ezcTranslation)	`getTranslation( )` Returns an array of translation datamaps indexed by context
public string	`visitLiteralTstNode( $type )` Transform the literal from a TST node to a string.
public void	`visitTranslationContextTstNode( $node )` visitTranslationContextTstNode
public void	`visitTranslationTstNode( $node )` visitTranslationTstNode

Methods

__construct

ezcTemplateTranslationStringExtracter __construct( $parser )

Initialize the transformer, after this send this object to the accept() method on a node.

Parameters:

Name	Type	Description
`$parser`	ezcTemplateParser	The main parser object.

getStrings

array(string=>array(ezcTranslationData)) getStrings( )

Returns an array of translation objects indexed by context

getTranslation

array(string=>ezcTranslation) getTranslation( )

Returns an array of translation datamaps indexed by context

visitLiteralTstNode

string visitLiteralTstNode( $type )

Transform the literal from a TST node to a string.

The text will transformed by processing the escape sequences according to the type which is either ezcTemplateLiteralTstNode::SINGLE_QUOTE or ezcTemplateLiteralTstNode::DOUBLE_QUOTE.

Parameters:

Name	Type	Description
`$type`	ezcTemplateLiteralTstNode

visitTranslationContextTstNode

void visitTranslationContextTstNode( $node )

visitTranslationContextTstNode

Parameters:

Name	Type	Description
`$node`	ezcTemplateTranslationContextTstNode

visitTranslationTstNode

void visitTranslationTstNode( $node )

visitTranslationTstNode

Parameters:

Name	Type	Description
`$node`	ezcTemplateTranslationTstNode

Documentation generated by phpDocumentor 1.4.3