API Documentation
\

\Horde_Push

A content element that will be pushed to various recipients.

Copyright 2011-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
getSummary()
setSummary()
getContent()
getStringContent()
getMimeTypes()
addContent()
addRecipient()
addReference()
getReferences()
hasReferences()
addTag()
getTags()
hasTags()
push()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_summary
$_content
$_types
$_recipients
$_references
$_tags
N/A

Properties

$_summary

$_summary : string

Content summary.

Type

string

$_content

$_content : array

Content.

Type

array

$_types

$_types : array

Content types.

Type

array

$_recipients

$_recipients : array

The recipients that will receive the content.

Type

array

$_references

$_references : array

Reference links.

Type

array

$_tags

$_tags : array

Tags for the push.

Type

array

Methods

getSummary()

getSummary() : string

Return the summary for this content element.

Returns

string —

The summary.

setSummary()

setSummary(string  $summary) : \Horde_Push

Set the summary for this content element.

Parameters

string $summary

The summary.

Returns

\Horde_Push —

This content element.

getContent()

getContent() : array

Return the contents for this element.

Returns

array —

The content list.

getStringContent()

getStringContent(integer  $index) : string

Return the content at the given index as a string.

Parameters

integer $index

Index of the content part.

Returns

string —

The content.

getMimeTypes()

getMimeTypes() : array

Return the contents by MIME type for this element.

Returns

array —

The content list ordered by MIME type.

addContent()

addContent(string|resource  $content, string  $mime_type = 'text/plain', array  $params = array()) : \Horde_Push

Add content to this element.

Parameters

string|resource $content

The UTF-8 encoded content.
string $mime_type

The MIME type of the content.
array $params

Content specific parameters.

Returns

\Horde_Push —

This content element.

addRecipient()

addRecipient(\Horde_Push_Recipient  $recipient) : \Horde_Push

Add a recipient for this element.

Parameters

\Horde_Push_Recipient $recipient

The recipient.

Returns

\Horde_Push —

This content element.

addReference()

addReference(string  $reference) : \Horde_Push

Add a URL reference for this element.

Parameters

string $reference

The link.

Returns

\Horde_Push —

This content element.

getReferences()

getReferences() : array

Retrieve the URL references for this element.

Returns

array —

The URL references.

hasReferences()

hasReferences() : boolean

Indicate if this element has URL references.

Returns

boolean —

True, if there have been links added to the element.

addTag()

addTag(string  $tag) : \Horde_Push

Add a tag for this element.

Parameters

string $tag

The tag.

Returns

\Horde_Push —

This content element.

getTags()

getTags() : array

Retrieve the tags for this element.

Returns

array —

The tags.

hasTags()

hasTags() : boolean

Indicate if this element has tags.

Returns

boolean —

True, if there have been tags added to the element.

push()

push(array  $options = array()) : \Horde_Push

Push the content to the recipients.

Parameters

array $options

Additional options.

Returns

\Horde_Push —

This content element.