Class lists

[Строка 23]

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

Описание

Класс модуля "Списки"

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

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

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

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

Методы

boolean CopyList()
Копирование списка
int CopyListItem()
Копирование элемента списка
void DeleteListDir()
Удаление раздела списков
boolean del_lists()
Удаление списка
boolean del_lists_items()
Удаление элемента списка
string GenXml4ListItems()
Генерация XML для всех элементов списка
resource GetAllListDirs()
Получение информации о разделах списков
resource GetAllListsForSite()
Получение списков определенного сайта
resource GetList()
Получение данных о списках
mixed GetListDir()
Получение информации о разделе списков
array GetListDirPathArray()
Построение массива пути от текущего раздела к корневому
array GetListDirsTree()
Формирование дерева разделов списков
mixed GetListItem()
Получение данных об элементе списка
mixed GetListItemIfIssetValue()
Проверка наличия значения в списке
array GetListItemsById()
Получение элементов списка в виде массива
resource GetListItemsValuesById()
Получение элементов списка в виде resource.
array GetListsItems()
Получение данных об элементах списка
int InsertList()
Вставка/обновление данных о списке
int InsertListDir()
Добавление/редактирование раздела списков
int InsertListItem()
Вставка/обновление данных об элементе списка
int insert_lists()
Устаревший метод. Вставка/обновление данных о списке
int insert_lists_items()
Устаревший метод. Вставка/обновление данных об элементе списка
mixed SelectList()
Получение данных о списке
resource SelectListsItems()
Получение данных об элементах списка
resource select_lists_items()
Получение данных об элементе списка
void ShowList()
Отображение элементов списка. Внутренний метод

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

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

lists::CopyList

CopyList( int $lists_id, [int $site_id = false] );

Описание

Копирование списка

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

$lists_id

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

$site_id

идентификатор сайта, на который следует перенести скопированный список, если не передан, используется текущий

 <?php
 $lists = & singleton('lists');
 
 $lists_id = 2;
 
 $result = $lists->CopyList($lists_id);
 
 if ($result)
 {
     echo "Копирование выполнено успешно";
 }
 else
 {
    echo "Ошибка копирования";
 }
 ?>

[ Наверх ]

lists::CopyListItem

CopyListItem( int $list_item_id );

Описание

Копирование элемента списка

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

$list_item_id

идентификатор копируемого элемента списка

 <?php
 $lists = & singleton('lists');
 
 $list_item_id = 8;
 
 $newid = $lists->CopyListItem($list_item_id);
 
 // Распечатаем результат
 if ($newid)
 {
     echo 'Элемент списка скопирован';
 }
 else
 {
     echo 'Ошибка! Элемент списка не скопирован!';
 }
 ?>

Возвращает

идентификатор копии элемента списка в случае успешного завершения, false - в противном случае

[ Наверх ]

lists::DeleteListDir

DeleteListDir( $list_dir_id $list_dir_id );

Описание

Удаление раздела списков

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

$list_dir_id

идентификатор раздела списков

[ Наверх ]

lists::del_lists

del_lists( int $lists_id );

Описание

Удаление списка

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

$lists_id

