Changeset 395

Show
Ignore:
Timestamp:
10/12/08 08:00:45 (2 months ago)
Author:
alexeyshockov
Message:

#280: task, documentation.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • branches/2.4/classes/phing/tasks/defaults.properties

    r387 r395  
    8787ftpdeploy=phing.tasks.ext.FtpDeployTask 
    8888phkpackage=phing.tasks.ext.phk.PhkPackageTask 
     89pharpackage=phing.tasks.ext.phar.PharPackageTask 

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

    r388 r395  
    856856  <li>mapping</li> 
    857857</ul> 
     858 
     859 
     860<h2><a name="PharPackageTask"></a>PharPackageTask</h2> 
     861<p> 
     862  <a href="http://ru2.php.net/manual/en/book.phar.php" target="_blank">Phar</a> 
     863  packages generating with Phing. 
     864 
     865  This task <strong>require <a href="http://pecl.php.net/package/phar" target="_blank">PECL's 
     866  Phar</a></strong> extension to be installed on your system. Phar is built-in in PHP 
     867  from 5.3 version. 
     868</p> 
     869<h3>Attributes</h3> 
     870<table> 
     871  <thead> 
     872    <tr> 
     873      <th>Name</th> 
     874      <th>Type</th> 
     875      <th>Description</th> 
     876      <th>Default</th> 
     877      <th>Required</th> 
     878    </tr> 
     879  </thead> 
     880  <tbody> 
     881    <tr> 
     882      <td>basedir</td> 
     883      <td>String</td> 
     884      <td>Base directory, which will be deleted from each included file (from path). Paths with deleted <em>basedir</em> part are local paths in package.</td> 
     885      <td>n/a</td> 
     886      <td>Yes</td> 
     887    </tr> 
     888    <tr> 
     889      <td>destfile</td> 
     890      <td>String</td> 
     891      <td>Destination (output) file. Will be recreated, if exists!</td> 
     892      <td>n/a</td> 
     893      <td>Yes</td> 
     894    </tr> 
     895    <tr> 
     896      <td>compress</td> 
     897      <td>String</td> 
     898      <td>Compression type (gzip, bzip2, none) to apply to the packed files.</td> 
     899      <td>none</td> 
     900      <td>No</td> 
     901    </tr> 
     902    <tr> 
     903      <td>webstub</td> 
     904      <td>String</td> 
     905      <td>Relative path within the phar package to run, if accessed through a web browser.</td> 
     906      <td>n/a</td> 
     907      <td>No</td> 
     908    </tr> 
     909    <tr> 
     910      <td>clistub</td> 
     911      <td>String</td> 
     912      <td>Relative path within the phar package to run, if accessed on the command line.</td> 
     913      <td>n/a</td> 
     914      <td>No</td> 
     915    </tr> 
     916    <tr> 
     917      <td>signature</td> 
     918      <td>String</td> 
     919      <td>Signature algorithm (md5, sha1, sha256, sha512), used for this package.</td> 
     920      <td>sha1</td> 
     921      <td>No</td> 
     922    </tr> 
     923  </tbody> 
     924</table> 
     925<h3>Supported Nested Tags</h3> 
     926<ul> 
     927  <li>fileset</li> 
     928  <!-- 
     929    TODO Describe metadata element. 
     930  --> 
     931  <li>metadata 
     932    <p></p> 
     933  </li> 
     934</ul> 
     935<h3>Examples</h3> 
     936<p>Sample build command:</p> 
     937<pre>&lt;pharpackage 
     938  destfile=&quot;./build/package.phar&quot; 
     939  basedir=&quot;./&quot;&gt; 
     940  &lt;fileset dir=&quot;./classes&quot;&gt; 
     941    &lt;include name=&quot;**/**&quot; /&gt; 
     942  &lt;/fileset&gt; 
     943  &lt;metadata&gt; 
     944    &lt;element name=&quot;version&quot; value=&quot;1.0&quot; /&gt; 
     945    &lt;element name=&quot;authors&quot;&gt; 
     946      &lt;element name=&quot;John Doe&quot;&gt; 
     947        &lt;element name=&quot;e-mail&quot; value=&quot;john@example.com&quot; /&gt; 
     948      &lt;/element&gt; 
     949    &lt;/element&gt; 
     950  &lt;/metadata&gt; 
     951&lt;/pharpackage&gt; 
     952</pre> 
    858953 
    859954<h2><a name="PhkPackageTask"></a>PhkPackageTask</h2> 

  • branches/2.4/docs/phing_guide/book/toc/FrameToC.html

    r388 r395  
    88<html xmlns="http://www.w3.org/1999/xhtml"> 
    99<head> 
    10         <title> binarycloud contributor guide </title>  
     10        <title> binarycloud contributor guide </title> 
    1111        <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> 
    1212        <link rel="Stylesheet" rev="Stylesheet" href="../css/FrameToc.css" type="text/css" media="All" charset="iso-8859-1" /> 
    …… 
    133133<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PearPackageTask" target="Content">PearPackageTask</a></li> 
    134134<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PearPackage2Task" target="Content">PearPackage2Task</a></li> 
     135<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PharPackageTask" target="Content">PharPackageTask</a></li> 
    135136<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhkPackageTask" target="Content">PhkPackageTask</a></li> 
    136137<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhpCodeSnifferTask" target="Content">PhpCodeSnifferTask</a></li> 

  • branches/2.4/docs/phing_guide/book/toc/ToC.html

    r388 r395  
    118118<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PearPackageTask">PearPackageTask</a></li> 
    119119<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PearPackage2Task">PearPackage2Task</a></li> 
     120<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PharPackageTask">PharPackageTask</a></li> 
    120121<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhkPackageTask">PhkPackageTask</a></li> 
    121122<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhpCodeSnifferTask">PhpCodeSnifferTask</a></li>