buildFromDirectory.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="phardata.buildfromdirectory" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>PharData::buildFromDirectory</refname>
  <refpurpose>Construct a tar/zip archive from the files within a directory.</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>array</type><methodname>Phar::buildFromDirectory</methodname>
   <methodparam><type>string</type><parameter>base_dir</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>regex</parameter></methodparam>
  </methodsynopsis>

  <para>
   Populate a tar/zip archive from directory contents.  The optional second
   parameter is a regular expression (pcre) that is used to exclude files.
   Any filename that matches the regular expression will be included, all others will be
   excluded.  For more fine-grained control, use <function>PharData::buildFromIterator</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>base_dir</parameter></term>
     <listitem>
      <para>
       The full or relative path to the directory that contains all files
       to add to the archive.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>regex</parameter></term>
     <listitem>
      <para>
       An optional pcre regular expression that is used to filter the
       list of files.  Only file paths matching the regular expression
       will be included in the archive.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>Phar::buildFromDirectory</function> returns an associative array
   mapping internal path of file to the full path of the file on the
   filesystem.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   This method throws <classname>BadMethodCallException</classname> when unable
   to instantiate the internal directory iterators,
   or a <classname>PharException</classname> if there were errors
   saving the phar archive.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
    <title>A <function>PharData::buildFromDirectory</function> example</title>
  <para>
   
  </para>
  <para>
   <programlisting role="php">
    <![CDATA[
<?php
$phar = new PharData('project.tar');
// add all files in the project
$phar->buildFromDirectory(dirname(__FILE__) . '/project');

$phar2 = new PharData('project2.zip');
// add all files in the project, only include php files
$phar2->buildFromDirectory(dirname(__FILE__) . '/project', '/\.php$/');
?>
    ]]>
   </programlisting>
  </para>
  </example>
 </refsect1>


 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>Phar::buildFromDirectory</function></member>
    <member><function>PharData::buildFromIterator</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->