Документация

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== Объект w_input ======

Класс отвечает за обработку и фильтрацию POST и GET запросов.

===== Расположение =====
''core/format.php''

===== Статичные методы =====
==== address(key, default) ====
Получить значение и обработать как адрес

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
^Возвращает|Отформатированное значение|string| |

==== attribute(key, default) ====
Получить значение и обработать для вывода в атрибут html тега

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
^Возвращает|Экранированное значение|string| |
==== bool(key, default) ====
Получить значение и обработать как логический тип

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
^Возвращает|Отформатированное значение|boolean| |

==== captcha() ====
Проверить переданную капчу

^Возвращает|true, если капча пройдена|boolean|

==== captchaRender() ====
Отображение капчи [[https://www.google.com/recaptcha/admin]]

^Возвращает|Шаблон капчи|string|

==== code(key, default) ====
Получить значение и обработать как численно-буквенный код

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательно| |
|default|возвращаемое значение если запрос не передан|mixed|null|
^Возвращает|Отформатированное значение|string| |

==== confirmEmail(command, email,field) ====
Проверить код подтверждения с E-mail

^Аргумент^Описание^Тип^По-умолчанию^
|command|Имя команды|string обязательное| |
|email|E-mail|string обязательное| |
|field|ключ|string обязательное| |
^Возвращает|true, если переданный код верен|boolean| |

==== confirmEmailSend(command, email) ====
Отправить код подтверждения на E-mail

^Аргумент^Описание^Тип^По-умолчанию^
|command|Имя команды|string обязательное| |
|email|E-mail|string обязательное| |
^Возвращает|true|boolean| |

==== confirmSms(command, phone, field) ====
Проверить код подтверждения с SMS

^Аргумент^Описание^Тип^По-умолчанию^
|command|Имя команды|string обязательное| |
|phone|Номер мобильного телефона|string обязательное| |
|field|ключ|string обязательное| |
^Возвращает|true, если переданный код верен|boolean| |

==== confirmSmsSend(command, phone) ====
Отправить код подтверждения по SMS

^Аргумент^Описание^Тип^По-умолчанию^
|command|Имя команды|string обязательное| |
|phone|Номер мобильного телефона|string обязательное| |
^Возвращает|true|boolean| |

==== date(key, default) ====
Получить значение и обработать как дату

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|значение по-умолчанию|mixed|null|
^Возвращает|Дату|[[ядро:w_date|Объект w_date]]|

==== email(key, default) ====
Получить значение и обработать как E-mail

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
^Возвращает|Отформатированное значение|string| |

==== file(key, dir, prefix, maxsize, allow_ext) ====
Сохранить единственный файл переданный POST-запросом

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|dir|папка назначения в папке ''/media''|string|other|
|prefix|префикс для файла|string| |
|maxsize|максимальный размер в мб. 0 - не ограничен|int|по-умолчанию для сервера|
|allow_ext|массив допустимых расширений файлов|array string|по-умолчанию для системы|
^Возвращает|Загруженный файл|[[сore:w_file|Объект w_file]]| |

==== files(key, dir, prefix, maxsize, allow_ext) ====
Сохранить файлы переданные POST-запросом

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|dir|папка назначения в папке ''/media''|string|other|
|prefix|префикс для файла|string| |
|maxsize|максимальный размер в мб. 0 - не ограничен|int|по-умолчанию для сервера|
|allow_ext|массив допустимых расширений файлов|array of string|по-умолчанию для системы|
^Возвращает|Загруженные файлы|array [[сore:w_file|Объект w_file]]| |

==== float(key, default,min,max) ====
Получить значение и обработать как число с плавающей точкой

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
|min|минимальное значение|float| |
|max|максимальное значение|float| |
^Возвращает|Отформатированное значение|float| |

==== int ====
Получить значение обработать как целое число

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
|min|минимальное значение|int| |
|max|максимальное значение|int| |
^Возвращает|Отформатированное значение|int| |



==== login(key, default) ====
Получить значение и обработать как логин (E-mail/Телефон)

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
^Возвращает|Отформатированное значение|string| |


==== name(key, default) ====
Получить значение и обработать как имя собственное

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
^Возвращает|Отформатированное значение|string| |

==== of(key, default, of) ====	
Получить значение из списка допустимых передаваемых значений //of//

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если значение не соответствует списку|mixed|null|
|haystack|список допустимых передаваемых значений|mixed|null|
^Возвращает|Значение, если оно присутствует в массиве //of//, или значение //default// в противном случае|string| |

==== phone(key, default) ====
Получить значение и обработать как номер телефона

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
^Возвращает|Отформатированное значение|string| |

==== raw(key, default) ====
Получить значение без фильтрации

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
^Возвращает|Значение поля|mixed| |

==== request() ====
Получить массив данных запроса

^Возвращает|Массив данных запроса|array| |
==== set(key, value) ====
Записать новое значение запроса

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|value|новое значение|string обязательное| |
^Возвращает|Приведенное значение поля|mixed| |

==== text(key, value) ====
Получить значение и обработать как текст

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
^Возвращает|Отформатированное значение|string| |
==== uint ====
Получить значение обработать как целое беззнаковое число

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
|min|минимальное значение|int| |
|max|максимальное значение|int| |
^Возвращает|Отформатированное значение|int| |


==== url(key, default) ====
Получить значение и обработать как Url

^Аргумент^Описание^Тип^По-умолчанию^
|key|ключ|string обязательное| |
|default|возвращаемое значение если запрос не передан|mixed|null|
^Возвращает|Отформатированное значение|string| |

===== Формат ключа =====
Если параметры передаются в виде массива, в ключе можно указывать как имя массива, так и обращаться к определенному его элементу.

<code php>
w_input::raw('arr');
w_input::raw('arr[0]');
w_input::raw('arr[1][2]');
</code>

===== Примеры =====
Запрос:

''http://site.ru/?arg1=89081234567890&arg2=Wmart&arg3[1]=a&arg3[2]=15.11.2018&arg[3]=10,5''

Код:
<code php>
echo w_input::int('arg1'); // 89081234567890

echo w_input::mobile('arg1'); // 9081234567890
echo w_input::name('arg2'); //Wmart
echo w_input::raw('arg2'); //Wmart1
echo w_input::raw('arg3[1]'); //a
echo w_input::raw('arg3[2]')->format('d-m-Y'); //15-11-2018
echo w_input::raw('arg3[3]'); //10.5

print_r(w_input::raw('arg[]'); /*
Array
(
    [1] => a
    [2] => b
    [3] => c
)
*/
</code>
Документация

Инструменты пользователя

Инструменты сайта

Инструменты страницы
