Class documents

[Строка 14]

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

Описание

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

Класс модуля "Старницы и документы".

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

author

Hostmake LLC

version

5.x

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

$CacheGetCurrentDocumentVersion = array()
Кэш для метода GetCurrentDocumentVersion()
$documents_id_array = array()
Массив соответствия старых и новых идентификаторов скопированных документов
$mas_documents_dir = array()
Массив разделов документов
$path_array = array()

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

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

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

Методы

mixed CopyCurrentDocumentVersion()
Копирование текущей версии документа
void CopyDocuments()
Метод копирования документа
void CopyDocumentsDir()
Копирование групп документов с документами
mixed CopyDocumentStatus()
Копирование статуса документа
boolean current_version()
Метод для переобозначения текущей версии документа
boolean delete_old_version()
Метод удаления записей обо всех не текущих версиях
boolean delete_status()
Метод удаления статуса документов
boolean delete_version()
Метод удаления записей о версиях
boolean del_documents()
Удаления документов
boolean del_documents_dir()
Удаление разделов документов
mixed GetCurrentDocumentVersion()
Получение информации о текущей версии документа
mixed GetDocument()
Получение информации о документе
resource GetDocumentDir()
Получение информации о разделе документов
array GetDocumentsDirTree()
Метод формирования дерева разделов документов.
resource GetDocumentsFromDir()
Получение списка документов раздела без учета подразделов
array GetDocumentsPathArray()
Метод для построения массива пути от текущего узла к корневому. Предназначен для использования только в центре администрирования.
mixed GetDocumentVersion()
Получение информации о версии документа
string GetDocumentVersionPath()
Получение пути к файлу версии документа
array get_documents_dir()
Метод формирования дерева разделов текущего сайта
int insert_documents()
Вставка/обновление новых документов
int insert_documents_dir()
Вставка/обновления разделов документов
int insert_status()
Метод добавления(редактирования) статусов документов
int insert_version()
Метод добавления/редактирования записей о версиях
resource select_documents()
Получение информации о документе или обо всех документах.
resource select_documents_dir()
Метод выбора раздела документов
resource select_status()
Получение информации о статусе документа
resource select_version()
Метод выборки информации о версиях
void ShowDocument()
Показ текста текущей версии страницы

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

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

documents::CopyCurrentDocumentVersion

CopyCurrentDocumentVersion( int $documents_id, [ $new_document_id = 0], [ $array_template_ids = array()] );

Описание

Копирование текущей версии документа

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

$documents_id

Идентификатор документа

$new_document_id

$array_template_ids

Возвращает

int или false

[ Наверх ]

documents::CopyDocuments

CopyDocuments( int $documents_id, [ $new_site_id = false], [int $documents_dir_parent_id = -1], [bool $return_array_ids = false], [array $array_template_ids = array()], [array $array_document_status_ids = array()] );

Описание

Метод копирования документа

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

$documents_id

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

$documents_dir_parent_id

идентификатор категории, к которой необходимо отнести скопированный документ (не обязательный параметр. Если имеет значение -1 - скопированные документы кладутся в ту же директорию, что и копируемые. по умолчанию -1)

$return_array_ids

Флаг, указывающий, нужно ли запоминать соответсятвия старых и новых идентификаторов (по умолчанию - false)

$array_template_ids

Массив с соответствиями старых и новых идентификаторов (не обязательный параметр)

$array_document_status_ids

Массив с соответствиями новых и старых идентификаторов статусов документов (не обязательный параметр)

 <?php
 $documents = new documents();
 
 $documents_id = 7;
 
 $newid = $documents->CopyDocuments($documents_id);
 
 // Распечатаем результат
 echo $newid;
 ?>

$new_site_id

[ Наверх ]

documents::CopyDocumentsDir

CopyDocumentsDir( int $documents_dir_parent_id, $site_id, [ $new_site_id = false], [int $new_documents_dir_parent_id = 0], [bool $return_array_ids = false], [array $array_template_ids = array()], [array $array_document_status_ids = array()] );

Описание

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

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

$documents_dir_parent_id

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

$new_documents_dir_parent_id

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

$return_array_ids

Флаг, указывающий, нужно ли возвращать массив с соответствиями старых и новых идентификаторов фокументов (по умолчанию false)

