Changeset 273

Show
Ignore:
Timestamp:
10/30/07 23:08:17 (9 months ago)
Author:
hans
Message:

Merging recent 2.3 branch changes.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/classes/phing/tasks/system/PropertyPromptTask.php

    r144 r273  
    3737 */  
    3838class PropertyPromptTask extends Task { 
    39  
     39         
     40        /** 
     41         * The property name to set with the output. 
     42         * @var string 
     43         */ 
    4044    private $propertyName;        // required 
     45     
     46    /** 
     47     * The default value to use if no input is entered. 
     48     * @var string 
     49     */ 
    4150    private $defaultValue; 
    42     private $proposedValue;        // required 
    43     private $promptText;        // required 
     51     
     52    /** 
     53     * The entered value. 
     54     * @var string 
     55     */ 
     56    private $proposedValue; 
     57     
     58    /** 
     59     * The text to use for the prompt. 
     60     * @var string 
     61     */ 
     62    private $promptText; 
     63     
     64    /** 
     65     * The character to put after the text. 
     66     * @var string 
     67     */ 
    4468    private $promptCharacter; 
     69     
     70    /** 
     71     *  
     72     */ 
    4573    private $useExistingValue; 
    46  
    47     /** 
    48      * Sets the prompt text that will be presented to the user. 
    49      * @param string $prompt 
    50      * @return void 
    51      */ 
    52     public function addText($prompt) { 
    53         $this->setPromptText($prompt); 
    54     } 
    5574 
    5675    /** 
    …… 
    5978     */ 
    6079    public function main() { 
     80         
    6181        $this->proposedValue = $this->project->getProperty($this->propertyName); 
    6282        $currentValue = $this->defaultValue; 
    63         if ($currentValue == "" && $this->proposedValue !== null) { $currentValue = $this->proposedValue; } 
    64         if (! (($this->useExistingValue === true) && ($this->proposedValue !== null))) { 
     83         
     84        if ($currentValue == "" && $this->proposedValue !== null) { 
     85                        $currentValue = $this->proposedValue; 
     86        } 
     87         
     88        if ($this->useExistingValue !== true || $this->proposedValue === null) { 
    6589                         
    6690            $this->log("Prompting user for " . $this->propertyName . ". " . $this->getDefaultMessage(), Project::MSG_VERBOSE); 
    …… 
    78102            } 
    79103             
    80             if (empty($this->proposedValue)) { 
     104            if ($this->proposedValue === "") { 
    81105                $this->log("No value specified, using default.", Project::MSG_VERBOSE); 
    82106                $this->proposedValue = $this->defaultValue; 
    83107            } 
    84108             
    85             if (!empty($this->proposedValue)) {                     
     109            if (isset($this->proposedValue) && $this->proposedValue !== "") {                     
    86110                $this->project->setProperty($this->propertyName, $this->proposedValue); 
    87111            } 
    …… 
    167191     * Sets the terminating character used to  
    168192     * punctuate the prompt text (default is "?"). 
    169      * @param newPromptcharacter java.lang.String 
     193     * @param string $newPromptcharacter 
    170194     */ 
    171195    public function setPromptCharacter($newPromptcharacter) { 
    …… 
    175199    /** 
    176200     * Sets text of the prompt. 
    177      * @param newPrompttext java.lang.String 
     201     * @param string $newPrompttext 
    178202     */ 
    179203    public function setPromptText($newPrompttext) { 
    …… 
    192216    /** 
    193217     *  
    194      *  
    195      * @param boolean newUseExistingValue 
     218     * @param boolean $newUseExistingValue 
    196219     */ 
    197220    public function setUseExistingValue($newUseExistingValue) { 
    …… 
    199222    } 
    200223     
     224    /** 
     225     * Sets the prompt text that will be presented to the user. 
     226     * @param string $prompt 
     227     * @return void 
     228     */ 
     229    public function addText($prompt) { 
     230        $this->setPromptText($prompt); 
     231    } 
     232     
     233     
    201234} 

  • trunk/docs/phing_guide/book/PhingGuide.book

    r123 r273  
    1111chapters/appendixes/AppendixC-OptionalTasks.html 
    1212chapters/appendixes/AppendixD-CoreTypes.html 
     13chapters/appendixes/AppendixD2-CoreFilters.html 
     14chapters/appendixes/AppendixD3-CoreMappers.html 
     15chapters/appendixes/AppendixD4-CoreSelectors.html 
    1316chapters/appendixes/AppendixE-ProjectComponents.html 
    1417chapters/appendixes/AppendixF-FileFormats.html 

  • trunk/docs/phing_guide/book/chapters/ProjectComponents.html

    r182 r273  
    2121  individual pieces do. </p> 
    2222<p>For supplemental reference information, you should see <a href="appendixes/AppendixB-CoreTasks.html">Appendix 
    23   B</a>, <a href="appendixes/AppendixC-CoreTypes.html">Appendix C</a> and <a href="appendixes/AppendixD-ProjectComponents.html">Appendix 
     23  B</a>, <a href="appendixes/AppendixC-CoreTypes.html">Appendix C</a> and <a href="appendixes/AppendixE-ProjectComponents.html">Appendix 
    2424  D</a>. </p> 
    2525 
    …… 
    4343  attributes are fairly self-explanatory; the <em>default</em> attribute specifies 
    4444  the default <em>Target</em> to execute if no target is specified (<a href="#Target">Targets</a> 
    45   are described below). For a complete reference, see <a href="appendixes/AppendixD-ProjectComponents.html#Project">Appendix 
     45  are described below). For a complete reference, see <a href="appendixes/AppendixE-ProjectComponents.html#Project">Appendix 
    4646  D</a>. </p> 
    4747 
    …… 
    358358 
    359359<p>Conditions are nested elements of the 
    360 <a href="appendixes/AppendixB-CoreTasks.html#ConditionTask">condition</code></a> and 
     360<a href="appendixes/AppendixB-CoreTasks.html#ConditionTask">condition</a> and 
    361361<a href="appendixes/AppendixB-CoreTasks.html#IfTask">if</a> tasks. 
    362362</p> 

  • trunk/docs/phing_guide/book/chapters/appendixes/AppendixB-CoreTasks.html

    r207 r273  
    13091309                <td>n/a</td> 
    13101310                <td>No</td> 
    1311  
     1311        </tr> 
     1312  </tbody> 
     1313</table> 
     1314 
     1315<h2><a name="PropertyPromptTask"></a>PropertyPromptTask</h2> 
     1316<p> 
     1317  PropertyPromptTask is a simple task to read in user input into a property. 
     1318  If you need something more advanced, see the <a href="#InputTask">InputTask</a>. 
     1319</p> 
     1320<h3>Example</h3> 
     1321 
     1322<pre>&lt;propertyprompt propertyName=&quot;someprop&quot; defaultValue=&quot;/var/www&quot;  
     1323                promptText=&quot;Enter your web root&quot; /&gt; 
     1324&lt;echo&gt;${someprop}&lt;/echo&gt; 
     1325</pre> 
     1326<h3>Attributes</h3> 
     1327<table> 
     1328  <thead> 
     1329    <tr> 
     1330      <th>Name</th> 
     1331      <th>Type</th> 
     1332      <th>Description</th> 
     1333      <th>Default</th> 
     1334      <th>Required</th> 
     1335    </tr> 
     1336  </thead> 
     1337  <tbody> 
     1338    <tr> 
     1339      <td>propertyName</td> 
     1340      <td>String</td> 
     1341      <td> 
     1342        The name of the Property to set. 
     1343      </td> 
     1344      <td>n/a</td> 
     1345      <td>Yes</td> 
     1346    </tr> 
     1347    <tr> 
     1348      <td>promptText</td> 
     1349      <td>String</td> 
     1350      <td> 
     1351        The text to use for the prompt. 
     1352      </td> 
     1353      <td>n/a</td> 
     1354      <td>Yes</td> 
     1355    </tr> 
     1356    <tr> 
     1357      <td>promptCharacter</td> 
     1358      <td>String</td> 
     1359      <td> 
     1360        The character to use after the prompt. 
     1361      </td> 
     1362      <td>?</td> 
     1363      <td>No</td> 
     1364    </tr> 
     1365        <tr> 
     1366         <td>defaultValue</td> 
     1367      <td>String</td> 
     1368      <td> 
     1369                A default value to use (if user just hits enter). 
     1370      </td> 
     1371      <td>n/a</td> 
     1372      <td>No</td> 
     1373        </tr> 
     1374        <tr> 
     1375                <td>useExistingValue</td> 
     1376                <td>String</td> 
     1377                <td>Whether existing property should be used if available. (This will 
     1378                        result in user only being prompted if the propertyName property is not already set.)</td> 
     1379                <td>false</td> 
     1380                <td>No</td> 
     1381        </tr> 
    13121382  </tbody> 
    13131383</table> 

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

    r262 r273  
    394394      <td>none</td> 
    395395      <td>No</td> 
    396     </tr> 
    397396    </tr> 
    398397    <tr> 

  • trunk/docs/phing_guide/book/chapters/appendixes/AppendixD-CoreTypes.html

    r246 r273  
    180180<p> The <em>&lt;path&gt; </em>tag supports nested <em>&lt;fileset&gt;</em> and 
    181181  <em>&lt;dirset&gt;</em> tags.</p> 
    182 <h2><a name="CoreFilters"></a>Core Filters</h2> 
    183  
    184 <p>Filters have to be defined within a <em>&lt;filterchain&gt;</em> 
    185 context to work. Example:</p> 
    186 <pre> 
    187 &lt;filterchain&gt; 
    188   &lt;expandproperties /&gt; 
    189 &lt;/filterchain&gt; 
    190 </pre> 
    191 <p> There are two ways to use a filter: System filters (the ones shipped with 
    192   Phing) can be used with their own tag name, such as <em>&lt;xsltfilter</em>&gt;, 
    193   &lt;<em>expandpropertyfilter</em>&gt; or <em>&lt;tabtospaces</em>&gt;. Another 
    194   way is to use the <em>&lt;filterreader&gt;</em> tag. </p> 
    195  
    196 <h2><a name="PhingFilterReader"></a>PhingFilterReader</h2> 
    197 <p> The PhingFilterReader is used when you want to use filters that are not directly 
    198   available through their own tag. Example: </p> 
    199 <pre> 
    200 &lt;filterchain&gt; 
    201   &lt;filterreader classname=&quot;phing.filter.ReplaceTokens&quot;&gt; 
    202     &lt;-- other way to set attributes --&gt; 
    203     &lt;param name=&quot;begintoken&quot; value=&quot;@@&quot; /&gt; 
    204     &lt;param name=&quot;endtoken&quot; value=&quot;@@&quot; /&gt; 
    205  
    206     &lt;-- other way to set nested tags --&gt; 
    207     &lt;param type=&quot;token&quot; key=&quot;bar&quot; value=&quot;foo&quot; /&gt; 
    208   &lt;/filterreader&gt; 
    209 &lt;/filterchain&gt; 
    210 </pre> 
    211 <p> In the <em>filterreader</em> tag you have to specify the path the class is 
    212   in. The <em>FilterReader</em> will then load this class and pass the parameters 
    213   to the loaded filter. There are two types of parameters: First, you can pass 
    214   &quot;normal&quot; parameters to the loaded filter. That means, you can pass 
    215   parameters as if they were attributes. If you want to do this, you only specify 
    216   the <em>name</em> and <em>value</em> attributes in the <em>param</em> tag. You 
    217   can also pass nested elements to the filter. Then, you have to specify the <em>type</em> 
    218   attribute. This attribute specifies the name of the nested tag. </p> 
    219 <p>The result of the example above is identical with the following code: </p> 
    220 <pre> 
    221 &lt;filterchain&gt; 
    222   &lt;replacetokens begintoken=&quot;@@&quot; endtoken=&quot;@@&quot;&gt; 
    223     &lt;token key=&quot;bar&quot; value=&quot;foo&quot; /> 
    224   &lt;/replacetokens&gt; 
    225 &lt;/filterchain&gt;</pre> 
    226 <h3>Attributes</h3> 
    227 <table> 
    228   <caption> 
    229   Attributes for <em>&lt;filterreader&gt;</em> 
    230   </caption> 
    231   <thead> 
    232     <tr> 
    233       <th>Name</th> 
    234       <th>Type</th> 
    235       <th>Description</th> 
    236       <th>Default</th> 
    237       <th>Required</th> 
    238     </tr> 
    239   </thead> 
    240   <tbody> 
    241     <tr> 
    242       <td>classname</td> 
    243       <td>String</td> 
    244       <td> Name of class to use (in dot-path notation).</td> 
    245       <td>n/a</td> 
    246       <td>Yes</td> 
    247     </tr> 
    248     <tr> 
    249       <td>classpath</td> 
    250       <td>String</td> 
    251       <td> The classpath to use when including classes. This is added to PHP's 
    252         include_path.</td> 
    253       <td>n/a</td> 
    254       <td>No</td> 
    255     </tr> 
    256     <tr> 
    257       <td>classpathref</td> 
    258       <td>String</td> 
    259       <td> Reference to classpath to use when including classes. This is added 
    260         to PHP's include_path.</td> 
    261       <td>n/a</td> 
    262       <td>No</td> 
    263     </tr> 
    264   </tbody> 
    265 </table> 
    266 <h3>Nested Tags</h3> 
    267 <p> The <em>PhingFilterReader</em> supports nested &lt;classpath&gt;.</p> 
    268 <h3>Advanced</h3> 
    269 <p>In order to support the &lt;filterreader ... /&gt; sytax, your class must 
    270 extend the BaseParamFilterReader class.  Most of the filters that are bundled 
    271 with Phing can be invoked using this syntax.  The noteable exception (at time of 
    272 writing) is the ReplaceRegexp filter, which expects find/replace parameters that do not fit the 
    273 name/value mold. For this reason, you must always use the shorthand &lt;replaceregexp .../&gt; to invoke 
    274 this filter.</p> 
    275  
    276 <h2><a name="ExpandProperties"></a>ExpandProperties</h2> 
    277 <p> 
    278 The ExpandProperties simply replaces property names with their 
    279 property values. For example, if you have the following in your 
    280 build file: 
    281 </p> 
    282 <pre> 
    283 &lt;property name=&quot;description.txt&quot; value=&quot;This is a text file&quot; /&gt; 
    284  
    285 &lt;copy todir=&quot;/tmp&quot;&gt; 
    286   &lt;filterchain&gt; 
    287     &lt;expandproperties /&gt; 
    288   &lt;/filterchain&gt; 
    289  
    290   &lt;fileset dir=&quot;.&quot;&gt; 
    291     &lt;include name=&quot;**&quot; /&gt; 
    292   &lt;/fileset&gt; 
    293 &lt;/copy&gt; 
    294 </pre> 
    295 <p> 
    296 And the string <em>${description.txt}</em> it will be replaced by 
    297 <em>This is a text file</em>. 
    298 </p> 
    299  
    300 <h2><a name="HeadFilter"></a>HeadFilter</h2> 
    301 <p> 
    302 This filter reads the first <em>n</em> lines of a file; the others 
    303 are not further passed through the filter chain. Usage example: 
    304 </p> 
    305 <pre> 
    306 &lt;filterchain&gt; 
    307   &lt;headfilter lines=&quot;20&quot; /&gt; 
    308 &lt;/filterchain&gt; 
    309 </pre> 
    310 <h3>Attributes</h3> 
    311 <table> 
    312   <caption> 
    313   Attributes for the <em>&lt;headfilter&gt; </em>tag 
    314   </caption> 
    315   <thead> 
    316     <tr> 
    317       <th>Name</th> 
    318       <th>Type</th> 
    319       <th>Description</th> 
    320       <th>Default</th> 
    321       <th>Required</th> 
    322     </tr> 
    323   </thead> 
    324   <tbody> 
    325     <tr> 
    326       <td>lines</td> 
    327       <td>Integer</td> 
    328       <td> 
    329         Number of lines to read. 
    330       </td> 
    331       <td>10</td> 
    332       <td>No</td> 
    333     </tr> 
    334   </tbody> 
    335 </table> 
    336  
    337 <h2><a name="LineContains"></a>Line Contains</h2> 
    338 <p> 
    339 This filter is only &quot;permeable&quot; for lines that contain 
    340 the expression given as parameter. For example, the following 
    341 filterchain would only let all the lines pass that contain 
    342 <em>class</em>: 
    343 </p> 
    344 <pre> 
    345 &lt;filterchain&gt; 
    346   &lt;linecontains&gt; 
    347     &lt;contains value=&quot;class&quot; /&gt; 
    348   &lt;/linecontains&gt; 
    349 &lt;/filterchain&gt; 
    350 </pre> 
    351  
    352 <h3>Nested Tags</h3> 
    353  
    354 <p> 
    355 The <em>linecontains</em> tag must contain one or more <em>contains</em> 
    356 tags. Latter must have a <em>value</em> attribute that has to be set 
    357 to the string the line has to contain to be let through. 
    358 </p> 
    359  
    360 <h2><a name="LineContainsRegexp"></a>LineContainsRegexp</h2> 
    361 <p> 
    362 This filter is similar to <a href="#LineContains">LineContains</a> 
    363 but you can specify regular expressions instead of simple strings. 
    364 </p> 
    365 <pre> 
    366 &lt;filterchain&gt; 
    367   &lt;linecontainsregexp&gt; 
    368     &lt;regexp pattern=&quot;foo(.*)bar&quot; /&gt; 
    369   &lt;/linecontainsregexp&gt; 
    370 &lt;/filterchain&gt; 
    371 </pre> 
    372  
    373 <h3>Nested Tags</h3> 
    374  
    375 <p> 
    376 The <em>LineContains</em> filter has to contain at least one <em>regexp</em> 
    377 tag. This must have a <em>pattern</em> attribute that is set to a 
    378 regular expression. 
    379 </p> 
    380  
    381 <h2><a name="PrefixLines"></a>PrefixLines</h2> 
    382 <p> 
    383 This filter adds a prefix to every line. The following example will add 
    384 the string <em>foo: </em> in front of every line. 
    385 </p> 
    386 <pre> 
    387 &lt;filterchain&gt; 
    388   &lt;prefixlines prefix=&quot;foo: &quot; /&gt; 
    389 &lt;/filterchain&gt; 
    390 </pre> 
    391 <h3>Attributes</h3> 
    392 <table> 
    393   <caption> 
    394   Attributes for the <em>&lt;prefixlines&gt;</em> tag 
    395   </caption> 
    396   <thead> 
    397     <tr> 
    398       <th>Name</th> 
    399       <th>Type</th> 
    400       <th>Description</th> 
    401       <th>Default</th> 
    402       <th>Required</th> 
    403     </tr> 
    404   </thead> 
    405   <tbody> 
    406     <tr> 
    407       <td>prefix</td> 
    408       <td>string</td> 
    409       <td> 
    410         Strint to prepend to every line. 
    411       </td> 
    412       <td>n/a</td> 
    413       <td>Yes</td> 
    414     </tr> 
    415   </tbody> 
    416 </table> 
    417  
    418 <h2><a name="ReplaceTokens"></a>ReplaceTokens</h2> 
    419 <p> 
    420 The <em>ReplaceTokens</em> filter will replace certain tokens. Tokens 
    421 are strings enclosed in special characters. If you want to replace 
    422 <em>##BCHOME##</em> by the path to the directory set in the 
    423 environment variable <em>BCHOME</em>, you could do the following: 
    424 </p> 
    425 <pre> 
    426 &lt;property environment=&quot;env&quot; /> 
    427  
    428 &lt;filterchain&gt; 
    429   &lt;replacetokens begintoken=&quot;##&quot; endtoken=&quot;##&quot;&gt; 
    430     &lt;token key=&quot;BCHOME&quot; value=&quot;${env.BCHOME}&quot; /&gt; 
    431   &lt;/replacetokens&gt; 
    432 &lt;/filterchain&gt; 
    433 </pre> 
    434 <h3>Attributes</h3> 
    435 <table> 
    436   <caption> 
    437   Attributes for the <em>&lt;replacetokens&gt;</em> tag 
    438   </caption> 
    439   <thead> 
    440     <tr> 
    441       <th>Name</th> 
    442       <th>Type</th> 
    443       <th>Description</th> 
    444       <th>Default</th> 
    445       <th>Required</th> 
    446     </tr> 
    447   </thead> 
    448   <tbody> 
    449     <tr> 
    450       <td>begintoken</td> 
    451       <td>string</td> 
    452       <td> 
    453         The string that marks the beginning of a token. 
    454       </td> 
    455       <td>@</td> 
    456       <td>No</td> 
    457     </tr> 
    458     <tr> 
    459       <td>endtoken</td> 
    460       <td>string</td> 
    461       <td> 
    462         The string that marks the end of a token. 
    463       </td> 
    464       <td>@</td> 
    465       <td>No</td> 
    466     </tr> 
    467   </tbody> 
    468 </table> 
    469 <h3>Nested Tags</h3> 
    470 <p> 
    471 The <em>ReplaceTokens</em> filter must contain one or more <em>token</em> 
    472 tags. These must have a <em>key</em> and a <em>value</em> attribute. 
    473 </p> 
    474  
    475 <h2><a name="ReplaceRegexp"></a>ReplaceRegexp</h2> 
    476 <p> 
    477 The <em>ReplaceRegexp</em> filter will perform a regexp find/replace on the input 
    478 stream. For example, if you want to replace ANT with Phing (ignoring case) and you want 
    479 to replace references to *.java with *.php: 
    480 </p> 
    481 <pre> 
    482 &lt;filterchain&gt; 
    483   &lt;replaceregexp&gt; 
    484         &lt;regexp pattern=&quot;ANT&quot; replace=&quot;Phing&quot; ignoreCase=&quot;true&quot;/&gt; 
    485         &lt;regexp pattern=&quot;(\w+)\.java&quot; replace=&quot;\1.php&quot;/&gt; 
    486   &lt;/replaceregexp&gt; 
    487 &lt;/filterchain&gt; 
    488 </pre> 
    489  
    490 <h3>Nested Tags</h3> 
    491 <p> 
    492 The <em>ReplaceTokens</em> filter must contain one or more <em>regexp</em> 
    493 tags. These must have <em>pattern</em> and <em>replace</em> attributes -- and optionally 
    494 the <em>ignoreCase</em> attribute. 
    495 </p> 
    496  
    497  
    498 <h2><a name="StripLineBreaks"></a>StripLineBreaks</h2> 
    499 <p> 
    500 The <em>StripLineBreaks</em> filter removes all linebreaks from the 
    501 stream passed through the filter chain. 
    502 </p> 
    503 <pre> 
    504 &lt;filterchain&gt; 
    505   &lt;striplinebreaks /&gt; 
    506 &lt;/filterchain&gt; 
    507 </pre> 
    508  
    509 <h2><a name="StripLineComments"></a>StripLineComments</h2> 
    510 <p> 
    511 The <em>StripLineComments</em> filter removes all line comments from 
    512 the stream passed through the filter chain: 
    513 </p> 
    514 <pre> 
    515 &lt;filterchain&gt; 
    516   &lt;striplinecomments&gt; 
    517     &lt;comment value=&quot;#&quot; /&gt; 
    518     &lt;comment value=&quot;--&quot; /&gt; 
    519     &lt;comment value=&quot;//&quot; /&gt; 
    520   &lt;/striplinecomments&gt; 
    521 &lt;/filterchain&gt; 
    522 </pre> 
    523  
    524 <h3>Nested Tags</h3> 
    525 <p> 
    526 The <em>striplinecomments</em> tag must contain one or more <em>comment</em> 
    527 tags. These must have a <em>value</em> attribute that specifies the 
    528 character(s) that start a line comment. 
    529 </p> 
    530  
    531 <h2><a name="StripPhpComments"></a>StripPhpComments</h2> 
    532 <p> 
    533 The <em>StripPhpComments</em> filter removes all PHP comments from 
    534 the stream passed through the filter. 
    535 </p> 
    536 <pre> 
    537 &lt;filterchain&gt; 
    538   &lt;stripphpcomments /&gt; 
    539 &lt;/filterchain&gt; 
    540 </pre> 
    541  
    542 <h2><a name="StripWhitespace"></a>StripWhitespace</h2> 
    543 <p> 
    544 The <em>StripWhitespace</em> filter removes all PHP comments and whitespace from 
    545 the stream passed through the filter.  Internally, this filter uses the php_strip_whitespace() function. 
    546 </p> 
    547 <pre> 
    548 &lt;filterchain&gt; 
    549   &lt;stripwhitespace /&gt; 
    550 &lt;/filterchain&gt; 
    551 </pre> 
    552  
    553 <h2><a name="TabToSpaces"></a>TabToSpaces</h2> 
    554 <p> 
    555 The TabToSpaces filter replaces all tab characters with a given 
    556 count of space characters. 
    557 </p> 
    558 <pre> 
    559 &lt;filterchain&gt; 
    560   &lt;tabtospaces tablength=&quot;8&quot; /&gt; 
    561 &lt;/filterchain&gt; 
    562 </pre> 
    563 <h3>Attributes</h3> 
    564 <table> 
    565   <caption> 
    566   Attributes for the <em>&lt;tabtospaces&gt;</em> filter 
    567   </caption> 
    568   <thead> 
    569     <tr> 
    570       <th>Name</th> 
    571       <th>Type</th> 
    572       <th>Description</th> 
    573       <th>Default</th> 
    574       <th>Required</th> 
    575     </tr> 
    576   </thead> 
    577   <tbody> 
    578     <tr> 
    579       <td>tablength</td> 
    580       <td>Integer</td> 
    581       <td> 
    582         The number of space characters that a tab is to represent. 
    583       </td> 
    584       <td>8</td> 
    585       <td>No</td> 
    586     </tr> 
    587   </tbody> 
    588 </table> 
    589  
    590 <h2><a name="TailFilter"></a>TailFilter</h2> 
    591 <p> 
    592 Similar to <a href="#HeadFilter">HeadFilter</a>, 
    593 this filter reads the last <em>n</em> lines of a file; the others 
    594 are not further passed through the filter chain. Usage example: 
    595 </p> 
    596 <pre> 
    597 &lt;filterchain&gt; 
    598   &lt;tailfilter lines=&quot;20&quot; /&gt; 
    599 &lt;/filterchain&gt; 
    600 </pre> 
    601 <h3>Attributes</h3> 
    602 <table> 
    603   <caption> 
    604   Attributes for the <em>&lt;tailfilter&gt;</em> tag 
    605   </caption> 
    606   <thead> 
    607     <tr> 
    608       <th>Name</th> 
    609       <th>Type</th> 
    610       <th>Description</th> 
    611       <th>Default</th> 
    612       <th>Required</th> 
    613     </tr> 
    614   </thead> 
    615   <tbody> 
    616     <tr> 
    617       <td>lines</td> 
    618       <td>Integer</td> 
    619       <td> 
    620         Number of lines from the back to read. 
    621       </td> 
    622       <td>10</td> 
    623       <td>No</td> 
    624     </tr> 
    625   </tbody> 
    626 </table> 
    627  
    628 <h2><a name="XincludeFilter"></a>XincludeFilter</h2> 
    629 <p> 
    630 The <em>XincludeFilter</em> processes a stream for Xinclude tags, and processes the inclusions. 
    631 This is useful for processing modular XML files.  DocBook book files are one example of 
    632 modular XML files.  Usage example: 
    633 <pre> 
    634 &lt;!-- 
    635   Render a DocBook book file called manual.xml, which 
    636   contains Xinclude tags to include individual book sections. 
    637   --&gt; 
    638 &lt;copy todir=&quot;${manual.dest.dir}&quot;&gt; 
    639   &lt;filterchain&gt; 
    640     &lt;xincludefilter basedir=&quot;${manual.src.dir}&quot; /&gt; 
    641     &lt;xsltfilter style=&quot;${manual.src.dir}/html.xsl&quot;&gt; 
    642       &lt;param name=&quot;base.dir&quot; expression=&quot;${manual.dest.dir}/&quot; /&gt; 
    643     &lt;/xsltfilter&gt; 
    644   &lt;/filterchain&gt; 
    645   &lt;fileset dir=&quot;${manual.src.dir}&quot;&gt; 
    646     &lt;include name=&quot;manual.xml&quot; /&gt; 
    647   &lt;/fileset&gt; 
    648 &lt;/copy&gt; 
    649 </pre> 
    650 <h3>Attributes</h3> 
    651 <table> 
    652   <caption> 
    653   Attributes for the <em>&lt;xincludefilter&gt;</em> tag 
    654   </caption> 
    655   <thead> 
    656     <tr> 
    657       <th>Name</th> 
    658       <th>Type</th> 
    659       <th>Description</th> 
    660       <th>Default</th> 
    661       <th>Required</th> 
    662     </tr> 
    663   </thead> 
    664   <tbody> 
    665     <tr> 
    666       <td>basedir</td> 
    667       <td>String</td> 
    668       <td> 
    669         The working directory from which to 
    670         process the Xincludes.  Relative pathnames 
    671         in the include tags are based on this 
    672         location. 
    673       </td> 
    674       <td>Project basedir</td> 
    675       <td>No</td> 
    676     </tr> 
    677   </tbody> 
    678 </table> 
    679  
    680  
    681 <h2><a name="XsltFilter"></a>XsltFilter</h2> 
    682 <p> 
    683 The <em>XsltFilter</em> applies a XSL template to the stream. 
    684 Though you can use this filter directly, you should use 
    685 <a href="AppendixB-CoreTasks.html#XsltTask">XsltTask</a> 
    686 which is shortcut to the following lines: 
    687 </p> 
    688 <pre> 
    689 &lt;filterchain&gt; 
    690   &lt;xsltfilter style=&quot;somexslt.xsl&quot; /&gt; 
    691 &lt;/filterchain&gt; 
    692 </pre> 
    693 <h3>Attributes</h3> 
    694 <table> 
    695   <caption> 
    696   Attributes for the <em>&lt;xsltfilter&gt;</em> tag 
    697   </caption> 
    698   <thead> 
    699     <tr> 
    700       <th>Name</th> 
    701       <th>Type</th> 
    702       <th>Description</th> 
    703       <th>Default</th> 
    704       <th>Required</th> 
    705     </tr> 
    706   </thead> 
    707   <tbody> 
    708     <tr> 
    709       <td>style</td> 
    710       <td>String</td> 
    711       <td> 
    712         The XSLT stylesheet to use for transformation. 
    713       </td> 
    714       <td>n/a</td> 
    715       <td>Yes</td> 
    716     </tr> 
    717         <tr> 
    718       <td>html</td> 
    719       <td>Boolean</td> 
    720       <td> 
    721         Whether to parse the input as HTML (using libxml2 DOMDocument::loadHTML()). 
    722       </td> 
    723       <td>false</td> 
    724       <td>No</td> 
    725     </tr> 
    726   </tbody> 
    727 </table> 
    728  
    729 <h3>Nested Tags</h3> 
    730 <p> 
    731 The <em>XsltFilter</em> filter may contain one or more <em>param</em> 
    732 tags to pass any XSLT parameters to the stylesheet. These <em>param</em> tags 
    733 must have <em>name</em> and <em>expression</em> attributes. 
    734 </p> 
    735  
    736 <h2><a name="CoreMappers"></a>Core Mappers</h2> 
    737 <p> 
    738 While filters are applied to the <em>content</em> of files, Mappers 
    739 are applied to the <em>filenames</em>. All mappers have the same 
    740 API, i.e. the way you use them is the same: 
    741 </p> 
    742 <pre> 
    743 &lt;mapper type=&quot;<em>mappername</em>&quot; from=&quot;<em>frompattern</em>&quot; to=&quot;<em>topattern</em>&quot; /&gt; 
    744 </pre> 
    745 <h3>Attributes</h3> 
    746 <table> 
    747   <caption> 
    748   Attributes for the <em>&lt;mapper&gt;</em> tag 
    749   </caption> 
    750   <thead> 
    751     <tr> 
    752       <th>Name</th> 
    753       <th>Type</th> 
    754       <th>Description</th> 
    755       <th>Default</th> 
    756       <th>Required</th> 
    757     </tr> 
    758   </thead> 
    759   <tbody> 
    760     <tr> 
    761       <td>type</td> 
    762       <td>String</td> 
    763       <td> 
    764         Type of the mapper. 
    765       </td> 
    766       <td>n/a</td> 
    767       <td>Yes</td> 
    768     </tr> 
    769     <tr> 
    770       <td>from</td> 
    771       <td>String</td> 
    772       <td> 
    773         The pattern the filename is to be matched to. The 
    774         exact meaning is dependent on the implementation 
    775         of the mapper. 
    776       </td> 
    777       <td>n/a</td> 
    778       <td>depends on the implementation of the mapper</td> 
    779     </tr> 
    780     <tr> 
    781       <td>to</td> 
    782       <td>String</td> 
    783       <td> 
    784         The pattern according to which the filename is to 
    785         be changed to. Here, the usage is dependent on 
    786         the implementation of the mapper, too. 
    787       </td> 
    788       <td>n/a</td> 
    789       <td>depends on the implementation of the mapper</td> 
    790     </tr> 
    791   </tbody> 
    792 </table> 
    793  
    794 <h2><a name="FlattenMapper"></a>FlattenMapper</h2> 
    795 <p> 
    796 The <em>FlattenMapper</em> removes the directories from 
    797 a filename and solely returns the filename. 
    798 </p> 
    799 <pre> 
    800 &lt;copy todir=&quot;/tmp&quot;&gt; 
    801   &lt;mapper type=&quot;flatten&quot; /&gt; 
    802  
    803   &lt;fileset refid=&quot;someid&quot; /&gt; 
    804 &lt;/copy&gt; 
    805 </pre> 
    806 <p> 
    807 This code will copy all files in the fileset to /tmp. All 
    808 files will be in the target directory. 
    809 </p> 
    810 <h3>Examples</h3> 
    811 <pre> 
    812 &lt;mapper type=&quot;flatten&quot; /&gt; 
    813 </pre> 
    814 <p> 
    815 Applying the mapper, you will get the following results from the 
    816 following filenames: 
    817 </p> 
    818 <table> 
    819   <tr> 
    820     <th>From</th> 
    821     <th>To</th> 
    822   </tr> 
    823   <tr> 
    824     <td>test.txt</td> 
    825     <td>test.txt</td> 
    826   </tr> 
    827   <tr> 
    828     <td>./foo/bar/test.bak</td> 
    829     <td>test.bak</td> 
    830   </tr> 
    831 </table> 
    832  
    833 <h2><a name="GlobMapper"></a>GlobMapper</h2> 
    834 <p> 
    835 The <em>GlobMapper</em> works like the <em>copy</em> command in DOS: 
    836 </p> 
    837 <pre> 
    838 &lt;copy todir=&quot;/tmp&quot;&gt; 
    839   &lt;mapper type=&quot;glob&quot; from=&quot;*.php&quot; to=&quot;*.php.bak&quot;/&gt; 
    840  
    841   &lt;fileset refid=&quot;someid&quot; /&gt; 
    842 &lt;/copy&gt; 
    843 </pre> 
    844 <p> 
    845 This will change the extension of all files matching the pattern 
    846 <em>*.php</em> to <em>.php.bak</em>. 
    847 </p> 
    848 <h3>Examples</h3> 
    849 <pre> 
    850 &lt;mapper type=&quot;glob&quot; from=&quot;*txt&quot; to=&quot;*txt.bak&quot;/&gt; 
    851 </pre> 
    852 <p> 
    853 Applying the mapper, you will get the following results from the 
    854 following filenames: 
    855 </p> 
    856 <table> 
    857   <tr> 
    858     <th>From</th> 
    859     <th>To</th> 
    860   </tr> 
    861   <tr> 
    862     <td>test.txt</td> 
    863     <td>test.txt.bak</td> 
    864   </tr> 
    865   <tr> 
    866     <td>./foo/bar/test.txt</td> 
    867     <td>./foo/bar/test.txt.bak</td> 
    868   </tr> 
    869   <tr> 
    870     <td>mytxt</td> 
    871     <td>mytxt.bak</td> 
    872   </tr> 
    873   <tr> 
    874     <td>SomeClass.php</td> 
    875     <td><em>ignored</em>, SomeClass.php</td> 
    876   </tr> 
    877 </table> 
    878  
    879 <h2><a name="IdentityMapper"></a>IdentityMapper</h2> 
    880 <p> 
    881 The <em>IdentityMapper</em> will not change anything on the 
    882 source filenames. 
    883 </p> 
    884  
    885 <h2><a name="MergeMapper"></a>MergeMapper</h2> 
    886 <p> 
    887 The <em>MergeMapper</em> changes all source filenames to the same 
    888 filename. 
    889 </p> 
    890 <h3>Examples</h3> 
    891 <pre> 
    892 &lt;mapper type=&quot;merge&quot; to=&quot;test.tar&quot;/&gt; 
    893 </pre> 
    894 <p> 
    895 Applying the mapper, you will get the following results from the 
    896 following filenames: 
    897 </p> 
    898 <table> 
    899   <tr> 
    900     <th>From</th> 
    901     <th>To</th> 
    902   </tr> 
    903   <tr> 
    904     <td>test.txt</td> 
    905     <td>test.tar</td> 
    906   </tr> 
    907   <tr> 
    908     <td>./foo/bar/test.txt</td> 
    909     <td>test.tar</td> 
    910   </tr> 
    911   <tr> 
    912     <td>mytxt</td> 
    913     <td>test.tar</td> 
    914   </tr> 
    915   <tr> 
    916     <td>SomeClass.php</td> 
    917     <td>test.tar</td> 
    918   </tr> 
    919 </table> 
    920  
    921 <h2><a name="RegexpMapper"></a>RegexpMapper</h2> 
    922 <p> 
    923 The <em>RegexpMapper</em> changes filenames according to a pattern 
    924 defined by a regular expression. This is the most powerful mapper and 
    925 you should be able to use it for every possible application. 
    926 </p> 
    927 <h3>Examples</h3> 
    928 <pre> 
    929 &lt;mapper type=&quot;regexp&quot; from=&quot;^(.*)\.conf\.xml&quot; to=&quot;\1.php&quot;/&gt; 
    930 </pre> 
    931 <p> 
    932 The mapper as above will do the following mappings: 
    933 </p> 
    934 <table> 
    935   <tr> 
    936     <th>From</th> 
    937     <th>To</th> 
    938   </tr> 
    939   <tr> 
    940     <td>test.txt</td> 
    941     <td><em>ignore</em>, test.txt</td> 
    942   </tr> 
    943   <tr> 
    944     <td>./foo/bar/test.conf.xml</td> 
    945     <td>./foo/bar/test.php</td> 
    946   </tr> 
    947   <tr> 
    948     <td>someconf.conf.xml</td> 
    949     <td>someconf.php</td> 
    950   </tr> 
    951 </table> 
    952  
    953   </body> 
     182    </body> 
    954183</html> 

  • trunk/docs/phing_guide/book/js/Chapters.js

    r159 r273  
    99new Array('chapters/appendixes/AppendixC-OptionalTasks.html','Appendix C: Optional Tasks'), 
    1010new Array('chapters/appendixes/AppendixD-CoreTypes.html','Appendix D: Core Types'), 
     11new Array('chapters/appendixes/AppendixD2-CoreFilters.html','Appendix D-2: Core Filters'), 
     12new Array('chapters/appendixes/AppendixD3-CoreMappers.html','Appendix D-3: Core Mappers'), 
     13new Array('chapters/appendixes/AppendixD4-CoreSelectors.html','Appendix D: Core Selectors'), 
    1114new Array('chapters/appendixes/AppendixE-ProjectComponents.html','Appendix E: Project Components'), 
    1215new Array('chapters/appendixes/AppendixF-FileFormats.html','Appendix F: File Formats'), 

  • trunk/docs/phing_guide/book/toc/FrameToC.html

    r222 r273  
    109109<li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#PhpEvalTask" target="Content">PhpEvalTask</a></li> 
    110110<li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#PropertyTask" target="Content">PropertyTask</a></li> 
     111<li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#PropertyPromptTask" target="Content">PropertyPromptTask</a></li> 
    111112<li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#ReflexiveTask" target="Content">ReflexiveTask</a></li> 
    112113<li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#ResolvePathTask" target="Content">ResolvePathTask</a></li> 
    …… 
    153154<li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#Fileset" target="Content">FileSet</a></li> 
    154155<li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#Path" target="Content">Path / Classpath</a></li> 
    155 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#CoreFilters" target="Content">Core Filters</a></li> 
    156 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#PhingFilterReader" target="Content">PhingFilterReader</a></li> 
    157 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#ExpandProperties" target="Content">ExpandProperties</a></li> 
    158 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#HeadFilter" target="Content">HeadFilter</a></li> 
    159 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#LineContains" target="Content">Line Contains</a></li> 
    160 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#LineContainsRegexp" target="Content">LineContainsRegexp</a></li> 
    161 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#PrefixLines" target="Content">PrefixLines</a></li> 
    162 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#ReplaceTokens" target="Content">ReplaceTokens</a></li> 
    163 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#ReplaceRegexp" target="Content">ReplaceRegexp</a></li> 
    164 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#StripLineBreaks" target="Content">StripLineBreaks</a></li> 
    165 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#StripLineComments" target="Content">StripLineComments</a></li> 
    166 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#StripPhpComments" target="Content">StripPhpComments</a></li> 
    167 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#TabToSpaces" target="Content">TabToSpaces</a></li> 
    168 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#TailFilter" target="Content">TailFilter</a></li> 
    169 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#XincludeFilter" target="Content">XincludeFilter</a></li> 
    170 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#XsltFilter" target="Content">XsltFilter</a></li> 
    171 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#CoreMappers" target="Content">Core Mappers</a></li> 
    172 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#FlattenMapper" target="Content">FlattenMapper</a></li> 
    173 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#GlobMapper" target="Content">GlobMapper</a></li> 
    174 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#IdentityMapper" target="Content">IdentityMapper</a></li> 
    175 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#MergeMapper" target="Content">MergeMapper</a></li> 
    176 <li><a href="../chapters/appendixes/AppendixD-CoreTypes.html#RegexpMapper" target="Content">RegexpMapper</a></li> 
    177 </ul> 
     156</ul> 
     157</ul> 
     158<ul> 
     159<li><a href="../chapters/appendixes/AppendixD2-CoreFilters.html" target="Content">Appendix D-2: Core Filters</a></li> 
     160<ul> 
     161<li><a href="../chapters/appendixes/AppendixD2-CoreFilters.html#PhingFilterReader" target="Content">PhingFilterReader</a></li> 
     162<li><a href="../chapters/appendixes/AppendixD2-CoreFilters.html#ExpandProperties" target="Content">ExpandProperties</a></li> 
     163<li><a href="../chapters/appendixes/AppendixD2-CoreFilters.html#HeadFilter" target="Content">HeadFilter</a></li> 
     164<li><a href="../chapters/appendixes/AppendixD2-CoreFilters.html#LineContains" target="Content">Line Contains</a></li> 
     165<li><a href="../chapters/appendixes/AppendixD2-CoreFilters.html#LineContainsRegexp" target="Content">LineContainsRegexp</a></li> 
     166<li><a href="../chapters/appendixes/A