Описание класса redirects

Материал из Umicms
Перейти к:навигация, поиск


Описание класса: Класс служит для управления редиректами (перенаправлениями) в системе, записи которых находятся в таблице `cms3_redirects` базы данных. Класс является синглтоном, экземпляр класса можно получить через статический метод getInstance(). Исходный код класса находится в файле classes\system\subsystems\redirects\redirects.php

Описание методов класса redirects:

  • getInstance() - Получить экземпляр коллекции

    Параметры:

    Результат: экземпляр класса redirects


  • add($source, $target, $status = 301) - Добавить новое перенаправление

    Параметры:
    String $source: адрес страницы, с которой осуществляется перенаправление
    String $target: адрес целевой страницы
    Integer $status = 301: статус перенаправления

    Результат: не возвращает значения


  • getRedirectsIdBySource($source) - Получить список перенаправлений со страницы $source

    Параметры:
    String $source: адрес страницы, с которой осуществляется перенаправление

    Результат: Массив перенаправлений


  • getRedirectIdByTarget($target) - Получить перенаправление по целевому адресу

    Параметры:
    String $target: адрес целевой страницы

    Результат: Массив перенаправлений


  • del($id) - Удалить перенаправление

    Параметры:
    Integer $id: id перенаправления

    Результат: не возвращает значения


  • redirectIfRequired($currentUri) - Сделать перенаправление, если url есть в таблице перенаправлений

    Параметры:
    String $currentUri: url для поиска

    Результат: Редирект в случае успеха


  • init() - Инициализировать события

    Параметры:

    Результат: Инициализировать события для точек вызова systemModifyElement и systemMoveElement модуля "Структура"