Просмотр исходного текста страницы Описание класса redirects

[[category:Вопросы и уроки разработки сайтов на UMI.CMS]]

'''Описание класса:''' Класс служит для управления редиректами (перенаправлениями) в системе, записи которых находятся в таблице `cms3_redirects` базы данных. Класс является синглтоном, экземпляр класса можно получить через статический метод getInstance(). Исходный код класса находится в файле classes\system\subsystems\redirects\redirects.php<br/><br/>
'''Описание методов класса redirects:'''
<ul>
  <li><span style="color:blue">getInstance()</span> - Получить экземпляр коллекции
  <p>'''Параметры:''' </p>
  <p>'''Результат:''' экземпляр класса redirects</p>
  <hr>
  </li>
  
  <li><span style="color:blue">add($source, $target, $status = 301)</span> - Добавить новое перенаправление
  <p>'''Параметры:''' <br/> 
 String<span style="color:blue"> $source</span>:
адрес страницы, с которой осуществляется перенаправление<br/>
String <span style="color:blue">$target</span>: адрес целевой страницы<br/>
Integer <span style="color:blue">$status = 301</span>:
статус перенаправления<br/>
</p>
  <p>'''Результат:''' не возвращает значения</p>
  <hr>
  </li>
   
  <li><span style="color:blue">getRedirectsIdBySource($source)</span> - Получить список перенаправлений со страницы $source
  <p>'''Параметры:''' <br/> 
 String <span style="color:blue">$source</span>:
адрес страницы, с которой осуществляется перенаправление<br/>
</p>
  <p>'''Результат:''' Массив перенаправлений</p>
  <hr>
  </li>

  <li><span style="color:blue">getRedirectIdByTarget($target)</span> - Получить перенаправление по целевому адресу
  <p>'''Параметры:''' <br/> 
 String <span style="color:blue">$target</span>:
адрес целевой страницы<br/>
</p>
  <p>'''Результат:''' Массив перенаправлений</p>
  <hr>
  </li>

  <li><span style="color:blue">del($id)</span> - Удалить перенаправление
  <p>'''Параметры:''' <br/> 
 Integer <span style="color:blue">$id</span>:
id перенаправления<br/>
</p>
  <p>'''Результат:''' не возвращает значения</p>
  <hr>
  </li>

   <li><span style="color:blue">redirectIfRequired($currentUri)</span> - Сделать перенаправление, если url есть в таблице перенаправлений
  <p>'''Параметры:''' <br/> 
 String <span style="color:blue">$currentUri</span>:
url для поиска<br/>
</p>
  <p>'''Результат:''' Редирект в случае успеха</p>
  <hr>
  </li>

   <li><span style="color:blue">init()</span> - Инициализировать события
  <p>'''Параметры:''' </p>
  <p>'''Результат:''' Инициализировать события для точек вызова systemModifyElement и systemMoveElement модуля "Структура"</p>
  <hr>
  </li>

</ul>