doc-es/reference/phar/PharData/addFile.xml at master · php/doc-es · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phardata.addfile" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>PharData::addFile</refname>
  <refpurpose>Añade un fichero del sistema de archivos al archivo tar/zip</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="PharData">
   <modifier>public</modifier> <type>void</type><methodname>PharData::addFile</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>localName</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Con este método, cualquier fichero o URL puede ser añadido al archivo tar/zip. Si
   el segundo argumento opcional <literal>localname</literal> es especificado,
   el fichero será almacenado en el archivo con este nombre, de lo contrario el argumento
   <literal>file</literal> es utilizado como ruta hacia donde almacenar el fichero dentro de
   el archivo. Las URLs deben tener un nombre local de lo contrario se lanza una excepción.
   Este método es idéntico a <function>ZipArchive::addFile</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Ruta relativa o absoluta hacia un fichero del disco a añadir
       al archivo phar.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>localName</parameter></term>
     <listitem>
      <para>
       Ruta hacia donde el fichero será almacenado dentro del archivo.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   No se devuelve ningún valor, se lanza una excepción en caso de fallo.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>localName</parameter> ahora es nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Un ejemplo con <function>PharData::addFile</function></title>
    <programlisting role="php">
<![CDATA[
<?php
try {
    $a = new PharData('/ruta/al/archivo.tar');

    $a->addFile('/ruta/completa/al/fichero');
    // muestra cómo el fichero es almacenado
    $b = $a['ruta/completa/al/fichero']->getContent();

    $a->addFile('/ruta/completa/al/fichero', 'mi/fichero.txt');
    $c = $a['mi/fichero.txt']->getContent();

    // muestra el uso de URLs
    $a->addFile('http://www.ejemplo.com', 'ejemplo.html');
} catch (Exception $e) {
    // los errores son manejados aquí
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &phardata.note.performance;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>PharData::offsetSet</function></member>
    <member><function>Phar::addFile</function></member>
    <member><function>PharData::addFromString</function></member>
    <member><function>PharData::addEmptyDir</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
-->