From 2ebc788abc7a338bfc7168d6589f6d58dfba28d6 Mon Sep 17 00:00:00 2001
From: nikic <nikita.ppv@googlemail.com>
Date: Sat, 29 Oct 2011 14:05:14 +0200
Subject: [PATCH] Update extension docs and interface

Twig isn't using globals for functions anymore.
---
 doc/extensions.rst              |   54 ++++++++++++++++++++++++++++-----------
 lib/Twig/Extension.php          |    4 +-
 lib/Twig/ExtensionInterface.php |    4 +-
 3 files changed, 43 insertions(+), 19 deletions(-)

diff --git a/doc/extensions.rst b/doc/extensions.rst
index 1f61a3e..2ff1334 100644
--- a/doc/extensions.rst
+++ b/doc/extensions.rst
@@ -29,56 +29,63 @@ An extension is a class that implements the following interface::
          *
          * @param Twig_Environment $environment The current Twig_Environment instance
          */
-        public function initRuntime(Twig_Environment $environment);
+        function initRuntime(Twig_Environment $environment);
 
         /**
          * Returns the token parser instances to add to the existing list.
          *
          * @return array An array of Twig_TokenParserInterface or Twig_TokenParserBrokerInterface instances
          */
-        public function getTokenParsers();
+        function getTokenParsers();
 
         /**
          * Returns the node visitor instances to add to the existing list.
          *
          * @return array An array of Twig_NodeVisitorInterface instances
          */
-        public function getNodeVisitors();
+        function getNodeVisitors();
 
         /**
          * Returns a list of filters to add to the existing list.
          *
          * @return array An array of filters
          */
-        public function getFilters();
+        function getFilters();
 
         /**
          * Returns a list of tests to add to the existing list.
          *
          * @return array An array of tests
          */
-        public function getTests();
+        function getTests();
+
+        /**
+         * Returns a list of functions to add to the existing list.
+         *
+         * @return array An array of functions
+         */
+        function getFunctions();
 
         /**
          * Returns a list of operators to add to the existing list.
          *
          * @return array An array of operators
          */
-        public function getOperators();
+        function getOperators();
 
         /**
-         * Returns a list of global functions to add to the existing list.
+         * Returns a list of global variables to add to the existing list.
          *
-         * @return array An array of global functions
+         * @return array An array of global variables
          */
-        public function getGlobals();
+        function getGlobals();
 
         /**
          * Returns the name of the extension.
          *
          * @return string The extension name
          */
-        public function getName();
+        function getName();
     }
 
 To keep your extension class clean and lean, it can inherit from the built-in
@@ -120,18 +127,35 @@ Of course, you need to first load the extension file by either using
 
     The bundled extensions are great examples of how extensions work.
 
-Globals and Functions
----------------------
+Globals
+-------
 
-Global variables and functions can be registered in an extensions via the
-``getGlobals()`` method::
+Global variables can be registered in an extensions via the ``getGlobals()``
+method::
 
     class Project_Twig_Extension extends Twig_Extension
     {
         public function getGlobals()
         {
             return array(
-                'text'   => new Text(),
+                'text' => new Text(),
+            );
+        }
+
+        // ...
+    }
+
+Functions
+---------
+
+Functions can be registered in an extensions via the ``getFunctions()``
+method::
+
+    class Project_Twig_Extension extends Twig_Extension
+    {
+        public function getFunctions()
+        {
+            return array(
                 'lipsum' => new Twig_Function_Function('generate_lipsum'),
             );
         }
diff --git a/lib/Twig/Extension.php b/lib/Twig/Extension.php
index ac289cb..931fc03 100644
--- a/lib/Twig/Extension.php
+++ b/lib/Twig/Extension.php
@@ -82,9 +82,9 @@ abstract class Twig_Extension implements Twig_ExtensionInterface
     }
 
     /**
-     * Returns a list of global functions to add to the existing list.
+     * Returns a list of global variables to add to the existing list.
      *
-     * @return array An array of global functions
+     * @return array An array of global variables
      */
     public function getGlobals()
     {
diff --git a/lib/Twig/ExtensionInterface.php b/lib/Twig/ExtensionInterface.php
index f8b232a..0bfed88 100644
--- a/lib/Twig/ExtensionInterface.php
+++ b/lib/Twig/ExtensionInterface.php
@@ -69,9 +69,9 @@ interface Twig_ExtensionInterface
     function getOperators();
 
     /**
-     * Returns a list of global functions to add to the existing list.
+     * Returns a list of global variables to add to the existing list.
      *
-     * @return array An array of global functions
+     * @return array An array of global variables
      */
     function getGlobals();
 
-- 
1.7.2.5