<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.xdiff.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.xdiff-string-patch.php',
    1 => 'xdiff_string_patch',
    2 => '文字列に unified diff 形式のパッチを適用する',
  ),
  'up' => 
  array (
    0 => 'ref.xdiff.php',
    1 => 'xdiff 関数',
  ),
  'prev' => 
  array (
    0 => 'function.xdiff-string-merge3.php',
    1 => 'xdiff_string_merge3',
  ),
  'next' => 
  array (
    0 => 'function.xdiff-string-patch-binary.php',
    1 => 'xdiff_string_patch_binary',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/xdiff/functions/xdiff-string-patch.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.xdiff-string-patch" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">xdiff_string_patch</h1>
  <p class="verinfo">(PECL xdiff &gt;= 0.2.0)</p><p class="refpurpose"><span class="refname">xdiff_string_patch</span> &mdash; <span class="dc-title">文字列に unified diff 形式のパッチを適用する</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.xdiff-string-patch-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>xdiff_string_patch</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">$str</code></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">$patch</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">$flags</code><span class="initializer"> = ?</span></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 reference">&$error</code><span class="initializer"> = ?</span></span><br>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   ある文字列 <code class="parameter">str</code> に、unified 形式のパッチ文字列
   <code class="parameter">patch</code> を適用してその結果を返します。
   <code class="parameter">patch</code> は、
   <span class="function"><a href="function.xdiff-file-diff.php" class="function">xdiff_file_diff()</a></span>/<span class="function"><a href="function.xdiff-string-diff.php" class="function">xdiff_string_diff()</a></span>
   関数で作成した unified diff 形式でなければなりません。
   オプションのパラメータ <code class="parameter">flags</code>
   で、操作モードを指定します。パッチが拒否された部分については、
   もし <code class="parameter">error</code> を指定していればそこに保存されます。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.xdiff-string-patch-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">str</code></dt>
     <dd>
      <p class="para">
       元の文字列。
      </p>
     </dd>
    
    
     <dt><code class="parameter">patch</code></dt>
     <dd>
      <p class="para">
       unified 形式のパッチ文字列。
       <span class="function"><a href="function.xdiff-string-diff.php" class="function">xdiff_string_diff()</a></span> 関数や
       <span class="function"><a href="function.xdiff-file-diff.php" class="function">xdiff_file_diff()</a></span> 関数、
       あるいは互換性のあるツールで作成したものでなければなりません。
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">flags</code> は
       <strong><code><a href="xdiff.constants.php#constant.xdiff-patch-normal">XDIFF_PATCH_NORMAL</a></code></strong> (デフォルト。通常のパッチ)
       あるいは <strong><code><a href="xdiff.constants.php#constant.xdiff-patch-reverse">XDIFF_PATCH_REVERSE</a></code></strong> (逆パッチ)
       のいずれかです。
      </p>
      <p class="para">
       バージョン 1.5.0 以降では、バイナリ OR を使用して
       <strong><code>XDIFF_PATCH_IGNORESPACE</code></strong>
       フラグを有効にすることもできます。
      </p>
     </dd>
    
    
     <dt><code class="parameter">error</code></dt>
     <dd>
      <p class="para">
       これを指定すると、パッチを拒否された部分がここに保存されます。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.xdiff-string-patch-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   パッチ適用後の文字列、あるいはエラー時に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.xdiff-string-patch-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>xdiff_string_patch()</strong></span> の例</strong></p>
    <div class="example-contents"><p>
     以下のコードは、ある記事に対して変更を適用します。
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$old_article </span><span style="color: #007700">= </span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">'./old_article.txt'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$diff </span><span style="color: #007700">= </span><span style="color: #0000BB">$_SERVER</span><span style="color: #007700">[</span><span style="color: #DD0000">'patch'</span><span style="color: #007700">]; </span><span style="color: #FF8000">/* だれかが html フォームからパッチを投稿したとしましょう */<br /><br /></span><span style="color: #0000BB">$errors </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$new_article </span><span style="color: #007700">= </span><span style="color: #0000BB">xdiff_string_patch</span><span style="color: #007700">(</span><span style="color: #0000BB">$old_article</span><span style="color: #007700">, </span><span style="color: #0000BB">$diff</span><span style="color: #007700">, </span><span style="color: #0000BB">XDIFF_PATCH_NORMAL</span><span style="color: #007700">, </span><span style="color: #0000BB">$errors</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">is_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$new_article</span><span style="color: #007700">)) {<br />    echo </span><span style="color: #DD0000">"新しい記事:\n"</span><span style="color: #007700">;<br />    echo </span><span style="color: #0000BB">$new_article</span><span style="color: #007700">;<br />}<br /><br />if (</span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$errors</span><span style="color: #007700">)) {<br />    echo </span><span style="color: #DD0000">"Rejects: \n"</span><span style="color: #007700">;<br />    echo </span><span style="color: #0000BB">$errors</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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


 <div class="refsect1 seealso" id="refsect1-function.xdiff-string-patch-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.xdiff-string-diff.php" class="function" rel="rdfs-seeAlso">xdiff_string_diff()</a> - 2 つの文字列の unified diff を作成する</span></li>
   </ul>
  </p>
 </div>

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