Documentation

Horde_Imap_Client_Data_SearchCharset
in package
implements Serializable, SplSubject

Query the search charsets available on a server.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2014-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

since
2.24.0

Interfaces, Classes, Traits and Enums

Serializable
SplSubject

Table of Contents

$charsets  : array<string|int, mixed>
$_baseob  : Horde_Imap_Client_Base
Base client object.
$_charsets  : array<string|int, mixed>
Charset data.
$_observers  : array<string|int, mixed>
Observers.
__get()  : mixed
__serialize()  : array<string|int, mixed>
__unserialize()  : mixed
attach()  : mixed
detach()  : mixed
notify()  : mixed
Notification is triggered internally whenever the object's internal data storage is altered.
query()  : bool
Query the validity of a charset.
serialize()  : mixed
setBaseOb()  : mixed
setValid()  : mixed
Set the validity of a given charset.
unserialize()  : mixed

Properties

$charsets read-only

public array<string|int, mixed> $charsets

The list of valid charsets that have been discovered on the server.

$_charsets

Charset data.

protected array<string|int, mixed> $_charsets = array('US-ASCII' => \true)

$_observers

Observers.

protected array<string|int, mixed> $_observers = array()

Methods

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

__serialize()

public __serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

__unserialize()

public __unserialize(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Return values
mixed

attach()

public attach(SplObserver $observer) : mixed
Parameters
$observer : SplObserver
Return values
mixed

detach()

public detach(SplObserver $observer) : mixed
Parameters
$observer : SplObserver
Return values
mixed

notify()

Notification is triggered internally whenever the object's internal data storage is altered.

public notify() : mixed
Return values
mixed

query()

Query the validity of a charset.

public query(string $charset[, bool $cached = false ]) : bool
Parameters
$charset : string

The charset to query.

$cached : bool = false

If true, only query cached values.

Return values
bool

True if the charset is valid for searching.

serialize()

public serialize() : mixed
Return values
mixed

setValid()

Set the validity of a given charset.

public setValid(string $charset[, bool $valid = true ]) : mixed
Parameters
$charset : string

The charset.

$valid : bool = true

Is charset valid?

Return values
mixed

unserialize()

public unserialize(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed

Search results