added some phpdoc for TokenParser classes

This commit is contained in:
Fabien Potencier
2010-06-07 19:28:03 +02:00
parent dc37698ce0
commit 3606ad0dcd
16 changed files with 192 additions and 0 deletions
+12
View File
@@ -10,6 +10,13 @@
*/
class Twig_TokenParser_AutoEscape extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$lineno = $token->getLine();
@@ -39,6 +46,11 @@ class Twig_TokenParser_AutoEscape extends Twig_TokenParser
return $token->test('endautoescape');
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'autoescape';
+12
View File
@@ -11,6 +11,13 @@
*/
class Twig_TokenParser_Block extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$lineno = $token->getLine();
@@ -53,6 +60,11 @@ class Twig_TokenParser_Block extends Twig_TokenParser
return $token->test('endblock');
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'block';
+12
View File
@@ -10,6 +10,13 @@
*/
class Twig_TokenParser_Debug extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$lineno = $token->getLine();
@@ -23,6 +30,11 @@ class Twig_TokenParser_Debug extends Twig_TokenParser
return new Twig_Node_Debug($expr, $lineno, $this->getTag());
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'debug';
+12
View File
@@ -10,6 +10,13 @@
*/
class Twig_TokenParser_Display extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$lineno = $token->getLine();
@@ -22,6 +29,11 @@ class Twig_TokenParser_Display extends Twig_TokenParser
return new Twig_Node_BlockReference($name, $lineno, $this->getTag());
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'display';
+12
View File
@@ -11,6 +11,13 @@
*/
class Twig_TokenParser_Extends extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
if (null !== $this->parser->getParent()) {
@@ -22,6 +29,11 @@ class Twig_TokenParser_Extends extends Twig_TokenParser
return null;
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'extends';
+12
View File
@@ -10,6 +10,13 @@
*/
class Twig_TokenParser_Filter extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$filters = $this->parser->getExpressionParser()->parseFilterExpressionRaw();
@@ -36,6 +43,11 @@ class Twig_TokenParser_Filter extends Twig_TokenParser
return $token->test('endfilter');
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'filter';
+12
View File
@@ -11,6 +11,13 @@
*/
class Twig_TokenParser_For extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$lineno = $token->getLine();
@@ -56,6 +63,11 @@ class Twig_TokenParser_For extends Twig_TokenParser
return $token->test('endfor');
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'for';
+12
View File
@@ -11,6 +11,13 @@
*/
class Twig_TokenParser_If extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$lineno = $token->getLine();
@@ -65,6 +72,11 @@ class Twig_TokenParser_If extends Twig_TokenParser
return $token->test(array('endif'));
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'if';
+12
View File
@@ -10,6 +10,13 @@
*/
class Twig_TokenParser_Import extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$macro = $this->parser->getExpressionParser()->parseExpression();
@@ -20,6 +27,11 @@ class Twig_TokenParser_Import extends Twig_TokenParser
return new Twig_Node_Import($macro, $var, $token->getLine(), $this->getTag());
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'import';
+12
View File
@@ -11,6 +11,13 @@
*/
class Twig_TokenParser_Include extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$expr = $this->parser->getExpressionParser()->parseExpression();
@@ -27,6 +34,11 @@ class Twig_TokenParser_Include extends Twig_TokenParser
return new Twig_Node_Include($expr, $variables, $token->getLine(), $this->getTag());
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'include';
+12
View File
@@ -10,6 +10,13 @@
*/
class Twig_TokenParser_Macro extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$lineno = $token->getLine();
@@ -31,6 +38,11 @@ class Twig_TokenParser_Macro extends Twig_TokenParser
return $token->test('endmacro');
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'macro';
+12
View File
@@ -11,6 +11,13 @@
*/
class Twig_TokenParser_Parent extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
if (!count($this->parser->getBlockStack())) {
@@ -21,6 +28,11 @@ class Twig_TokenParser_Parent extends Twig_TokenParser
return new Twig_Node_Parent($this->parser->peekBlockStack(), $token->getLine(), $this->getTag());
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'parent';
+12
View File
@@ -10,6 +10,13 @@
*/
class Twig_TokenParser_Sandbox extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$this->parser->getStream()->expect(Twig_Token::BLOCK_END_TYPE);
@@ -24,6 +31,11 @@ class Twig_TokenParser_Sandbox extends Twig_TokenParser
return $token->test('endsandbox');
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'sandbox';
+12
View File
@@ -10,6 +10,13 @@
*/
class Twig_TokenParser_Set extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$lineno = $token->getLine();
@@ -47,6 +54,11 @@ class Twig_TokenParser_Set extends Twig_TokenParser
return $token->test('endset');
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'set';
+12
View File
@@ -10,6 +10,13 @@
*/
class Twig_TokenParser_Trans extends Twig_TokenParser
{
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token)
{
$lineno = $token->getLine();
@@ -45,6 +52,11 @@ class Twig_TokenParser_Trans extends Twig_TokenParser
return $token->test('endtrans');
}
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag()
{
return 'trans';
+12
View File
@@ -12,7 +12,19 @@ interface Twig_TokenParserInterface
{
public function setParser(Twig_Parser $parser);
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(Twig_Token $token);
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
*/
public function getTag();
}