Overview

Namespaces

  • Charcoal
    • Object
    • User
      • Acl

Classes

  • Content
  • ObjectRevision
  • ObjectRoute
  • ObjectSchedule
  • UserData

Interfaces

  • ArchivableInterface
  • CategorizableInterface
  • CategorizableMultipleInterface
  • CategoryInterface
  • ContentInterface
  • HierarchicalInterface
  • ObjectRevisionInterface
  • ObjectRouteInterface
  • ObjectScheduleInterface
  • PublishableInterface
  • RevisionableInterface
  • RoutableInterface
  • UserDataInterface

Traits

  • ArchivableTrait
  • CategorizableMultipleTrait
  • CategorizableTrait
  • CategoryTrait
  • HierarchicalTrait
  • PublishableTrait
  • RevisionableTrait
  • RoutableTrait
  • Overview
  • Namespace
  • Class

Interface UserDataInterface

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

Charcoal\Object\UserDataInterface implements Charcoal\Model\ModelInterface

Direct known implementers

Charcoal\Object\UserData
Namespace: Charcoal\Object
See: UserData for basic implementation of interface.
Located at Charcoal/Object/UserDataInterface.php
Methods summary
public Charcoal\Object\UserDataInterface
# setIp( integer|null $ip )

Set the client IP address.

Set the client IP address.

Parameters

$ip
The remote IP at object creation.

Returns

Charcoal\Object\UserDataInterface
Chainable
public integer|null
# ip( )

Retrieve the client IP address.

Retrieve the client IP address.

Returns

integer|null
public Charcoal\Object\UserDataInterface
# setLang( string $lang )

Set the origin language.

Set the origin language.

Parameters

$lang
The language code.

Returns

Charcoal\Object\UserDataInterface
Chainable
public string
# lang( )

Retrieve the language.

Retrieve the language.

Returns

string
public Charcoal\Object\UserDataInterface
# setOrigin( string $origin )

Set the origin of the object submission.

Set the origin of the object submission.

Parameters

$origin
The source URL or identifier of the submission.

Returns

Charcoal\Object\UserDataInterface
Chainable
public string
# origin( )

Retrieve the origin of the object submission.

Retrieve the origin of the object submission.

Returns

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

Set when the object was created.

Set when the object was created.

Parameters

$timestamp
The timestamp at object's creation.

Returns

Charcoal\Object\UserDataInterface
Chainable
public DateTime|null
# ts( )

Retrieve the creation timestamp.

Retrieve the creation timestamp.

Returns

DateTime|null
API documentation generated by ApiGen