<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.image.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.imagecropauto.php',
    1 => 'imagecropauto',
    2 => 'Обрезает изображение автоматически на основе заданного режима',
  ),
  'up' => 
  array (
    0 => 'ref.image.php',
    1 => 'Функции GD и функции для работы с изображениями',
  ),
  'prev' => 
  array (
    0 => 'function.imagecrop.php',
    1 => 'imagecrop',
  ),
  'next' => 
  array (
    0 => 'function.imagedashedline.php',
    1 => 'imagedashedline',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/image/functions/imagecropauto.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.imagecropauto" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imagecropauto</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.5.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imagecropauto</span> &mdash; <span class="dc-title">Обрезает изображение автоматически на основе заданного режима</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.imagecropauto-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imagecropauto</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.gdimage.php" class="type GdImage">GdImage</a></span> <code class="parameter">$image</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$mode</code><span class="initializer"> = <strong><code><a href="image.constants.php#constant.img-crop-default">IMG_CROP_DEFAULT</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$threshold</code><span class="initializer"> = 0.5</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$color</code><span class="initializer"> = -1</span></span><br>): <span class="type"><span class="type"><a href="class.gdimage.php" class="type GdImage">GdImage</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Функция автоматически обрезает изображение на основе заданного
   режима <code class="parameter">mode</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.imagecropauto-parameters">
  <h3 class="title">Список параметров</h3>
  <dl>
   
 <dt><code class="parameter">image</code></dt>
 <dd>
  <p class="para">
   Объект <span class="classname"><a href="class.gdimage.php" class="classname">GdImage</a></span>, который вернула функция <span class="function"><a href="function.imagecreatetruecolor.php" class="function">imagecreatetruecolor()</a></span>
   или другая функция генерации изображений.
  </p>
 </dd>

   
    <dt><code class="parameter">mode</code></dt>
    <dd>
     <p class="para">
      Константа из следующего списка:
     </p>
     <dl>
      
       <dt><strong><code><a href="image.constants.php#constant.img-crop-default">IMG_CROP_DEFAULT</a></code></strong></dt>
       <dd>
        <span class="simpara">
         То же, что и <strong><code><a href="image.constants.php#constant.img-crop-transparent">IMG_CROP_TRANSPARENT</a></code></strong>.
         До PHP 7.4.0 встроенный модуль libgd выбирал режим <strong><code><a href="image.constants.php#constant.img-crop-sides">IMG_CROP_SIDES</a></code></strong>,
         если у изображения не было прозрачного цвета.
        </span>
       </dd>
      
      
       <dt><strong><code><a href="image.constants.php#constant.img-crop-transparent">IMG_CROP_TRANSPARENT</a></code></strong></dt>
       <dd>
        <span class="simpara">
         Обрезает прозрачный фон.
        </span>
       </dd>
      
      
       <dt><strong><code><a href="image.constants.php#constant.img-crop-black">IMG_CROP_BLACK</a></code></strong></dt>
       <dd>
        <span class="simpara">
         Обрезает чёрный фон.
        </span>
       </dd>
      
      
       <dt><strong><code><a href="image.constants.php#constant.img-crop-white">IMG_CROP_WHITE</a></code></strong></dt>
       <dd>
        <span class="simpara">
          Обрезает белый фон.
        </span>
       </dd>
      
      
       <dt><strong><code><a href="image.constants.php#constant.img-crop-sides">IMG_CROP_SIDES</a></code></strong></dt>
       <dd>
        <span class="simpara">
         Анализирует 4 угла изображения, чтобы попытаться обнаружить фон для обрезки.
        </span>
       </dd>
      
      
       <dt><strong><code><a href="image.constants.php#constant.img-crop-threshold">IMG_CROP_THRESHOLD</a></code></strong></dt>
       <dd>
        <span class="simpara">
         Обрезает изображение по заданным допуску <code class="parameter">threshold</code>
         и цвету <code class="parameter">color</code>.
        </span>
       </dd>
      
     </dl>
    </dd>
   
   
    <dt><code class="parameter">threshold</code></dt>
    <dd>
     <p class="para">
      Параметр определяет допуск в процентах, который функция не превысит при сравнении цвета изображения
      и цвета обрезки. Метод расчёта цветовой
      разницы основан на цветовом расстоянии в кубе RGB(a).
     </p>
     <p class="para">
      Учитывается только в режиме <strong><code><a href="image.constants.php#constant.img-crop-threshold">IMG_CROP_THRESHOLD</a></code></strong>.
     </p>
     <blockquote class="note"><p><strong class="note">Замечание</strong>: 
      <span class="simpara">
       До PHP 7.4.0 встроенная библиотека libgd работала по другому алгоритму,
       поэтому один и тот же порог <code class="parameter">threshold</code> выдавал разные результаты
       для системной и встроенной библиотеки libgd.
      </span>
     </p></blockquote>
    </dd>
   
   
    <dt><code class="parameter">color</code></dt>
    <dd>
     <p class="para">
      Значение RGB-цвета или индекс палитры.
     </p>
     <p class="para">
      Учитывается только в режиме <strong><code><a href="image.constants.php#constant.img-crop-threshold">IMG_CROP_THRESHOLD</a></code></strong>.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.imagecropauto-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция возвращает объект обрезанного изображения, если выполнилась успешно, или <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если возникла ошибка.
   Функция возвращает <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> и при обрезке всего изображения.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.imagecropauto-changelog">
  <h3 class="title">Список изменений</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Версия</th>
      <th>Описание</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.0.0</td>
 <td>
  Параметр <code class="parameter">image</code> теперь принимает объект <span class="classname"><a href="class.gdimage.php" class="classname">GdImage</a></span>;
  раньше параметр принимал корректный <code class="literal">gd</code>-ресурс (<span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>).
 </td>
