API системы управления сайтом Playmaks
Классы библиотеки conf.dll
Материал по api в стадии написания
Класс CONFPM
ability_to_move_lower_branc
библиотека conf.dll
класс confpm
Проверка возможности увеличить ранг параметра в наборе одноименных параметров одного родителя
ability_to_move_lower_Branc(id, namepar)
Параметры
id string - уникальный номер объекта (значение поля id в системной таблице).
namepar string - имя параметра.
Возвращаемое значение
Boolean
Логическое значение True если увеличение возможно
См. также
ability_to_move_pickup_branc
библиотека conf.dll
класс confpm
Проверка возможности уменьшить ранг параметра в наборе одноименных параметров одного родителя
ability_to_move_pickup_branc(id, namepar)
Параметры
id string - уникальный номер объекта (значение поля id в системной таблице).
namepar string - имя параметра.
Возвращаемое значение
Boolean
Логическое значение True если уменьшение возможно
См. также
AddParametr
библиотека conf.dll
класс confpm
Создание нового параметра в реестре системы. Ранг создаваемого параметра устанавливается как наивысший из существующих в родительской ветке + 1
AddParametr(pid, namePar, idUser)
AddParametr(pid, namePar, valuePar, deskPar, idUser)
Параметры
pid string - ID параметра родителя
namePar string - Имя создаваемого параметра.
valuePar string - Основное значение создаваемого параметра.
deskPar string - Дополнительное значение (описание) создаваемого параметра.
idUser string - id пользователя создателя.
См. также
chekID
библиотека conf.dll
класс confpm
Проверка наличия дочернего параметра в родителе по имени (по имени и значению)
chekID(pid, namepar)
chekID(pid, namepar, valpar)
Параметры
pid string - id родительского параметра.
namepar string - имя параметра.
valpar string - значение параметра.
Возвращаемое значение
Boolean
Логическое значение True если параметр найден.
См. также
chekID_name_descr
библиотека conf.dll
класс confpm
Проверка наличия дочернего параметра в родителе по имени и описанию
chekID_name_descr(pid, namepar, description)
Параметры
pid string - id родительского параметра.
namepar string - имя параметра.
description string - описание параметра.
Возвращаемое значение
Boolean
Логическое значение True если параметр найден.
См. также
ChangePartOfTextSysDesr
библиотека conf.dll
класс confpm
Запускает процесс замещения части текста в системной таблице в поле описания (используется для быстрого изменения url адресов ссылок при изменении адреса страницы)
ChangePartOfTextSysDesr(replaceable, substitutional)
Параметры
replaceable string - заменяемая строка
substitutional string - заменяющая строка.
См. также
ChangePartOfTextSysVal
библиотека conf.dll
класс confpm
Запускает процесс замещения части текста в системной таблице в поле значения (используется для быстрого изменения url адресов ссылок при изменении адреса страницы)
ChangePartOfTextSysVal(replaceable, substitutional)
Параметры
replaceable string - заменяемая строка
substitutional string - заменяющая строка.
См. также
CheckNodeAvailability
библиотека conf.dll
класс confpm
Проверка наличия узла реестра (записи в системной таблице) по ID
CheckNodeAvailability(nodeId)
Параметры
nodeId string - ID узла реестра (записи в системной таблицы)
Возвращаемое значение
Boolean
Логическое значение True если узел найден.
См. также
CopyParametr
библиотека conf.dll
класс confpm
Копирование дочерних элементов параметра
CopyParametr(sourceID, receiverID, userID)
Параметры
sourceID string - id исходного параметра.
receiverID string - id принимающего параметра.
userID string - id пользователя инициатора.
См. также
CountRowsDB
библиотека conf.dll
класс confpm
Количество строк в системной таблице
CountRowsDB()
Возвращаемое значение
Integer
Количество строк
См. также
DelNode
библиотека conf.dll
класс confpm
Удаление узла реестра (записи в системной таблице) по ID записи.
Удаляется любая запись со всеми дочерними записями, кроме корневых разделов справочников (параметры c именами "directory" и "directory_sys") и содержимого справочника системных настроек "directory_sys".
DelNode(id)
Параметры
id string id записи в системной таблице
См. также
DelNodesArr
библиотека conf.dll
класс confpm
Удаление узлов по ID из массива.
Удаляются любые записи со всеми дочерними записями, кроме корневых разделов справочников (параметры c именами "directory" и "directory_sys") и содержимого справочника системных настроек "directory_sys".
DelNodesArr(arrID)
Параметры
arrID string массив ID записей в виде строки с разделителем "|"
См. также
FindLostNodes
библиотека conf.dll
класс confpm
Получить массив дочерних узлов без родителей.
Производится поиск записей в реестре (системной таблицы) не имеющих реальной ссылки на родителя. Такие узлы не принадлежат ни к одной из веток реестра и считаются потерянными.
FindLostNodes()
Возвращаемое значение
string массив ID записей в виде строки с разделителем "|"
См. также
getArrAllIDForName
библиотека conf.dll
класс confpm
Получить массив ID всех записей в реестре (системной таблице) по имени
getArrAllIDForName(name)
Параметры
name String Имя параметра (записи)
Возвращаемое значение
String
Строковой массив ID записей с разделителем "|"
См. также
getArrAllIDForNameAndDescr
библиотека conf.dll
класс confpm
Получить массив ID всех записей в реестре (системной таблице) по имени и описанию
getArrAllIDForNameAndDescr(name, descript)
Параметры
name String Имя параметра (записи)
descript String Описание параметра (записи)
Описание или дополнительное значение - поле параметра (узла) c именем "description"
Возвращаемое значение
String
Строковой массив ID записей с разделителем "|"
См. также
getArrAllIDForNameAndPid
библиотека conf.dll
класс confpm
Получить массив ID всех записей в реестре (системной таблице) по имени и родителю
getArrAllIDForNameAndPid(name, pid)
Параметры
name String Имя параметра (записи)
pid String ID узла родителя
Возвращаемое значение
String
Строковой массив ID записей с разделителем "|"
См. также
getArrAllIDForNameAndVal
библиотека conf.dll
класс confpm
Получить массив ID всех записей в реестре (системной таблице) по имени и значению
getArrAllIDForNameAndVal(name, value)
Параметры
name String Имя параметра (записи)
value String Значение параметра
Возвращаемое значение
String
Строковой массив ID записей с разделителем "|"
См. также
getArrAllIDForNameAndValAndDescr
библиотека conf.dll
класс confpm
Получить массив ID всех записей в реестре (системной таблице) по имени, значению и описанию
getArrAllIDForNameAndValAndDescr(name, value, descript)
Параметры
name String Имя параметра (записи)
value String Значение параметра
descript String Описание параметра
Возвращаемое значение
String
Строковой массив ID записей с разделителем "|"
См. также
getArreyDescription
библиотека conf.dll
класс confpm
Получить массив значений описаний всех дочерних записей в узле родителя реестра (системной таблице)
3 - перегрузки
getArreyDescription(pid)
getArreyDescription(pid,name)
getArreyDescription(pid,name,value)
Параметры
pid String ID родительского узла
name String Имя отбираемых параметров
value String Значение отбираемых параметров
Возвращаемое значение
String
Строковой массив значений описаний записей с разделителем "|"
См. также
getArreyID
библиотека conf.dll
класс confpm
Получить массив ID всех дочерних записей в узле родителя реестра (системной таблице)
3 - перегрузки
getArreyID(pid)
getArreyID(pid,name)
getArreyID(pid,name,value)
Параметры
pid String ID родительского узла
name String Имя отбираемых параметров
value String Значение отбираемых параметров
Возвращаемое значение
String
Строковой массив ID записей с разделителем "|"
См. также
getArreyValue
библиотека conf.dll
класс confpm
Получить массив значений всех дочерних записей в узле родителя реестра (системной таблице)
2 - перегрузки
getArreyValue(pid)
getArreyID(pid, name)
Параметры
pid String ID родительского узла
name String Имя отбираемых параметров
Возвращаемое значение
String
Строковой массив значений записей с разделителем "|"
См. также
getArrPageId
библиотека conf.dll
класс confpm
Получить массив ID всех страниц сайта в реестре (системной таблице)
getArrPageId()
Возвращаемое значение
String
Строковой массив ID страниц с разделителем "|"
См. также
getArrRazdel
библиотека conf.dll
класс confpm
Получить массив ID всех разделов сайта в реестре (системной таблице)
getArrRazdel()
Возвращаемое значение
String
Строковой массив ID разделов с разделителем "|"
См. также
getArrStyleId
библиотека conf.dll
класс confpm
Получить массив ID всех стилей сайта в реестре (системной таблице)
getArrStyleId()
Возвращаемое значение
String
Строковой массив ID стилей с разделителем "|"
См. также
getArrTemplateId
библиотека conf.dll
класс confpm
Получить массив ID всех шаблонов сайта в реестре (системной таблице)
getArrTemplateId()
Возвращаемое значение
String
Строковой массив ID шаблонов с разделителем "|"
См. также
getAuthorId
библиотека conf.dll
класс confpm
Получить ID автора записи в реестре (системной таблице) по ID записи
getAuthorId(id)
Параметры
id String ID записи в реестре (системной таблице)
Возвращаемое значение
String
ID пользователя сайта, создателя записи.
См. также
getBODY
библиотека conf.dll
класс confpm
Получить HTML код (текст) страницы
getBODY(pageID, strServer, strURl, userID, sessionID, clientIP)
Параметры
pageID String ID страницы
strServer String Имя WEB сервера
strURl String Строка URL адреса
userID String ID пользователя
sessionID String ID сессии
clientIP String IP клиента
Возвращаемое значение
String
HTML код страницы
См. также
getCountChilds
библиотека conf.dll
класс confpm
Получить количество дочерних узлов (записей) в родительском узле
getCountChilds(pid)
Параметры
pid String ID родительского узла
Возвращаемое значение
Integer
Количество дочерних узлов.
См. также
getCountLostNodes
библиотека conf.dll
класс confpm
Получить количество узлов (записей) не имеющих родительского узла
getCountLostNodes()
Возвращаемое значение
Integer
Количество потерянных узлов
См. также
getDescription
библиотека conf.dll
класс confpm
Получить описание (второе значение) параметра (узла) по ID записи
getDescription(id)
Параметры
id String ID записи в реестре (системной таблице)
Возвращаемое значение
String
Описание (второе значение) параметра (узла).
См. также
getID
библиотека conf.dll
класс confpm
Получить ID параметра (узла) в реестра (системной таблице)
4 - перегрузки
getID(pid,namepar)
getID(pid,namepar, valpar)
getID(pid,namepar, valpar, descript)
getID(pid,namepar, valpar, descript, rang)
Параметры
pid String ID родительского узла (записи) в реестре (системной таблице)
namepar String Имя узла (записи) в реестре (системной таблице)
valpar String Значение узла (записи) в реестре (системной таблице)
descript String Описание (второе значение) параметра (узла).
rang String Порядковый ранг параметра (узла) в ветке родителя.
Возвращаемое значение
String
ID параметра (узла) подходящего под входящие условия.
См. также
getIDBreadCrumbs
библиотека conf.dll
класс confpm
Получить массив id узлов от дочернего узла до указанного предка в строку
getIDBreadCrumbs(rootID, selID)
Параметры
selID String ID дочернего узла
rootID String ID корневого предка
Возвращаемое значение
String
Строковой массив ID узлов с разделителем "|"
См. также
getIdDirectory
библиотека conf.dll
класс confpm
Получить ID справочника в реестра (системной таблице) по имени справочника
getIdDirectory(nameDir)
Параметры
nameDir String Имя справочника (допустимые имена: "users", "аccess_groups", "styles", "templates", "static_content", "menu", "modules", "pages", "partitions", "mpages", "plugin_lid", "gmetategs", "metategs", "scripts", "links")
Возвращаемое значение
String
ID записи (узла) справочника.
См. также
getIdDirectorySys
библиотека conf.dll
класс confpm
Получить ID системного справочника в реестра (системной таблице)
getIdDirectorySys()
Возвращаемое значение
String
ID записи (узла) системного справочника.
См. также
getIDfromRANG
библиотека conf.dll
класс confpm
Получить ID записи по родителю и рангу
getIDfromRANG(pid, rang)
Параметры
pid String Id родительского узла
rang Integer Номер позиции в родительской ветке
Возвращаемое значение
String
ID записи (узла) справочника.
См. также
getIdIndex
библиотека conf.dll
класс confpm
Получить ID индекса статьи по ID страницы
getIdIndex(pageID)
Параметры
pageID String Id страницы
Возвращаемое значение
String
ID записи индекса статьи.
См. также
getIdInFullBrancForName
библиотека conf.dll
класс confpm
Получения массива id всех дочерних узлов с одним именем по родительскому id
getIdInFullBrancForName(PID, namepar)
Параметры
PID String Id родительского узла
namepar String Имя параметра
Возвращаемое значение
String
Строковой массив ID узлов. Разделитель |.
См. также
getIdInFullBrancForNameAndVal
библиотека conf.dll
класс confpm
Получения массива id всех дочерних узлов с одним именем и значением по родительскому id
getIdInFullBrancForNameAndVal(PID, namepar, value)
Параметры
PID String Id родительского узла
namepar String Имя параметра
value String Значение параметра
Возвращаемое значение
String
Строковой массив ID узлов. Разделитель |.
См. также
getIdRazdel
библиотека conf.dll
класс confpm
Получить ID раздела
getIdRazdel(path)
Параметры
path String Полное имя раздела (с путем)
Возвращаемое значение
String
ID записи раздела.
См. также
getIndexTabName
библиотека conf.dll
класс confpm
Получить имя таблицы индексирования статей. Проверка наличия и при отсутствие создание.
getIndexTabName()
Возвращаемое значение
String
Имя таблицы индексирования статей.
См. также
getLastRang
библиотека conf.dll
класс confpm
Получить наивысший ранг в ветке родителя
GetLastRang(pid)
Параметры
pid String Id родительского узла
Возвращаемое значение
String
Значение наивысшего ранга.
См. также
getModData
библиотека conf.dll
класс confpm
Дата последнего изменения записи
getModData(id)
Параметры
id String Id записи
Возвращаемое значение
String
Дата последнего изменения записи
См. также
getName
библиотека conf.dll
класс confpm
Получить имя параметра (узла) по id в реестра
getName(id)
Параметры
id String Id записи
Возвращаемое значение
String
Имя параметра
См. также
getNewRang
библиотека conf.dll
класс confpm
Получить ранг для нового узла
getNewRang(id)
Параметры
pid String ID родительского узла
Возвращаемое значение
Integer
Доступный ранг
См. также
getPathMod
библиотека conf.dll
класс confpm
Получить путь расположения плагинов
getPathMod()
Возвращаемое значение
String
Строка пути
См. также
getPID
библиотека conf.dll
класс confpm
Получить id родительского узла
getPID(id)
Параметры
id String ID параметра
Возвращаемое значение
String
ID родительского узла
См. также
getRANG
библиотека conf.dll
класс confpm
Получить позицию (ранг) параметра
getRANG(id)
Параметры
id String ID параметра
Возвращаемое значение
String
Позиция (ранг) параметра
См. также
getUniqueNamesInBranch
библиотека conf.dll
класс confpm
Получить массив уникальных имен в ветке
getUniqueNamesInBranch(pid)
Параметры
pid String Id родительского узла
Возвращаемое значение
String
Строковой массив имен дочерних узлов (разделитель "|").
См. также
getValue
библиотека conf.dll
класс confpm
Получить значение параметра по ID
getValue(id)
Параметры
id String Id узла (параметра)
Возвращаемое значение
String
Значение параметра.
См. также
getValueInFullBrancForName
библиотека conf.dll
класс confpm
Получить строку массив значений одноименных параметров из всех дочерних ветвях
getValueInFullBrancForName(pid,namepar)
Параметры
pid String ID родительского узла
namepar String Общее имя параметра
Возвращаемое значение
String
Строка значений с разделителями |
См. также
lowerBranc
библиотека conf.dll
класс confpm
Увеличить ранг параметра в родительской ветке
lowerBranc(id)
lowerBranc(id, namePar )
Параметры
id string - ID параметра
namePar string - Имя параметра. При указании имени параметра, ранг будет увеличен только среди одноименных параметров.
См. также
pickupBranc
библиотека conf.dll
класс confpm
Уменьшить ранг параметра в родительской ветке
pickupBranc(id)
pickupBranc(id, namePar )
Параметры
id string - ID параметра
namePar string - Имя параметра. При указании имени параметра, ранг будет уменьшен только среди одноименных параметров.