Index: branches/5.2.x/core/units/email_events/email_events_event_handler.php
===================================================================
diff -u -N -r14572 -r14628
--- branches/5.2.x/core/units/email_events/email_events_event_handler.php (.../email_events_event_handler.php) (revision 14572)
+++ branches/5.2.x/core/units/email_events/email_events_event_handler.php (.../email_events_event_handler.php) (revision 14628)
@@ -1,6 +1,6 @@
Application->GetVar('module');
@@ -76,10 +78,11 @@
* Apply any custom changes to list's sql query
*
* @param kEvent $event
+ * @return void
* @access protected
- * @see OnListBuild
+ * @see kDBEventHandler::OnListBuild()
*/
- function SetCustomQuery(&$event)
+ protected function SetCustomQuery(&$event)
{
$object =& $event->getObject();
/* @var $object kDBList */
@@ -96,11 +99,13 @@
}
/**
- * Sets event id
+ * Set default headers
*
* @param kEvent $event
+ * @return void
+ * @access protected
*/
- function OnPreCreate(&$event)
+ protected function OnPreCreate(&$event)
{
parent::OnPreCreate($event);
@@ -649,22 +654,24 @@
}
/**
- * Raised when email message shoul be sent
+ * Raised when email message should be sent
*
* @param kEvent $event
+ * @return void
+ * @access protected
*/
- function OnEmailEvent(&$event)
+ protected function OnEmailEvent(&$event)
{
$email_event_name = $event->getEventParam('EmailEventName');
- if (strpos($email_event_name, '_') !== false) {
+ if ( strpos($email_event_name, '_') !== false ) {
throw new Exception('Invalid email event name ' . $email_event_name . '. Use only UPPERCASE characters and dots as email event names');
}
$object =& $this->_getEmailEvent($event);
- if (!is_object($object)) {
+ if ( !is_object($object) ) {
// email event not found OR it's won't be send under given circumstances
- return false;
+ return ;
}
// additional parameters from kApplication->EmailEvent
@@ -677,15 +684,15 @@
// 2. prepare message to be sent
$message_language = $this->_getSendLanguage($send_params);
$message_template = $this->_getMessageBody($event, $message_language);
- if (!trim($message_template)) {
+ if ( !trim($message_template) ) {
trigger_error('Message template is empty', E_USER_WARNING);
- return false;
+ return ;
}
list ($message_headers, $message_body) = $this->ParseMessageBody($message_template, $send_params);
- if (!trim($message_body)) {
+ if ( !trim($message_body) ) {
trigger_error('Message template is empty after parsing', E_USER_WARNING);
- return false;
+ return ;
}
// 3. set headers & send message
@@ -695,8 +702,8 @@
$message_subject = isset($message_headers['Subject']) ? $message_headers['Subject'] : 'Mail message';
$esender->SetSubject($message_subject);
- if ($this->Application->isDebugMode()) {
- // set special header with event name, so it will be easier to determite what's actually was received
+ if ( $this->Application->isDebugMode() ) {
+ // set special header with event name, so it will be easier to determine what's actually was received
$message_headers['X-Event-Name'] = $email_event_name . ' - ' . ($object->GetDBField('Type') == EmailEvent::EVENT_TYPE_ADMIN ? 'ADMIN' : 'USER');
}
@@ -708,23 +715,23 @@
$event->status = $esender->Deliver() ? kEvent::erSUCCESS : kEvent::erFAIL;
- if ($event->status == kEvent::erSUCCESS) {
+ if ( $event->status == kEvent::erSUCCESS ) {
// all keys, that are not used in email sending are written to log record
$send_keys = Array ('from_email', 'from_name', 'to_email', 'to_name', 'message');
foreach ($send_keys as $send_key) {
unset($send_params[$send_key]);
}
$fields_hash = Array (
- 'fromuser' => $from_name.' ('.$from_email.')',
- 'addressto' => $to_name.' ('.$to_email.')',
+ 'fromuser' => $from_name . ' (' . $from_email . ')',
+ 'addressto' => $to_name . ' (' . $to_email . ')',
'subject' => $message_subject,
'timestamp' => adodb_mktime(),
'event' => $email_event_name,
'EventParams' => serialize($send_params),
);
- $this->Conn->doInsert($fields_hash, TABLE_PREFIX.'EmailLog');
+ $this->Conn->doInsert($fields_hash, TABLE_PREFIX . 'EmailLog');
}
}
@@ -741,19 +748,20 @@
{
static $prev_language_id = null;
- if (!isset($language_id)) {
+ if ( !isset($language_id) ) {
// restore language
$language_id = $prev_language_id;
}
$this->Application->SetVar('m_lang', $language_id);
+
$language =& $this->Application->recallObject('lang.current');
- /* @var $lang_object kDBItem */
+ /* @var $language LanguagesItem */
$language->Load($language_id);
$this->Application->Phrases->LanguageId = $language_id;
- $this->Application->Phrases->Phrases = Array();
+ $this->Application->Phrases->Phrases = Array ();
$prev_language_id = $language_id; // for restoring it later
}
@@ -870,8 +878,10 @@
* Fixes default recipient type
*
* @param kEvent $event
+ * @return void
+ * @access protected
*/
- function OnAfterItemLoad(&$event)
+ protected function OnAfterItemLoad(&$event)
{
parent::OnAfterItemLoad($event);
@@ -1011,8 +1021,10 @@
* Don't allow to enable/disable events in non-debug mode
*
* @param kEvent $event
+ * @return void
+ * @access protected
*/
- function OnBeforeItemCreate(&$event)
+ protected function OnBeforeItemCreate(&$event)
{
parent::OnBeforeItemCreate($event);
@@ -1023,8 +1035,10 @@
* Don't allow to enable/disable events in non-debug mode
*
* @param kEvent $event
+ * @return void
+ * @access protected
*/
- function OnBeforeItemUpdate(&$event)
+ protected function OnBeforeItemUpdate(&$event)
{
parent::OnBeforeItemUpdate($event);