documentation/manual/en/ref/requirements.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <appendix id="requirements" xmlns:xi="http://www.w3.org/2001/XInclude">
   4     <title>Zend Framework Requirements</title>
   5
   6     <sect1 id="requirements.introduction">
   7         <title>Introduction</title>
   8
   9         <para>
  10             Zend Framework requires a <acronym>PHP</acronym> 5 interpreter with a web server
  11             configured to handle <acronym>PHP</acronym> scripts correctly. Some features require
  12             additional extensions or web server features; in most cases the framework can be used
  13             without them, although performance may suffer or ancillary features may not be fully
  14             functional. An example of such a dependency is mod_rewrite in an Apache environment,
  15             which can be used to implement "pretty <acronym>URL</acronym>'s" like
  16             "<filename>http://www.example.com/user/edit</filename>". If mod_rewrite is not enabled,
  17             Zend Framework can be configured to support <acronym>URL</acronym>'s such as
  18             "<command>http://www.example.com?controller=user&amp;action=edit</command>". Pretty
  19             <acronym>URL</acronym>'s may be used to shorten <acronym>URL</acronym>'s for textual
  20             representation or search engine optimization (<acronym>SEO</acronym>), but they do not
  21             directly affect the functionality of the application.
  22         </para>
  23
  24         <sect2 id="requirements.version">
  25             <title>PHP Version</title>
  26
  27             <para>
  28                 Zend recommends the most current release of <acronym>PHP</acronym> for critical
  29                 security and performance enhancements, and currently supports
  30                 <acronym>PHP</acronym> 5.2.4 or later.
  31             </para>
  32
  33             <para>
  34                 Zend Framework has an extensive collection of unit tests, which you can run using
  35                 PHPUnit 3.3.0 or later.
  36             </para>
  37         </sect2>
  38
  39         <sect2 id="requirements.extensions">
  40             <title>PHP Extensions</title>
  41
  42             <para>
  43                 You will find a table listing all extensions typically found in
  44                 <acronym>PHP</acronym> and how they are used in Zend Framework below. You should
  45                 verify that the extensions on which Zend Framework components you'll be using in
  46                 your application are available in your <acronym>PHP</acronym> environments. Many
  47                 applications will not require every extension listed below.
  48             </para>
  49
  50             <para>
  51                 A dependency of type "hard" indicates that the components or classes
  52                 cannot function properly if the respective extension is not available,
  53                 while a dependency of type "soft" indicates that the component may use
  54                 the extension if it is available but will function properly if it is not.
  55                 Many components will automatically use certain extensions if they are available
  56                 to optimize performance but will execute code with similar functionality in the
  57                 component itself if the extensions are unavailable.
  58             </para>
  59
  60             <xi:include href="requirements-php-extensions-table.xml" />
  61         </sect2>
  62
  63         <sect2 id="requirements.zendcomponents">
  64             <title>Zend Framework Components</title>
  65
  66             <para>
  67                 Below is a table that lists all available Zend Framework Components
  68                 and which <acronym>PHP</acronym> extension they need. This can help guide you
  69                 to know which extensions are required for your application.
  70                 Not all extensions used by Zend Framework are required for every
  71                 application.
  72             </para>
  73
  74             <para>
  75                 A dependency of type "hard" indicates that the components or classes
  76                 cannot function properly if the respective extension is not available,
  77                 while a dependency of type "soft" indicates that the component may use
  78                 the extension if it is available but will function properly if it is not.
  79                 Many components will automatically use certain extensions if they are available
  80                 to optimize performance but will execute code with similar functionality in the
  81                 component itself if the extensions are unavailable.
  82             </para>
  83
  84             <xi:include href="requirements-zendcomponents-table.xml" />
  85         </sect2>
  86
  87         <sect2 id="requirements.dependencies">
  88             <title>Zend Framework Dependencies</title>
  89
  90             <para>
  91                 Below you can find a table listing Zend Framework Components
  92                 and their dependencies to other Zend Framework Components. This
  93                 can help you if you need to have only single components instead
  94                 of the complete Zend Framework.
  95             </para>
  96
  97             <para>
  98                 A dependency of type "hard" indicates that the components or classes
  99                 cannot function properly if the respective dependent component is not available,
 100                 while a dependency of type "soft" indicates that the component may need
 101                 the dependent component in special situations or with special adapters.
 102                 At last a dependency of type "fix" indicated that these components or classes are
 103                 in any case used by subcomponents, and a dependency of type "sub" indicates that
 104                 these components can be used by subcomponents in special situations or with special
 105                 adapters.
 106             </para>
 107
 108             <note>
 109                 <para>
 110                     Even if it's possible to separate single components for
 111                     usage from the complete Zend Framework you should keep
 112                     in mind that this can lead to problems when files are missed
 113                     or components are used dynamically.
 114                 </para>
 115             </note>
 116
 117             <xi:include href="requirements-dependencies-table.xml" />
 118         </sect2>
 119     </sect1>
 120 </appendix>
 121 <!--
 122 vim:se ts=4 sw=4 et:
 123 -->