API Documentation
\
Charcoal
Object
User
Acl

\Charcoal\ObjectUserDataInterface

Defines a model for objects typically submitted by the end-user of the application.

Summary

Methods
Constants
setIp()
ip()
setLang()
lang()
setOrigin()
origin()
setTs()
ts()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

setIp()

setIp(integer|null  $ip) : \Charcoal\Object\UserDataInterface

Set the client IP address.

Parameters

integer|null $ip

The remote IP at object creation.

Returns

\Charcoal\Object\UserDataInterface —

Chainable

ip()

ip() : integer|null

Retrieve the client IP address.

Returns

integer|null

setLang()

setLang(string  $lang) : \Charcoal\Object\UserDataInterface

Set the origin language.

Parameters

string $lang

The language code.

Returns

\Charcoal\Object\UserDataInterface —

Chainable

lang()

lang() : string

Retrieve the language.

Returns

string

setOrigin()

setOrigin(string  $origin) : \Charcoal\Object\UserDataInterface

Set the origin of the object submission.

Parameters

string $origin

The source URL or identifier of the submission.

Returns

\Charcoal\Object\UserDataInterface —

Chainable

origin()

origin() : string

Retrieve the origin of the object submission.

Returns

string

setTs()

setTs(\DateTime|string|null  $timestamp) : \Charcoal\Object\UserDataInterface

Set when the object was created.

Parameters

\DateTime|string|null $timestamp

The timestamp at object's creation.

Returns

\Charcoal\Object\UserDataInterface —

Chainable

ts()

ts() : \DateTime|null

Retrieve the creation timestamp.

Returns

\DateTime|null