\PrivateBin\ModelComment

Comment

Model of a PrivateBin comment.

Summary

Methods

Properties

Constants

__construct()
getId()
setId()
setData()
get()
store()
delete()
exists()
isValidId()
setPaste()
getPaste()
setParentId()
getParentId()

No public properties found

No constants found

_sanitize()
_validate()

$_id
$_data
$_conf
$_store

N/A

No private methods found

$_paste

N/A

Properties

$_id

$_id :string

Instance ID.

Type

string

$_data

$_data :array

Instance data.

Type

array

$_conf

$_conf :\PrivateBin\Configuration

Configuration.

Type

\PrivateBin\Configuration

$_store

$_store :\PrivateBin\Data\AbstractData

Data storage.

Type

\PrivateBin\Data\AbstractData

$_paste

$_paste :\PrivateBin\Model\Paste

Instance's parent.

Type

\PrivateBin\Model\Paste

Methods

__construct()

__construct(\PrivateBin\Configuration  $configuration,\PrivateBin\Data\AbstractData  $storage)

Instance constructor.

Parameters

\PrivateBin\Configuration	$configuration
\PrivateBin\Data\AbstractData	$storage

getId()

getId(): string

Get ID.

Returns

string

setId()

setId(string  $id)

Set ID.

Parameters

string

$id

Throws

\Exception

setData()

setData(array  $data)

Set data and recalculate ID.

Parameters

array

$data

Throws

\Exception

get()

get(): array

Get instance data.

Returns

array

store()

store()

Store the comment's data.

Throws

\Exception

delete()

delete()

Delete the comment.

Throws

\Exception

exists()

exists(): boolean

Test if comment exists in store.

Returns

boolean

isValidId()

isValidId(string  $id): boolean

Validate ID.

Parameters

string

$id

Returns

boolean

static

Inherited from: \PrivateBin\Model\AbstractModel

Tags

static

setPaste()

setPaste(\PrivateBin\Model\Paste  $paste)

Set paste.

Parameters

\PrivateBin\Model\Paste

$paste

Throws

\Exception

getPaste()

getPaste(): \PrivateBin\Model\Paste

Get paste.

Returns

\PrivateBin\Model\Paste

setParentId()

setParentId(string  $id)

Set parent ID.

Parameters

string

$id

Throws

\Exception

getParentId()

getParentId(): string

Get parent ID.

Returns

string

_sanitize()

_sanitize(array  $data): array

Sanitizes data to conform with current configuration.

Parameters

array

$data

Returns

array

_validate()

_validate(array  $data)

Validate data.

Parameters

array

$data

Throws

\Exception