HumHub Documentation (unofficial)

Message extends Component
in package

Application

Message represents a base HTTP message.

Properties

$behaviors : array<string|int, Behavior>
$client : Client
$content : string
$cookies : CookieCollection|array<string|int, Cookie>
$data : mixed
$format : string
$headers : HeaderCollection
$_behaviors : array<string|int, Behavior>|null
$_content : string|null
$_cookies : CookieCollection
$_data : mixed
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_format : string
$_headers : HeaderCollection

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__toString() : string: PHP magic method that returns the string representation of this object.
__unset() : mixed: Sets a component property to be null.
addCookies() : $this: Adds more cookies to the already defined ones.
addData() : $this: Adds data fields to the existing ones.
addHeaders() : $this: Adds more headers to the already defined ones.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
composeHeaderLines() : array<string|int, mixed>: Composes raw header lines from [[headers]].
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getContent() : string: Returns HTTP message raw content.
getCookies() : CookieCollection|array<string|int, Cookie>: Returns the cookie collection.
getData() : mixed: Returns the data fields, parsed from raw content.
getFormat() : string: Returns body format.
getHeaders() : HeaderCollection: Returns the header collection.
hasContent() : bool: Checks if content with provided name exists
hasCookies() : bool: Checks of HTTP message contains any cookie.
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasHeaders() : bool: Checks of HTTP message contains any header.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes the object.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
setContent() : $this: Sets the HTTP message raw content.
setCookies() : $this: Sets the cookies associated with HTTP message.
setData() : $this: Sets the data fields, which composes message content.
setFormat() : $this: Sets body format.
setHeaders() : $this: Sets the HTTP headers associated with HTTP message.
toString() : string: Returns string representation of this HTTP message.
trigger() : mixed: Triggers an event.
defaultFormat() : string: Returns default format name.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$client


    public
        Client
    $client

owner client instance.

$content


    public
        string
    $content

Raw body.

$cookies


    public
        CookieCollection|array<string|int, Cookie>
    $cookies

The cookie collection. Note that the type of this property differs in getter and setter. See [[getCookies()]] and [[setCookies()]] for details.

$data


    public
        mixed
    $data

Content data fields.

$format


    public
        string
    $format

Body format name.

$headers


    public
        HeaderCollection
    $headers

The header collection. Note that the type of this property differs in getter and setter. See [[getHeaders()]] and [[setHeaders()]] for details.

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_content


    private
        string|null
    $_content

raw content

$_cookies


    private
        CookieCollection
    $_cookies

cookies.

$_data


    private
        mixed
    $_data

content data

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

$_format


    private
        string
    $_format

content format name


    private
        HeaderCollection
    $_headers

headers.

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.


    public
                    __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

Initializes the object with the given configuration $config.
Call [[init()]].

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.


    public
                    __isset(string $name) : bool

This method will check in the following order and act accordingly:

a property defined by a setter: return whether the property is set
a property of a behavior: return whether the property is set
return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__toString()

PHP magic method that returns the string representation of this object.


    public
                    __toString() : string

Return values

string —

the string representation of this object.

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value to be null
a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters

$name : string: the property name

addCookies()

Adds more cookies to the already defined ones.


    public
                    addCookies(array<string|int, Cookie>|array<string|int, mixed> $cookies) : $this

Parameters

$cookies : array<string|int, Cookie>|array<string|int, mixed>: additional cookies.

Return values

$this —

self reference.

addData()

Adds data fields to the existing ones.


    public
                    addData(array<string|int, mixed> $data) : $this

Parameters

$data : array<string|int, mixed>: additional content data fields.

Return values

$this —

self reference.

addHeaders()

Adds more headers to the already defined ones.


    public
                    addHeaders(array<string|int, mixed> $headers) : $this

Parameters

$headers : array<string|int, mixed>: additional headers in format: [headerName => headerValue]

Return values

$this —

self reference.

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values

array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

composeHeaderLines()

Composes raw header lines from [[headers]].


    public
                    composeHeaderLines() : array<string|int, mixed>

Each line will be a string in format: 'header-name: value'.

Return values

array<string|int, mixed> —

raw header lines.

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.


    public
                    ensureBehaviors() : mixed

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getContent()

Returns HTTP message raw content.


    public
                    getContent() : string

Return values

string —

raw body.

getCookies()

Returns the cookie collection.


    public
                    getCookies() : CookieCollection|array<string|int, Cookie>

The cookie collection contains the cookies associated with HTTP message.

Return values

CookieCollection|array<string|int, Cookie> —

the cookie collection.

getData()

Returns the data fields, parsed from raw content.


    public
                    getData() : mixed

Return values

mixed —

content data fields.

getFormat()

Returns body format.


    public
                    getFormat() : string

Return values

string —

body format name.

getHeaders()

Returns the header collection.


    public
                    getHeaders() : HeaderCollection

The header collection contains the HTTP headers associated with HTTP message.

Return values

HeaderCollection —

the header collection

hasContent()

Checks if content with provided name exists


    public
                    hasContent(mixed $key) : bool

Parameters

$key : mixed: string Name of the content parameter

Return values

bool

hasCookies()

Checks of HTTP message contains any cookie.


    public
                    hasCookies() : bool

Using this method you are able to check cookie presence without instantiating [[CookieCollection]].

Return values

bool —

whether message contains any cookie.

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasHeaders()

Checks of HTTP message contains any header.


    public
                    hasHeaders() : bool

Using this method you are able to check cookie presence without instantiating [[HeaderCollection]].

Return values

bool —

whether message contains any header.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

the class has a method with the specified name
an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].
$append : bool = true: whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

setContent()

Sets the HTTP message raw content.


    public
                    setContent(string $content) : $this

Parameters

$content : string: raw content.

Return values

$this —

self reference.

setCookies()

Sets the cookies associated with HTTP message.


    public
                    setCookies(CookieCollection|array<string|int, Cookie>|array<string|int, mixed> $cookies) : $this

Parameters

$cookies : CookieCollection|array<string|int, Cookie>|array<string|int, mixed>: cookie collection or cookies list.

Return values

$this —

self reference.

setData()

Sets the data fields, which composes message content.


    public
                    setData(mixed $data) : $this

Parameters

$data : mixed: content data fields.

Return values

$this —

self reference.

setFormat()

Sets body format.


    public
                    setFormat(string $format) : $this

Parameters

$format : string: body format name.

Return values

$this —

self reference.

setHeaders()

Sets the HTTP headers associated with HTTP message.


    public
                    setHeaders(array<string|int, mixed>|HeaderCollection $headers) : $this

Parameters

$headers : array<string|int, mixed>|HeaderCollection: headers collection or headers list in format: [headerName => headerValue]

Return values

$this —

self reference.

toString()

Returns string representation of this HTTP message.


    public
                    toString() : string

Return values

string —

the string representation of this HTTP message.

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

defaultFormat()

Returns default format name.


    protected
                    defaultFormat() : string

Return values

string —

default format name.

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

Message extends Component in package Application

Tags

Table of Contents

Properties

Methods

Properties

$behaviors read-only

$client

$content

$cookies

$data

$format

$headers

$_behaviors

$_content

$_cookies

$_data

$_events

$_eventWildcards

Tags

$_format

$_headers

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__toString()

Return values

__unset()

Parameters

Tags

addCookies()

Parameters

Return values

addData()

Parameters

Tags

Return values

addHeaders()

Parameters

Return values

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

behaviors()

Return values

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Message extends Component
in package

Application