$array_template_ids

Массив с соответствиями новых и старых идентификаторов макетов (не обязательный параметр)

$array_document_status_ids

Массив с соответствиями новых и старых идентификаторов статусов документов (не обязательный параметр)

$site_id

$new_site_id

[ Наверх ]

documents::CopyDocumentStatus

CopyDocumentStatus( int $documents_status_id, [int $new_site_id = 0] );

Описание

Копирование статуса документа

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

$documents_status_id

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

$new_site_id

Идентификатор сайта, к которому необходимо отнести скопированный статус (не обязательный параметр. Если не указан, скопированный статус будет отнесен к тому же сайту, что и копируемый)

Возвращает

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

[ Наверх ]

documents::current_version

current_version( int $documents_id, int $documents_version_id );

Описание

Метод для переобозначения текущей версии документа

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

$documents_id

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

$documents_version_id

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

 <?php
 $documents = new documents();
 $documents_id = 7;
 $documents_version_id = 20;
 $new_current_version = $documents->current_version($documents_id, $documents_version_id);
 // Распечатаем результат
 echo $new_current_version;
 ?>

[ Наверх ]

documents::delete_old_version

delete_old_version( int $documents_id );

Описание

Метод удаления записей обо всех не текущих версиях

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

$documents_id

идентификатор документа
Пример использования:

 <?php
 $documents = new documents();
 
 // Идентификатор документа
 $documents_id = 12;
 
 $result = $documents->delete_old_version($documents_id);
 
 // Распечатаем результат
 echo $result;
 ?>

Возвращает

true при удачном удалении, false - в обратном случае

[ Наверх ]

documents::delete_status

delete_status( int $status_id );

Описание

Метод удаления статуса документов

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

$status_id

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

 <?php
 $documents = new documents();
 
 // Идентификатор статуса документа
 $status_id = 3;
 
 $result = $documents->delete_status($status_id);
 
 // Распечатаем результат
 echo $result;
 
 ?>

Возвращает

истина при удачном удалении, ложь - в обратном случае

[ Наверх ]

documents::delete_version

delete_version( int $documents_version_id );

Описание

Метод удаления записей о версиях

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

$documents_version_id

идентификатор удаляемой версии
Пример использования:

 <?php
 $documents = new documents();
 
 // Идентификатор версии документа
 $documents_version_id = 28;
 
 $result = $documents->delete_version($documents_version_id);
 
 // Распечатаем результат
 echo $result;
 ?>

Возвращает

true при удачном удалении, false - в обратном случае

[ Наверх ]

documents::del_documents

del_documents( int $documents_id );

Описание

Удаления документов

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

$documents_id

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

Возвращает

true при удачном удалении, false - в обратном случае
Пример использования:

 <?php
 $documents = new documents();
 
 // Идентификатор удаляемого документа
 $documents_id = 7;
 
 $result = $documents->del_documents($documents_id);
 
 // Распечатаем результат
 echo $result;
 ?>

[ Наверх ]

documents::del_documents_dir

del_documents_dir( int $documents_dir_id );

Описание

Удаление разделов документов

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

$documents_dir_id

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

Возвращает

true при удачном удалении, false - в обратном случае
Пример использования:

 <?php
 $documents = new documents();
 // Идентификатор удаляемого раздела документов
 $documents_dir_id = 3;
 
 $result = $documents->del_documents_dir($documents_dir_id);
 
 // Распечатаем результат
 echo $result;
 ?>

[ Наверх ]

documents::GetCurrentDocumentVersion

GetCurrentDocumentVersion( int $documents_id );

Описание

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

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

$documents_id

идентификатор отображаемого документа

Возвращает

информарция о версии документа в случае успешного выполнения или false, если текущая версия не найдена
Пример использования:

 <?php
 $documents = new documents();
 
 // Идентификатор документа
 $documents_id = 12;
 
 $row = $documents->GetCurrentDocumentVersion($documents_id);
 
 // Распечатаем результат
 print_r($row);
 ?>

[ Наверх ]

documents::GetDocument

GetDocument( int $documents_id );

Описание

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

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

$documents_id

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

Возвращает

