geckon01/Twig
1
0
Fork 0
mirror of https://github.com/twigphp/Twig.git synced 2026-09-16 20:36:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

fixing and improving PHPDoc in Template.php

Browse Source
This commit is contained in:
Tobias Schultze
2011-11-22 09:11:56 +01:00
parent 82e3ecc6da
commit 4802f696a3
1 changed files with 16 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/Twig/Template.php
+16 -20
View File
@@ -45,9 +45,7 @@ abstract class Twig_Template implements Twig_TemplateInterface
abstract public function getTemplateName(); abstract public function getTemplateName();
/** /**
* Returns the Twig environment. * {@inheritdoc}
*
* @return Twig_Environment The Twig environment
*/ */
public function getEnvironment() public function getEnvironment()
{ {
@@ -217,10 +215,7 @@ abstract class Twig_Template implements Twig_TemplateInterface
} }
/** /**
* Displays the template with the given context. * {@inheritdoc}
*
* @param array $context An array of parameters to pass to the template
* @param array $blocks An array of blocks to pass to the template
*/ */
public function display(array $context, array $blocks = array()) public function display(array $context, array $blocks = array())
{ {
@@ -242,11 +237,7 @@ abstract class Twig_Template implements Twig_TemplateInterface
} }
/** /**
* Renders the template with the given context and returns it as string. * {@inheritdoc}
*
* @param array $context An array of parameters to pass to the template
*
* @return string The rendered template
*/ */
public function render(array $context) public function render(array $context)
{ {
@@ -276,9 +267,9 @@ abstract class Twig_Template implements Twig_TemplateInterface
/** /**
* Returns a variable from the context. * Returns a variable from the context.
* *
* @param array $context The context * @param array $context The context
* @param string $item The variable to return from the context * @param string $item The variable to return from the context
* @param Boolean $isDefinedTest Whether to ignore the strict variable check or not * @param Boolean $ignoreStrictCheck Whether to ignore the strict variable check or not
* *
* @return The content of the context variable * @return The content of the context variable
* *
@@ -300,11 +291,16 @@ abstract class Twig_Template implements Twig_TemplateInterface
/** /**
* Returns the attribute value for a given array/object. * Returns the attribute value for a given array/object.
* *
* @param mixed $object The object or array from where to get the item * @param mixed $object The object or array from where to get the item
* @param mixed $item The item to get from the array or object * @param mixed $item The item to get from the array or object
* @param array $arguments An array of arguments to pass if the item is an object method * @param array $arguments An array of arguments to pass if the item is an object method
* @param string $type The type of attribute (@see Twig_TemplateInterface) * @param string $type The type of attribute (@see Twig_TemplateInterface)
* @param Boolean $isDefinedTest Whether this is only a defined check * @param Boolean $isDefinedTest Whether this is only a defined check
* @param Boolean $ignoreStrictCheck Whether to ignore the strict attribute check or not
*
* @return mixed The attribute value, or a Boolean when $isDefinedTest is true, or null when the attribute is not set and $ignoreStrictCheck is true
*
* @throws Twig_Error_Runtime if the attribute does not exist and Twig is running in strict mode and $isDefinedTest is false
*/ */
protected function getAttribute($object, $item, array $arguments = array(), $type = Twig_TemplateInterface::ANY_CALL, $isDefinedTest = false, $ignoreStrictCheck = false) protected function getAttribute($object, $item, array $arguments = array(), $type = Twig_TemplateInterface::ANY_CALL, $isDefinedTest = false, $ignoreStrictCheck = false)
{ {