Author: mtorres
Date: 2010-05-19 06:33:58 +0200 (Wed, 19 May 2010)
New Revision: 29516
Modified:
plugins/mtAlertPlugin/trunk/README
plugins/mtAlertPlugin/trunk/TODO
Log:
Modified initial versions of the README & the TODO
Modified: plugins/mtAlertPlugin/trunk/README
===================================================================
--- plugins/mtAlertPlugin/trunk/README 2010-05-19 04:27:19 UTC (rev 29515)
+++ plugins/mtAlertPlugin/trunk/README 2010-05-19 04:33:58 UTC (rev 29516)
@@ -1,5 +1,13 @@
-Instalation
+REQUIREMENTS
+============
+ * Add a getUsername method to myUser class (MANDATORY)
+ * If mail service is required: dcMailerPlugin (OPTIONAL)
+ * If rich text editing is desired: sfFormExtraPlugin & tinyMCE library.
(OPTIONAL)
+
+INSTALATION
+===========
+
* First of all you must create some methods in the myUser class:
- you should provide a 'getUsername' method in you myUser class. The
username returned by this method should be unique.
@@ -24,17 +32,24 @@
enabled_modules: [..., mt_alert_message_view]
- * Also you should provide some 'extra methods' if you'd like to send mails.
This methods are configured in the 'app.yml' section of the plugin. Three
static methods are needed:
+ *** IF MAIL SERVICE IS DESIRED ***
+ ==================================
- app.yml
- all:
- mt_alert_plugin:
- mail_retrieve_mails_method: This method should
retrieve the mail address of an array of usernames passed as parameter.
- mail_retrieve_usernames_by_credential_method: This methos should
retrieve the usernames of the user who have a credential passed as parameter.
- mail_retrieve_all_mails_method: This should retrieve
the mail addresses of all the users of the application.
+ * Also you should provide some 'extra methods' if you'd like to send
mails. This methods are configured in the 'app.yml' section of the plugin.
Three static methods are needed:
- This plugin uses the dcMailerPlugin to send mails, so its installation is
needed.
+ app.yml
+ all:
+ mt_alert_plugin:
+ mail_retrieve_mails_method: This method should
retrieve the mail address of an array of usernames passed as parameter.
+ mail_retrieve_usernames_by_credential_method: This methos should
retrieve the usernames of the user who have a credential passed as parameter.
+ mail_retrieve_all_mails_method: This should
retrieve the mail addresses of all the users of the application.
+ This plugin uses the dcMailerPlugin to send mails, so its installation
is needed.
+
+
+*** APP.YML Example ***
+=======================
+
* Full example of the app.yml:
mt_alert_plugin:
Modified: plugins/mtAlertPlugin/trunk/TODO
===================================================================
--- plugins/mtAlertPlugin/trunk/TODO 2010-05-19 04:27:19 UTC (rev 29515)
+++ plugins/mtAlertPlugin/trunk/TODO 2010-05-19 04:33:58 UTC (rev 29516)
@@ -1,3 +1,4 @@
- Does not work if the user ain't authenticated
- Improve the alert css. ¿Themes?
- Javascript scrolling on the shown alert!
+- Works on symfony 1.3? Works on symfony 1.4?
--
You received this message because you are subscribed to the Google Groups
"symfony SVN" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/symfony-svn?hl=en.