массив с информацией о документе или false
Пример использования:

 <?php
 $documents = new documents();
 
 // Идентификатор документа
 $documents_id = 12;
 
 $row = $documents->GetDocument($documents_id);
 
 // Распечатаем результат
 print_r($row);
 ?>

[ Наверх ]

documents::GetDocumentDir

GetDocumentDir( int $documents_dir_id );

Описание

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

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

$documents_dir_id

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

Возвращает

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

Пример использования:

 <?php
 $documents = new documents();
 
 // Идентификатор раздела документов
 $documents_dir_id = 4;
 
 $row = $documents->GetDocumentDir($documents_dir_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

documents::GetDocumentsDirTree

GetDocumentsDirTree( int $documents_dir_parent_id, string $separator, [ $current_group_id = false], [bool $first_call = true], [int $site_id = false] );

Описание

Метод формирования дерева разделов документов.

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

$documents_dir_parent_id

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

$separator

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

$first_call

$site_id

идентификатор сайта, необязательный параметр. Если не передан - определяется автоматически.
Пример использования:

 <?php
 $documents = new documents();
 
 // Идентификатор родительского раздела документов
 $documents_dir_parent_id = 0;
 $separator = '';
 $documents_dir_tree = $documents->GetDocumentsDirTree($documents_dir_parent_id, $separator);
 
 // Распечатаем результат
 print_r ($documents_dir_tree);
 ?>

$current_group_id

Возвращает

массив с данными о дереве разделов документов

[ Наверх ]

documents::GetDocumentsFromDir

GetDocumentsFromDir( int $documents_dir_id, [int $site_id = 0] );

Описание

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

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

$documents_dir_id

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

$site_id

идентификатор сайта (не обязательный параметр. Если не передан, или имеет значение 0, то подставляется идентификатор текущего сайта)
Пример использования:

 <?php
 $documents = new documents();
 
 // Идентификатор раздела документов
 $documents_dir_id = 0;
 
 $documents_from_dir = $documents->GetDocumentsFromDir($documents_dir_id);
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($documents_from_dir))
 {
         print_r($row);
 }
 ?>

Возвращает

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

[ Наверх ]

documents::GetDocumentsPathArray

GetDocumentsPathArray( int $documents_dir_id, [bool $first_call = true] );

Описание

Метод для построения массива пути от текущего узла к корневому. Предназначен для использования только в центре администрирования.

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

$documents_dir_id

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

$first_call

первый вызов ф-ции, по умолчанию - true
Пример использования:

 <?php
 $documents = new documents();
 
 // Идентификатор раздела документов
 $documents_dir_id = 4;
 
 $path = $documents->GetDocumentsPathArray($documents_dir_id);
 
 // Распечатаем результат
 print_r($path);
 ?>

Возвращает

массив с элементами пути группы

[ Наверх ]

documents::GetDocumentVersion

GetDocumentVersion( int $documents_version_id );

Описание

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

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

$documents_version_id

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

Возвращает

массив с данными о версии документа или false
Пример использования:

 <?php
 $documents = new documents();
 
 // Идентификатор версии документа
 $documents_version_id = 29;
 
 $row = $documents->GetDocumentVersion($documents_version_id);
 
 // Распечатаем результат
 print_r($row);
 ?>

[ Наверх ]

documents::GetDocumentVersionPath

GetDocumentVersionPath( int $documents_version_id );

Описание

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

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

$documents_version_id

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

Возвращает

путь к документу

[ Наверх ]

documents::get_documents_dir

get_documents_dir( int $documents_dir_parent_id, int $separator_dir, [int $documents_dir_id = 0] );

Описание

Метод формирования дерева разделов текущего сайта

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

$documents_dir_parent_id

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

$separator_dir

отступ для подразделов

$documents_dir_id

идентификатор раздела, который необходимо пропустить (не включать в дерево вместе с подразделами)
Пример использования:

 <?php
 $documents = new documents();
 
 $documents_dir_parent_id = 0;
 $separator_dir = '&nbsp';
 
 $documents_tree = $documents->get_documents_dir($documents_dir_parent_id, $separator_dir);
 
 // Распечатаем результат
 print_r ($documents_tree);
 ?>

Возвращает

ассоциативный массив с информацией о дереве разделов

[ Наверх ]

documents::insert_documents

