Class Tag

---

[Строка 14]

Размещен: /tag/tag.class.php

---

Описание

Система управления сайтом HostCMS v. 5.xx

Copyright © 2005-2010 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Ядро, методы работы с тегами.

Файл: /modules/tag/tag.class.php

author

Hostmake LLC

version

5.x

---

Свойства класса

• $CacheGetTag = array()
  mem-cache для GetTag()
• $CacheGetTagRelation = array()
  mem-cache для GetTagRelation()

---

Константы класса

---

Унаследованные константы класса

---

Унаследованные свойства класса

---

Методы

• boolean DeleteTag()
  Удаление тега
• boolean DeleteTagRelation()
  Список соответствий тега
• boolean DeleteTagsGroup()
  Удаление группы тегов
• void FillMemCacheGetTagRelation()
  Метод заполняет mem-кэш для переданного списка идентификаторов товаров соответствиями тегов.
• mixed GenXmlForTag()
  Генерация XML для тега
• resource GetAllTags()
  Получение информации о тегах
• mixed GetAllTagsGroups()
  Получение информации о группах меток
• array GetTag()
  Получение информации о теге
• array GetTagByName()
  Получение информации о теге по его имени
• array GetTagByPath()
  Получение информации о теге по его пути
• mixed GetTagRelation()
  Список соответствий тега
• array GetTags()
  Получение информации о тегах
• mixed GetTagsGroup()
  Получение информации о группе меток
• array GetTagsGroupsPathArray()
  Построение массива пути от текущей группы меток к корневой
• array GetTagsGroupsTree()
  Формирование дерева групп меток
• mixed InsertTag()
  Вставка/обновление тега
• int InsertTagRelation()
  Вставка соответствия тега элементам контента
• mixed InsertTagsGroup()
  Вставка/обновление группы тегов
• boolean JoinTags()
  Объединение тегов, теги объединяются по наименьшему идентификатору, тег с наименьшим идентификатором получает данные всех остальных тегов, остальные теги удаляются

Унаследованные методы

---

Описания методов

Tag::DeleteTag

DeleteTag( int $tag_id );

Описание

Удаление тега

Принимаемые параметры

$tag_id

