<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.oci8.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'class.ocilob.php',
    1 => 'OCILob',
    2 => 'The OCILob class',
  ),
  'up' => 
  array (
    0 => 'book.oci8.php',
    1 => 'OCI8',
  ),
  'prev' => 
  array (
    0 => 'ocicollection.trim.php',
    1 => 'OCICollection::trim',
  ),
  'next' => 
  array (
    0 => 'ocilob.append.php',
    1 => 'OCILob::append',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/oci8/ocilob.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.ocilob.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.ocilob" class="reference">
 <h1 class="title">The OCILob class</h1>
 
 
 <div class="partintro"><p class="verinfo">(PHP 5, PHP 7, PHP 8, PECL OCI8 &gt;= 1.1.0)</p>
 

  <div class="section" id="ocilob.intro">
   <h2 class="title">Introduction</h2>
   <p class="para">
    OCI8 LOB functionality for large binary (BLOB) and character (CLOB) objects.
   </p>
   <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    The <span class="classname"><strong class="classname">OCI-Lob</strong></span> class was renamed to <span class="classname"><strong class="classname">OCILob</strong></span> in PHP 8 and PECL OCI8 3.0.0 to align with PHP naming standards.
   </p>
   </p></blockquote>
  </div>

 
  <div class="section" id="ocilob.synopsis">
   <h2 class="title">Class synopsis</h2>
 

   <div class="classsynopsis"><div class="classsynopsisinfo">
    
     <span class="modifier">class</span> <strong class="classname"><strong class="classname">OCILob</strong></strong>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="ocilob.append.php" class="methodname">append</a></span>(<span class="methodparam"><span class="type"><a href="class.ocilob.php" class="type OCILob">OCILob</a></span> <code class="parameter">$from</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.close.php" class="methodname">close</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.eof.php" class="methodname">eof</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.erase.php" class="methodname">erase</a></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$offset</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$length</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.export.php" class="methodname">export</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$filename</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$offset</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$length</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.flush.php" class="methodname">flush</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flag</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.free.php" class="methodname">free</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.getbuffering.php" class="methodname">getBuffering</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.import.php" class="methodname">import</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$filename</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.load.php" class="methodname">load</a></span>(): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.read.php" class="methodname">read</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$length</code></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.rewind.php" class="methodname">rewind</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.save.php" class="methodname">save</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$offset</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.seek.php" class="methodname">seek</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$offset</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$whence</code><span class="initializer"> = <strong><code><a href="oci8.constants.php#constant.oci-seek-set">OCI_SEEK_SET</a></code></strong></span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.setbuffering.php" class="methodname">setBuffering</a></span>(<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$mode</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.size.php" class="methodname">size</a></span>(): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.tell.php" class="methodname">tell</a></span>(): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.truncate.php" class="methodname">truncate</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$length</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.write.php" class="methodname">write</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$length</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ocilob.writetemporary.php" class="methodname">writeTemporary</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$type</code><span class="initializer"> = <strong><code><a href="oci8.constants.php#constant.oci-temp-clob">OCI_TEMP_CLOB</a></code></strong></span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

   }</div>

 
  </div>
  
 </div>
 
 

















































































































<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="ocilob.append.php">OCILob::append</a> — Appends data from the large object to another large object</li><li><a href="ocilob.close.php">OCILob::close</a> — Closes LOB descriptor</li><li><a href="ocilob.eof.php">OCILob::eof</a> — Tests for end-of-file on a large object's descriptor</li><li><a href="ocilob.erase.php">OCILob::erase</a> — Erases a specified portion of the internal LOB data</li><li><a href="ocilob.export.php">OCILob::export</a> — Exports LOB's contents to a file</li><li><a href="ocilob.flush.php">OCILob::flush</a> — Flushes/writes buffer of the LOB to the server</li><li><a href="ocilob.free.php">OCILob::free</a> — Frees resources associated with the LOB descriptor</li><li><a href="ocilob.getbuffering.php">OCILob::getBuffering</a> — Returns current state of buffering for the large object</li><li><a href="ocilob.import.php">OCILob::import</a> — Imports file data to the LOB</li><li><a href="ocilob.load.php">OCILob::load</a> — Returns large object's contents</li><li><a href="ocilob.read.php">OCILob::read</a> — Reads part of the large object</li><li><a href="ocilob.rewind.php">OCILob::rewind</a> — Moves the internal pointer to the beginning of the large object</li><li><a href="ocilob.save.php">OCILob::save</a> — Saves data to the large object</li><li><a href="ocilob.savefile.php">OCILob::saveFile</a> — Alias of OCILob::import</li><li><a href="ocilob.seek.php">OCILob::seek</a> — Sets the internal pointer of the large object</li><li><a href="ocilob.setbuffering.php">OCILob::setBuffering</a> — Changes current state of buffering for the large object</li><li><a href="ocilob.size.php">OCILob::size</a> — Returns size of large object</li><li><a href="ocilob.tell.php">OCILob::tell</a> — Returns the current position of internal pointer of large object</li><li><a href="ocilob.truncate.php">OCILob::truncate</a> — Truncates large object</li><li><a href="ocilob.write.php">OCILob::write</a> — Writes data to the large object</li><li><a href="ocilob.writetemporary.php">OCILob::writeTemporary</a> — Writes a temporary large object</li><li><a href="ocilob.writetofile.php">OCILob::writeToFile</a> — Alias of OCILob::export</li></ul>
</div>
<?php manual_footer($setup); ?>