Index: branches/5.2.x/core/units/users/users_event_handler.php =================================================================== diff -u -N -r16463 -r16513 --- branches/5.2.x/core/units/users/users_event_handler.php (.../users_event_handler.php) (revision 16463) +++ branches/5.2.x/core/units/users/users_event_handler.php (.../users_event_handler.php) (revision 16513) @@ -1,6 +1,6 @@ getObject(); - /* @var $object kDBItem */ if ( $event->Special == 'forgot' || $object->getFormName() == 'registration' ) { $this->_makePasswordRequired($event); @@ -84,8 +84,8 @@ { parent::SetCustomQuery($event); + /** @var kDBList $object */ $object = $event->getObject(); - /* @var $object kDBList */ if ( $event->Special == 'regular' ) { $object->addFilter('primary_filter', '%1$s.UserType = ' . UserType::USER); @@ -139,8 +139,8 @@ } if ( $event->Name == 'OnLoginAs' ) { + /** @var Session $admin_session */ $admin_session = $this->Application->recallObject('Session.admin'); - /* @var $admin_session Session */ return $admin_session->LoggedIn(); } @@ -155,8 +155,8 @@ } if ( substr($event->Name, 0, 8) == 'OnUpdate' && $user_id > 0 ) { + /** @var UsersItem $user_dummy */ $user_dummy = $this->Application->recallObject($event->Prefix . '.-item', null, Array ('skip_autoload' => true)); - /* @var $user_dummy UsersItem */ foreach ($items_info as $id => $field_values) { if ( $id != $user_id ) { @@ -219,8 +219,8 @@ if ($this->Application->GetVar('admin') == 1) { // Front-End showed in admin's right frame + /** @var Session $session_admin */ $session_admin = $this->Application->recallObject('Session.admin'); - /* @var $session_admin Session */ if (!$session_admin->LoggedIn()) { // front-end session created from admin session & both expired @@ -261,15 +261,15 @@ */ protected function OnLogin($event) { + /** @var kDBItem $object */ $object = $event->getObject( Array ('form_name' => 'login') ); - /* @var $object kDBItem */ $object->SetFieldsFromHash($this->getSubmittedFields($event)); $username = $object->GetDBField('UserLogin'); $password = $object->GetDBField('UserPassword'); $remember_login = $object->GetDBField('UserRememberLogin') == 1; - /* @var $user_helper UserHelper */ + /** @var UserHelper $user_helper */ $user_helper = $this->Application->recallObject('UserHelper'); $user_helper->event =& $event; @@ -296,8 +296,8 @@ */ protected function OnLoginAjax($event) { + /** @var AjaxFormHelper $ajax_form_helper */ $ajax_form_helper = $this->Application->recallObject('AjaxFormHelper'); - /* @var $ajax_form_helper AjaxFormHelper */ $ajax_form_helper->transitEvent($event, 'OnLogin'); } @@ -315,7 +315,7 @@ return ; } - /* @var $user_helper UserHelper */ + /** @var UserHelper $user_helper */ $user_helper = $this->Application->recallObject('UserHelper'); $user_helper->loginUser('', '', false, false, $remember_login_cookie); @@ -328,8 +328,8 @@ */ function OnInpLogin($event) { + /** @var UsersSyncronizeManager $sync_manager */ $sync_manager = $this->Application->recallObject('UsersSyncronizeManager', null, Array(), Array ('InPortalSyncronize')); - /* @var $sync_manager UsersSyncronizeManager */ $sync_manager->performAction('LoginUser', $event->getEventParam('user'), $event->getEventParam('pass') ); @@ -346,8 +346,8 @@ */ function OnInpLogout($event) { + /** @var UsersSyncronizeManager $sync_manager */ $sync_manager = $this->Application->recallObject('UsersSyncronizeManager', null, Array(), Array ('InPortalSyncronize')); - /* @var $sync_manager UsersSyncronizeManager */ $sync_manager->performAction('LogoutUser'); } @@ -361,7 +361,7 @@ */ protected function OnLogout($event) { - /* @var $user_helper UserHelper */ + /** @var UserHelper $user_helper */ $user_helper = $this->Application->recallObject('UserHelper'); $user_helper->event =& $event; @@ -399,8 +399,8 @@ return ; } + /** @var UsersItem $object */ $object = $event->getObject( Array('form_name' => 'registration') ); - /* @var $object UsersItem */ $field_values = $this->getSubmittedFields($event); $user_email = getArrayValue($field_values, 'Email'); @@ -443,8 +443,8 @@ */ protected function OnRegisterAjax(kEvent $event) { + /** @var AjaxFormHelper $ajax_form_helper */ $ajax_form_helper = $this->Application->recallObject('AjaxFormHelper'); - /* @var $ajax_form_helper AjaxFormHelper */ $ajax_form_helper->transitEvent($event, 'OnCreate', Array ('do_refresh' => 1)); } @@ -458,8 +458,8 @@ */ protected function getSubscriberByEmail($email) { + /** @var UsersItem $verify_user */ $verify_user = $this->Application->recallObject('u.verify', null, Array ('skip_autoload' => true)); - /* @var $verify_user UsersItem */ $verify_user->Load($email, 'Email'); @@ -473,11 +473,11 @@ */ function autoLoginUser($event) { + /** @var UsersItem $object */ $object = $event->getObject(); - /* @var $object UsersItem */ if ( $object->GetDBField('Status') == STATUS_ACTIVE ) { - /* @var $user_helper UserHelper */ + /** @var UserHelper $user_helper */ $user_helper = $this->Application->recallObject('UserHelper'); $user =& $user_helper->getUserObject(); @@ -502,11 +502,11 @@ $this->beforeItemChanged($event); + /** @var kCountryStatesHelper $cs_helper */ $cs_helper = $this->Application->recallObject('CountryStatesHelper'); - /* @var $cs_helper kCountryStatesHelper */ + /** @var UsersItem $object */ $object = $event->getObject(); - /* @var $object UsersItem */ if ( !$object->isSubscriberOnly() ) { // don't check state-to-country relations for subscribers @@ -521,7 +521,7 @@ $this->setUserGroup($object); - /* @var $user_helper UserHelper */ + /** @var UserHelper $user_helper */ $user_helper = $this->Application->recallObject('UserHelper'); if ( !$user_helper->checkBanRules($object) ) { @@ -574,8 +574,8 @@ */ protected function assignToPrimaryGroup($event) { + /** @var kDBItem $object */ $object = $event->getObject(); - /* @var $object kDBItem */ $primary_group_id = $object->GetDBField('PrimaryGroupId'); @@ -604,8 +604,8 @@ */ protected function OnAfterItemValidate(kEvent $event) { + /** @var kDBItem $object */ $object = $event->getObject(); - /* @var $object kDBItem */ $resource_id = $object->GetDBField('ResourceId'); @@ -621,8 +621,8 @@ */ function OnRecommend($event) { + /** @var kDBItem $object */ $object = $event->getObject( Array ('form_name' => 'recommend') ); - /* @var $object kDBItem */ $object->SetFieldsFromHash($this->getSubmittedFields($event)); @@ -658,8 +658,8 @@ */ function OnUpdateAddress($event) { + /** @var kDBItem $object */ $object = $event->getObject(Array ('skip_autoload' => true)); - /* @var $object kDBItem */ $items_info = $this->Application->GetVar($event->getPrefixSpecial(true)); @@ -677,8 +677,8 @@ $object->Validate(); } + /** @var kCountryStatesHelper $cs_helper */ $cs_helper = $this->Application->recallObject('CountryStatesHelper'); - /* @var $cs_helper kCountryStatesHelper */ $cs_helper->PopulateStates($event, 'State', 'Country'); @@ -692,8 +692,8 @@ */ function OnSubscribeQuery($event) { + /** @var UsersItem $object */ $object = $event->getObject( Array ('form_name' => 'subscription') ); - /* @var $object UsersItem */ $object->SetFieldsFromHash($this->getSubmittedFields($event)); @@ -724,8 +724,8 @@ */ function OnSubscribeUser($event) { + /** @var UsersItem $object */ $object = $event->getObject( Array ('form_name' => 'subscription') ); - /* @var $object UsersItem */ $user_email = $this->Application->GetVar('subscriber_email'); $object->SetDBField('SubscriberEmail', $user_email); @@ -748,8 +748,8 @@ } if ( $object->isSubscriberOnly() ) { + /** @var kTempTablesHandler $temp_handler */ $temp_handler = $this->Application->recallObject($event->Prefix . '_TempHandler', 'kTempTablesHandler'); - /* @var $temp_handler kTempTablesHandler */ $temp_handler->DeleteItems($event->Prefix, '', Array($object->GetID())); } @@ -826,13 +826,13 @@ */ function OnForgotPassword($event) { + /** @var kDBItem $object */ $object = $event->getObject( Array ('form_name' => 'forgot_password') ); - /* @var $object kDBItem */ $object->SetFieldsFromHash($this->getSubmittedFields($event)); + /** @var UsersItem $user */ $user = $this->Application->recallObject('u.tmp', null, Array ('skip_autoload' => true)); - /* @var $user UsersItem */ $found = $allow_reset = false; $email_or_username = $object->GetDBField('ForgotLogin'); @@ -915,14 +915,14 @@ $this->beforeItemChanged($event); + /** @var kCountryStatesHelper $cs_helper */ $cs_helper = $this->Application->recallObject('CountryStatesHelper'); - /* @var $cs_helper kCountryStatesHelper */ $cs_helper->CheckStateField($event, 'State', 'Country'); $cs_helper->PopulateStates($event, 'State', 'Country'); + /** @var kDBItem $object */ $object = $event->getObject(); - /* @var $object kDBItem */ if ( $event->Special == 'forgot' ) { $object->SetDBField('PwResetConfirm', ''); @@ -949,8 +949,8 @@ */ function beforeItemChanged($event) { + /** @var UsersItem $object */ $object = $event->getObject(); - /* @var $object UsersItem */ if ( !$this->Application->isAdmin && $object->getFormName() == 'registration' ) { // sets new user's status based on config options @@ -962,8 +962,8 @@ } if ( $this->Application->ConfigValue('RegistrationCaptcha') ) { + /** @var kCaptchaHelper $captcha_helper */ $captcha_helper = $this->Application->recallObject('CaptchaHelper'); - /* @var $captcha_helper kCaptchaHelper */ $captcha_helper->validateCode($event, false); } @@ -985,8 +985,8 @@ { $event->SetRedirectParam('opener', 's'); + /** @var UsersItem $object */ $object = $event->getObject(); - /* @var $object UsersItem */ $next_template = false; @@ -1074,8 +1074,8 @@ $item_info = $this->Application->GetVar( $event->getPrefixSpecial(true) ); list($id, $field_values) = each($item_info); + /** @var kDBItem $object */ $object = $event->getObject( Array ('skip_autoload' => true) ); - /* @var $object kDBItem */ $object->IgnoreValidation = true; @@ -1112,8 +1112,8 @@ { switch ($event->Special) { case 'ord': + /** @var OrdersItem $order */ $order = $this->Application->recallObject('ord'); - /* @var $order OrdersItem */ return $order->GetDBField('PortalUserId'); break; @@ -1132,7 +1132,7 @@ break; case 'forgot': - /* @var $user_helper UserHelper */ + /** @var UserHelper $user_helper */ $user_helper = $this->Application->recallObject('UserHelper'); $id = $user_helper->validateUserCode($this->Application->GetVar('user_key'), 'forgot_password'); @@ -1173,8 +1173,8 @@ $user_id = $this->Application->RecallVar('user_id'); if ( $id == $user_id && ($user_id > 0 || $user_id == USER_ROOT) ) { + /** @var kDBItem $user_dummy */ $user_dummy = $this->Application->recallObject($event->Prefix . '.-item', null, Array ('skip_autoload' => true)); - /* @var $user_dummy kDBItem */ $user_dummy->Load($id); $status_field = $user_dummy->getStatusField(); @@ -1186,8 +1186,8 @@ } if ( $user_id == USER_ROOT ) { + /** @var UsersItem $object */ $object = $event->getObject(Array ('skip_autoload' => true)); - /* @var $object UsersItem */ // this is internal hack to allow root/root passwords for dev if ( $this->Application->isDebugMode() && $field_values['RootPassword'] == 'root' ) { @@ -1273,8 +1273,8 @@ */ protected function checkItemStatus(kEvent $event) { + /** @var kDBItem $object */ $object = $event->getObject(); - /* @var $object kDBItem */ if ( !$object->isLoaded() ) { return true; @@ -1298,8 +1298,8 @@ $this->afterItemChanged($event); + /** @var UsersItem $object */ $object = $event->getObject(); - /* @var $object UsersItem */ if ( !$this->Application->isAdmin && ($event->Special != 'email-restore') ) { $this->sendEmailChangeEvent($event); @@ -1321,8 +1321,8 @@ { $this->saveUserImages($event); + /** @var UsersItem $object */ $object = $event->getObject(); - /* @var $object UsersItem */ if ( $object->GetDBField('EmailPassword') && $object->GetDBField('Password_plain') ) { $email_passwords = $this->Application->RecallVar('email_passwords'); @@ -1381,8 +1381,8 @@ $email_passwords = unserialize($email_passwords); if ( isset($email_passwords[$temp_id]) ) { + /** @var kDBItem $object */ $object = $event->getObject(); - /* @var $object kDBItem */ $object->SwitchToLive(); $object->Load( $event->getEventParam('id') ); @@ -1462,8 +1462,8 @@ */ protected function sendEmailChangeEvent(kEvent $event) { + /** @var UsersItem $object */ $object = $event->getObject(); - /* @var $object UsersItem */ $new_email = $object->GetDBField('Email'); $prev_email = $object->GetOriginalField('Email'); @@ -1519,8 +1519,8 @@ $form_fields =& $forms['default']['Fields']; // 1. arrange user registration countries + /** @var SiteHelper $site_helper */ $site_helper = $this->Application->recallObject('SiteHelper'); - /* @var $site_helper SiteHelper */ $first_country = $site_helper->getDefaultCountry('', false); @@ -1537,8 +1537,8 @@ $form_fields['PrimaryGroupId']['default'] = $this->Application->ConfigValue('User_NewGroup'); // 3. allow avatar upload on Front-End + /** @var FileHelper $file_helper */ $file_helper = $this->Application->recallObject('FileHelper'); - /* @var $file_helper FileHelper */ $file_helper->createItemFiles($event->Prefix, true); // create image fields @@ -1589,8 +1589,8 @@ return; } + /** @var kTempTablesHandler $temp_handler */ $temp_handler = $this->Application->recallObject($event->Prefix.'_TempHandler', 'kTempTablesHandler'); - /* @var $temp_handler kTempTablesHandler */ $ids = $this->StoreSelectedIDs($event); $temp_handler->CloneItems($event->Prefix, '', $ids); @@ -1608,8 +1608,8 @@ { parent::OnBeforeClone($event); + /** @var UsersItem $object */ $object = $event->getObject(); - /* @var $object UsersItem */ $object->generatePassword(); $object->SetDBField('ResourceId', 0); // this will reset it @@ -1692,16 +1692,16 @@ parent::OnAfterItemLoad($event); // linking existing images for item with virtual fields + /** @var ImageHelper $image_helper */ $image_helper = $this->Application->recallObject('ImageHelper'); - /* @var $image_helper ImageHelper */ + /** @var UsersItem $object */ $object = $event->getObject(); - /* @var $object UsersItem */ $image_helper->LoadItemImages($object); + /** @var kCountryStatesHelper $cs_helper */ $cs_helper = $this->Application->recallObject('CountryStatesHelper'); - /* @var $cs_helper kCountryStatesHelper */ $cs_helper->PopulateStates($event, 'State', 'Country'); @@ -1726,8 +1726,8 @@ $ret = $this->Application->getCache($cache_key); if ( $ret === false ) { + /** @var kDBList $languages */ $languages = $this->Application->recallObject('lang.enabled', 'lang_List'); - /* @var $languages kDBList */ $ret = Array (); @@ -1749,11 +1749,11 @@ function saveUserImages($event) { if (!$this->Application->isAdmin) { + /** @var ImageHelper $image_helper */ $image_helper = $this->Application->recallObject('ImageHelper'); - /* @var $image_helper ImageHelper */ + /** @var kDBItem $object */ $object = $event->getObject(); - /* @var $object kDBItem */ // process image upload in virtual fields $image_helper->SaveItemImages($object); @@ -1775,8 +1775,8 @@ return; } + /** @var kDBItem $object */ $object = $event->getObject(); - /* @var $object kDBItem */ $user_type = $this->Application->GetVar('user_type'); @@ -1802,8 +1802,8 @@ */ function _makePasswordRequired($event) { + /** @var kDBItem $object */ $object = $event->getObject(); - /* @var $object kDBItem */ $required_fields = Array ('Password', 'Password_plain', 'VerifyPassword', 'VerifyPassword_plain'); $object->setRequired($required_fields); @@ -1823,8 +1823,8 @@ if ( $id < 0 ) { // when root, guest and so on + /** @var kDBItem $object */ $object = $event->getObject(); - /* @var $object kDBItem */ $object->Clear($id); return; @@ -1878,13 +1878,13 @@ */ function OnResetLostPassword($event) { + /** @var kDBItem $object */ $object = $event->getObject(); - /* @var $object kDBItem */ $event->CallSubEvent('OnUpdate'); if ( $event->status == kEvent::erSUCCESS ) { - /* @var $user_helper UserHelper */ + /** @var UserHelper $user_helper */ $user_helper = $this->Application->recallObject('UserHelper'); $user =& $user_helper->getUserObject(); @@ -1905,8 +1905,8 @@ */ protected function OnResetRootPassword($event) { + /** @var kPasswordFormatter $password_formatter */ $password_formatter = $this->Application->recallObject('kPasswordFormatter'); - /* @var $password_formatter kPasswordFormatter */ $new_root_password = kUtil::generatePassword(); @@ -1926,7 +1926,7 @@ */ protected function OnLoginAs(kEvent $event) { - /* @var $user_helper UserHelper */ + /** @var UserHelper $user_helper */ $user_helper = $this->Application->recallObject('UserHelper'); $user =& $user_helper->getUserObject();