PHP Class Horde_Push, horde

Copyright 2011-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
See link: http://www.horde.org/libraries/Horde_Push
Author: Gunnar Wrobel ([email protected])
Afficher le fichier Open project: horde/horde Class Usage Examples

Méthodes publiques

Méthode 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.

Method Details

addContent() public méthode

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.
Résultat Horde_Push This content element.

addRecipient() public méthode

Add a recipient for this element.
public addRecipient ( Horde_Push_Recipient $recipient ) : Horde_Push
$recipient Horde_Push_Recipient The recipient.
Résultat Horde_Push This content element.

addReference() public méthode

Add a URL reference for this element.
public addReference ( string $reference ) : Horde_Push
$reference string The link.
Résultat Horde_Push This content element.

addTag() public méthode

Add a tag for this element.
public addTag ( string $tag ) : Horde_Push
$tag string The tag.
Résultat Horde_Push This content element.

getContent() public méthode

Return the contents for this element.
public getContent ( ) : array
Résultat array The content list.

getMimeTypes() public méthode

Return the contents by MIME type for this element.
public getMimeTypes ( ) : array
Résultat array The content list ordered by MIME type.

getReferences() public méthode

Retrieve the URL references for this element.
public getReferences ( ) : array
Résultat array The URL references.

getStringContent() public méthode

Return the content at the given index as a string.
public getStringContent ( integer $index ) : string
$index integer Index of the content part.
Résultat string The content.

getSummary() public méthode

Return the summary for this content element.
public getSummary ( ) : string
Résultat string The summary.

getTags() public méthode

Retrieve the tags for this element.
public getTags ( ) : array
Résultat array The tags.

hasReferences() public méthode

Indicate if this element has URL references.
public hasReferences ( ) : boolean
Résultat boolean True, if there have been links added to the element.

hasTags() public méthode

Indicate if this element has tags.
public hasTags ( ) : boolean
Résultat boolean True, if there have been tags added to the element.

push() public méthode

Push the content to the recipients.
public push ( array $options = [] ) : Horde_Push
$options array Additional options.
Résultat Horde_Push This content element.

setSummary() public méthode

Set the summary for this content element.
public setSummary ( string $summary ) : Horde_Push
$summary string The summary.
Résultat Horde_Push This content element.