Documentation

Horde_Pack_Driver
in package

Abstract driver class for implementing a pack driver.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2013-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

$id  : int
$phpob  : bool
$_id  : int
Identifer for this driver. Each driver needs a unique priority.
$_phpob  : bool
Does this driver support packing PHP objects?
__get()  : mixed
pack()  : string
Pack a string.
supported()  : bool
Is this driver supported on this system?
unpack()  : mixed
Unpack a string.

Properties

$id read-only

public int $id

The single-byte identifier for this driver (also used as priority).

$phpob read-only

public bool $phpob

Supports packing PHP objects?

$_id

Identifer for this driver. Each driver needs a unique priority.

protected int $_id = 0

$_phpob

Does this driver support packing PHP objects?

protected bool $_phpob = \false

Methods

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

pack()

Pack a string.

public abstract pack(mixed $data) : string
Parameters
$data : mixed

The data to pack.

Tags
throws
Horde_Pack_Exception
Return values
string

The packed string.

supported()

Is this driver supported on this system?

public static supported() : bool
Return values
bool

True if supported.

unpack()

Unpack a string.

public abstract unpack(string $data) : mixed
Parameters
$data : string

The packed string.

Tags
throws
Horde_Pack_Exception
Return values
mixed

The unpacked data.

Search results