mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 07:18:55 +00:00
f45d3cb110
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@251096 c90b9560-bf6c-de11-be94-00142212c4b1
120 lines
3.3 KiB
XML
120 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<refentry xml:id="phar.copy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>Phar::copy</refname>
|
|
<refpurpose>Copy a file internal to the phar archive to another new file within the phar</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>Phar::copy</methodname>
|
|
<methodparam><type>string</type><parameter>oldfile</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>newfile</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&phar.write;
|
|
|
|
<para>
|
|
Copy a file internal to the phar archive to another new file within the phar.
|
|
This is an object-oriented alternative to using <function>copy</function> with
|
|
the phar stream wrapper.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>oldfile</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>newfile</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
returns &true; on success, but it is safer to encase method call in a
|
|
try/catch block and assume success if no exception is thrown.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
throws <classname>UnexpectedValueException</classname> if the source file does not
|
|
exist, the destination file already exists, write access is disabled, opening either
|
|
file fails, reading the source file fails, or a <classname>PharException</classname>
|
|
if writing the changes to the phar fails.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>Phar::copy</function> example</title>
|
|
<para>
|
|
This example shows using <function>Phar::copy</function> and the
|
|
equivalent stream wrapper performance of the same thing. The primary
|
|
difference between the two approaches is error handling. All Phar methods
|
|
throw exceptions, whereas the stream wrapper uses <function>trigger_error</function>.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
try {
|
|
$phar = new Phar('myphar.phar');
|
|
$phar['a'] = 'hi';
|
|
$phar->copy('a', 'b');
|
|
echo $phar['b']; // outputs "hi"
|
|
} catch (Exception $e) {
|
|
// handle error
|
|
}
|
|
|
|
// the stream wrapper equivalent of the above code.
|
|
// E_WARNINGS are triggered on error rather than exceptions.
|
|
copy('phar://myphar.phar/a', 'phar//myphar.phar/c');
|
|
echo file_get_contents('phar://myphar.phar/c'); // outputs "hi"
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</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:"../../../../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
|
|
-->
|