Horde_Push
in package
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.
Tags
Table of Contents
- $_content : array<string|int, mixed>
- Content.
- $_recipients : array<string|int, mixed>
- The recipients that will receive the content.
- $_references : array<string|int, mixed>
- Reference links.
- $_summary : string
- Content summary.
- $_tags : array<string|int, mixed>
- Tags for the push.
- $_types : array<string|int, mixed>
- Content types.
- addContent() : Horde_Push
- Add content to this element.
- addRecipient() : Horde_Push
- Add a recipient for this element.
- addReference() : Horde_Push
- Add a URL reference for this element.
- addTag() : Horde_Push
- Add a tag for this element.
- getContent() : array<string|int, mixed>
- Return the contents for this element.
- getMimeTypes() : array<string|int, mixed>
- Return the contents by MIME type for this element.
- getReferences() : array<string|int, mixed>
- Retrieve the URL references for this element.
- getStringContent() : string
- Return the content at the given index as a string.
- getSummary() : string
- Return the summary for this content element.
- getTags() : array<string|int, mixed>
- Retrieve the tags for this element.
- hasReferences() : bool
- Indicate if this element has URL references.
- hasTags() : bool
- Indicate if this element has tags.
- push() : Horde_Push
- Push the content to the recipients.
- setSummary() : Horde_Push
- Set the summary for this content element.
Properties
$_content
Content.
private
array<string|int, mixed>
$_content
= array()
$_recipients
The recipients that will receive the content.
private
array<string|int, mixed>
$_recipients
= array()
$_references
Reference links.
private
array<string|int, mixed>
$_references
= array()
$_summary
Content summary.
private
string
$_summary
= ''
$_tags
Tags for the push.
private
array<string|int, mixed>
$_tags
= array()
$_types
Content types.
private
array<string|int, mixed>
$_types
= array()
Methods
addContent()
Add content to this element.
public
addContent(string|resource $content[, string $mime_type = 'text/plain' ][, array<string|int, mixed> $params = array() ]) : Horde_Push
Parameters
- $content : string|resource
-
The UTF-8 encoded content.
- $mime_type : string = 'text/plain'
-
The MIME type of the content.
- $params : array<string|int, mixed> = array()
-
Content specific parameters.
Return values
Horde_Push —This content element.
addRecipient()
Add a recipient for this element.
public
addRecipient(Horde_Push_Recipient $recipient) : Horde_Push
Parameters
- $recipient : Horde_Push_Recipient
-
The recipient.
Return values
Horde_Push —This content element.
addReference()
Add a URL reference for this element.
public
addReference(string $reference) : Horde_Push
Parameters
- $reference : string
-
The link.
Return values
Horde_Push —This content element.
addTag()
Add a tag for this element.
public
addTag(string $tag) : Horde_Push
Parameters
- $tag : string
-
The tag.
Return values
Horde_Push —This content element.
getContent()
Return the contents for this element.
public
getContent() : array<string|int, mixed>
Return values
array<string|int, mixed> —The content list.
getMimeTypes()
Return the contents by MIME type for this element.
public
getMimeTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —The content list ordered by MIME type.
getReferences()
Retrieve the URL references for this element.
public
getReferences() : array<string|int, mixed>
Return values
array<string|int, mixed> —The URL references.
getStringContent()
Return the content at the given index as a string.
public
getStringContent(int $index) : string
Parameters
- $index : int
-
Index of the content part.
Return values
string —The content.
getSummary()
Return the summary for this content element.
public
getSummary() : string
Return values
string —The summary.
getTags()
Retrieve the tags for this element.
public
getTags() : array<string|int, mixed>
Return values
array<string|int, mixed> —The tags.
hasReferences()
Indicate if this element has URL references.
public
hasReferences() : bool
Return values
bool —True, if there have been links added to the element.
hasTags()
Indicate if this element has tags.
public
hasTags() : bool
Return values
bool —True, if there have been tags added to the element.
push()
Push the content to the recipients.
public
push([array<string|int, mixed> $options = array() ]) : Horde_Push
Parameters
- $options : array<string|int, mixed> = array()
-
Additional options.
Return values
Horde_Push —This content element.
setSummary()
Set the summary for this content element.
public
setSummary(string $summary) : Horde_Push
Parameters
- $summary : string
-
The summary.
Return values
Horde_Push —This content element.