php-doc-en/reference/phar/Phar/apiVersion.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phar.apiversion">
 <refnamediv>
  <refname>Phar::apiVersion</refname>
  <refpurpose>Returns the api version</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>Phar::apiVersion</methodname>
   <void/>
  </methodsynopsis>

  <para>
   Return the API version of the phar file format that will be
   used when creating phars.  The Phar extension supports reading API
   version 1.0.0 or newer.  API version 1.1.0 is required for SHA-256 and SHA-512
   hash, and API version 1.1.1 is required to store empty directories.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The API version string as in <literal>&quot;1.0.0&quot;</literal>.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>Phar::apiVersion</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
echo Phar::apiVersion();
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
1.1.1
]]>
    </screen>
   </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:"~/.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
-->