Docs For Class URL

URL

Описание

Класс URL - предназначен для работы со ссылками, а также с адресной строкой.

Доступен из любой точки программы.

Реализован в виде синглтона, что исключает его дублирование. Имеет в себе реестр queryParams для хранения любых объектов.

Методы класса
string add_get() Добавляет, либо заменяет $_GET параметр в строке URL. Обычно нужен для пейджера навигации.
string clearingUrl() Чистит входящий URL и возвращает URI , аналогично методу getClearUri() только для заданного URL.
string|bool createUrl() Конвертирует русскоязычный URL в транслит.
string get() Возвращает защищенный параметр из массива $_GET.
string getClearUri() Возвращает чистый URI, без строки с get параметрами.
int getCountSections() Возвращает количество секций.
string getCutPath() Возвращает часть пути, до папки с CMS.
string getCutSection() Возвращает часть пути, до папки с CMS.
array getDataUrl() Возвращает массив составных частей ссылки.
string getDocumentRoot() Вычисляет настоящее местоположение до файла на сервере.
object - getInstance() Возвращает единственный экземпляр данного класса.
string getLastSection() Возвращает последнюю часть uri.
string getQueryParametr() Возвращает запрошенный request параметр.
string getQueryString() Возвращает запрошенную строку параметров.
string getRoute() Возвращает имя для роутера.
array getSections() Возвращает массив секций URI.
string getUri() Возвращает URI, с get параметров.
string getUrl() Возвращает ссылку с хостом и протоколом.
array|bool getUrlRedirect() Получает ссылку для редиректа, если она была указана в настройках SEO для запрашиваемой страницы.
void init() Инициализирует данный класс URL.
bool isSection() Проверяет является ли полученное значение - именем текущего раздела.
string multiLangLink() Возвращает страницу с изменеными ссылками для мультиязычности.
string parsePageUrl() Возвращает последнюю секцию URL.
string parseParentUrl() Возвращает часть url являющуюся parent_url.
string post() Возвращает защищенный параметр из $_POST массива.
string prepareUrl() Удаляет из URL все запрещенные спецсимволы.
void setQueryParametr() Устанавливает параметр в реестр URL. Можно использовать как реестр переменных.
Описание методов и примеры их использования

Метод

string add_get (string $url, string $param, [string $pvalue = ''])

Параметры

  • $url: ссылка
  • $param: параметр
  • $pvalue: значение параметра

Описание

Добавляет, либо заменяет $_GET параметр в строке URL. Обычно нужен для пейджера навигации.

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

  1.  echo URL::add_get('http://site.ru/catalog?page=2''page''4');

Метод

string clearingUrl (string $url)

Параметры

  • $url: входящая ссылка

Описание

Чистит входящий URL и возвращает URI , аналогично методу getClearUri() только для заданного URL.

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

  1.  echo URL::clearingUrl('http://site.ru/smartfony/apple-iphone-8');

Метод

string|bool createUrl (string $urlstr)

Параметры

  • $urlstr: русскоязычный url.

Описание

Конвертирует русскоязычный URL в транслит.

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

  1.   $url URL::createUrl('русский-домен.рф');

Метод

string get (string $param)

Параметры

  • $param: нужный параметр

Описание

Возвращает защищенный параметр из массива $_GET.

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

  1.   $url URL::get('id');

Метод

string getClearUri ()

Описание

Возвращает чистый URI, без строки с get параметрами.

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

  1.  echo URL::getClearUri();

Метод

int getCountSections ()

Описание

Возвращает количество секций.

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

  1.  echo URL::getCountSections();

Метод

string getCutPath ()

Описание

Возвращает часть пути, до папки с CMS.

Например если движок расположен по этому пути http://sitename.ru/shop/index.php, то метод вернет строку "/shop"

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

  1.  echo URL::getCutPath();

Метод

string getCutSection ()

Описание

Возвращает часть пути, до папки с CMS.