insert_documents( int $type, int $documents_id, int $documents_dir_id, int $users_id, int $documents_status_id, string $documents_name, int $documents_version_id, int $version_current, int $version_comment, string $documents_text, int $templates_id, $site_id );

Описание

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

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

$type

тип действия 0 - вставка, 1 - обновление

$documents_id

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

$documents_dir_id

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

$users_id

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

$documents_status_id

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

$documents_name

наименование документа

$documents_version_id

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

$version_current

указатель на текущую версию

$version_comment

комментарий к версии документа

$documents_text

текст документа

$templates_id

идентификатор шаблона

$site_id

Возвращает

идентификатор документа
Пример использования:

 <?php
 $documents = new documents();
 
 $type = 0;
 $documents_id = 0;
 $documents_dir_id = 0;
 $users_id = false;
 $documents_status_id = 0;
 $documents_name = 'Тестовый документ';
 $documents_version_id = 0;
 $version_current = 1;
 $version_comment = 'Комментарий к версии';
 $documents_text = 'Тестовый текст';
 $templates_id = 1;
 $site_id = 1;
 
 $newid = $documents->insert_documents($type, $documents_id, $documents_dir_id, $users_id, $documents_status_id, $documents_name, $documents_version_id, $version_current, $version_comment, $documents_text, $templates_id, $site_id);
 
 // Распечатаем результат
 echo $newid;
 ?>

[ Наверх ]

documents::insert_documents_dir

insert_documents_dir( int $type, int $documents_dir_id, int $documents_dir_parent_id, string $documents_dir_name, [int $users_id = false], [int $site_id = 0] );

Описание

Вставка/обновления разделов документов

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

$type

тип действия 0 - вставка, 1 - обновление

$documents_dir_id

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

$documents_dir_parent_id

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

$documents_dir_name

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

$users_id

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

$site_id

идентификатор сайта. Если 0, то система получит текущий сайт из константы CURRENT_SITE. В противном случае можно указать ID сайта явно. по умолчанию равен 0.

Возвращает

идентификатор отредактированного (вставленного) раздела
Пример использования:

 <?php
 $documents = new documents();
 
 $type = 0;
 $documents_dir_id = '';
 $documents_dir_parent_id = 0;
 $documents_dir_name = 'Тестовый раздел';
 
 // Если 0, то система получит текущий сайт из константы CURRENT_SITE. В противном случае можно указать ID сайта явно
 $site_id = 0;
 $users_id = false;
 
 $newid = $documents->insert_documents_dir($type, $documents_dir_id, $documents_dir_parent_id, $documents_dir_name, $users_id, $site_id);
 
 // Распечатаем результат
 echo $newid;
 ?>

[ Наверх ]

documents::insert_status

insert_status( int $type, int $status_id, string_type $status_name, string $status_description, [int $users_id = false], [ $site_id = false] );

Описание

Метод добавления(редактирования) статусов документов

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

$type

тип действия 0 - вставка, 1 - обновление

$status_id

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

$status_name

наименование статуса

$status_description

описание статуса

$users_id

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

 <?php
 $documents = new documents();
 
 $type = 0;
 $status_id = '';
 $status_name = 'Новый статус';
 $status_description = 'Описание нового статуса';
 
 $newid = $documents->insert_status($type, $status_id, $status_name, $status_description);
 
 // Распечатаем результат
 echo $newid;
 ?>

$site_id

Возвращает

идентификатор нового или редатируемого статуса (в зависимости от типа действия)

[ Наверх ]

documents::insert_version

insert_version( int $type, int $documents_version_id, int $documents_id, int $version_current, string $version_comment, string $documents_text, int $users_id, int $templates_id );

Описание

Метод добавления/редактирования записей о версиях

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

$type

тип действия 0 - вставка, 1 - обновление

$documents_version_id

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

$documents_id

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

$version_current

флаг текущей версии

$version_comment

комментарий к версии

$documents_text

текст документа

$users_id

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

$templates_id

