Class lib

[Строка 14]

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

Описание

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

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

Класс модуля "Типовые динамические страницы".

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

author

Hostmake LLC

version

5.x


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


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


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


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


Методы

  • void ConvertSqlProperty()
    Конвертирование SQL-запроса, введенного для свойства типовой динамической страницы, с учетом замены заранее определенных значенией.
  • boolean CopyLib()
    Создание копии типовой динамической страницы
  • mixed DeleteLib()
    Удаление типовой динамической страницы из библиотеки страниц
  • boolean DeleteLibDir()
    Рекурсивное удаление раздела типовых динамической страниц со всеми его подразделами
  • mixed DeleteLibProperty()
    Удаление параметра типовой динамической страницы
  • результат DeleteLibPropertyListItem()
    Удаление элемента списка параметра типовой динамической страницы типа "Список"
  • mixed GetAllLibDirs()
    Получение списка директорий типовых дин. страниц
  • mixed GetAllLibProperties()
    Получение списка всех дополнительных параметров типовой динамической страницы
  • mixed GetAllLibPropertyListItems()
    Получение списка элеметов параметра типовой динамической страницы типа "Список"
  • mixed GetAllLibs()
    Получение списка типовых динамических страниц
  • mixed GetLib()
    Получение типовой динамической страницы по её идентификатору
  • mixed GetLibDir()
    Получение информации о директории типовых дин. страниц
  • array GetLibDirTree()
    Формирование дерева разделов
  • string GetLibPath()
    Получение пути к директории lib
  • array GetLibPathArray()
    Получение пути от текущего каталога типовых динамических страниц до корневого
  • mixed GetLibProperty()
    Получение информации о параметре типовой динамической страницы
  • void GetSectionPath()
    Внутренний метод возвращает путь к типовой дин. странице
  • mixed InsertLib()
    Вставка информации о типовой динамической странице
  • mixed InsertLibDir()
    Вставка/обновление информации о разделе типовых динамических страниц
  • mixed InsertLibProperty()
    Вставка информации о параметре типовой динамической страницы
  • mixed InsertLibPropertyListItem()
    Вставка/обновление элемента списка для параметра типовой динамической страницы
  • array LoadLibPropertiesValue()
    Загрузка значений параметров типовой дин. страницы для структуры
  • bool SaveLibPropertiesValue()
    Сохранение настроек типовой динамической страницы для стурктуры в файл
  • результат UpdateLibPropertyOrder()
    Обновление порядка сортировки параметра типовой дин. страницы

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


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

    lib::ConvertSqlProperty

    ConvertSqlProperty( string $sql );

    Описание

    Конвертирование SQL-запроса, введенного для свойства типовой динамической страницы, с учетом замены заранее определенных значенией.


    Список замен:
    {SITE_ID} - идентификатор текущего выбранного сайта

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

    $sql

    [ Наверх ]


    lib::CopyLib

    CopyLib( int $lib_id );

    Описание

    Создание копии типовой динамической страницы

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

    $lib_id

    идентификатор типовой дин. страницы

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_id = 1;
    5.  
    6.  $copy_result $lib->CopyLib($lib_id);
    7.  
    8.  // Распечатаем результат
    9.  if ($copy_result)
    10.  {
    11.      echo 'Типовая динамическая страница скопирована';
    12.  }
    13.  else
    14.  {
    15.      echo 'Ошибка! Типовая динамическая страница не скопирована!';
    16.  }
    17.  ?>

    [ Наверх ]


    lib::DeleteLib

    DeleteLib( int $lib_id );

    Описание

    Удаление типовой динамической страницы из библиотеки страниц

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

    $lib_id

    идентификатор типовой динамической страницы

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_id = 33;
    5.  
    6.  $result $lib->DeleteLib($lib_id);
    7.  
    8.  if ($result)
    9.  {
    10.      echo "Удаление выполнено успешно";
    11.  }
    12.  else
    13.  {
    14.      echo "Ошибка удаления";
    15.  }
    16.  ?>

    Возвращает

    результат выполнения запроса

    [ Наверх ]


    lib::DeleteLibDir

    DeleteLibDir( int $lib_dir_id );

    Описание

    Рекурсивное удаление раздела типовых динамической страниц со всеми его подразделами

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

    $lib_dir_id

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

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_dir_id = 28;
    5.  
    6.  $result $lib->DeleteLibDir($lib_dir_id);
    7.  
    8.  if ($result)
    9.  {
    10.      echo "Удаление выполнено успешно";
    11.  }
    12.  else
    13.  {
    14.      echo "Ошибка удаления";
    15.  }
    16.  ?>

    [ Наверх ]


    lib::DeleteLibProperty

    DeleteLibProperty( int $lib_property_id );

    Описание

    Удаление параметра типовой динамической страницы

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

    $lib_property_id

    идентификатор параметра типовой динамической страницы

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_property_id = 426;
    5.  
    6.  $result $lib->DeleteLibProperty($lib_property_id);
    7.  
    8.  if ($result)
    9.  {
    10.      echo "Параметр типовой динамической страницы удален";
    11.  }
    12.  else
    13.  {
    14.      echo "Ошибка! Параметр типовой динамической страницы не удален!";
    15.  }
    16.  ?>

    Возвращает

    результат выполнения запроса

    [ Наверх ]


    lib::DeleteLibPropertyListItem

    DeleteLibPropertyListItem( int $lib_property_list_id );

    Описание

    Удаление элемента списка параметра типовой динамической страницы типа "Список"

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

    $lib_property_list_id

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

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_property_list_id = 33;
    5.  
    6.  $result $lib->DeleteLibPropertyListItem($lib_property_list_id);
    7.  
    8.  if ($result)
    9.  {
    10.      echo "Удаление выполнено успешно";
    11.  }
    12.  else
    13.  {
    14.      echo "Ошибка удаления";
    15.  }
    16.  ?>

    Возвращает

    выполнения запроса

    [ Наверх ]


    lib::GetAllLibDirs

    GetAllLibDirs( [int $lib_dir_parent_id = false] );

    Описание

    Получение списка директорий типовых дин. страниц

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

    $lib_dir_parent_id

    идентификатор родительской директории, если false, то отображаются все директории

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_dir_parent_id = false;
    5.  
    6.  $resource $lib->GetAllLibDirs($lib_dir_parent_id);
    7.  
    8.  // Распечатаем результат
    9.  while($row mysql_fetch_assoc($resource))
    10.  {
    11.      print_r($row);
    12.  }
    13.  ?>

    Возвращает

    результат выборки

    [ Наверх ]


    lib::GetAllLibProperties

    GetAllLibProperties( int $lib_id );

    Описание

    Получение списка всех дополнительных параметров типовой динамической страницы

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

    $lib_id

    идентификатор типовой динамической страницы

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_id = 1;
    5.  
    6.  $resource $lib->GetAllLibProperties($lib_id);
    7.  
    8.  // Распечатаем результат
    9.  while($row mysql_fetch_assoc($resource))
    10.  {
    11.      print_r($row);
    12.  }
    13.  ?>

    Возвращает

    результат выборки

    [ Наверх ]


    lib::GetAllLibPropertyListItems

    GetAllLibPropertyListItems( [int $lib_property_id = false] );

    Описание

    Получение списка элеметов параметра типовой динамической страницы типа "Список"

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

    $lib_property_id

    идентификатор параметра типовой динамическойстраницы типа "Список", если равен false - получаем список элементов всех парметров типовых динамических страниц типа "Список"

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_property_id = 81;
    5.  
    6.  $resource $lib->GetAllLibPropertyListItems($lib_property_id);
    7.  
    8.  // Распечатаем результат
    9.  while($row mysql_fetch_assoc($resource))
    10.  {
    11.      print_r($row);
    12.  }
    13.  ?>

    Возвращает

    результат выборки

    [ Наверх ]


    lib::GetAllLibs

    GetAllLibs( [int $lib_dir_id = false] );

    Описание

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

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

    $lib_dir_id

    идентификатор родительской директории, если false, то отображаются все директории

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_dir_id = false;
    5.  
    6.  $resource $lib->GetAllLibs($lib_dir_id);
    7.  
    8.  // Распечатаем результат
    9.  while($row mysql_fetch_assoc($resource))
    10.  {
    11.      print_r($row);
    12.  }
    13.  ?>

    Возвращает

    результат выборки

    [ Наверх ]


    lib::GetLib

    GetLib( int $lib_id );

    Описание

    Получение типовой динамической страницы по её идентификатору

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

    $lib_id

    идентификатор типовой страницы

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_id = 33;
    5.  
    6.  $row $lib->GetLib($lib_id);
    7.  
    8.  // Распечатаем результат
    9.  print_r ($row);
    10.  ?>

    Возвращает

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

    [ Наверх ]


    lib::GetLibDir

    GetLibDir( int $lib_dir_id );

    Описание

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

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

    $lib_dir_id

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

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_dir_id = 15;
    5.  
    6.  $row $lib->GetLibDir($lib_dir_id);
    7.  
    8.  // Распечатаем результат
    9.  print_r ($row);
    10.  ?>

    Возвращает

    массив с информацией о директории или false

    [ Наверх ]


    lib::GetLibDirTree

    GetLibDirTree( int $lib_dir_parent_id, string $separator, [int $lib_dir_id_not_set = false] );

    Описание

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

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

    $lib_dir_parent_id

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

    $separator

    - символ (строка)-разделитель

    $lib_dir_id_not_set

    lib_dir_id_not_set - идентификатор группы, которая не включается в дерево вместе с потомками. Необязательный параметр.

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_dir_parent_id = 15;
    5.  $separator '';
    6.  
    7.  $row $lib->GetLibDirTree($lib_dir_parent_id$separator);
    8.  
    9.  // Распечатаем результат
    10.  print_r ($row);
    11.  ?>

    Возвращает

    массив с данными о дереве разделов типовых дин. страниц

    [ Наверх ]


    lib::GetLibPath

    GetLibPath( int $lib_id );

    Описание

    Получение пути к директории lib

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

    $lib_id

    Идентификатор типовой динамической страницы

    Возвращает

    путь к файлу

    [ Наверх ]


    lib::GetLibPathArray

    GetLibPathArray( int $lib_dir_id, [ $first_call = true] );

    Описание

    Получение пути от текущего каталога типовых динамических страниц до корневого

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

    $lib_dir_id

    идентификатор узла

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_dir_id = 28;
    5.  
    6.  $row $lib->GetLibPathArray($lib_dir_id);
    7.  
    8.  // Распечатаем результат
    9.  print_r ($row);
    10.  ?>

    $first_call

    Возвращает

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

    [ Наверх ]


    lib::GetLibProperty

    GetLibProperty( int $lib_property_id );

    Описание

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

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

    $lib_property_id

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

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_property_id = 95;
    5.  
    6.  $row $lib->GetLibProperty($lib_property_id);
    7.  
    8.  // Распечатаем результат
    9.  print_r ($row);
    10.  ?>

    Возвращает

    информация о параметре типовой динамической страниы или false

    [ Наверх ]


    lib::GetSectionPath

    GetSectionPath( int $lib_dir_id );

    Описание

    Внутренний метод возвращает путь к типовой дин. странице

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

    $lib_dir_id

    идентификатор директории или типовой дин. страницы

    [ Наверх ]


    lib::InsertLib

    InsertLib( array $param );

    Описание

    Вставка информации о типовой динамической странице

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

    $param

    список доп. параметров

    • int $param['lib_id'] идентификатор динамической страницы
    • int $param['lib_dir_id'] идентификатор раздела динамической страницы
    • string $param['lib_name'] название страницы
    • string $param['lib_description'] описание страницы
    • string $param['lib_module'] код динамической страницы (берем из файла)
    • string $param['lib_module_config'] код настроек динамической страницы (берем из файла)
    • int $param['users_id'] идентификатор пользователя, если false - берется текущий пользователь
      1.  <?php
      2.  $lib = new lib();
      3.  
      4.  $param['lib_dir_id'= 27;
      5.  $param['lib_name''newlib';
      6.  $param['lib_description''Тестовая типовая динамическая страница';
      7.  
      8.  $newid $lib->InsertLib($param);
      9.  
      10.  // Распечатаем результат
      11.  echo $newid;
      12.  ?>

    Возвращает

    идентификатор вставленной страницы или false

    [ Наверх ]


    lib::InsertLibDir

    InsertLibDir( array $param );

    Описание

    Вставка/обновление информации о разделе типовых динамических страниц

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

    $param

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

    • int $param['lib_dir_id'] идентификатор раздела динамической страницы
    • int $param['lib_dir_parent_id'] идентификатор родителя раздела динамической страницы
    • int $param['lib_dir_name'] название раздела
    • int $param['users_id'] идентификатор пользователя, если false - берется текущий пользователь
      1.  <?php
      2.  $lib = new lib();
      3.  
      4.  $param['lib_dir_parent_id'= 15;
      5.  $param['lib_dir_name''New';
      6.  
      7.  $newid $lib->InsertLibDir($param);
      8.  
      9.  // Распечатаем результат
      10.  if ($newid)
      11.  {
      12.      echo 'Раздел типовых динамических страниц добавлен';
      13.  }
      14.  else
      15.  {
      16.      echo 'Ошибка! Раздел типовых динамических страниц не добавлен!';
      17.  }
      18.  ?>

    Возвращает

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

    [ Наверх ]


    lib::InsertLibProperty

    InsertLibProperty( array $param );

    Описание

    Вставка информации о параметре типовой динамической страницы

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

    $param

    список доп. параметров

    • int $param['lib_property_id'] идентификатор параметра динамической страницы
    • int $param['lib_id'] идентификатор динамической страницы
    • string $param['lib_property_name'] название параметра динамической страницы
    • string $param['lib_property_description'] описание параметра динамической страницы
    • string $param['lib_property_varible_name'] название переменной параметра динамической страницы
    • int $param['lib_property_type'] тип свойства параметра динамической страницы
    • string $param['lib_property_default_value'] значение по умолчанию параметра динамической страницы
    • int $param['lib_property_order'] порядок сортировки параметра динамической страницы
    • int $param['lib_property_sql_request'] параметр типовой дин. страницы - SQL запрос, текст запроса
    • int $param['lib_property_sql_caption_field'] параметр типовой дин. страницы - SQL запрос, поле заголовка
    • int $param['lib_property_sql_value_field'] параметр типовой дин. страницы - SQL запрос, поле значения
    • int $param['users_id'] идентификатор пользователя, если false - берется текущий пользователь
      1.  <?php
      2.  $lib = new lib();
      3.  
      4.  $param['lib_id'= 34;
      5.  $param['lib_property_name''Новый параметр';
      6.  $param['lib_property_varible_name''test_param';
      7.  $param['lib_property_type'= 0;
      8.  $param['lib_property_default_value''Значение по умолчанию';
      9.  $param['lib_property_order'= 10;
      10.  
      11.  $newid $lib->InsertLibProperty($param);
      12.  
      13.  // Распечатаем результат
      14.  echo $newid;
      15.  ?>

    Возвращает

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

    [ Наверх ]


    lib::InsertLibPropertyListItem

    InsertLibPropertyListItem( array $param );

    Описание

    Вставка/обновление элемента списка для параметра типовой динамической страницы

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

    $param

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

    • int $param['lib_property_id'] идентификатор параметра типовой дин. страницы
    • int $param['lib_property_list_id'] идентификатор элемента списка
    • string $param['lib_property_list_name'] название элемента списка
    • string $param['lib_property_list_value'] значение элемента списка
    • int $param['$lib_property_list_order'] порядок сортировки элемента списка
    • int $param['users_id'] идентификатор пользователя, если false - берется текущий пользователь
      1.  <?php
      2.  $lib = new lib();
      3.  
      4.  $param['lib_property_id'= 439;
      5.  $param['lib_property_list_name''Вариант 1';
      6.  $param['lib_property_list_value''1';
      7.  
      8.  $param['$lib_property_list_order'= 0;
      9.  
      10.  $newid $lib->InsertLibPropertyListItem($param);
      11.  
      12.  // Распечатаем результат
      13.  if ($newid)
      14.  {
      15.      echo 'Элемент списка для параметра типовой динамической страницы добавлен';
      16.  }
      17.  else
      18.  {
      19.      echo 'Ошибка! Элемент списка для параметра типовой динамической страницы не добавлен!';
      20.  }
      21.  ?>

    Возвращает

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

    [ Наверх ]


    lib::LoadLibPropertiesValue

    LoadLibPropertiesValue( int $lib_id, int $structure_id );

    Описание

    Загрузка значений параметров типовой дин. страницы для структуры

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

    $lib_id

    идентификатор типовой динамической страницы

    $structure_id

    идентификатор структуры

    Возвращает

    массив с данными в виде 'Имя_переменной' => 'значение'

    [ Наверх ]


    lib::SaveLibPropertiesValue

    SaveLibPropertiesValue( int $lib_id, int $structure_id, array $values );

    Описание

    Сохранение настроек типовой динамической страницы для стурктуры в файл

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

    $lib_id

    идентификатор типовой динамической страницы

    $structure_id

    идентификатор структуры

    $values

    массив с данными в виде 'Имя_переменной' => 'значение'

    [ Наверх ]


    lib::UpdateLibPropertyOrder

    UpdateLibPropertyOrder( int $lib_property_id, int $lib_property_order );

    Описание

    Обновление порядка сортировки параметра типовой дин. страницы

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

    $lib_property_id

    идентификатор параметра типовой дин. страницы

    $lib_property_order

    порядок сортировки

    1.  <?php
    2.  $lib = new lib();
    3.  
    4.  $lib_property_id = 91;
    5.  $lib_property_order = 65;
    6.  
    7.  $result $lib->UpdateLibPropertyOrder($lib_property_id$lib_property_order);
    8.  
    9.  // Распечатаем результат
    10.  if ($result)
    11.  {
    12.      echo 'Порядок сортировки параметра типовой динамической страницы изменен';
    13.  }
    14.  else
    15.  {
    16.      echo 'Ошибка! Порядок сортировки параметра типовой динамической страницы не изменен!';
    17.  }
    18.  ?>

    Возвращает

    запроса

    [ Наверх ]



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

  • $mas_lib_dir = array() [Строка 17]
  • Data type: mixed

  • $section_path =  '' [Строка 16]
  • Data type: mixed


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