Overview

Packages

  • Folks
  • None

Classes

  • Folks
  • Folks_Activity_Form
  • Folks_Api
  • Folks_Application
  • Folks_Block_Activities
  • Folks_Block_Friends
  • Folks_Block_Know
  • Folks_Block_New
  • Folks_Block_Random
  • Folks_Block_Recent
  • Folks_Driver
  • Folks_Driver_sql
  • Folks_Friends
  • Folks_Friends_application
  • Folks_Friends_facebook
  • Folks_Friends_prefs
  • Folks_Friends_shared
  • Folks_Friends_sql
  • Folks_Login_Form
  • Folks_Notification
  • Folks_Notification_facebook
  • Folks_Notification_letter
  • Folks_Notification_mail
  • Folks_Notification_tickets
  • Folks_Search_Form
  • Overview
  • Package
  • Class
  • Tree

Class Folks_Notification

Folks Notification Class.

Copyright Obala d.o.o. (www.obala.si)

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

Direct known subclasses

Folks_Notification_facebook, Folks_Notification_letter, Folks_Notification_mail, Folks_Notification_tickets
Package: Folks
Author: Duck duck@obala.net
Located at Notification.php
Methods summary
public
# __construct( array $params = array() )

Constructor

Constructor

Parameters

$params
<p>A hash containing any additional configuration or connection parameters a subclass might need.</p>
public true
# notifyAll( string $subject, string $body, array $attachments = array(), mixed $user = null )

Notify user in all available drivers

Notify user in all available drivers

Parameters

$subject
Subject of message
$body
Body of message
$attachments
Attached files
$user
User or array of users to send notification to

Returns

true
on succes, PEAR_Error on failure
public true
# notifyAllFriends( mixed $subject, string $body, string $attachments = array(), array $user = null )

Notify user's friends in all available drivers

Notify user's friends in all available drivers

Parameters

$subject
$user User or array of users to send notification to
$body
$subject Subject of message
$attachments
$body Body of message
$user
$attachments Attached files

Returns

true
on succes, PEAR_Error on failure
public true
# notifyAdmins( string $subject, string $body, array $attachments = array() )

Notify user in all available drivers

Notify user in all available drivers

Parameters

$subject
Subject of message
$body
Body of message
$attachments
Attached files

Returns

true
on succes, PEAR_Error on failure
public Array
# getAdmins( )

Get current scope admins

Get current scope admins

Returns

Array
of user with delete permission in "scope:admin" permission
public true
# getMethods( string $type = 'user' )

Returns all avaiable methods

Returns all avaiable methods

Parameters

$type
Type of notification to check

Returns

true
on succes, PEAR_Error on failure
public static
# singleton( string $driver, array $params = null )

Singleton for driver object

Singleton for driver object

Parameters

$driver
<p>The type of the concrete Folks_Notification subclass to return. The class name is based on the storage Notification ($driver). The code is dynamically included.</p>
$params
<p>A hash containing any additional configuration or connection parameters a subclass might need.</p>
API documentation generated by ApiGen