articleCatalog

Класс для работы с каталогами статей

Переменные

Переменные отсутсвуют

Методы

void __call ()
void dropCache () Сбрасывает кеш информации о каталогах статей
mixed getDevName ({ [id] }) Возвращает devName каталога статей
mixed getId ({ [devName], [urlName] }) Возвращает id каталога статей
mixed getImage ({ [id] }) Возвращает путь к изображению каталога статьи
mixed getLevel ({ [id] }) Возвращает уровень вложенности каталога статей
array getList ({ [id], [pageNumber], [amount], [af], [orderType] }) Возвращает список каталогов статьи
mixed getMetaDescription ({ [id] }) Возвращает metaDescription каталога статей
mixed getMetaDescription2 ({ [id] }) Возвращает metaDescription каталога статей
mixed getMetaKeywords ({ [id] }) Возвращает metaKeywords каталога статей
mixed getMetaTitle ({ [id] }) Возвращает metaTitle каталога статей
mixed getMetaTitle2 ({ [id] }) Возвращает metaTitle2 каталога статей
object getNew () Возвращает новую копию класса
mixed getPageTitle ({ [id] }) Возвращает pageTitle каталога статей
mixed getParentId ({ [id] }) Возвращает id родительского каталога статьи
mixed getParents ({ [id] }) Возвращает информацию о всех родителях каталога статей.
mixed getTitle ({ [id] }) Возвращает наименование каталога статей
void getUrl ({ [id] }) Возвращает url каталога статей
mixed getUrlName ({ [id] }) Возвращает urlName каталога статей (deprecated)
mixed hasArticle ({ [id] }) Проверяет существование статей в данном каталоге статей
mixed hasChild ({ [id] }) Проверяет существование дочерних каталогов статей
mixed init ({ id }) Инициализация класса
mixed isExist ({ [id], [devName], [urlName] }) Проверяет существование каталога статей
mixed set ({ id, name, value }) Устанавливает значение

__call

Примеры кода




dropCache

Сбрасывает кеш информации о каталогах статей

Возвращаемые значения

void

Примеры кода




getDevName

Синоним: devName
Возвращает devName каталога статей

Параметры

[id] int Id каталога статей

Возвращаемые значения

string Имя для разработчика
bool False - в случае ошибки

Примеры кода




getId

Синоним: id
Возвращает id каталога статей

Параметры

[devName] string DevName каталога статей
[urlName] string UrlName каталога статей (deprecated)

Возвращаемые значения

int Id каталога статей
bool False - в случае ошибки

Примеры кода




getImage

Синоним: image
Возвращает путь к изображению каталога статьи

Параметры

[id] int Id каталога статьи

Возвращаемые значения

string Путь к изображению каталога статьи
bool False - в случае ошибки

Примеры кода




getLevel

Синоним: level
Возвращает уровень вложенности каталога статей

Параметры

[id] int Id каталога статей

Возвращаемые значения

int Уровень вложенности каталога статей
bool False - в случае ошибки

Примеры кода




getList

Синоним: list
Возвращает список каталогов статьи

Параметры

[id] int Id каталога статьи. По умолчанию: 0 (все каталоги статей первого уровня)
[pageNumber] int Номер страницы. По умолчанию: 1
[amount] int Кол-во каталогов статей на странице. По умолчанию: 0 (все каталоги статей)
[af] string Список доп. полей которые нужно достать. Пример: "af_field1, af_field2" (deprecated)
[orderType] string Метод сортировки. title, position. По умолчанию: position

Возвращаемые значения

array Массив обьектов articleCatalog

Примеры кода




getMetaDescription

Синоним: metaDescription
Возвращает metaDescription каталога статей

Параметры

[id] int Id каталога статей

Возвращаемые значения

string MetaDescription каталога статей
bool False - в случае ошибки

Примеры кода




getMetaDescription2

Синоним: metaDescription2
Возвращает metaDescription каталога статей

Параметры

[id] int Id каталога статей

Возвращаемые значения

string MetaDescription2 каталога статей
bool False - в случае ошибки

Примеры кода




getMetaKeywords

Синоним: metaKeywords
Возвращает metaKeywords каталога статей

Параметры

[id] int Id каталога статей

Возвращаемые значения

string MetaKeywords каталога статей
bool False - в случае ошибки

Примеры кода




getMetaTitle

Синоним: metaTitle
Возвращает metaTitle каталога статей

Параметры

[id] int Id каталога статей

Возвращаемые значения

string MetaTitle каталога статей
bool False - в случае ошибки

Примеры кода




getMetaTitle2

Синоним: metaTitle2
Возвращает metaTitle2 каталога статей

Параметры

[id] int Id каталога статей

Возвращаемые значения

string MetaTitle2 каталога статей
bool False - в случае ошибки

Примеры кода




getNew

Синоним: new
Возвращает новую копию класса

Возвращаемые значения

object articleCatalog

Примеры кода




getPageTitle

Синоним: pageTitle
Возвращает pageTitle каталога статей

Параметры

[id] int Id каталога статей

Возвращаемые значения

string PageTitle каталога статей
bool False - в случае ошибки

Примеры кода




getParentId

Синоним: parentId
Возвращает id родительского каталога статьи

Параметры

[id] int Id каталога статей

Возвращаемые значения

int Id родительского каталога статей
bool False - в случае ошибки

Примеры кода




getParents

Синоним: parents
Возвращает информацию о всех родителях каталога статей.

Параметры

[id] int Id каталога статьи

Возвращаемые значения

array Массив обьектов articleCatalog
bool False - в случае ошибки

Примеры кода




getTitle

Синоним: title
Возвращает наименование каталога статей

Параметры

[id] int Id каталога статей

Возвращаемые значения

string Наименование каталога статей
bool False - в случае ошибки

Примеры кода




getUrl

Синоним: url
Возвращает url каталога статей
Тоже самое, что @url.get с параметрами urlType и id

Параметры

[id] int Id каталога статей

Примеры кода




getUrlName

Синоним: urlName
Возвращает urlName каталога статей (deprecated)

Параметры

[id] int Id каталога статей

Возвращаемые значения

string UrlName каталога статей
bool False - в случае ошибки

Примеры кода




hasArticle

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

Параметры

[id] int Id каталога статьи

Возвращаемые значения

bool True - если статьи существуют
bool False - если статей не существует или в случае ошибки

Примеры кода




hasChild

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

Параметры

[id] int Id каталога статей

Возвращаемые значения

bool True - если дочерние каталоги статей существуют
bool False - если дочерних каталогов статей не существует или в случае ошибки

Примеры кода




init

Инициализация класса

Параметры

id int Id каталога статьи

Возвращаемые значения

bool True - обьект инициализирован
bool False - в случае ошибки

Примеры кода




isExist

Проверяет существование каталога статей

Параметры

[id] int Id каталога статей
[devName] string DevName каталога статей
[urlName] string UrlName каталога статей (deprecated)

Возвращаемые значения

bool True - если каталог статей существует
bool False - если каталога статей не существует или в случае ошибки

Примеры кода




set

Устанавливает значение

Параметры

id int Id каталога статей
name string Имя дополнительного поля
value string Значение дополнительного поля

Возвращаемые значения

bool True - значение установленно
bool False - в случае ошибки

Примеры кода