Например если движок расположен по этому пути http://sitename.ru/shop/index.php, то метод вернет строку "/shop"

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

  1.  echo URL::getCutSection();

Метод

array getDataUrl ([string|bool $url = false])

Параметры

  • $url: ссылка для разбивки на составные части

Описание

Возвращает массив составных частей ссылки.

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

  1.  $result URL::getDataUrl('http://site.ru/smartfony/apple-iphone-8');
  2.  viewData($result);

Метод

string getDocumentRoot ([bool $lastSep = true])

Параметры

  • $lastSep: добавляет последний слеш в конец пути

Описание

Вычисляет настоящее местоположение до файла на сервере.

Вместо этой функции можно использовать константу SITE_DIR

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

  1.  echo URL::getDocumentRoot();

Метод

string getLastSection ()

Описание

Возвращает последнюю часть uri.

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

  1.  echo URL::getLastSection();

Метод

string getQueryParametr (string $param)

Параметры

  • $param: ключ необхомиго параметра

Описание

Возвращает запрошенный request параметр.

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

  1.  echo URL::getQueryParametr('http://site.ru/integration?int=ym&name=getyml''name')// getyml

Метод

string getQueryString ()

Описание

Возвращает запрошенную строку параметров.

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

  1.  echo URL::getQueryString();

Метод

string getRoute ()

Описание

Возвращает имя для роутера.

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

  1.  echo URL::getRoute();

Метод

array getSections ([string|bool $path = false])

Параметры

  • $path: uri для разбивки

Описание

Возвращает массив секций URI.

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

  1.  $result URL::getSections('http://site.ru/smartfony/apple-iphone-8');
  2.  viewData($result);

Метод

string getUri ()

Описание

Возвращает URI, с get параметров.

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

  1.  echo URL::getUri();

Метод

string getUrl ()

Описание

Возвращает ссылку с хостом и протоколом.

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

  1.  echo URL::getUrl();

Метод

array|bool getUrlRedirect ()

Описание

Получает ссылку для редиректа, если она была указана в настройках SEO для запрашиваемой страницы.

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

  1.  $result URL::getUrlRedirect();
  2.  viewData($result);

Метод

bool isSection (string $section)

Параметры

  • $section: название секции.

Описание

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

Пример: isSection('catalog') вернет true если открыта страница каталога.

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

  1.  $result URL::isSection('catalog');
  2.  var_dump($result);

Метод

string multiLangLink ([string $data = ''])

Параметры

  • $data: верстка страницы

Описание

Возвращает страницу с изменеными ссылками для мультиязычности.

Метод

string parsePageUrl ([string|bool $path = false])

Параметры

  • $path: url

Описание

Возвращает последнюю секцию URL.

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

  1.  echo URL::parsePageUrl('http://site.ru/smartfony/apple-iphone-8');

Метод

string parseParentUrl ([string|bool $path = false])

Параметры

  • $path: url

Описание

Возвращает часть url являющуюся parent_url.

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

  1.  echo URL::parseParentUrl('http://site.ru/smartfony/apple-iphone-8');

Метод

string post (string $param)

Параметры

  • $param: запрошенный параметр.

Описание

Возвращает защищенный параметр из $_POST массива.

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

  1.  $result URL::post('id');
  2.  viewData($result);

Метод

string prepareUrl (string $str, [bool $product = false], [bool $toLower = true])

Параметры

  • $str: - строка для операции
  • $product: для товаров
  • $toLower: перевести в нижний регистр

Описание

Удаляет из URL все запрещенные спецсимволы.

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

  1.  echo URL::prepareUrl('http://site.ru/catalog ? <page>=2''page''4');

Метод

void setQueryParametr (string $param,  $value)

Параметры

  • $param: значение параметра.

Описание

Устанавливает параметр в реестр URL. Можно использовать как реестр переменных.

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

  1.  URL::setQueryParametr('param''paramval');