<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.yaml.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.yaml-parse-file.php',
    1 => 'yaml_parse_file',
    2 => 'Разбирает YAML-поток из файла',
  ),
  'up' => 
  array (
    0 => 'ref.yaml.php',
    1 => 'Функции Yaml',
  ),
  'prev' => 
  array (
    0 => 'function.yaml-parse.php',
    1 => 'yaml_parse',
  ),
  'next' => 
  array (
    0 => 'function.yaml-parse-url.php',
    1 => 'yaml_parse_url',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/yaml/functions/yaml-parse-file.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.yaml-parse-file" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">yaml_parse_file</h1>
  <p class="verinfo">(PECL yaml &gt;= 0.4.0)</p><p class="refpurpose"><span class="refname">yaml_parse_file</span> &mdash; <span class="dc-title">Разбирает YAML-поток из файла</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.yaml-parse-file-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>yaml_parse_file</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$filename</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">$pos</code><span class="initializer"> = 0</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 reference">&$ndocs</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$callbacks</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>

  <p class="para rdfs-comment">
   Конвертирует полностью или частично поток YAML-документов, читаемых из файла, в переменную PHP.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.yaml-parse-file-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">filename</code></dt>
     <dd>
      <p class="para">
       Путь к файлу.
      </p>
     </dd>
    
    
     <dt><code class="parameter">pos</code></dt>
     <dd>
      <p class="para">
       Индекс документа для извлечения из потока (<code class="literal">-1</code> для всех
       документов, <code class="literal">0</code> для первого документа, ...).
      </p>
     </dd>
    
    
     <dt><code class="parameter">ndocs</code></dt>
     <dd>
      <p class="para">
       Если <code class="parameter">ndocs</code> передан, то он будет заполнен
       количеством документов, найденных в потоке.
      </p>
     </dd>
    
    
     <dt><code class="parameter">callbacks</code></dt>
     <dd>
      <p class="para">
       Обработчики содержимого для узлов YAML. Ассоциативный массив (<span class="type"><a href="language.types.array.php" class="type array">array</a></span>),
       ключи которого являются тегами YAML,
       а значения callback-функциями (<span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span>), которые будут их обрабатывать.
       Более подробно этот механизм описан в разделе
       <a href="yaml.callbacks.parse.php" class="link">callback-функции разбора</a>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.yaml-parse-file-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="simpara">
   Функция возвращает значение, закодированное в пути <code class="parameter">filename</code>, в соответствующем
   PHP-типе
  </p>
  <p class="simpara">
   В случае ошибки возвращается строка, содержащая сообщение об ошибке.
  </p>
  <p class="simpara">
   Если значение параметра <code class="parameter">pos</code> равно <code class="literal">-1</code>,
   возвращается массив (<span class="type"><a href="language.types.array.php" class="type array">array</a></span>) с одной записью для каждого документа,
   найденного в потоке.
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.yaml-parse-file-notes">
  <h3 class="title">Примечания</h3>
  <div class="warning"><strong class="warning">Внимание</strong>
   <p class="para">
    Обработка ненадёжного пользовательского ввода функцией
    <span class="function"><strong>yaml_parse_file()</strong></span> опасна, если для узлов с тегом <code class="literal">!php/object</code>
    включено использование функции <span class="function"><a href="function.unserialize.php" class="function">unserialize()</a></span>.
    Такое поведение
    может быть запрещено через ini-настройку <code class="literal">yaml.decode_php</code>.
   </p>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.yaml-parse-file-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.yaml-parse.php" class="function" rel="rdfs-seeAlso">yaml_parse()</a> - Разбирает поток YAML</span></li>
    <li><span class="function"><a href="function.yaml-parse-url.php" class="function" rel="rdfs-seeAlso">yaml_parse_url()</a> - Разбирает YAML-поток по URL-адресу</span></li>
    <li><span class="function"><a href="function.yaml-emit.php" class="function" rel="rdfs-seeAlso">yaml_emit()</a> - Возвращает YAML-представление значения</span></li>
   </ul>
  </p>
 </div>


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