README.ru_RU.md

English | Русский

REQUEST CSE HELPERS

Данная библиотек позволяет удобно работать с запросами. Доступны методы POST/GET/REQUEST для получения данных и установки значений по умолчанию, также можно проверить существование методов AJAX, POST и GET, а так же другие функци.

Репозиторий проекта: https://github.com/cs-eliseev/helpers-request

DEMO

switch(true) {
    case Request::isAjax():
    case Request::isPost():
        Request::post('example', 5);
        break;
    case Request::isGet():
        Request::getRequestUri();
        break;
}

---

Описание проекта

CSE HELPERS - это набор из небольших библиотек с простыми функциями написанных на PHP специально для вас.

Несмотря на повсеместное использование PHP в качестве основного языка для WEB разработки, его зачастую недостаточно. REQUEST CSE HELPERS, позволит вам довольно просто проверять и обрабатывать запросы.

CSE HELPERS создан для быстрой разработки веб-приложений.

Список библиотек CSE Helpers:

• Array CSE helpers
• Cookie CSE helpers
• Date CSE helpers
• Email CSE helpers
• IP CSE helpers
• Json CSE helpers
• Math Converter CSE helpers
• Phone CSE helpers
• Request CSE helpers
• Session CSE helpers
• Word CSE helpers

Ниже представлена информация об установке и перечне команд с примерами их использования.

Установка

Самая последняя версия проекта доступна здесь.

Composer

Чтобы установить последнюю версию проекта, выполните следующую команду в терминале:

composer require cse/helpers-request

Или добавьте следующее содержимое в файл composer.json:

{
    "require": {
        "cse/helpers-request": "*"
    }
}

Git

Добавить этот репозиторий локально можно следующим образом:

git clone https://github.com/cs-eliseev/helpers-request.git

Скачать

Скачать последнюю версию проекта можно здесь.

Использование

Данный класс использует статические методы, которые удобно использовать в любом проекте. Смотрите пример examples-request.php.

Получить POST данные по ключу

Пример:

$_POST['example'] = 12345;
Request::post('example');
// 12345

Установить значение по умолчанию:

Request::post('example_2', 12345);
// 12345

Получить GET данные по ключу

Пример:

$_GET['example'] = 12345;
Request::get('example');
// 12345

Установить значение по умолчанию:

Request::get('example_2', 12345);
// 12345

Получить данные из REQUEST по ключу

Пример:

$_REQUEST['example'] = 12345;
Request::request('example');
// 12345

Установить значение по умолчанию:

Request::request('example_2', 12345);
// 12345

Проверить что пришел AJAX запрос

Пример:

$_SERVER['HTTP_X_REQUESTED_WITH'] = 'xmlhttprequest';
Request::isAjax();
// true

Проверить что пришел POST запрос

Пример:

$_SERVER['REQUEST_METHOD'] = Request::METHOD_POST;
Request::isPost();
// true

Проверить что пришел GET запрос

Пример:

$_SERVER['REQUEST_METHOD'] = Request::METHOD_GET;
Request::isGet();
// true

Получить ссылку запроса

Пример:

$_SERVER['HTTP_REFERER'] = '/link/example';
Request::getRequestUri();
// /link/example

Установить значение по умолчанию:

Request::getRequestUri('/link/home');
// /link/home

Пример для AJAX запроса:

$_SERVER['HTTP_X_REQUESTED_WITH'] = 'xmlhttprequest';
$_SERVER['REQUEST_URI'] = '/link/example_ajax';
Request::getRequestUri();
// /link/example_ajax

Проверить что есть перенаправление на HTTPS

Пример:

Request::isRedirectedToHttps('http://google.com');
// true

Тестирование и покрытие кода

PHPUnit используется для модульного тестирования. Данные тесты гарантируют, что методы класса выполняют свою задачу.

Подробную документацию по PHPUnit можно найти по адресу: https://phpunit.de/documentation.html.

Чтобы запустить тесты выполните:

phpunit PATH/TO/PROJECT/tests/

Чтобы сформировать отчет о покрытии тестами кода, необходимо выполнить следующую команду:

phpunit --coverage-html ./report PATH/TO/PROJECT/tests/

Чтобы использовать настройки по умолчанию, достаточно выполнить:

phpunit --configuration PATH/TO/PROJECT/phpunit.xml

Вклад в общее дело

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

Лицензия

REQUEST CSE HELPERS это PHP-библиотека с открытым исходным кодом распространяемая по лицензии MIT. Для получения более подробной информации, пожалуйста, ознакомьтесь с лицензионным файлом.

---

GitHub @cs-eliseev