Overview

Packages

  • Push

Classes

  • Horde_Push
  • Horde_Push_Cli
  • Horde_Push_Exception
  • Horde_Push_Factory_Push
  • Horde_Push_Factory_Recipients
  • Horde_Push_Recipient_Base
  • Horde_Push_Recipient_Blogger
  • Horde_Push_Recipient_Facebook
  • Horde_Push_Recipient_Mail
  • Horde_Push_Recipient_Mock
  • Horde_Push_Recipient_Twitter
  • Horde_Push_Translation

Interfaces

  • Horde_Push_Recipient
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Push

A content element that will be pushed to various recipients.

Copyright 2011-2012 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.

Package: Push
Category: Horde
License: LGPL 2.1
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://www.horde.org/libraries/Horde_Push
Located at Horde/Push.php
Methods summary
public string
# getSummary( )

Return the summary for this content element.

Return the summary for this content element.

Returns

string
The summary.
public Horde_Push
# setSummary( string $summary )

Set the summary for this content element.

Set the summary for this content element.

Parameters

$summary
The summary.

Returns

Horde_Push
This content element.
public array
# getContent( )

Return the contents for this element.

Return the contents for this element.

Returns

array
The content list.
public string
# getStringContent( integer $index )

Return the content at the given index as a string.

Return the content at the given index as a string.

Parameters

$index
Index of the content part.

Returns

string
The content.
public array
# getMimeTypes( )

Return the contents by MIME type for this element.

Return the contents by MIME type for this element.

Returns

array
The content list ordered by MIME type.
public Horde_Push
# addContent( string|resource $content, string $mime_type = 'text/plain', array $params = array() )

Add content to this element.

Add content to this element.

Parameters

$content
The UTF-8 encoded content.
$mime_type
The MIME type of the content.
$params
Content specific parameters.

Returns

Horde_Push
This content element.
public Horde_Push
# addRecipient( Horde_Push_Recipient $recipient )

Add a recipient for this element.

Add a recipient for this element.

Parameters

$recipient
The recipient.

Returns

Horde_Push
This content element.
public Horde_Push
# addReference( string $reference )

Add a URL reference for this element.

Add a URL reference for this element.

Parameters

$reference
The link.

Returns

Horde_Push
This content element.
public array
# getReferences( )

Retrieve the URL references for this element.

Retrieve the URL references for this element.

Returns

array
The URL references.
public boolean
# hasReferences( )

Indicate if this element has URL references.

Indicate if this element has URL references.

Returns

boolean
True, if there have been links added to the element.
public Horde_Push
# addTag( string $tag )

Add a tag for this element.

Add a tag for this element.

Parameters

$tag
The tag.

Returns

Horde_Push
This content element.
public array
# getTags( )

Retrieve the tags for this element.

Retrieve the tags for this element.

Returns

array
The tags.
public boolean
# hasTags( )

Indicate if this element has tags.

Indicate if this element has tags.

Returns

boolean
True, if there have been tags added to the element.
public Horde_Push
# push( array $options = array() )

Push the content to the recipients.

Push the content to the recipients.

Parameters

$options
Additional options.

Returns

Horde_Push
This content element.
API documentation generated by ApiGen