Index: branches/5.3.x/core/units/categories/categories_event_handler.php
===================================================================
diff -u -N -r16503 -r16519
--- branches/5.3.x/core/units/categories/categories_event_handler.php	(.../categories_event_handler.php)	(revision 16503)
+++ branches/5.3.x/core/units/categories/categories_event_handler.php	(.../categories_event_handler.php)	(revision 16519)
@@ -1,6 +1,6 @@
 <?php
 /**
-* @version	$Id: categories_event_handler.php 16503 2016-12-26 18:16:21Z alex $
+* @version	$Id: categories_event_handler.php 16519 2017-01-20 20:21:46Z alex $
 * @package	In-Portal
 * @copyright	Copyright (C) 1997 - 2009 Intechnic. All rights reserved.
 * @license      GNU/GPL
@@ -70,8 +70,8 @@
 			if ( $event->Name == 'OnResetCMSMenuCache' ) {
 				// events from "Tools -> System Tools" section are controlled via that section "edit" permission
 
+				/** @var kPermissionsHelper $perm_helper */
 				$perm_helper = $this->Application->recallObject('PermissionsHelper');
-				/* @var $perm_helper kPermissionsHelper */
 
 				$perm_value = $this->Application->CheckPermission('in-portal:service.edit');
 
@@ -95,8 +95,8 @@
 			if ( in_array($event->Name, $this->_getMassPermissionEvents()) ) {
 				$items = $this->_getPermissionCheckInfo($event);
 
+				/** @var kPermissionsHelper $perm_helper */
 				$perm_helper = $this->Application->recallObject('PermissionsHelper');
-				/* @var $perm_helper kPermissionsHelper */
 
 				if ( ($event->Name == 'OnSave') && array_key_exists(0, $items) ) {
 					// adding new item (ID = 0)
@@ -125,8 +125,8 @@
 			}
 
 			if ( $event->Name == 'OnRecalculatePriorities' ) {
+				/** @var kPermissionsHelper $perm_helper */
 				$perm_helper = $this->Application->recallObject('PermissionsHelper');
-				/* @var $perm_helper kPermissionsHelper */
 
 				$category_id = $this->Application->GetVar('m_cat_id');
 
@@ -250,8 +250,8 @@
 		 */
 		function OnProcessSelected($event)
 		{
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			$selected_ids = $this->Application->GetVar('selected_ids');
 
@@ -274,8 +274,8 @@
 		{
 			parent::SetCustomQuery($event);
 
+			/** @var kDBList $object */
 			$object = $event->getObject();
-			/* @var $object kDBList */
 
 			// don't show "Content" category in advanced view
 			$object->addFilter('system_categories', '%1$s.Status <> 4');
@@ -381,8 +381,8 @@
 					$processed_prefix = $this->Application->processPrefix($prefix_special);
 					if ($processed_prefix['prefix'] == $related_prefix) {
 						// printing related categories within list of items (not on details page)
+						/** @var kDBList $list */
 						$list = $this->Application->recallObject($prefix_special);
-						/* @var $list kDBList */
 
 						$id = $list->GetID();
 					}
@@ -398,8 +398,8 @@
 					}
 				}
 
+				/** @var kCatDBItem $p_item */
 				$p_item = $this->Application->recallObject($related_prefix . '.current', null, Array('skip_autoload' => true));
-				/* @var $p_item kCatDBItem */
 
 				$p_item->Load( (int)$id );
 
@@ -532,8 +532,8 @@
 				$search_event = $event_mapping[$type];
 				$this->$search_event($event);
 
+				/** @var kDBList $object */
 				$object = $event->getObject();
-				/* @var $object kDBList */
 
 				$search_sql = '	FROM ' . $search_helper->getSearchTable() . ' search_result
 								JOIN %1$s ON %1$s.ResourceId = search_result.ResourceId';
@@ -570,8 +570,8 @@
 				$view_perm = 1;
 			}
 			else {
+				/** @var kCountHelper $count_helper */
 				$count_helper = $this->Application->recallObject('CountHelper');
-				/* @var $count_helper kCountHelper */
 
 				list ($view_perm, $view_filter) = $count_helper->GetPermissionClause($object->Prefix, 'perm');
 				$object->addFilter('perm_filter2', $view_filter);
@@ -587,8 +587,8 @@
 		 */
 		function _getCurrentThemeId()
 		{
+			/** @var kThemesHelper $themes_helper */
 			$themes_helper = $this->Application->recallObject('ThemesHelper');
-			/* @var $themes_helper kThemesHelper */
 
 			return (int)$themes_helper->getCurrentThemeId();
 		}
@@ -696,8 +696,8 @@
 				return;
 			}
 
+			/** @var kDBItem $object */
 			$object = $event->getObject(Array ('skip_autoload' => true));
-			/* @var $object kDBItem */
 
 			$object->addCalculatedField(
 				'IsNew',
@@ -744,8 +744,8 @@
 		{
 			parent::OnAfterCopyToLive($event);
 
+			/** @var CategoriesItem $object */
 			$object = $this->Application->recallObject($event->Prefix . '.-item', null, Array ('skip_autoload' => true, 'live_table' => true));
-			/* @var $object CategoriesItem */
 
 			$parent_path = false;
 			$object->Load($event->getEventParam('id'));
@@ -763,8 +763,8 @@
 			}
 
 			if ( $parent_path ) {
+				/** @var kPermCacheUpdater $cache_updater */
 				$cache_updater = $this->Application->makeClass('kPermCacheUpdater', Array (null, $parent_path));
-				/* @var $cache_updater kPermCacheUpdater */
 
 				$cache_updater->OneStepRun();
 			}
@@ -784,8 +784,8 @@
 			$id = $event->getEventParam('id');
 
 			// loading anyway, because this object is needed by "c-perm:OnBeforeDeleteFromLive" event
+			/** @var CategoriesItem $temp_object */
 			$temp_object = $event->getObject(Array ('skip_autoload' => true));
-			/* @var $temp_object CategoriesItem */
 
 			$temp_object->Load($id);
 
@@ -799,8 +799,8 @@
 			}
 
 			// existing category was edited, check if in-cache fields are modified
+			/** @var CategoriesItem $live_object */
 			$live_object = $this->Application->recallObject($event->Prefix . '.-item', null, Array ('live_table' => true, 'skip_autoload' => true));
-			/* @var $live_object CategoriesItem */
 
 			$live_object->Load($id);
 			$cached_fields = Array ('l' . $this->Application->GetDefaultLanguageId() . '_Name', 'Filename', 'Template', 'ParentId', 'Priority');
@@ -852,8 +852,8 @@
 
 			parent::OnPreCreate($event);
 
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			// 2. preset template
 			$category_id = $this->Application->GetVar('m_cat_id');
@@ -881,8 +881,8 @@
 			$is_editing = implode('', $ids);
 			$old_statuses = $is_editing ? $this->_getCategoryStatus($ids) : Array ();
 
+			/** @var CategoriesItem $object */
 			$object = $event->getObject();
-			/* @var $object CategoriesItem */
 
 			parent::OnSave($event);
 
@@ -916,8 +916,8 @@
 			$filename_changes = $this->Application->GetVar($event->Prefix . '_filename_changes', Array ());
 
 			if ( $filename_changes ) {
+				/** @var kOpenerStack $opener_stack */
 				$opener_stack = $this->Application->makeClass('kOpenerStack');
-				/* @var $opener_stack kOpenerStack */
 
 				list ($template, $params, $index_file) = $opener_stack->pop();
 
@@ -959,8 +959,8 @@
 		 */
 		protected function OnPreSaveCreated(kEvent $event)
 		{
+			/** @var CategoriesItem $object */
 			$object = $event->getObject( Array ('skip_autoload' => true) );
-			/* @var $object CategoriesItem */
 
 			if ( $object->IsRoot() ) {
 				// don't create root category while saving permissions
@@ -981,8 +981,8 @@
 		{
 			parent::OnAfterItemDelete($event);
 
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			$sql = 'UPDATE ' . $object->TableName . '
 					SET SymLinkCategoryId = NULL
@@ -996,8 +996,8 @@
 			$ids = $this->Conn->GetCol($sql);
 
 			if ( $ids ) {
+				/** @var kTempTablesHandler $temp_handler */
 				$temp_handler = $this->Application->recallObject('system-event-subscription_TempHandler', 'kTempTablesHandler', Array ('parent_event' => $event->MasterEvent));
-				/* @var $temp_handler kTempTablesHandler */
 
 				$temp_handler->DeleteItems('system-event-subscription', '', $ids);
 			}
@@ -1094,13 +1094,13 @@
 			$recycle_bin = $this->Application->ConfigValue('RecycleBinFolder');
 
 			if ( $recycle_bin ) {
+				/** @var CategoriesItem $rb */
 				$rb = $this->Application->recallObject('c.recycle', null, Array ('skip_autoload' => true));
-				/* @var $rb CategoriesItem */
 
 				$rb->Load($recycle_bin);
 
+				/** @var CategoriesItem $cat */
 				$cat = $event->getObject(Array ('skip_autoload' => true));
-				/* @var $cat CategoriesItem */
 
 				foreach ($ids as $id) {
 					$cat->Load($id);
@@ -1124,8 +1124,8 @@
 			$ids = $event->getEventParam('ids');
 
 			if ( $ids ) {
+				/** @var kRecursiveHelper $recursive_helper */
 				$recursive_helper = $this->Application->recallObject('RecursiveHelper');
-				/* @var $recursive_helper kRecursiveHelper */
 
 				foreach ($ids as $id) {
 					$recursive_helper->DeleteCategory($id, $event->Prefix);
@@ -1146,8 +1146,8 @@
 		{
 			$this->Application->RemoveVar('clipboard');
 
+			/** @var kClipboardHelper $clipboard_helper */
 			$clipboard_helper = $this->Application->recallObject('ClipboardHelper');
-			/* @var $clipboard_helper kClipboardHelper */
 
 			$clipboard_helper->setClipboard($event, 'copy', $this->StoreSelectedIDs($event));
 			$this->clearSelectedIDs($event);
@@ -1162,8 +1162,8 @@
 		{
 			$this->Application->RemoveVar('clipboard');
 
+			/** @var kClipboardHelper $clipboard_helper */
 			$clipboard_helper = $this->Application->recallObject('ClipboardHelper');
-			/* @var $clipboard_helper kClipboardHelper */
 
 			$clipboard_helper->setClipboard($event, 'cut', $this->StoreSelectedIDs($event));
 			$this->clearSelectedIDs($event);
@@ -1193,8 +1193,8 @@
 		 */
 		function _checkPastePermission($event)
 		{
+			/** @var kPermissionsHelper $perm_helper */
 			$perm_helper = $this->Application->recallObject('PermissionsHelper');
-			/* @var $perm_helper kPermissionsHelper */
 
 			$category_id = $this->Application->GetVar('m_cat_id');
 			if ($perm_helper->AddCheckPermission($category_id, $event->Prefix) == 0) {
@@ -1238,8 +1238,8 @@
 				$source_category_id = $this->Conn->GetOne($sql);
 			}
 
+			/** @var kRecursiveHelper $recursive_helper */
 			$recursive_helper = $this->Application->recallObject('RecursiveHelper');
-			/* @var $recursive_helper kRecursiveHelper */
 
 			if ( $clipboard_data['cut'] ) {
 				$recursive_helper->MoveCategories($clipboard_data['cut'], $this->Application->GetVar('m_cat_id'));
@@ -1262,8 +1262,8 @@
 				}
 			}
 
+			/** @var kPriorityHelper $priority_helper */
 			$priority_helper = $this->Application->recallObject('PriorityHelper');
-			/* @var $priority_helper kPriorityHelper */
 
 			if ( $clipboard_data['cut'] ) {
 				$ids = $priority_helper->recalculatePriorities($event, 'ParentId = ' . $source_category_id);
@@ -1360,8 +1360,8 @@
 		{
 			parent::OnBeforeItemCreate($event);
 
+			/** @var CategoriesItem $object */
 			$object = $event->getObject();
-			/* @var $object CategoriesItem */
 
 			if ( $object->GetDBField('ParentId') <= 0 ) {
 				// no parent category - use current (happens during import)
@@ -1375,8 +1375,8 @@
 				return ;
 			}
 
+			/** @var kPermissionsHelper $perm_helper */
 			$perm_helper = $this->Application->recallObject('PermissionsHelper');
-			/* @var $perm_helper kPermissionsHelper */
 
 			$new_status = false;
 			$category_id = $this->Application->GetVar('m_cat_id');
@@ -1431,8 +1431,8 @@
 
 			$this->_beforeItemChange($event);
 
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			if ( $object->GetChangedFields() ) {
 				$object->SetDBField('ModifiedById', $this->Application->RecallVar('user_id'));
@@ -1450,8 +1450,8 @@
 		 */
 		protected function ItemPrepareQuery(kEvent $event)
 		{
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			$sqls = $object->getFormOption('ItemSQLs', Array ());
 			$category_special = $this->_getCategorySpecial($event);
@@ -1474,8 +1474,8 @@
 		 */
 		protected function ListPrepareQuery(kEvent $event)
 		{
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			$special = $this->_getCategorySpecial($event);
 			$sqls = $object->getFormOption('ListSQLs', Array ());
@@ -1499,11 +1499,11 @@
 				return;
 			}
 
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
+			/** @var kPermCacheUpdater $cache_updater */
 			$cache_updater = $this->Application->makeClass('kPermCacheUpdater', Array (null, $object->GetDBField('ParentPath')));
-			/* @var $cache_updater kPermCacheUpdater */
 
 			$cache_updater->OneStepRun();
 
@@ -1562,8 +1562,8 @@
 					$page = $this->Application->GetVar($page_var);
 
 					if ( is_numeric($page) ) {
+						/** @var kDBList $object */
 						$object = $event->getObject();
-						/* @var $object kDBList */
 
 						$object->SetPage($page);
 					}
@@ -1589,8 +1589,8 @@
 				return;
 			}
 
+			/** @var CategoriesItem $object */
 			$object = $event->getObject(Array ('skip_autoload' => true));
-			/* @var $object CategoriesItem */
 
 			$ids = $this->StoreSelectedIDs($event);
 
@@ -1629,8 +1629,8 @@
 		 */
 		protected function checkItemStatus(kEvent $event)
 		{
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			if ( !$object->isLoaded() ) {
 				return true;
@@ -1663,8 +1663,8 @@
 			if ( in_array('search', $types) ) {
 				$event->setPseudoClass('_List');
 
+				/** @var kDBList $object */
 				$object = $event->getObject();
-				/* @var $object kDBList */
 
 				// 1. no user sorting - sort by relevance
 				$default_sortings = parent::_getDefaultSorting($event);
@@ -1767,8 +1767,8 @@
 				$t = $this->Application->GetVar('t');
 			}
 
+			/** @var CategoriesItem $page */
 			$page = $this->Application->recallObject($this->Prefix . '.-virtual', null, Array ('page' => $t));
-			/* @var $page CategoriesItem */
 
 			if ( $page->isLoaded() ) {
 				$real_t = $page->GetDBField('CachedTemplate');
@@ -1784,15 +1784,15 @@
 
 			// replace alias in form #alias_name# to actual template used in this theme
 			if ( $this->Application->isAdmin ) {
+				/** @var kThemesHelper $themes_helper */
 				$themes_helper = $this->Application->recallObject('ThemesHelper');
-				/* @var $themes_helper kThemesHelper */
 
 				// only, used when in "Design Mode"
 				$this->Application->SetVar('theme.current_id', $themes_helper->getCurrentThemeId());
 			}
 
+			/** @var kDBItem $theme */
 			$theme = $this->Application->recallObject('theme.current');
-			/* @var $theme kDBItem */
 
 			$template = $theme->GetField('TemplateAliases', $real_t);
 
@@ -1825,8 +1825,8 @@
 		 */
 		function _beforeItemChange($event)
 		{
+			/** @var CategoriesItem $object */
 			$object = $event->getObject();
-			/* @var $object CategoriesItem */
 
 			$now = time();
 
@@ -1912,8 +1912,8 @@
 		{
 			$value = $object->GetField($field, 'no_default'); // current value of target field
 
+			/** @var kMultiLanguage $ml_formatter */
 			$ml_formatter = $this->Application->recallObject('kMultiLanguage');
-			/* @var $ml_formatter kMultiLanguage */
 
 			$src_field = $ml_formatter->LangFieldName('Name');
 			$dst_field = $ml_formatter->LangFieldName($field);
@@ -1938,8 +1938,8 @@
 		{
 			parent::OnBeforeItemDelete($event);
 
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			if ( $object->GetDBField('Protected') && !$this->Application->isDebugMode(false) ) {
 				$event->status = kEvent::erFAIL;
@@ -2054,13 +2054,13 @@
 
 			$backup_category_id = $this->Application->GetVar('m_cat_id');
 
+			/** @var CategoriesItem $object */
 			$object = $this->Application->recallObject($this->Prefix . '.rebuild-path', null, Array ('skip_autoload' => true));
-			/* @var $object CategoriesItem */
 
 			$parent_id = $base_category;
 
+			/** @var kFilenamesHelper $filenames_helper */
 			$filenames_helper = $this->Application->recallObject('FilenamesHelper');
-			/* @var $filenames_helper kFilenamesHelper */
 
 			$safe_category_path = array_map(Array (&$filenames_helper, 'replaceSequences'), $category_path);
 
@@ -2180,8 +2180,8 @@
 				return ;
 			}
 
+			/** @var SiteConfigHelper $site_config_helper */
 			$site_config_helper = $this->Application->recallObject('SiteConfigHelper');
-			/* @var $site_config_helper SiteConfigHelper */
 
 			$settings = $site_config_helper->getSettings();
 
@@ -2208,8 +2208,8 @@
 			$config->addSectionAdjustments($section_adjustments);
 
 			// prepare structure dropdown
+			/** @var CategoryHelper $category_helper */
 			$category_helper = $this->Application->recallObject('CategoryHelper');
-			/* @var $category_helper CategoryHelper */
 
 			$fields = $config->getFields();
 
@@ -2315,8 +2315,8 @@
 				return;
 			}
 
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			// remove this category & it's children from dropdown
 			$sql = 'SELECT ' . $object->IDField . '
@@ -2344,8 +2344,8 @@
 		{
 			parent::OnAfterItemCreate($event);
 
+			/** @var CategoriesItem $object */
 			$object = $event->getObject();
-			/* @var $object CategoriesItem */
 
 			// need to update path after category is created, so category is included in that path
 			$fields_hash = $object->buildParentBasedFields();
@@ -2377,8 +2377,8 @@
 
 			kUtil::setResourceLimit();
 
+			/** @var CategoriesItem $dummy */
 			$dummy = $this->Application->recallObject($event->Prefix . '.rebuild', NULL, Array ('skip_autoload' => true));
-			/* @var $dummy CategoriesItem */
 
 			$error_count = 0;
 			foreach ($files as $a_file => $file_info) {
@@ -2389,8 +2389,8 @@
 			}
 
 			if ( $this->Application->ConfigValue('CategoryPermissionRebuildMode') == CategoryPermissionRebuild::SILENT ) {
+				/** @var kPermCacheUpdater $updater */
 				$updater = $this->Application->makeClass('kPermCacheUpdater');
-				/* @var $updater kPermCacheUpdater */
 
 				$updater->OneStepRun();
 			}
@@ -2445,8 +2445,8 @@
 			$event->status = kEvent::erSTOP;
 			$string = $this->Application->unescapeRequestVariable($this->Application->GetVar('preview_content'));
 
+			/** @var CategoryHelper $category_helper */
 			$category_helper = $this->Application->recallObject('CategoryHelper');
-			/* @var $category_helper CategoryHelper */
 
 			$string = $category_helper->replacePageIds($string);
 
@@ -2465,8 +2465,8 @@
 
 			$keywords = $this->Application->unescapeRequestVariable(trim($this->Application->GetVar('keywords')));
 
+			/** @var kHTTPQuery $query_object */
 			$query_object = $this->Application->recallObject('kHTTPQuery');
-			/* @var $query_object kHTTPQuery */
 
 			/** @var kSearchHelper $search_helper */
 			$search_helper = $this->Application->recallObject('SearchHelper');
@@ -2494,8 +2494,8 @@
 
 			$event->setPseudoClass('_List');
 
+			/** @var kDBList $object */
 			$object = $event->getObject();
-			/* @var $object kDBList */
 
 			$config = $event->getUnitConfig();
 
@@ -2810,8 +2810,8 @@
 				return;
 			}
 
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			$id = $this->getPassedID($event);
 
@@ -2821,8 +2821,8 @@
 			}
 
 			if ( $object->Load($id, null, true) ) {
+				/** @var Params $actions */
 				$actions = $this->Application->recallObject('kActions');
-				/* @var $actions Params */
 
 				$actions->Set($event->getPrefixSpecial() . '_id', $object->GetID());
 			}
@@ -2847,8 +2847,8 @@
 			$actual_event_name = $event->getEventParam('actual_event');
 
 			if ( $actual_event_name == 'OnSavePriorityChanges' || $event_name == 'OnAfterItemLoad' || $event_name == 'OnAfterItemDelete' ) {
+				/** @var kDBItem $object */
 				$object = $event->getObject();
-				/* @var $object kDBItem */
 
 				$constrain = 'ParentId = ' . $object->GetDBField('ParentId');
 			}
@@ -2874,8 +2874,8 @@
 		 */
 		protected function OnAfterItemValidate(kEvent $event)
 		{
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			$resource_id = $object->GetDBField('ResourceId');
 
@@ -2896,8 +2896,8 @@
 		{
 			parent::OnBeforeClone($event);
 
+			/** @var kDBItem $object */
 			$object = $event->getObject();
-			/* @var $object kDBItem */
 
 			$object->SetDBField('ResourceId', 0); // this will reset it