HeaderTask

<p>The <a href="http://phing.info/">phing</a> Header Task. To add a heading to a set of files.</p> <p><em><strong>Notice</strong>: All destination files are overwritten!</em></p> <h2>Attributes</h2> <table> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> <th>Required</th> </tr> <tr> <td style="vertical-align:top;">file</td> <td style="vertical-align:top;">String</td> <td style="vertical-align:top;">The location of the header file to load.</td> <td style="vertical-align:top;text-align:center;">n/a</td> <td style="vertical-align:top;text-align:center;">Yes</td> </tr> <tr> <td style="vertical-align:top;">eol</td> <td style="vertical-align:top;">String</td> <td style="vertical-align:top;">Specifies what the end of line character<sup class="footnote"><a href="#fn1">1</a></sup>.</td> <td style="vertical-align:top;text-align:center;"><code>PHP_EOL</code></td> <td style="vertical-align:top;text-align:center;">No</td> </tr> <tr> <td style="vertical-align:top;">preservelastmodified</td> <td style="vertical-align:top;">Boolean</td> <td style="vertical-align:top;">To preserve the last modified time of all files.</td> <td style="vertical-align:top;text-align:center;">false</td> <td style="vertical-align:top;text-align:center;">No</td> </tr> <tr> <td style="vertical-align:top;">failonerror</td> <td style="vertical-align:top;">Boolean</td> <td style="vertical-align:top;">Stop process if one error occurred.</td> <td style="vertical-align:top;text-align:center;">true</td> <td style="vertical-align:top;text-align:center;">No</td> </tr> <tr> <td style="vertical-align:top;">verbose</td> <td style="vertical-align:top;">Boolean</td> <td style="vertical-align:top;">Log the files that are being modified.</td> <td style="vertical-align:top;text-align:center;">false</td> <td style="vertical-align:top;text-align:center;">No</td> </tr> <tr> <td style="vertical-align:top;">encoding</td> <td style="vertical-align:top;">String</td> <td style="vertical-align:top;">Specifies the encoding for header file.</td> <td style="vertical-align:top;text-align:center;"><span class="caps">UTF</span>-8</td> <td style="vertical-align:top;text-align:center;">No</td> </tr> <tr> <td style="vertical-align:top;">toencoding</td> <td style="vertical-align:top;">String</td> <td style="vertical-align:top;">Specifies the encoding for the destination file(s).</td> <td style="vertical-align:top;text-align:center;"><span class="caps">UTF</span>-8</td> <td style="vertical-align:top;text-align:center;">No</td> </tr> </table> <h2>Supported Nested Tags</h2> <ul> <li><a href="http://phing.info/docs/guide/current/chapters/appendixes/AppendixD-CoreTypes.html#Fileset">Fileset</a></li> </ul> <h2>Examples</h2> <p><b>Add a heading to a single file</b></p> <pre><code> <taskdef name="header" classname="phing.tasks.ext.HeaderTask" /> <header file="${project.basedir}/LICENSE" tofile="${project.basedir}/build/foo.txt" /> </code></pre> <p><b>Add a heading to a set of files</b></p> <pre><code> <taskdef name="header" classname="phing.tasks.ext.HeaderTask" /> <header file="${project.basedir}/LICENSE"> <fileset dir="${project.basedir}/build"> <include name="**/*.txt" /> <exclude name="**/foo*.txt" /> </fileset> </header></code></pre> <p><b>Add a heading encoded in <span class="caps">ISO</span>-8859-1 to a file encoded in <span class="caps">UTF</span>-8</b></p> <pre><code> <taskdef name="header" classname="phing.tasks.ext.HeaderTask" /> <header file="${project.basedir}/LICENSE" encoding="ISO-8859-1" tofile="${project.basedir}/build/foo.txt" /> </code></pre> <h2>Footnotes</h2> <p class="footnote" id="fn1"><sup>1</sup> Valid values for eol property are:</p> <ul> <li>cr: a single CR</li> <li>lf: a single LF</li> <li>crlf: the pair <span class="caps">CRLF</span></li> <li>mac: a single CR</li> <li>unix: a single LF</li> <li>dos: the pair <span class="caps">CRLF</span></li> </ul> <p>The default is platform dependent. For Unix platforms, the default is “lf”. For <span class="caps">DOS</span> based systems (including Windows), the default is “crlf”. For Mac OS, the default is “cr”.</p> 2008-09-02T15:16:02-07:00 51753 headertask

48166

HeaderTask

2008-09-06T14:42:25-07:00

22614