Class DataWrapper in namespace com\setasign\SetaFramework\Helper in SetaFramework API Reference

Index

\com\setasign\SetaFramework
1. Helper

com\setasign\SetaFramework\Helper

DataWrapper Class DataWrapper

File: /SetaFramework/src/Helper/DataWrapper.php

Class hierarchy

DataWrapper

Implements

Summary

Constants

MODE_ADD

public const DataWrapper::MODE_ADD = 'add'

MODE_DELETED

public const DataWrapper::MODE_DELETED = 'deleted'

MODE_READ

public const DataWrapper::MODE_READ = 'read'

Properties

$actualData

protected array|false DataWrapper::$actualData

$actualFile

protected ?int DataWrapper::$actualFile

$cacheData

protected array DataWrapper::$cacheData = array()

$directory

protected string DataWrapper::$directory

$key

protected ?int DataWrapper::$key

$metaData

protected array{compressed: bool, chunkSize: int|float, fileCount: int} DataWrapper::$metaData

$mode

protected ?string DataWrapper::$mode

Methods

__construct()

public DataWrapper::__construct (

string $dataPath,
string $mode = DataWrapper ::MODE_ADD

)

Parameters

$dataPath : string
$mode : string

addData()

public DataWrapper::addData (

iterable $data

): void

Parameters

$data : iterable

createDataPath()

private DataWrapper::createDataPath (

string $dataPath

): void

Parameters

$dataPath : string

current()

public DataWrapper::current (

void

): ?mixed

(PHP 5 >= 5.0.0)
Return the current element

Return Values

Can return any type.

delete()

public DataWrapper::delete (

void

): void

Exceptions

Throws \com\setasign\SetaFramework\Exception If some files cannot be deleted. If will stop at the file which couldn't be deleted. All remaining files won't be tried to delete!

getHash()

public DataWrapper::getHash (

void

): string

getMetaData()

public DataWrapper::getMetaData (

void

): array

jumpToOffset()

public DataWrapper::jumpToOffset (

int $offset

): void

Parameters

$offset : int

key()

public DataWrapper::key (

void

): ?int

(PHP 5 >= 5.0.0)
Return the key of the current element

Return Values

scalar on success, or null on failure.

next()

public DataWrapper::next (

void

): void

(PHP 5 >= 5.0.0)
Move forward to next element

Return Values

Any returned value is ignored.

offsetExists()

public DataWrapper::offsetExists (

mixed $offset

): bool

Whether a offset exists.

Warning: this method shouldn't be used too much because of performance. If you want to use it multiple times maybe jumpToOffset is a faster way.

Parameters

$offset : mixed: An offset to check for.

Return Values

true on success or false on failure.

The return value will be cast to boolean if non-boolean was returned.

offsetGet()

public DataWrapper::offsetGet (

mixed $offset

): ?mixed

Offset to retrieve.

Warning: this method should be used too much because of performance. If you want to use it multiple times maybe jumpToOffset is a faster way.

Parameters

$offset : mixed: The offset to retrieve.

Return Values

Can return all value types.

offsetSet()

public DataWrapper::offsetSet (

mixed $offset,
mixed $value

): void

(PHP 5 >= 5.0.0)
Offset to set

Parameters

$offset : mixed: The offset to assign the value to.
$value : mixed: The value to set.

offsetUnset()

public DataWrapper::offsetUnset (

mixed $offset

): void

(PHP 5 >= 5.0.0)
Offset to unset

Parameters

$offset : mixed: The offset to unset.

readFile()

protected DataWrapper::readFile (

int $fileCount

): array

Parameters

$fileCount : int

rewind()

public DataWrapper::rewind (

void

): void

(PHP 5 >= 5.0.0)
Rewind the Iterator to the first element

Return Values

Any returned value is ignored.

setMode()

public DataWrapper::setMode (

string $mode

): void

Parameters

$mode : string

updateMetaData()

protected DataWrapper::updateMetaData (

array $metaData

): void

Parameters

$metaData : array

valid()

public DataWrapper::valid (

void

): bool

(PHP 5 >= 5.0.0)
Checks if current position is valid

Return Values

The return value will be cast to boolean and then evaluated. Returns true on success or false on failure.

writeFile()

protected DataWrapper::writeFile (

int $fileCount,
array $data

): void

Parameters

$fileCount : int
$data : array