</tr>

     <tr>
      <td>8.0.0</td>
      <td>
       Функция теперь возвращает объект класса <span class="classname"><a href="class.gdimage.php" class="classname">GDImage</a></span>, если выполнилась успешно;
       раньше возвращался ресурс (<span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>).
      </td>
     </tr>

     <tr>
      <td>7.4.0</td>
      <td>
       Поведение функции imagecropauto() во встроенной библиотеке libgd синхронизировали
       с поведением системной библиотеки libgd: режим <strong><code><a href="image.constants.php#constant.img-crop-default">IMG_CROP_DEFAULT</a></code></strong> больше
       не откатывается к режиму <strong><code><a href="image.constants.php#constant.img-crop-sides">IMG_CROP_SIDES</a></code></strong>, а пороговая обрезка теперь
       работает по тому же алгоритму, что и системная библиотека libgd.
      </td>
     </tr>

     <tr>
      <td>7.4.0</td>
      <td>
       Значение режима <code class="parameter">mode</code> по умолчанию изменили
       на <strong><code>IMG_CROP_AUTO</code></strong>. Раньше значением по умолчанию было
       <code class="literal">-1</code>, что соответствует режиму <strong><code><a href="image.constants.php#constant.img-crop-default">IMG_CROP_DEFAULT</a></code></strong>,
       но передача значения <code class="literal">-1</code> теперь устарела.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.imagecropauto-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Правильная обработка автообрезки</strong></p>
    <div class="example-contents"><p>
     Как отмечает раздел возвращаемого значения, функция <span class="function"><strong>imagecropauto()</strong></span>
     возвращает <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если обрезала всё изображение.
     В этом примере ресурс изображения <code class="literal">$im</code> автоматически обрезается,
     только если есть, что обрезать; иначе продолжается работа с исходным изображением.
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$cropped </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecropauto</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #0000BB">IMG_CROP_DEFAULT</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$cropped </span><span style="color: #007700">!== </span><span style="color: #0000BB">false</span><span style="color: #007700">) { </span><span style="color: #FF8000">// При возврате нового объекта изображения<br />    </span><span style="color: #0000BB">$im </span><span style="color: #007700">= </span><span style="color: #0000BB">$cropped</span><span style="color: #007700">;       </span><span style="color: #FF8000">// Назначаем обрезанное изображение переменной $im<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.imagecropauto-seealso">
  <h3 class="title">Смотрите также</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.imagecrop.php" class="function" rel="rdfs-seeAlso">imagecrop()</a> - Обрезает изображение до заданного прямоугольника</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>