идентификатор шаблона
Пример использования:

 <?php
 $documents = new documents();
 
 $type = 0;
 $documents_version_id = '';
 $documents_id = 12;
 $version_current = 1;
 $version_comment = 'Новая версия';
 $documents_text = 'Тестовый текст';
 $users_id = '';
 $templates_id = '';
 
 $newid = $documents->insert_version($type, $documents_version_id, $documents_id, $version_current, $version_comment, $documents_text, $users_id, $templates_id);
 
 // Распечатаем результат
 echo $newid;
 ?>

Возвращает

идентификатор новой или редатируемой версии (в зависимости от типа действия)

[ Наверх ]

documents::select_documents

select_documents( int $documents_id, [ $site_id = false] );

Описание

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

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

$documents_id

идентификатор документа (-1 - выбор всех документов)

$site_id

Возвращает

реестр документов или данные о конкретном документе

see

GetDocument() <br />Пример использования: <code> <?php $documents = new documents(); // Идентификатор выбираемого документа $documents_id = 12; $resource = $documents->select_documents($documents_id); // Распечатаем результат while($row = mysql_fetch_assoc($resource)) { print_r($row); } ?> </code>

[ Наверх ]

documents::select_documents_dir

select_documents_dir( int $documents_dir_id, [ $site_id = false] );

Описание

Метод выбора раздела документов

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

$documents_dir_id

идентификатор раздела (-1 - выбор всех разделов)

$site_id

Возвращает

список всех разделов или данные о конкретном разделе
Пример использования:

 <?php
 $documents = new documents();
 // Идентификатор выбираемого раздела
 $documents_dir_id = 4;
 
 $resource = $documents->select_documents_dir($documents_dir_id);
 
 // Распечатаем результат
 $row = mysql_fetch_assoc($resource);
 print_r($row);
 ?>

[ Наверх ]

documents::select_status

select_status( int $documents_status_id, [int $site_id = false] );

Описание

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

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

$documents_status_id

идентификатор статуса (false - выбор всех статусов)

$site_id

идентификатор сайта
Пример использования:

 <?php
 $documents = new documents();
 
 // Идентификатор статуса
 $documents_status_id = 1;
 
 $resource = $documents->select_status($documents_status_id);
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
         print_r($row);
 }
 ?>

[ Наверх ]

documents::select_version

select_version( int $documents_id, int $documents_version_id, [int $current = 1] );

Описание

Метод выборки информации о версиях

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

$documents_id

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

$documents_version_id

идентификатор версии, если false - версия неизвестна. При этом текущую версию необходимо установить в 1

$current

указатель на текущую версию, по умолчанию равен 1 - выбрать текущую версию.
Пример использования:

 <?php
 $documents = new documents();
 
 $documents_id = 12;
 $documents_version_id = false;
 
 $resource = $documents->select_version($documents_id, $documents_version_id);
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
         print_r($row);
 }
 ?>

Возвращает

информация о версиях документа

[ Наверх ]

documents::ShowDocument

ShowDocument( int $document_id );

Описание

Показ текста текущей версии страницы

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

$document_id

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

 <?php
 $documents = new documents();
 
 // Идентификатор документа
 $document_id = 12;
 
 $documents->ShowDocument($document_id);
 ?>

[ Наверх ]

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

$CacheGetCurrentDocumentVersion = array() [Строка 53]
Data type: array

Описание

Кэш для метода GetCurrentDocumentVersion()

$documents_id_array = array() [Строка 46]
Data type: array

Описание

Массив соответствия старых и новых идентификаторов скопированных документов

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

Описание

Массив разделов документов

$path_array = array() [Строка 39]
Data type: mixed

Class documents

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

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

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

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

Методы

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

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

documents::CopyCurrentDocumentVersion

documents::CopyDocuments

documents::CopyDocumentsDir

documents::CopyDocumentStatus

documents::current_version

documents::delete_old_version

documents::delete_status

documents::delete_version

documents::del_documents

documents::del_documents_dir

documents::GetCurrentDocumentVersion

documents::GetDocument

documents::GetDocumentDir

documents::GetDocumentsDirTree

documents::GetDocumentsFromDir

documents::GetDocumentsPathArray

documents::GetDocumentVersion

documents::GetDocumentVersionPath

documents::get_documents_dir

documents::insert_documents

documents::insert_documents_dir

documents::insert_status

documents::insert_version

documents::select_documents

documents::select_documents_dir

documents::select_status

documents::select_version

documents::ShowDocument

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

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