идентификатор удаляемого списка

 <?php
 $lists = & singleton('lists');
 
 $lists_id = 5;
 
 $result = $lists->del_lists($lists_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

[ Наверх ]

lists::del_lists_items

del_lists_items( int $lists_items_id );

Описание

Удаление элемента списка

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

$lists_items_id

идентификатор удаляемого элемента списка

 <?php
 $lists = & singleton('lists');
 
 $lists_items_id = 71;
 
 $result = $lists->del_lists_items($lists_items_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

[ Наверх ]

lists::GenXml4ListItems

GenXml4ListItems( int $lists_id );

Описание

Генерация XML для всех элементов списка

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

$lists_id

идентификатор списка

 <?php
 $lists = & singleton('lists');
 
 $lists_id = 8;
 
 $xml = $lists->GenXml4ListItems($lists_id);
 
 // Распечатаем результат
 echo nl2br(htmlspecialchars($xml));
 ?>

Возвращает

строка с XML или пустая строка

[ Наверх ]

lists::GetAllListDirs

GetAllListDirs( $list_dir_parent_id $list_dir_parent_id, [$site_id $site_id = CURRENT_SITE] );

Описание

Получение информации о разделах списков

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

$list_dir_parent_id

идентификатор родительского раздела

$site_id

идентификатор сайта, если равен false - идентификатор сайта не учитывается

[ Наверх ]

lists::GetAllListsForSite

GetAllListsForSite( int $site_id );

Описание

Получение списков определенного сайта

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

$site_id

идентификатор сайта

 <?php
 $lists = & singleton('lists');
 
 $site_id = 1;
 
 $resource = $lists->GetAllListsForSite($site_id);
 
  // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

[ Наверх ]

lists::GetList

GetList( mixed $lists_id );

Описание

Получение данных о списках

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

$lists_id

идентификатор выбираемого списка, если идентификатор равен false, то производится выбор информации о всех списках

 <?php
 $lists = & singleton('lists');
 
 $lists_id = 4;
 
 $resource = $lists->GetList($lists_id);
 
 // Распечатаем результат
 $row = mysql_fetch_assoc($resource);
 
 print_r($row);
 ?>

Возвращает

с данными о выбранных списках

see

lists::SelectList()

[ Наверх ]

lists::GetListDir

GetListDir( $list_dir_id $list_dir_id );

Описание

Получение информации о разделе списков

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

$list_dir_id

идентификатор раздела списков

Возвращает

массив с информацией о разделе списков, если раздел существует или false в противном случае

[ Наверх ]

lists::GetListDirPathArray

GetListDirPathArray( int $list_dir_id, [array $return_path_array = array()] );

Описание

Построение массива пути от текущего раздела к корневому

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

$list_dir_id

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

$return_path_array

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

Возвращает

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

[ Наверх ]

lists::GetListDirsTree

GetListDirsTree( int $list_dir_parent_id, [int $site_id = CURRENT_SITE], [string $separator = ''], [int $list_dir_id = false], [array $param = array()] );

Описание

Формирование дерева разделов списков

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

$list_dir_parent_id

идентификатор раздела, относительно которого строится дерево разделов

$site_id

идентификатор сайта

$separator

символ, отделяющий раздел нижнего уровня от родительского раздела

$list_dir_id

идентификатор раздела, который вместе с его подразделами не нужно включать в дерево разделов, если id = false, то включать в дерево разделов все подразделы.

$param

дополнительные параметры

$param['array'] - служебный элемент
$param['sum_separator'] - служебный элемент

Возвращает

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

[ Наверх ]

lists::GetListItem

GetListItem( int $lists_items_id, [array $param = array()] );

Описание

Получение данных об элементе списка

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

$lists_items_id

идентификатор элемента списка

$param

ассоциативный массив параметров

bool $param['cache_off'] - если параметр установлен - данные не кэшируются

 <?php
 $lists = & singleton('lists');
 
 $lists_items_id = 4;
 
 $row = $lists->GetListItem($lists_items_id);
 
 // Распечатаем результат
 print_r($row);
 ?>

Возвращает

ассоциативный массив с данными об элементе списка или false, если элемент не найден

[ Наверх ]

lists::GetListItemIfIssetValue

GetListItemIfIssetValue( int $lists_id, string $list_item_value );

Описание

Проверка наличия значения в списке

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

$lists_id

идентификатор списка

$list_item_value

значение элемента списка

 <?php
 $lists = & singleton('lists');
 
 $lists_id = 4;
 $list_item_value = 'Значение элемента';
 
 $row = $lists->GetListItemIfIssetValue($lists_id, $list_item_value);
 
 // Распечатаем результат
 print_r($row);
 ?>

Возвращает

информация об элементе списка с таким значением или false, если элемента с данным значением не существует

[ Наверх ]

lists::GetListItemsById

GetListItemsById( int $lists_id, [array $param = array()] );

Описание

Получение элементов списка в виде массива

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

$lists_id

идентификатор списка

$param

ассоциативный массив параметров

bool $param['cache_off'] - если параметр установлен - данные не кэшируются
array $param['item_activity'] array массив значений активности элементов. Может содержать следующие элементы:

active - активные элементы (по умолчанию);
inactive - неактивные элементы;

 <?php
 $lists = & singleton('lists');
 
 $lists_id = 8;
 
 $array = $lists->GetListItemsById($lists_id);
 
 if (is_array($array) && count($array) > 0)
 {
     // Распечатаем результат
     foreach ($array as $row)
     {
         print_r($row);
     }
 }
 ?>

Возвращает

массив с элементами

[ Наверх ]

lists::GetListItemsValuesById

GetListItemsValuesById( int $lists_id, [ $param = array()] );

Описание

Получение элементов списка в виде resource.

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

$lists_id

идентификатор списка

array $param['item_activity'] array массив значений активности элементов. Может содержать следующие элементы:

active - активные элементы (по умолчанию);
inactive - неактивные элементы;

 <?php
 $lists = & singleton('lists');
 
 $lists_id = 8;
 
 $resource = $lists->GetListItemsValuesById($lists_id);
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

$param

Возвращает

с элементами списка или false

see

lists::GetListItemsById()

[ Наверх ]

lists::GetListsItems

GetListsItems( int $lists_id, [array $property = array()] );

Описание

Получение данных об элементах списка

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

$lists_id

идентификатор списка

$property

дополнительные свойства

$property['orderfield'] - поле сортировки, по умолчанию lists_items_order
$property['ordertype'] - направление сортировки, по умолчанию по возрастанию
$property['item_activity'] array массив значений активности элементов. Может содержать следующие элементы:

active - активные элементы (по умолчанию);
inactive - неактивные элементы;

 <?php
 $lists = & singleton('lists');
 
 $lists_id = 4;
 
 $rows = $lists->GetListsItems($lists_id);
 
 // Распечатаем результат
 print_r($rows);
 
 ?>

Возвращает

данных об элементах списка

[ Наверх ]

lists::InsertList

InsertList( $param $param );

Описание

Вставка/обновление данных о списке

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

$param

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

$param['lists_id'] идентификатор редактируемого списка
$param['list_dir_id'] идентификатор раздела
$param['lists_name'] название списка
$param['lists_description'] описание списка
$param['site_id'] идентификатор сайта, к которому относится список. По умолчанию - текущий сайт
$param['users_id'] идентификатор пользователя центра администрирования, если false (по умолчанию) - берется текущий пользователь.

Возвращает

идентификатор добавленного/измененного списка или код ошибки.
Коды ошибок: -1 - не задано название списка -2 - сайту уже принадлежит список с переданным названием

[ Наверх ]

lists::InsertListDir

InsertListDir( array $param );

Описание

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

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

$param

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

$param['list_dir_id'] идентификатор изменяемого раздела списков
$param['list_dir_parent_id'] идентификатор родительского раздела списков
$param['list_dir_name'] название раздела списков
$param['list_dir_description'] описание раздела списков
$param['site_id'] идентификатор сайта
$param['users_id'] идентификатор пользователя, если false - берется текущий пользователь

Возвращает

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

[ Наверх ]

lists::InsertListItem

InsertListItem( array $param );

Описание

Вставка/обновление данных об элементе списка

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

$param

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

$param['lists_items_id'] идентификатор изменяемого элемента списка
$param['lists_id'] идетификатор списка, к которому относится вставляемый/обновляемый элемент
$param['lists_items_value'] значение элемента списка
$param['lists_items_order'] порядок сортировки элемента списка
$param['lists_items_description'] описание элемента списка
$param['lists_items_active'] активность элемента списка (0 - неактивен, 1 - активен). По умолчанию активен

$param['users_id'] идентификатор пользователя, если false - берется текущий пользователь.

 <?php
 $lists = & singleton('lists');
 
 $param['lists_id'] = 18;
 $param['lists_items_value'] = 'Значение списка';
 $param['lists_items_order'] = 10;
 $param['lists_items_description'] = 'Описание элемента списка';
 
 $newid = $lists->InsertListItem($param);
 
 // Распечатаем результат
 if ($newid)
 {
     echo 'Элемент списка добавлен';
 }
 else
 {
     echo 'Ошибка! Элемент списка не добавлен!';
 }
 ?>

Возвращает

идентификатор вставленного/обновленного элемента списка

[ Наверх ]

lists::insert_lists

insert_lists( int $type, $lists_id $lists_id, string $lists_name, string_type $lists_description, [int $users_id = false], [ $site_id = false] );

Описание

Устаревший метод. Вставка/обновление данных о списке

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

$type

параметр, определяющий будет производиться вставка или обновление данных о списке (0 – вставка, 1 - обновление)

$lists_name

название списка

$lists_description

описание списка

$users_id

идентификатор пользователя, если false - берется текущий пользователь.

 <?php
 $lists = & singleton('lists');
 
 $type = 0;
 $lists_id = 0;
 $lists_name = 'Новый список';
 $lists_description = 'Описание списка';
 
 $newid = $lists->insert_lists($type, $lists_id, $lists_name, $lists_description);
 
 // Распечатаем результат
 if ($newid)
 {
     echo 'Список добавлен';
 }
 
 ?>

$lists_id

идентификатор списка, для которого обновляется информация. При вставке $lists_id = 0

$site_id

Возвращает

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

see

lists::InsertList()

[ Наверх ]

lists::insert_lists_items

insert_lists_items( int $type, int $lists_items_id, int $lists_id, int $lists_items_value, [int $lists_items_order = 0], [ $lists_items_description = ''], [int $users_id = false] );

Описание

Устаревший метод. Вставка/обновление данных об элементе списка

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

$type

параметр, определяющий будет производится вставка или обновление данных об элементе списка (0 – вставка, 1 - обновление)

$lists_items_id

идентификатор элемента списка, для которого обновляется информация

$lists_id

идетификатор списка, к которому относится вставляемый/обновляемый элемент

$lists_items_value

значение элемента списка

$lists_items_order

порядок сортировки для элемента списка

$users_id

идентификатор пользователя, если false - берется текущий пользователь.

 <?php
 $lists = & singleton('lists');
 
 $type = 0;
 $lists_items_id = 0;
 $lists_id = 18;
 $lists_items_value = 'Значение списка';
 $lists_items_order = 10;
 $lists_items_description = 'Описание элемента списка';
 
 $newid = $lists->insert_lists_items($type, $lists_items_id, $lists_id, $lists_items_value, $lists_items_order, $lists_items_description);
 
 // Распечатаем результат
 if ($newid)
 {
     echo 'Элемент списка добавлен';
 }
 else
 {
     echo 'Ошибка! Элемент списка не добавлен!';
 }
 ?>

$lists_items_description

Возвращает

идентификатор вставленного/обновленного элемента списка

see

lists::InsertListItem()

[ Наверх ]

lists::SelectList

SelectList( mixed $lists_id, [array $param = array()] );

Описание

Получение данных о списке

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

$lists_id

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

$param

ассоциативный массив параметров

bool $param['cache_off'] - если параметр установлен - данные не кэшируются

 <?php
 $lists = & singleton('lists');
 
 $lists_id = 4;
 
 $row = $lists->SelectList($lists_id);
 
 // Распечатаем результат
 print_r($row);
 ?>

Возвращает

массив с данными о списке или false

[ Наверх ]

lists::SelectListsItems

SelectListsItems( int $lists_id, [array $property = array()] );

Описание

Получение данных об элементах списка

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

$lists_id

идентификатор списка

$property

дополнительные свойства

$property['orderfield'] - поле сортировки, по умолчанию lists_items_order
$property['ordertype'] - направление сортировки, по умолчанию по возрастанию
$property['item_activity'] array массив значений активности элементов. Может содержать следующие элементы:

active - активные элементы (по умолчанию);
inactive - неактивные элементы;

 <?php
 $lists = & singleton('lists');
 
 $lists_id = 4;
 
 $resource = $lists->SelectListsItems($lists_id);
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

Возвращает

данных об элементах списка

[ Наверх ]

lists::select_lists_items

select_lists_items( mixed $lists_items_id );

Описание

Получение данных об элементе списка

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

$lists_items_id

идентификатор выбираемого элемента. Если идетификатор = false или идентификатор = -1 - выбираются все элементы

 <?php
 $lists = & singleton('lists');
 
 $lists_items_id = 4;
 
 $resource = $lists->select_lists_items($lists_items_id);
 
 // Распечатаем результат
 $row = mysql_fetch_assoc($resource);
 
 print_r($row);
 
 ?>

Возвращает

данные об элементе списка

[ Наверх ]

lists::ShowList

ShowList( int $lists_id, string $xsl_name, [array $external_propertys = array()] );

Описание

Отображение элементов списка. Внутренний метод

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

$lists_id

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

$xsl_name

название XSL-шаблона, используемого для отображения списка

$external_propertys

массив дополнительных парметров, добавляемых в XML

[ Наверх ]

Class lists

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

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

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

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

Методы

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

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

lists::CopyList

lists::CopyListItem

lists::DeleteListDir

lists::del_lists

lists::del_lists_items

lists::GenXml4ListItems

lists::GetAllListDirs

lists::GetAllListsForSite

lists::GetList

lists::GetListDir

lists::GetListDirPathArray

lists::GetListDirsTree

lists::GetListItem

lists::GetListItemIfIssetValue

lists::GetListItemsById

lists::GetListItemsValuesById

lists::GetListsItems

lists::InsertList

lists::InsertListDir

lists::InsertListItem

lists::insert_lists

lists::insert_lists_items

lists::SelectList

lists::SelectListsItems

lists::select_lists_items

lists::ShowList

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

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