From 8fc66f309eb83d4af9b09984fe4e10c15107fd98 Mon Sep 17 00:00:00 2001 From: Chris Wright Date: Tue, 20 Aug 2013 15:38:11 +0000 Subject: [PATCH] Missing documentation for ZipArchive::addPattern() and ZipArchive::addGlob() -- Provided by Chris Wright (daverandom@php.net) with thanks to toto toto (poinsot.julien@gmail.com) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331176 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/zip/versions.xml | 2 + reference/zip/ziparchive/addglob.xml | 145 ++++++++++++++++++++++++ reference/zip/ziparchive/addpattern.xml | 117 +++++++++++++++++++ 3 files changed, 264 insertions(+) create mode 100644 reference/zip/ziparchive/addglob.xml create mode 100644 reference/zip/ziparchive/addpattern.xml diff --git a/reference/zip/versions.xml b/reference/zip/versions.xml index bba1bdd60d..a0952acb0f 100644 --- a/reference/zip/versions.xml +++ b/reference/zip/versions.xml @@ -9,6 +9,8 @@ + + diff --git a/reference/zip/ziparchive/addglob.xml b/reference/zip/ziparchive/addglob.xml new file mode 100644 index 0000000000..e4c7f4b4b5 --- /dev/null +++ b/reference/zip/ziparchive/addglob.xml @@ -0,0 +1,145 @@ + + + + + + ZipArchive::addGlob + Add files from a directory by glob pattern + + + + &reftitle.description; + + boolZipArchive::addGlob + stringpattern + intflags0 + arrayoptionsarray() + + + Add files from a directory which match the glob pattern. + + + + + &reftitle.parameters; + + + pattern + + + A glob pattern against which files will be matched. + + + + + flags + + + A bit mask of glob() flags. + + + + + options + + + An associative array of options. Available options are: + + + + "add_path" + + + 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 + "remove_path" or "remove_all_path" + options. + + + + + "remove_path" + + + Prefix to remove from matching file paths before adding to the archive. + + + + + "remove_all_path" + + + &true; to use the file name only and add to the root of the archive. + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.examples; + + <methodname>ZipArchive::addGlob</methodname> example + + Add all php scripts and text files from current working directory + + +open('application.zip', 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(); +} +?> +]]> + + + + + + + &reftitle.seealso; + + + ZipArchive::addFile + ZipArchive::addPattern + + + + + + diff --git a/reference/zip/ziparchive/addpattern.xml b/reference/zip/ziparchive/addpattern.xml new file mode 100644 index 0000000000..1df0d50505 --- /dev/null +++ b/reference/zip/ziparchive/addpattern.xml @@ -0,0 +1,117 @@ + + + + + + ZipArchive::addPattern + Add files from a directory by PCRE pattern + + + + &reftitle.description; + + boolZipArchive::addPattern + stringpattern + stringpath'.' + arrayoptionsarray() + + + Add files from a directory which match the regular expression pattern. + The operation is not recursive. The pattern will be matched against the file name only. + + + + + &reftitle.parameters; + + + pattern + + + A PCRE pattern against which files will be matched. + + + + + path + + + The directory that will be scanned. Defaults to the current working directory. + + + + + options + + + An associative array of options accepted by ZipArchive::addGlob. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.examples; + + <methodname>ZipArchive::addPattern</methodname> example + + Add all php scripts and text files from current directory + + +open('application.zip', ZipArchive::OVERWRITE); +if ($ret !== TRUE) { + printf('Failed with code %d', $ret); +} else { + $directory = realpath('.'); + $options = array('add_path' => 'sources/', 'remove_path' => $directory); + $zip->addPattern('/\.(?:php|txt)$/', $directory, $options); + $zip->close(); +} +?> +]]> + + + + + + &reftitle.seealso; + + + ZipArchive::addFile + ZipArchive::addGlob + + + + + +