doc-fr/reference/image/functions/imagettfbbox.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 593ea510e853ff034e03f78a4be0daa41661c9d4 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.imagettfbbox" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imagettfbbox</refname>
  <refpurpose>Retourne le rectangle entourant un texte et dessiné avec une police TrueType</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>imagettfbbox</methodname>
   <methodparam><type>float</type><parameter>size</parameter></methodparam>
   <methodparam><type>float</type><parameter>angle</parameter></methodparam>
   <methodparam><type>string</type><parameter>font_filename</parameter></methodparam>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   Calcule et retourne le rectangle entourant le texte
   <parameter>text</parameter>, écrit avec une police truetype.
  </para>
  <note>
   <para>
    Antérieur à PHP 8.0.0, <function>imageftbbox</function> était une variante
    étendue de <function>imagettfbbox</function> qui en plus supporte
    <parameter>extrainfo</parameter>.
    À partir de PHP 8.0.0, <function>imagettfbbox</function> est un alias de
    <function>imageftbbox</function>.
   </para>
  </note>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>size</parameter></term>
     <listitem>
      <para>&gd.font.size;</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>angle</parameter></term>
     <listitem>
      <para>
       L'angle, en degrés, dans lequel le paramètre <parameter>string</parameter>
       sera mesuré.
      </para>
     </listitem>
    </varlistentry>
    &gd.ttf.fontfile;
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       La chaîne à mesurer.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>imagettfbbox</function> retourne un tableau avec 8
   éléments représentant les 4 sommets du rectangle
   en cas de succès, &false; si une erreur survient.
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Clé</entry>
       <entry>Signification</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>0</entry>
       <entry>Coin inférieur gauche, abscisse</entry>
      </row>
      <row>
       <entry>1</entry>
       <entry>Coin inférieur gauche, ordonnée</entry>
      </row>
      <row>
       <entry>2</entry>
       <entry>Coin inférieur droit, abscisse</entry>
      </row>
      <row>
       <entry>3</entry>
       <entry>Coin inférieur droit, ordonnée</entry>
      </row>
      <row>
       <entry>4</entry>
       <entry>Coin supérieur droit, abscisse</entry>
      </row>
      <row>
       <entry>5</entry>
       <entry>Coin supérieur droit, ordonnée</entry>
      </row>
      <row>
       <entry>6</entry>
       <entry>Coin supérieur gauche, abscisse</entry>
      </row>
      <row>
       <entry>7</entry>
       <entry>Coin supérieur gauche, ordonnée</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
  <para>
   Les positions des points sont relatives au texte <emphasis>text</emphasis>,
   indépendamment de l'angle : coin supérieur gauche faire
   référence au coin supérieur gauche du texte écrit
   horizontalement.
  </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>
       Le paramètre <parameter>options</parameter> a été ajouté.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>imagettfbbox</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Création d'une image de 300x150 pixels
$im = imagecreatetruecolor(300, 150);
$black = imagecolorallocate($im, 0, 0, 0);
$white = imagecolorallocate($im, 255, 255, 255);

// Définit l'arrière-plan en blanc
imagefilledrectangle($im, 0, 0, 299, 299, $white);

// Chemin vers le fichier de police
$font = './arial.ttf';

// Tout d'abord, nous créons notre rectangle entourant notre premier texte
$bbox = imagettfbbox(10, 45, $font, 'Powered by PHP ' . phpversion());

// Nos coordonnées en X et en Y
$x = $bbox[0] + (imagesx($im) / 2) - ($bbox[4] / 2) - 25;
$y = $bbox[1] + (imagesy($im) / 2) - ($bbox[5] / 2) - 5;

// Dessin du texte
imagettftext($im, 10, 45, $x, $y, $black, $font, 'Powered by PHP ' . phpversion());

// Nous créons notre rectangle entourant notre second texte
$bbox = imagettfbbox(10, 45, $font, 'and Zend Engine ' . zend_version());

// Définit les coordonnées afin que le second text suive le premier
$x = $bbox[0] + (imagesx($im) / 2) - ($bbox[4] / 2) + 10;
$y = $bbox[1] + (imagesy($im) / 2) - ($bbox[5] / 2) - 5;

// Dessin du texte
imagettftext($im, 10, 45, $x, $y, $black, $font, 'and Zend Engine ' . zend_version());

// Affichage vers le navigateur
header('Content-Type: image/png');

imagepng($im);
imagedestroy($im);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.freetype;
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>imagettftext</function></member>
   <member><function>imageftbbox</function></member>
  </simplelist>
 </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
-->