documentation/manual/en/tutorials/plugins-intro.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="learning.plugins.intro">
   4     <title>Introduction</title>
   5
   6     <para>
   7         Zend Framework makes heavy use of plugin architectures. Plugins allow for easy extensibility
   8         and customization of the framework while keeping your code separate from Zend Framework's
   9         code.
  10     </para>
  11
  12     <para>
  13         Typically, plugins in Zend Framework work as follows:
  14     </para>
  15
  16     <itemizedlist>
  17         <listitem>
  18             <para>
  19                 Plugins are classes. The actual class definition will vary based on the component --
  20                 you may need to extend an abstract class or implement an interface, but the fact
  21                 remains that the plugin is itself a class.
  22             </para>
  23         </listitem>
  24
  25         <listitem>
  26             <para>
  27                 Related plugins will share a common class prefix. For instance, if you have created
  28                 a number of view helpers, they might all share the class prefix
  29                 "<classname>Foo_View_Helper_</classname>".
  30             </para>
  31         </listitem>
  32
  33         <listitem>
  34             <para>
  35                 Everything after the common prefix will be considered the <emphasis>plugin
  36                     name</emphasis> or <emphasis>short name</emphasis> (versus the "long name",
  37                 which is the full classname). For example, if the plugin prefix is
  38                 "<classname>Foo_View_Helper_</classname>", and the class name is
  39                 "<classname>Foo_View_Helper_Bar</classname>", the plugin name will be simply
  40                 "<classname>Bar</classname>".
  41             </para>
  42         </listitem>
  43
  44         <listitem>
  45             <para>
  46                 Plugin names are typically case sensitive. The one caveat is that the initial letter
  47                 can often be either lower or uppercase; in our previous example, both "bar" and
  48                 "Bar" would refer to the same plugin.
  49             </para>
  50         </listitem>
  51     </itemizedlist>
  52
  53     <para>
  54         Now let's turn to using plugins.
  55     </para>
  56 </sect1>