PHP Class Horde_Push, horde

Author: Gunnar Wrobel ([email protected])

Public Methods

Method	Description
addContent ( string \| resource $content, string $mime_type = 'text/plain', array $params = [] ) : Horde_Push	Add content to this element.
addRecipient ( Horde_Push_Recipient $recipient ) : Horde_Push	Add a recipient for this element.
addReference ( string $reference ) : Horde_Push	Add a URL reference for this element.
addTag ( string $tag ) : Horde_Push	Add a tag for this element.
getContent ( ) : array	Return the contents for this element.
getMimeTypes ( ) : array	Return the contents by MIME type for this element.
getReferences ( ) : array	Retrieve the URL references for this element.
getStringContent ( integer $index ) : string	Return the content at the given index as a string.
getSummary ( ) : string	Return the summary for this content element.
getTags ( ) : array	Retrieve the tags for this element.
hasReferences ( ) : boolean	Indicate if this element has URL references.
hasTags ( ) : boolean	Indicate if this element has tags.
push ( array $options = [] ) : Horde_Push	Push the content to the recipients.
setSummary ( string $summary ) : Horde_Push	Set the summary for this content element.

Add content to this element.

public addContent ( string \| resource $content, string $mime_type = 'text/plain', array $params = [] ) : Horde_Push
$content	string \| resource	The UTF-8 encoded content.
$mime_type	string	The MIME type of the content.
$params	array	Content specific parameters.
return	Horde_Push	This content element.

Add a recipient for this element.

public addRecipient ( Horde_Push_Recipient $recipient ) : Horde_Push
$recipient	Horde_Push_Recipient	The recipient.
return	Horde_Push	This content element.

Add a URL reference for this element.

public addReference ( string $reference ) : Horde_Push
$reference	string	The link.
return	Horde_Push	This content element.

Add a tag for this element.

public addTag ( string $tag ) : Horde_Push
$tag	string	The tag.
return	Horde_Push	This content element.

Return the contents for this element.

public getContent ( ) : array
return	array	The content list.

Return the contents by MIME type for this element.

public getMimeTypes ( ) : array
return	array	The content list ordered by MIME type.

Retrieve the URL references for this element.

public getReferences ( ) : array
return	array	The URL references.

Return the content at the given index as a string.

public getStringContent ( integer $index ) : string
$index	integer	Index of the content part.
return	string	The content.

Return the summary for this content element.

public getSummary ( ) : string
return	string	The summary.

Retrieve the tags for this element.

public getTags ( ) : array
return	array	The tags.

Indicate if this element has URL references.

public hasReferences ( ) : boolean
return	boolean	True, if there have been links added to the element.

Indicate if this element has tags.

public hasTags ( ) : boolean
return	boolean	True, if there have been tags added to the element.

Push the content to the recipients.

public push ( array $options = [] ) : Horde_Push
$options	array	Additional options.
return	Horde_Push	This content element.

Set the summary for this content element.

public setSummary ( string $summary ) : Horde_Push
$summary	string	The summary.
return	Horde_Push	This content element.