Index: branches/5.2.x/core/units/categories/categories_tag_processor.php =================================================================== diff -u -N -r16413 -r16513 --- branches/5.2.x/core/units/categories/categories_tag_processor.php (.../categories_tag_processor.php) (revision 16413) +++ branches/5.2.x/core/units/categories/categories_tag_processor.php (.../categories_tag_processor.php) (revision 16513) @@ -1,6 +1,6 @@ getObject($params); - /* @var $object kDBItem */ if ( isset($params['today']) && $params['today'] ) { $sql = 'SELECT COUNT(*) @@ -39,17 +39,17 @@ */ function CategoryCount($params) { + /** @var kCountHelper $count_helper */ $count_helper = $this->Application->recallObject('CountHelper'); - /* @var $count_helper kCountHelper */ $today_only = isset($params['today']) && $params['today']; return $count_helper->CategoryCount($today_only); } function IsNew($params) { + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ return $object->GetDBField('IsNew') ? 1 : 0; } @@ -67,8 +67,8 @@ */ function IsEditorsPick($params) { + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ return $object->GetDBField('EditorsPick') == 1; } @@ -90,8 +90,8 @@ return array_key_exists($icon_name, $icons) ? $icons[$icon_name] : ''; } + /** @var kDBList $object */ $object = $this->getObject($params); - /* @var $object kDBList */ if ($object->GetDBField('ThemeId') > 0) { if (!$object->GetDBField('IsMenu')) { @@ -123,8 +123,8 @@ function ItemCount($params) { + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ $ci_table = $this->Application->getUnitOption('ci', 'TableName'); @@ -185,8 +185,8 @@ function CategoryPath($params) { + /** @var kNavigationBar $navigation_bar */ $navigation_bar = $this->Application->recallObject('kNavigationBar'); - /* @var $navigation_bar kNavigationBar */ return $navigation_bar->build($params); } @@ -199,17 +199,17 @@ */ function FieldCategoryPath($params) { + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ $field = $this->SelectParam($params, 'name,field'); $category_id = $object->GetDBField($field); if ($category_id) { $params['cat_id'] = $category_id; + /** @var kNavigationBar $navigation_bar */ $navigation_bar = $this->Application->recallObject('kNavigationBar'); - /* @var $navigation_bar kNavigationBar */ return $navigation_bar->build($params); } @@ -219,8 +219,8 @@ function CurrentCategoryName($params) { + /** @var kDBList $cat_object */ $cat_object = $this->Application->recallObject($this->getPrefixSpecial(), $this->Prefix.'_List'); - /* @var $cat_object kDBList */ $sql = 'SELECT '.$this->getTitleField().' FROM '.$cat_object->TableName.' @@ -242,8 +242,8 @@ function getTitleField() { + /** @var kMultiLanguage $ml_formatter */ $ml_formatter = $this->Application->recallObject('kMultiLanguage'); - /* @var $ml_formatter kMultiLanguage */ return $ml_formatter->LangFieldName('Name'); } @@ -352,21 +352,21 @@ function Meta($params) { $object = $this->Application->recallObject($this->Prefix); // .'.-item' - /* @var $object CategoriesItem */ + /** @var CategoriesItem $object */ $meta_type = $params['name']; if ($object->isLoaded()) { // 1. get module prefix by current category + /** @var CategoryHelper $category_helper */ $category_helper = $this->Application->recallObject('CategoryHelper'); - /* @var $category_helper CategoryHelper */ $category_path = explode('|', substr($object->GetDBField('ParentPath'), 1, -1)); $module_info = $category_helper->getCategoryModule($params, $category_path); if ( $module_info ) { // 2. get item template by current category & module prefix + /** @var kRewriteUrlProcessor $rewrite_processor */ $rewrite_processor = $this->Application->recallObject('kRewriteUrlProcessor'); - /* @var $rewrite_processor kRewriteUrlProcessor */ $category_params = Array ( 'CategoryId' => $object->GetID(), @@ -377,8 +377,8 @@ if ($this->Application->GetVar('t') == $item_template) { // we are located on item's details page + /** @var kCatDBItem $item */ $item = $this->Application->recallObject($module_info['Var']); - /* @var $item kCatDBItem */ // 3. get item's meta data $value = $item->GetField('Meta'.$meta_type); @@ -523,8 +523,8 @@ $continue = 1; } + /** @var kPermCacheUpdater $updater */ $updater = $this->Application->makeClass('kPermCacheUpdater', Array ($continue)); - /* @var $updater kPermCacheUpdater */ if ( $continue === '0' ) { // No in dialog $updater->clearData(); @@ -638,8 +638,8 @@ */ function IsRootCategory($params) { + /** @var CategoriesItem $object */ $object = $this->getObject($params); - /* @var $object CategoriesItem */ return $object->IsRoot(); } @@ -757,8 +757,8 @@ $cat_id = $this->Application->findModule('Name', $params['module'], 'RootCat'); } + /** @var CategoriesItem $category */ $category = $this->Application->recallObject($this->Prefix . '.-c' . $cat_id, $this->Prefix, Array ('skip_autoload' => true)); - /* @var $category CategoriesItem */ $category->Load($cat_id); } @@ -778,12 +778,13 @@ */ function HasPermission($params) { + /** @var kPermissionsHelper $perm_helper */ $perm_helper = $this->Application->recallObject('PermissionsHelper'); - /* @var $perm_helper kPermissionsHelper */ $params['raise_warnings'] = 0; + + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ $params['cat_id'] = $object->isLoaded() ? $object->GetDBField('ParentPath') : $this->Application->GetVar('m_cat_id'); return $perm_helper->TagPermissionCheck($params); @@ -846,8 +847,8 @@ $format = isset($params['format']) ? $params['format'] : '_regional_DateTimeFormat'; if ( preg_match("/_regional_(.*)/", $format, $regs) ) { + /** @var LanguagesItem $lang */ $lang = $this->Application->recallObject('lang.current'); - /* @var $lang LanguagesItem */ if ( $regs[1] == 'DateTimeFormat' ) { // combined format @@ -864,13 +865,13 @@ function CategoryItemCount($params) { + /** @var kDBList $object */ $object = $this->getObject($params); - /* @var $object kDBList */ $params['cat_id'] = $object->GetID(); + /** @var kCountHelper $count_helper */ $count_helper = $this->Application->recallObject('CountHelper'); - /* @var $count_helper kCountHelper */ return $count_helper->CategoryItemCount($params['prefix'], $params); } @@ -894,8 +895,8 @@ */ function IsCategorySymLink($params) { + /** @var kDBList $object */ $object = $this->getObject($params); - /* @var $object kDBList */ $sym_category_id = $object->GetDBField('SymLinkCategoryId'); @@ -946,13 +947,13 @@ */ function GetModulePrefix($params) { + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ $parent_path = explode('|', substr($object->GetDBField('ParentPath'), 1, -1)); + /** @var CategoryHelper $category_helper */ $category_helper = $this->Application->recallObject('CategoryHelper'); - /* @var $category_helper CategoryHelper */ $module_info = $category_helper->getCategoryModule($params, $parent_path); @@ -1010,8 +1011,8 @@ } // 3. suggestion not found in database, ask webservice + /** @var kCurlHelper $curl_helper */ $curl_helper = $this->Application->recallObject('CurlHelper'); - /* @var $curl_helper kCurlHelper */ $curl_helper->SetRequestData(array( 'appid' => $this->Application->ConfigValue('YahooApplicationId'), @@ -1020,14 +1021,14 @@ $xml_data = $curl_helper->Send('http://search.yahooapis.com/WebSearchService/V1/spellingSuggestion'); + /** @var kXMLHelper $xml_helper */ $xml_helper = $this->Application->recallObject('kXMLHelper'); - /* @var $xml_helper kXMLHelper */ + /** @var kXMLNode $root_node */ $root_node =& $xml_helper->Parse($xml_data); - /* @var $root_node kXMLNode */ + /** @var kXMLNode $result */ $result = $root_node->FindChild('RESULT'); - /* @var $result kXMLNode */ if ( is_object($result) ) { // webservice responded -> save in local database @@ -1110,8 +1111,8 @@ function CategoryName($params) { // show category cachednavbar of + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ $category_id = isset($params['cat_id']) ? $params['cat_id'] : $object->GetDBField('CategoryId'); @@ -1166,8 +1167,8 @@ */ function &_getPage($params) { + /** @var kDBItem $page */ $page = $this->Application->recallObject($this->Prefix . '.' . $this->_getPageSpecial($params), null, $params); - /* @var $page kDBItem */ // 1. load by given id $page_id = array_key_exists('page_id', $params) ? $params['page_id'] : 0; @@ -1194,8 +1195,8 @@ if ( !$structure_path_match && !$design_match ) { // Same sql like in "c:getPassedID". Load, when current page object doesn't match requested page object + /** @var kThemesHelper $themes_helper */ $themes_helper = $this->Application->recallObject('ThemesHelper'); - /* @var $themes_helper kThemesHelper */ $page_id = $themes_helper->getPageByTemplate($template); @@ -1251,19 +1252,19 @@ return 'NO CONTENT NUM SPECIFIED'; } + /** @var kDBItem $page */ $page =& $this->_getPage($params); - /* @var $page kDBItem */ if ( !$page->isLoaded() ) { // page is not created yet => all blocks are empty return ''; } + /** @var PageHelper $page_helper */ $page_helper = $this->Application->recallObject('PageHelper'); - /* @var $page_helper PageHelper */ + /** @var kDBItem $content */ $content = $this->Application->recallObject('content.-block', null, Array ('skip_autoload' => true)); - /* @var $content kDBItem */ if ( !$page_helper->loadContentBlock($content, $page, $num) && EDITING_MODE ) { $page_helper->createNewContentBlock($page->GetID(), $num); @@ -1445,8 +1446,8 @@ $this->Application->SetVar('admin_scripts_included', 1); $js_url = $this->Application->BaseURL() . 'core/admin_templates/js'; + /** @var MinifyHelper $minify_helper */ $minify_helper = $this->Application->recallObject('MinifyHelper'); - /* @var $minify_helper MinifyHelper */ $to_compress = Array ( $js_url . '/jquery/thickbox/thickbox.css', @@ -1500,8 +1501,8 @@ $page =& $this->_getPage($params); + /** @var PageHelper $page_helper */ $page_helper = $this->Application->recallObject('PageHelper'); - /* @var $page_helper PageHelper */ $class_params = Array ( 'languagePrefix' => 'l' . $this->Application->GetVar('m_lang') . '_', @@ -1677,11 +1678,11 @@ $edit_code .= $tabs . 'a_toolbar.Render();' . "\n"; + /** @var kDBItem $revision */ $revision = $this->Application->recallObject('page-revision.current'); - /* @var $revision kDBItem */ + /** @var PageHelper $page_helper */ $page_helper = $this->Application->recallObject('PageHelper'); - /* @var $page_helper PageHelper */ foreach ( $page_helper->getToolbarButtonsState($revision) as $toolbar_button => $is_enabled ) { $edit_code .= $tabs . 'a_toolbar.SetEnabled("' . $toolbar_button . '", ' . json_encode($is_enabled) . ');'; @@ -1766,8 +1767,8 @@ $template = $this->Application->GetVar('t'); if (!$this->Application->TemplatesCache->TemplateExists($template) && !$this->Application->isAdmin) { + /** @var CategoriesEventHandler $cms_handler */ $cms_handler = $this->Application->recallObject($this->Prefix . '_EventHandler'); - /* @var $cms_handler CategoriesEventHandler */ $template = ltrim($cms_handler->GetDesignTemplate(), '/'); } @@ -1794,8 +1795,8 @@ return ''; } + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ $params['item_prefix'] = 'c'; @@ -1816,8 +1817,8 @@ */ function CachedMenu($params) { + /** @var MenuHelper $menu_helper */ $menu_helper = $this->Application->recallObject('MenuHelper'); - /* @var $menu_helper MenuHelper */ return $menu_helper->menuTag($this->getPrefixSpecial(), $params); } @@ -1857,8 +1858,8 @@ */ function PrintSubPages($params) { + /** @var kDBList $list */ $list = $this->Application->recallObject($this->getPrefixSpecial(), $this->Prefix.'_List', $params); - /* @var $list kDBList */ $category_id = array_key_exists('category_id', $params) ? $params['category_id'] : $this->Application->GetVar('m_cat_id'); @@ -1888,14 +1889,14 @@ */ function PageBrowseLink($params) { + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ + /** @var kThemesHelper $themes_helper */ $themes_helper = $this->Application->recallObject('ThemesHelper'); - /* @var $themes_helper kThemesHelper */ + /** @var SiteConfigHelper $site_config_helper */ $site_config_helper = $this->Application->recallObject('SiteConfigHelper'); - /* @var $site_config_helper SiteConfigHelper */ $settings = $site_config_helper->getSettings(); @@ -1926,11 +1927,11 @@ */ protected function DirectLink($params) { + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ + /** @var kThemesHelper $themes_helper */ $themes_helper = $this->Application->recallObject('ThemesHelper'); - /* @var $themes_helper kThemesHelper */ $url_params = Array ( 'm_cat_id' => $object->GetID(), @@ -1959,8 +1960,8 @@ */ function ContentPageLink($params) { + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ $params['t'] = mb_strtolower($object->GetDBField('NamedParentPath')); $params['m_cat_id'] = 0; @@ -2053,8 +2054,8 @@ $block_params = $this->prepareTagParams($params); $block_params['name'] = $block_params['render_as']; + /** @var kDBItem $object */ $object = $this->Application->recallObject($this->Prefix); - /* @var $object kDBItem */ $category_ids = explode('|', substr($object->GetDBField('ParentPath'), 1, -1)); @@ -2111,8 +2112,8 @@ return ''; } + /** @var TemplateHelper $template_helper */ $template_helper = $this->Application->recallObject('TemplateHelper'); - /* @var $template_helper TemplateHelper */ return $template_helper->blockInfo( $params['name'] ); } @@ -2156,8 +2157,8 @@ } } + /** @var JSONHelper $json_helper */ $json_helper = $this->Application->recallObject('JSONHelper'); - /* @var $json_helper JSONHelper */ return $json_helper->encode($ret); } @@ -2184,8 +2185,8 @@ */ function ItemEditLink($params) { + /** @var kDBList $object */ $object = $this->getObject($params); - /* @var $object kDBList */ $edit_template = $this->Application->getUnitOption($this->Prefix, 'AdminTemplatePath') . '/' . $this->Application->getUnitOption($this->Prefix, 'AdminTemplatePrefix') . 'edit'; @@ -2240,18 +2241,18 @@ $categories = true; } else { + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ + /** @var kPermissionsHelper $perm_helper */ $perm_helper = $this->Application->recallObject('PermissionsHelper'); - /* @var $perm_helper kPermissionsHelper */ $perm_prefix = $this->Application->getUnitOption($this->Prefix, 'PermItemPrefix'); $categories = $perm_helper->getPermissionCategories($perm_prefix . '.' . ($object->IsNewItem() ? 'ADD' : 'MODIFY')); } + /** @var JSONHelper $json_helper */ $json_helper = $this->Application->recallObject('JSONHelper'); - /* @var $json_helper JSONHelper */ return $json_helper->encode($categories); } @@ -2262,8 +2263,8 @@ return true; } + /** @var kDBItem $object */ $object = $this->getObject($params); - /* @var $object kDBItem */ return !$object->GetDBField('Protected'); } @@ -2277,11 +2278,11 @@ */ protected function CategoryItemElement($params) { + /** @var CategoryHelper $category_helper */ $category_helper = $this->Application->recallObject('CategoryHelper'); - /* @var $category_helper CategoryHelper */ + /** @var kNavigationBar $navigation_bar */ $navigation_bar = $this->Application->recallObject('kNavigationBar'); - /* @var $navigation_bar kNavigationBar */ $category_id = isset($params['cat_id']) ? $params['cat_id'] : $this->Application->GetVar('m_cat_id'); $parent_path = explode('|', substr($navigation_bar->getParentPath($category_id), 1, -1)); @@ -2294,8 +2295,8 @@ $module_prefix = $module_info['Var']; + /** @var kCatDBItem $object */ $object = $this->Application->recallObject($module_prefix); - /* @var $object kCatDBItem */ $title_field = $this->Application->getUnitOption($module_prefix, 'TitleField'); $block_params = $this->prepareTagParams($params);