Changeset 3571

Timestamp:

03/04/07 12:51:02 (6 years ago)

Author:

tristan

Message:

sfPropelNotificationPlugin :

• wrote installation docs
  
• started writing usage docs
  
• deprecated sfUser::getId() / getPeerClass() in favor of getAttribute() + plugin namespace
  

Files:

• plugins/sfPropelNotificationPlugin/README (modified) (2 diffs)
• plugins/sfPropelNotificationPlugin/config/schema.xml (modified) (1 diff)
• plugins/sfPropelNotificationPlugin/config/sfPropelNotificationPlugin/types.yml (modified) (1 diff)
• plugins/sfPropelNotificationPlugin/modules/sfPropelNotificationPluginNotifications/actions/actions.class.php (modified) (2 diffs)

plugins/sfPropelNotificationPlugin/README

@@ -15 +15 @@
-  
-{{{
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-}}}
-
-== Usage ==
-
+=== Defining notification types ===
+
+This plugin enable users to subscribe to notification "types". Let's see how to define a notification type which will trigger notification
+when an (imaginary) article is reported being offensive by five users or more : 
+
+ * Create a `sfPropelNotificationPlugin` directory in your application's `config` directory
+ * Create a `types.yml` file in this directory
+ * Specify a new notification type :
+{{{
+offensive_article:
+  enabled: on
+  logic_class: myLogicProvider
+}}}
+
+The `myLogicProvider` class implements the logic that will tell if notification logic should be triggered :
+{{{
+#!php
+<?php
+class myLogicProvider
+{
+  public static function OffensiveArticle(Article $article)
+  {
+    return $article->countOffensiveReports() >= 5;
+  }
+}
+}}}
+
+ * Register notification behavior with your `Article` class :
+
+{{{
+#!php
+<?php
+// lib/model/Article.php
+class Article extends BaseArticle
+{
+  // ...
+}
+
+sfPropelBehavior::add('Article', array('sfPropelNotificationPlugin' =>  array('types' => array('offensive_article')));
+}}}
+
+And that's it. Every time an article is modified, it will be checked against every notification type it's registered with.
+If type's associated logic method returns true, notification will be triggered for every user who subscribed to it, using whatever notification
+backend(s) they chose.
+
-=== Enabling the notification management module ===
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-=== Using the default email backend ===
-
+The plugin comes with a default email notification backend (based on symfony's `sfMail` class).
+
+You first need to configure it for your needs :
+
+ * Copy plugin's `config/sfPropelNotificationPlugin/backends.yml` file in yout application's `config/sfPropelNotificationPlugin` directory.
+ * Configure it accordingly to your needs :
+
+{{{ 
+email:
+  enabled: on
+  class: sfPropelNotificationPluginSfMailBackend
+  params:
+    mailer: sendmail
+    charset: utf-8
+    sender_name: Notification bot
+    sender_address: noreply@example.com
+    subject_prefix: "[notification]"
+}}}
+
+You must then implement the notification emails template. Email body is provided by plugin's `sfPropelNotificationPluginBackends::SfMail` action.
+Enable it in your application's `settings.yml` :
+
+{{{
+all:
+  .settings:  
+    enabled_modules: [default, sfPropelNotificationPluginNotifications, sfPropelNotificationPluginBackends]
+}}}
+
+You must create one template per notification type :
+
+ * Create a module directory tree in your application :
+
+{{{
+modules
+|-- sfPropelNotificationPluginBackends
+  | -- templates
+}}}
+
+ * Implement needed templates :
+
+Templates names correspond to notification type name (eg. `OffensiveArticleSuccess.php`)
+The following variables are made available to template :
+
+ * `$object` : the object which triggered notification
+ * `$watch` : the watch from database. It grants access database user through its `getUser` method. 
+
+Here is an example template :
+
+{{{
+#!php
+// modules/sfPropelNotificationPluginBackends/templates/OffensiveArticleSuccess.php
+
+Hello <?php echo $watch->getUser()->getFirstName() ?>,
+
+You receive this notification email because the article <?php echo $object->getTitle() ?> (<?php echo url_to('@article_view?id='.$object->getId()) ?>)
+has been reported offensive several times.
+
+You can :
+
+ * Delete it : <?php echo url_to('@article_delete?id='.$object->getId()) ?>
+
+or
+
+ * Reset its offensiveness status : <?php echo url_to('@article_reset?id='.$object->getId()) ?>
+}}}
+
-=== Implementing a new notification backend ===
+
+TODO.
-
-== Changelog ==
@@ -32 +187 @@
-=== trunk ===
-
-
+
+
+
+
-
-=== 2007-03-02 | 0.1.0 alpha ===

plugins/sfPropelNotificationPlugin/config/schema.xml

@@ -10 +10 @@
-        <index-column name="user_id" />
-      </index>
-FIXME
-FIXME
+@FIXME@
+@FIXME@
-      </foreign-key>
-    </table>

plugins/sfPropelNotificationPlugin/config/sfPropelNotificationPlugin/types.yml

@@ -1 @@
-new_user
+example_type
-  enabled: on
-
-
-
-
-
+

plugins/sfPropelNotificationPlugin/modules/sfPropelNotificationPluginNotifications/actions/actions.class.php

@@ -24 +24 @@
-  public function executeMy()
-  {
-    // TODO : get this from yamls
-    include(sfConfigCache::getInstance()->checkConfig('config/sfPropelNotificationPlugin/types.yml'));
-    include(sfConfigCache::getInstance()->checkConfig('config/sfPropelNotificationPlugin/backends.yml'));
@@ -40 +39 @@
-      }
-      
-
-
+
+
+
+
-      
-      foreach ($user->getWatchs() as $watch)