Spec-Zone.ru › ColdFusion

cfparam

Проверяет наличие параметра, его тип данных и, если значение по умолчанию не задано, при необходимости задаёт его.

<cfparam name="">

cfparam(name="", default="", pattern="");

  • CF2+
  • Lucee
  • BL 1.0.0+
  • См. также: cfset isDefined isValid

    Справочник по атрибутам

    name string
    Обязательный

    Имя проверяемого параметра (например, "client.email" или "cookie.backgroundColor"). Если параметр не существует и этот атрибут не указан, возникает ошибка.

    type string
    По умолчанию: Any

    Допустимый формат данных; один из следующих. * any: значение любого типа. * array: массив значений. * binary: двоичное значение. * boolean: логическое значение: yes, no, true, false или число. * creditcard: число из 13–16 цифр, соответствующее алгоритму mod10. * date или time: значение даты и времени. * email: допустимый адрес электронной почты. * eurodate: значение даты и времени. Любая часть даты должна иметь формат dd/mm/yy. В качестве разделителей можно использовать символы /, - или .. * float или numeric: числовое значение. * guid: глобально уникальный идентификатор формата "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", где 'X' — шестнадцатеричная цифра. * numeric: числовое значение * integer: целое число. * query: объект запроса. * range: числовой диапазон, заданный атрибутами min и max. * regex или regular_expression: проверяет соответствие входных данных атрибуту pattern. * ssn или social_security_number: номер социального страхования США. * string: строковое значение или одиночный символ. * struct: структура. * telephone: стандартный номер телефона США. * URL: URL-адрес с протоколом http, https, ftp, file, mailto или news. * UUID: глобально уникальный идентификатор ColdFusion формата 'XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXX', где 'X' — шестнадцатеричная цифра. См. CreateUUID. * USdate: дата США в формате mm/dd/yy, с 1–2 цифрами для дня и месяца и 1–4 цифрами для года. * variableName: строка, оформленная в соответствии с правилами именования переменных ColdFusion. * xml: XML-объекты и XML-строки. * zipcode: почтовые индексы США в формате из 5 или 9 цифр.
    Значения:
    • any
    • array
    • binary
    • boolean
    • creditcard
    • date
    • time
    • email
    • eurodate
    • float
    • numeric
    • guid
    • integer
    • query
    • range
    • regex
    • regular_expression
    • ssn
    • social_security_number
    • string
    • struct
    • telephone
    • url
    • uuid
    • usdate
    • variablename
    • xml
    • zipcode

    default any

    Значение, которое присваивается параметру, если он не существует. Любое выражение, указанное для атрибута default, вычисляется, даже если параметр существует. Результат не присваивается, если параметр существует, однако побочные эффекты выражения всё равно возникают.

    max numeric

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

    min numeric

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

    pattern string

    Регулярное выражение, которому должен соответствовать параметр; используется только для проверки типа regex или regular_expression.

    Совместимость

    BoxLang:

    Версия 1.0.0+ <bx:param> в BoxLang

    Примеры
    Примеры кода с тегом cfparam

    cfparam в CFML

    Простой пример использования cfparam в CFML

    <cfparam name="userID" default="0"/>

    cfparam в cfscript

    Простой пример использования cfparam в cfscript

    cfparam(name="userID", default=0);
    param userID=0;

    Синтаксис тега с регулярным выражением

    Вызывает ошибку, если значение не входит в список допустимых значений

    <cfparam name="sortdir" default="ASC" type="regex" pattern="ASC|DESC"/>

    Сокращённая форма param в cfscript

    Три способа использовать сокращённую форму param внутри тега cfscript

    param someVar; //declare the param
    param someVar=5; //declare the param with a default value
    param numeric someVar=3.1415; //declare the param with adefault value and set the type

    © 2012–present Foundeo, Inc. and the CFDocs contributors.
    Licensed under the MIT License.
    ColdFusion is a trademark of Adobe Systems Incorporated.
    https://cfdocs.org/cfparam

    Spec-Zone.ru

    Настройки Оффлайн Что нового Помощь О нас
    Spec-Zone .ru
    спецификации, руководства, описания, API