php-doc-en/reference/image/functions/gd-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.gd-info' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gd_info</refname>
  <refpurpose>Retrieve information about the currently installed GD library</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>gd_info</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Gets information about the version and capabilities of the installed GD
   library.
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an associative array.
  </para>
  <para>
   <table>
    <title>Elements of array returned by <function>gd_info</function></title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Attribute</entry>
       <entry>Meaning</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>GD Version</entry>
       <entry><type>string</type> value describing the installed
        <literal>libgd</literal> version.</entry>
      </row>
      <row>
       <entry>FreeType Support</entry>
       <entry><type>boolean</type> value.  &true;
        if FreeType Support is installed.</entry>
      </row>
      <row>
       <entry>FreeType Linkage</entry>
       <entry><type>string</type> value describing the way in which
        FreeType was linked. Expected values are: 'with freetype',
        'with TTF library', and 'with unknown library'.  This element will
        only be defined if <literal>FreeType Support</literal> evaluated to
        &true;.</entry>
      </row>
      <row>
       <entry>T1Lib Support</entry>
       <entry><type>boolean</type> value.  &true;
        if <literal>T1Lib</literal> support is included.</entry>
      </row>
      <row>
       <entry>GIF Read Support</entry>
       <entry><type>boolean</type> value.  &true;
        if support for <emphasis>reading</emphasis> <literal>GIF</literal>
        images is included.</entry>
      </row>
      <row>
       <entry>GIF Create Support</entry>
       <entry><type>boolean</type> value.  &true;
        if support for <emphasis>creating</emphasis> <literal>GIF</literal>
        images is included.</entry>
      </row>
      <row>
       <entry>JPEG Support</entry>
       <entry><type>boolean</type> value.  &true;
        if <literal>JPEG</literal> support is included.</entry>
      </row>
      <row>
       <entry>PNG Support</entry>
       <entry><type>boolean</type> value.  &true;
        if <literal>PNG</literal> support is included.</entry>
      </row>
      <row>
       <entry>WBMP Support</entry>
       <entry><type>boolean</type> value.  &true;
        if <literal>WBMP</literal> support is included.</entry>
      </row>
      <row>
       <entry>XBM Support</entry>
       <entry><type>boolean</type> value.  &true;
        if <literal>XBM</literal> support is included.</entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
  <note>
   <para>
    Previous to PHP 5.3.0, the <literal>JPEG Support</literal> attribute was named
    <literal>JPG Support</literal>.
   </para>
  </note>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Using <function>gd_info</function></title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(gd_info());
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
array(9) {
  ["GD Version"]=>
  string(24) "bundled (2.0 compatible)"
  ["FreeType Support"]=>
  bool(false)
  ["T1Lib Support"]=>
  bool(false)
  ["GIF Read Support"]=>
  bool(true)
  ["GIF Create Support"]=>
  bool(false)
  ["JPEG Support"]=>
  bool(false)
  ["PNG Support"]=>
  bool(true)
  ["WBMP Support"]=>
  bool(true)
  ["XBM Support"]=>
  bool(false)
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

<refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.3.0</entry>
       <entry>
        <literal>JPG Support</literal> attribute renamed to <literal>JPEG Support</literal>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imagepng</function></member>
    <member><function>imagejpeg</function></member>
    <member><function>imagegif</function></member>
    <member><function>imagewbmp</function></member>
    <member><function>imagetypes</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
-->