# The OCILob class

(PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0)

## Introduction

OCI8 LOB functionality for large binary (BLOB) and character (CLOB) objects.

> Note:

> The OCI-Lob class was renamed to OCILob in PHP 8 and PECL OCI8 3.0.0 to align with PHP naming standards.

## Class synopsis

class OCILob {
/* Methods */
public append(OCILob `$from`): bool
public close(): bool
public eof(): bool
public erase(?int `$offset` = `null`, ?int `$length` = `null`): int|false
public export(string `$filename`, ?int `$offset` = `null`, ?int `$length` = `null`): bool
public flush(int `$flag` = 0): bool
public free(): bool
public getBuffering(): bool
public import(string `$filename`): bool
public load(): string|false
public read(int `$length`): string|false
public rewind(): bool
public save(string `$data`, int `$offset` = 0): bool
public seek(int `$offset`, int `$whence` = `OCI_SEEK_SET`): bool
public setBuffering(bool `$mode`): bool
public size(): int|false
public tell(): int|false
public truncate(int `$length` = 0): bool
public write(string `$data`, ?int `$length` = `null`): int|false
public writeTemporary(string `$data`, int `$type` = `OCI_TEMP_CLOB`): bool
}

## Table of Contents

- OCILob::append — Appends data from the large object to another large object
- OCILob::close — Closes LOB descriptor
- OCILob::eof — Tests for end-of-file on a large object's descriptor
- OCILob::erase — Erases a specified portion of the internal LOB data
- OCILob::export — Exports LOB's contents to a file
- OCILob::flush — Flushes/writes buffer of the LOB to the server
- OCILob::free — Frees resources associated with the LOB descriptor
- OCILob::getBuffering — Returns current state of buffering for the large object
- OCILob::import — Imports file data to the LOB
- OCILob::load — Returns large object's contents
- OCILob::read — Reads part of the large object
- OCILob::rewind — Moves the internal pointer to the beginning of the large object
- OCILob::save — Saves data to the large object
- OCILob::saveFile — Alias of OCILob::import
- OCILob::seek — Sets the internal pointer of the large object
- OCILob::setBuffering — Changes current state of buffering for the large object
- OCILob::size — Returns size of large object
- OCILob::tell — Returns the current position of internal pointer of large object
- OCILob::truncate — Truncates large object
- OCILob::write — Writes data to the large object
- OCILob::writeTemporary — Writes a temporary large object
- OCILob::writeToFile — Alias of OCILob::export

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open