идентификатор тега

 <?php
 $Tag = new Tag();
 
 $tag_id = 104;
 
 $result = $Tag->DeleteTag($tag_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

[ Наверх ]




Tag::DeleteTagRelation

DeleteTagRelation( array $array );

Описание

Список соответствий тега

Принимаемые параметры

$array

массив атрибутов

• $array['information_items_id'] - идентификатор информационного элемента
• $array['shop_items_catalog_item_id'] идентификатор товара
• $array['tag_id'] - идентификатор тега

   <?php
   $Tag = new Tag();
   
   $array['information_items_id'] = 1;
   $array['tag_id'] = 27;
   
   $result = $Tag->DeleteTagRelation($array);
   
   // Распечатаем результат
   echo $result;
   ?>
  

[ Наверх ]




Tag::DeleteTagsGroup

DeleteTagsGroup( int $tags_group_id );

Описание

Удаление группы тегов

Принимаемые параметры

$tags_group_id

идентификатор группы тегов *

[ Наверх ]




Tag::FillMemCacheGetTagRelation

FillMemCacheGetTagRelation( array $param );

Описание

Метод заполняет mem-кэш для переданного списка идентификаторов товаров соответствиями тегов.

Заполнению подвергается массив $this->CacheGetTagRelation[X][shop_items_catalog_item_id][] = $row где X = information_items_id для ИС, = shop_items_catalog_item_id для товаров

Принимаемые параметры

$param

массив атрибутов

• $param['information_items_id'] массив идентификаторов информационных элементов
• $param['shop_items_catalog_item_id'] массив идентификаторов товаров

[ Наверх ]




Tag::GenXmlForTag

GenXmlForTag( int $tag_id, [array $tag_row = false], [ $count = false] );

Описание

Генерация XML для тега

Принимаемые параметры

$tag_id

Идентификатор тега

$tag_row

массив с данными о теге (не обязательное поле), по умолчанию false

 <?php
 $Tag = new Tag();
 
 $tag_id = 27;
 
 $result = $Tag->GenXmlForTag($tag_id);
 
 // Распечатаем результат
 echo $result;
 ?>

$count

Возвращает

строка с XML или false, если тег не найден

[ Наверх ]




Tag::GetAllTags

GetAllTags( [$param $param = array()] );

Описание

Получение информации о тегах

Принимаемые параметры

$param

array массив дополнительных параметров

• $param['tags_group_id'] идентификатор группы, для которой необходимо получить список тегов

[ Наверх ]




Tag::GetAllTagsGroups

GetAllTagsGroups( array $param );

Описание

Получение информации о группах меток

Принимаемые параметры

$param

массив параметров

• $param['tags_group_parent_id'] идентификатор родительской группы

Возвращает

resource с данными о группах тегов или false

[ Наверх ]




Tag::GetTag

GetTag( int $tag_id, [array $param = array()] );

Описание

Получение информации о теге

Принимаемые параметры

$tag_id

идентификатор тега

$param

массив параметров

• $param['cache'] кэшировать данные, по умолчанию true

   <?php
   $Tag = new Tag();
   
   $tag_id = 1;
   
   $row = $Tag->GetTag($tag_id);
   
   // Распечатаем результат
   print_r ($row);
   ?>
  

Возвращает

массив с данными о теге

[ Наверх ]




Tag::GetTagByName

GetTagByName( int $tag_name );

Описание

Получение информации о теге по его имени

Принимаемые параметры

$tag_name

имя тега

 <?php
 $Tag = new Tag();
 
 $tag_name = 'CMS';
 
 $row = $Tag->GetTagByName($tag_name);
 
 // Распечатаем результат
 print_r ($row);
 ?>

Возвращает

массив с данными о теге

[ Наверх ]




Tag::GetTagByPath

GetTagByPath( $tag_path, int $tag_name );

Описание

Получение информации о теге по его пути

Принимаемые параметры

$tag_name

имя тега

 <?php
 $Tag = new Tag();
 
 $tag_path = 'CMS';
 
 $row = $Tag->GetTagByPath($tag_name);
 
 // Распечатаем результат
 print_r ($row);
 ?>

$tag_path

Возвращает

массив с данными о теге

[ Наверх ]




Tag::GetTagRelation

GetTagRelation( array $array );

Описание

Список соответствий тега

Принимаемые параметры

$array

массив атрибутов

• $array['information_items_id'] идентификатор информационного элемента
• $array['shop_items_catalog_item_id'] идентификатор товара

   <?php
   $Tag = new Tag();
   
   $array['information_items_id'] = 1;
   
   $row = $Tag->GetTagRelation($array);
   
   // Распечатаем результат
   print_r ($row);
   ?>
  

Возвращает

массив с данными или false

[ Наверх ]




Tag::GetTags

GetTags( int $aTags, [array $param = array()] );

Описание

Получение информации о тегах

Принимаемые параметры

$aTags

массив идентификатор тегов

$param

массив параметров

• $param['cache'] кэшировать данные, по умолчанию true

   <?php
   $Tag = new Tag();
   
   $aTags = array(1, 2, 5, 7, 19);
   
   $rows = $Tag->GetTags($aTags);
   
   // Распечатаем результат
   print_r ($rows);
   ?>
  

Возвращает

массив с данными о тегах

[ Наверх ]




Tag::GetTagsGroup

GetTagsGroup( int $tags_group_id );

Описание

Получение информации о группе меток

Принимаемые параметры

$tags_group_id

идентификатор группы блогов

Возвращает

массив с данными о группе тегов или false

[ Наверх ]




Tag::GetTagsGroupsPathArray

GetTagsGroupsPathArray( int $tags_group_id, [array $return_path_array = array()] );

Описание

Построение массива пути от текущей группы меток к корневой

Принимаемые параметры

$tags_group_id

идентификатор группы меток, для которой необходимо построить путь

$return_path_array

служебный параметр

Возвращает

ассоциативный массив, элементы которого содержат информацию о группах тегов, составляющих путь от текущей группы до корневой

[ Наверх ]




Tag::GetTagsGroupsTree

GetTagsGroupsTree( array $param );

Описание

Формирование дерева групп меток

Принимаемые параметры

$param

массив параметров

• $param['tags_group_parent_id'] идентификатор группы меток, относительно которой строится дерево групп
• $param['separator'] символ, отделяющий группу нижнего уровня от родительской группы
• $param['tags_group_id'] идентификатор группы, которую вместе с ее
подгруппами не нужно включать в дерево групп, если равен false, то включать в дерево групп все подгруппы. - $param['array'] служебный элемент

Возвращает

двумерный массив, содержащий дерево подгрупп

[ Наверх ]




Tag::InsertTag

InsertTag( array $array );

Описание

Вставка/обновление тега

Принимаемые параметры

$array

массив атрибутов

• $array['tag_name'] имя тега
• $array['tag_path'] имя тега в URL. по умолчанию используется имя тега.
• $array['tag_description'] описание тега
• $array['tag_id'] идентификатор тега, необязательный параметр, указывается при редактировании тега
• $array['tags_group_id'] идентификатор группы тегов
• $array['users_id'] идентификатор пользователя центра администрирования

   <?php
   $Tag = new Tag();
   
   $array['tag_name'] = 'NewTag';
   
   $newid = $Tag->InsertTag($array);
   
   // Распечатаем результат
   echo $newid;
   ?>
  

Возвращает


0 - передано пустое имя тега,
false - ошибка вставки/обновления,
положительноче число - идентификатор вставленного/обновленного тега

[ Наверх ]




Tag::InsertTagRelation

InsertTagRelation( array $array );

Описание

Вставка соответствия тега элементам контента

Принимаемые параметры

$array

массив атрибутов

• $array['tag_id'] - идентификатор тега
• $array['information_items_id'] - идентификатор информационного элемента
• $array['site_id'] - идентификатор сайт, не обязательное поле. Если не указано - определяется автоматически.
• $array[''] -

   <?php
   $Tag = new Tag();
   
   $array['tag_id'] = 27;
   $array['information_items_id'] = 1;
   $array['site_id'] = CURRENT_SITE;
   
   $newid = $Tag->InsertTagRelation($array);
   
   // Распечатаем результат
   echo $newid;
   ?>
  

Возвращает

идентификатор вставленной/обновленной записи или 0

[ Наверх ]




Tag::InsertTagsGroup

InsertTagsGroup( array $param );

Описание

Вставка/обновление группы тегов

Принимаемые параметры

$param

массив параметров

• $param['tags_group_id'] идентификатор редактируемой группы тегов
• $param['tags_group_parent_id'] идентификатор родительской группы тегов
• $param['tags_group_name'] название группы тегов
• $param['tags_group_description'] описание группы тегов
• $param['tags_group_order'] порядковый номер группы
• $param['users_id'] идентификатор пользователя центра администрирования, создавшего группу тегов

Возвращает

идентификатор добавленной/измененной группы или false

[ Наверх ]




Tag::JoinTags

JoinTags( array $tags_array );

Описание

Объединение тегов, теги объединяются по наименьшему идентификатору, тег с наименьшим идентификатором получает данные всех остальных тегов, остальные теги удаляются

Принимаемые параметры

$tags_array

массив тегов, подлежащих удалению

Возвращает

TRUE в случае успеха объединения, FALSE в случае невозможности объединения

[ Наверх ]

---

Описания переменных

• $CacheGetTag = array() [Строка 28]
• Data type: array

Описание

mem-cache для GetTag()



• $CacheGetTagRelation = array() [Строка 21]
• Data type: array

Описание

mem-cache для GetTagRelation()

---

Описание констант класса

---