Sophie

Sophie

distrib > Mageia > 4 > i586 > by-pkgid > f800694edefe91adea2624f711a41a2d > files > 3051

php-manual-en-5.5.7-1.mga4.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Set the value of a field</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.fdf-set-target-frame.html">fdf_set_target_frame</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.fdf-set-version.html">fdf_set_version</a></div>
 <div class="up"><a href="ref.fdf.html">FDF Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.fdf-set-value" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">fdf_set_value</h1>
  <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">fdf_set_value</span> &mdash; <span class="dc-title">Set the value of a field</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.fdf-set-value-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">bool</span> <span class="methodname"><strong>fdf_set_value</strong></span>
    ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$fdf_document</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$fieldname</code></span>
   , <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
   [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$isName</code></span>
  ] )</div>

  <p class="para rdfs-comment">
   Sets the <em><code class="parameter">value</code></em> for the given field.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.fdf-set-value-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>

    <dt>

     <span class="term"><em><code class="parameter">fdf_document</code></em></span>
     <dd>

      <p class="para">
       The FDF document handle, returned by  <span class="function"><a href="function.fdf-create.html" class="function">fdf_create()</a></span>,
        <span class="function"><a href="function.fdf-open.html" class="function">fdf_open()</a></span> or  <span class="function"><a href="function.fdf-open-string.html" class="function">fdf_open_string()</a></span>.
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">fieldname</code></em></span>
     <dd>

      <p class="para">
       Name of the FDF field, as a string.
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">value</code></em></span>
     <dd>

      <p class="para">
       This parameter will be stored as a string unless it is an array. In
       this case all array elements will be stored as a value array.
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">isName</code></em></span>
     <dd>

      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        In older versions of the FDF toolkit last parameter determined if the
        field value was to be converted to a PDF Name (= 1) or set to a PDF
        String (= 0).
       </p>
       <p class="para">
        The value is no longer used in the current toolkit version 5.0. For
        compatibility reasons it is still supported as an optional parameter
        beginning with PHP 4.3, but ignored internally.
       </p>
      </p></blockquote>
     </dd>

    </dt>

   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.fdf-set-value-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.fdf-set-value-changelog">
  <h3 class="title">Changelog</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Version</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>4.3.0</td>
       <td>
        Support for arrays in the <em><code class="parameter">value</code></em> parameter was
        added.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.fdf-set-value-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"> <span class="function"><a href="function.fdf-get-value.html" class="function" rel="rdfs-seeAlso">fdf_get_value()</a> - Get the value of a field</span></li>
    <li class="member"> <span class="function"><a href="function.fdf-remove-item.html" class="function" rel="rdfs-seeAlso">fdf_remove_item()</a> - Sets target frame for form</span></li>
   </ul>
  </p>
 </div>


</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.fdf-set-target-frame.html">fdf_set_target_frame</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.fdf-set-version.html">fdf_set_version</a></div>
 <div class="up"><a href="ref.fdf.html">FDF Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>