Changeset 162

Show
Ignore:
Timestamp:
02/16/07 07:14:02 (2 years ago)
Author:
knut
Message:

added documentation for ZendCodeAnalyzerTask

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/classes/phing/tasks/ext/ZendCodeAnalyzerTask.php

    r144 r162  
    5959 * <b>expr-unused</b> - Expression result is never used 
    6060 * 
    61  * @author   Knut Urdalen <knut.urdalen@telio.no> 
     61 * @author   Knut Urdalen <knut.urdalen@gmail.com> 
    6262 * @package  phing.tasks.ext 
    6363 */ 

  • trunk/docs/phing_guide/book/chapters/appendixes/AppendixC-OptionalTasks.html

    r160 r162  
    14321432<p>Validate more XML files against one XSD file.</p> 
    14331433 
     1434<h2><a name="ZendCodeAnalyzerTask"></a>ZendCodeAnalyzerTask</h2> 
     1435<p>The <em>ZendCodeAnalyzerTask</em> analyze PHP source files using the Zend Code Analyzer tool that ships with all versions of Zend Studio.</p> 
     1436 
     1437<h3>Attributes</h3> 
     1438<table> 
     1439  <thead> 
     1440    <tr> 
     1441      <th>Name</th> 
     1442      <th>Type</th> 
     1443      <th>Description</th> 
     1444      <th>Default</th> 
     1445      <th>Required</th> 
     1446    </tr> 
     1447  </thead> 
     1448  <tbody> 
     1449    <tr> 
     1450      <td>analyzerPath</td> 
     1451      <td>String</td> 
     1452      <td>Path to Zend Code Analyzer binary</td> 
     1453      <td>n/a</td> 
     1454      <td>Yes</td> 
     1455    </tr> 
     1456    <tr> 
     1457      <td>file</td> 
     1458      <td>String</td> 
     1459      <td>Path to PHP source file</td> 
     1460      <td>n/a</td> 
     1461      <td>No</td> 
     1462    </tr> 
     1463    <tr> 
     1464      <td>disable</td> 
     1465      <td>String</td> 
     1466      <td>Disable warnings seperated by comma</td> 
     1467      <td>n/a</td> 
     1468      <td>No</td> 
     1469    </tr> 
     1470    <tr> 
     1471      <td>enable</td> 
     1472      <td>String</td> 
     1473      <td>Enable warnings separated by comma</td> 
     1474      <td>n/a</td> 
     1475      <td>No</td> 
     1476    </tr> 
     1477  </tbody> 
     1478</table> 
     1479 
     1480<h3>Supported Nested Tags</h3> 
     1481<ul> 
     1482  <li>fileset</li> 
     1483</ul> 
     1484 
     1485<h3>Example</h3> 
     1486<pre> 
     1487&lt;analyze analyzerPath=&quot;/usr/local/Zend/ZendStudioClient-5.1.0/bin/ZendCodeAnalyzer&quot; file=&quot;SomeClass.php&quot;/&gt; 
     1488</pre> 
     1489<p>Analyze one PHP source file with all default warnings enabled.</p> 
     1490<pre> 
     1491&lt;analyze analyzerPath=&quot;/usr/local/Zend/ZendStudioClient-5.1.0/bin/ZendCodeAnalyzer&quot; disable=&quot;var-ref-notmodified,if-if-else&quot;&gt; 
     1492&nbsp;&nbsp;&lt;fileset dir=&quot;.&quot;&gt; 
     1493&nbsp;&nbsp;&nbsp;&nbsp;&lt;include name="**/*.php"/&gt; 
     1494&nbsp;&nbsp;&lt;/fileset&gt; 
     1495&lt;/analyze&gt; 
     1496</pre> 
     1497<p>Analyze a set of PHP source files and disable a few warnings.</p> 
     1498 
    14341499<h2><a name="ZipTask"></a>ZipTask</h2> 
    14351500<p> The <em>ZipTask</em> creates a .zip archive from a fileset or directory.</p>