Documentation

TechnicalDefinitions
in package

Technical definitions for a service.

Table of Contents

Constants

TYPE_HTTP  = 'http'
TYPE_INDEXED_DB  = 'indexedDb'
TYPE_LOCAL_STORAGE  = 'local'
TYPE_SESSION_STORAGE  = 'session'

Properties

$duration  : int
The duration.
$durationUnit  : string
The duration unit.
$host  : string
The host or URL.
$isSessionDuration  : bool
Is session duration?
$name  : string
The name.
$purpose  : string
Purpose of the cookie.
$type  : string
HTTP cookie, local storage, session storage, .

Methods

fromJson()  : mixed
Generate a `ProviderContact` object from an array.
getDuration()  : mixed
Getter.
getDurationUnit()  : mixed
Getter.
getHost()  : mixed
Getter.
getName()  : mixed
Getter.
getPurpose()  : mixed
Getter.
getType()  : mixed
Getter.
isSessionDuration()  : mixed
Getter.
setDuration()  : mixed
Setter.
setDurationUnit()  : mixed
Setter.
setHost()  : mixed
Setter.
setIsSessionDuration()  : mixed
Setter.
setName()  : mixed
Setter.
setPurpose()  : mixed
Setter.
setType()  : mixed
Setter.
toJson()  : mixed
Create a JSON representation of this object.

Constants

Properties

$type

HTTP cookie, local storage, session storage, .

private string $type = self::TYPE_HTTP

..

Methods

fromJson()

Generate a `ProviderContact` object from an array.

public static fromJson(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

setDuration()

Setter.

public setDuration(int $duration) : mixed
Parameters
$duration : int
Tags
codeCoverageIgnore

setDurationUnit()

Setter.

public setDurationUnit(string $durationUnit) : mixed
Parameters
$durationUnit : string
Tags
codeCoverageIgnore

setHost()

Setter.

public setHost(string $host) : mixed
Parameters
$host : string
Tags
codeCoverageIgnore

setIsSessionDuration()

Setter.

public setIsSessionDuration(bool $isSessionDuration) : mixed
Parameters
$isSessionDuration : bool
Tags
codeCoverageIgnore

setName()

Setter.

public setName(string $name) : mixed
Parameters
$name : string
Tags
codeCoverageIgnore

setPurpose()

Setter.

public setPurpose(bool $purpose) : mixed
Parameters
$purpose : bool
Tags
codeCoverageIgnore

setType()

Setter.

public setType(string $type) : mixed
Parameters
$type : string
Tags
codeCoverageIgnore

        
On this page

Search results