mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
47ef5a87da
We're taking the wording from the zip_open() documentation[1], and don't care to document that ZipArchive::OVERWRITE implied ZipArchive::CREATE in some formerly bundled libzips. [1] <https://libzip.org/documentation/zip_open.html> git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344995 c90b9560-bf6c-de11-be94-00142212c4b1
146 lines
4 KiB
XML
146 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="ziparchive.addglob" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>ZipArchive::addGlob</refname>
|
|
<refpurpose>Add files from a directory by glob pattern</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="oop">
|
|
<type>bool</type><methodname>ZipArchive::addGlob</methodname>
|
|
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>array()</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Add files from a directory which match the glob <parameter>pattern</parameter>.
|
|
</para>
|
|
&zip.filename.separator;
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>pattern</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A <function>glob</function> pattern against which files will be matched.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A bit mask of <literal>glob()</literal> flags.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An associative array of options. Available options are:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
<literal>"add_path"</literal>
|
|
</para>
|
|
<para>
|
|
Prefix to prepend when translating to the local path of the file within
|
|
the archive. This is applied after any remove operations defined by the
|
|
<literal>"remove_path"</literal> or <literal>"remove_all_path"</literal>
|
|
options.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<literal>"remove_path"</literal>
|
|
</para>
|
|
<para>
|
|
Prefix to remove from matching file paths before adding to the archive.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<literal>"remove_all_path"</literal>
|
|
</para>
|
|
<para>
|
|
&true; to use the file name only and add to the root of the archive.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example xml:id="ziparchive.addglob.example.basic">
|
|
<title><methodname>ZipArchive::addGlob</methodname> example</title>
|
|
<para>
|
|
Add all php scripts and text files from current working directory
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$zip = new ZipArchive();
|
|
$ret = $zip->open('application.zip', ZipArchive::CREATE | ZipArchive::OVERWRITE);
|
|
if ($ret !== TRUE) {
|
|
printf('Failed with code %d', $ret);
|
|
} else {
|
|
$options = array('add_path' => 'sources/', 'remove_all_path' => TRUE);
|
|
$zip->addGlob('*.{php,txt}', GLOB_BRACE, $options);
|
|
$zip->close();
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>ZipArchive::addFile</methodname></member>
|
|
<member><methodname>ZipArchive::addPattern</methodname></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
|
|
-->
|