URL

Описание

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

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

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

Методы класса

string\|bool	createUrl()	Конвертирует русскоязычный URL в транслит. `$url = URL::createUrl('русский-домен.рф');`
string	get()	Возвращает защищенный параметр из массива $_GET. `$url = URL::get('id');`
string	getClearUri()	Возвращает чистый URI, без строки с get параметрами. `echo URL::getClearUri();`
string	clearingUrl()	Чистит входящий URL и возвращает URI , аналогично методу getClearUri() только для заданного URL. `echo URL::clearingUrl('http://site.ru/smartfony/apple-iphone-8');`
string	getCutPath()	Возвращает часть пути, до папки с CMS. Например если движок расположен по этому пути http://sitename.ru/shop/index.php, то метод вернет строку "/shop" `echo URL::getCutPath();`
int	getCountSections()	Возвращает количество секций. `echo URL::getCountSections();`
array	getDataUrl()	Возвращает массив составных частей ссылки. `$result = URL::getDataUrl('http://site.ru/smartfony/apple-iphone-8'); viewData($result);`
object	getInstance()	Возвращает единственный экземпляр данного класса. `$obj = URL::getInstance();`
string	getLastSection()	Возвращает последнюю часть uri. `echo URL::getLastSection();`
string	getCutSection()	Возвращает часть пути, до папки с CMS. Например если движок расположен по этому пути http://sitename.ru/shop/index.php, то метод вернет строку "/shop" `echo URL::getCutSection();`
string	getQueryParametr()	Возвращает запрошенный request параметр. `echo URL::getQueryParametr('http://site.ru/integration?int=ym&name=getyml', 'name'); // getyml`
string	getQueryString()	Возвращает запрошенную строку параметров. `echo URL::getQueryString();`
array	getSections()	Возвращает массив секций URI. `$result = URL::getSections('http://site.ru/smartfony/apple-iphone-8'); viewData($result);`
string	parseParentUrl()	Возвращает часть url являющуюся parent_url. `echo URL::parseParentUrl('http://site.ru/smartfony/apple-iphone-8');`
string	parsePageUrl()	Возвращает последнюю секцию URL. `echo URL::parsePageUrl('http://site.ru/smartfony/apple-iphone-8');`
string	getUri()	Возвращает URI, с get параметров. `echo URL::getUri();`
string	getUrl()	Возвращает ссылку с хостом и протоколом. `echo URL::getUrl();`
string	getRoute()	Возвращает имя для роутера. `echo URL::getRoute();`
bool	isSection()	Проверяет является ли полученное значение - именем текущего раздела. Пример: isSection('catalog') вернет true если открыта страница каталога. `$result = URL::isSection('catalog'); var_dump($result);`
string	post()	Возвращает запрошенный параметр из $_POST массива. `$result = URL::post('id'); viewData($result);`
void	setQueryParametr()	Устанавливает параметр в реестр URL. Можно использовать как реестр переменных. `URL::setQueryParametr('param', 'paramval');`
string	add_get()	Добавляет, либо заменяет $_GET параметр в строке URL. Обычно нужен для пейджера навигации. `echo URL::add_get('http://site.ru/catalog?page=2', 'page', '4');`
string	prepareUrl()	Удаляет из URL все запрещенные спецсимволы, заменяет пробелы на тире. `echo URL::prepareUrl('http://site.ru/catalog ? <page>=2');`
string	getDocumentRoot()	Вычисляет настоящее местоположение до файла на сервере. Вместо этой функции можно использовать константу SITE_DIR `echo URL::getDocumentRoot();`
array\|bool	getUrlRedirect()	Получает ссылку для редиректа, если она была указана в настройках SEO для запрашиваемой страницы. `$result = URL::getUrlRedirect(); viewData($result);`
string	clean()	Метод для очистки строки от лишних символов, которые не допустимы при создание URL'а
bool	isAdminAjax()	Метод для проверки, что пришел ajax запрос из административной панели. Нужен, чтобы в админке не обрабатывать локали плагинов, шорткоды и пр.

Описание методов и примеры их использования

Метод


string|bool createUrl (string $urlstr)

Параметры

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

Описание

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


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

Метод


string get (string $param)

Параметры

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

Описание

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


$url = URL::get('id');

Метод


string getClearUri ()

Описание

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


echo URL::getClearUri();

Метод


string clearingUrl (string $url)

Параметры

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

Описание

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


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

Метод


string getCutPath ()

Описание

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


echo URL::getCutPath();

Метод


int getCountSections ()

Описание

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


echo URL::getCountSections();

Метод


array getDataUrl ($url = false)

Параметры

string|bool ссылка для разбивки на составные части

Описание

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


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

Метод


object getInstance ()

Описание

Возвращает единственный экземпляр данного класса.


$obj = URL::getInstance();

Метод


string getLastSection ()

Описание

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


echo URL::getLastSection();

Метод


string getCutSection ()

Описание


echo URL::getCutSection();

Метод


string getQueryParametr (string $param)

Параметры

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

Описание

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


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

Метод


string getQueryString ()

Описание

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


echo URL::getQueryString();

Метод


array getSections (string|bool $path = false)

Параметры

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

Описание

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


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

Метод


string parseParentUrl (string|bool $path = false)

Параметры

$path: url

Описание

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


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

Метод


string parsePageUrl (string|bool $path = false)

Параметры

$path: url

Описание

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


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

Метод


string getUri ()

Описание

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


echo URL::getUri();

Метод


string getUrl ()

Описание

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


echo URL::getUrl();

Метод


string getRoute ()

Описание

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


echo URL::getRoute();

Метод


bool isSection (string $section)

Параметры

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

Описание

Проверяет является ли полученное значение - именем текущего раздела.
Пример: isSection('catalog') вернет true если открыта страница каталога.


$result = URL::isSection('catalog');
var_dump($result);

Метод


string post (string $param)

Параметры

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

Описание

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


$result = URL::post('id');
viewData($result);

Метод


setQueryParametr (string $param)

Параметры

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

Описание

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


URL::setQueryParametr('param', 'paramval');

Метод


string add_get (string $url, string $param, string $pvalue)

Параметры

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

Описание

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


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

Метод


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

Параметры

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

Описание

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


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

Метод


string getDocumentRoot (bool $lastSep = true)

Параметры

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

Описание

Вычисляет настоящее местоположение до файла на сервере.
Вместо этой функции можно использовать константу SITE_DIR


echo URL::getDocumentRoot();

Метод


array|bool getUrlRedirect ()

Описание

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


$result = URL::getUrlRedirect();
viewData($result);

Метод


string clean (string $string)

Параметры

$string:

Описание

Метод для очистки строки от лишних символов, которые не допустимы при создание URL'а

Метод


bool isAdminAjax ()

Описание

Метод для проверки, что пришел ajax запрос из административной панели.
Нужен, чтобы в админке не обрабатывать локали плагинов, шорткоды и пр.