cffunction

Строка; метод компонента, используемый внутри тега cfcomponent.

Строка; имя типа; тип данных возвращаемого функцией значения. Обязателен для веб-службы; в остальных случаях необязателен.

Список ролей безопасности CFML, разделённых запятыми, которым разрешено вызывать метод. Выполнять функцию могут только пользователи, вошедшие в систему с указанными ролями. Если этот атрибут не задан, вызывать метод могут все пользователи.

Контекст безопасности клиента, из которого можно вызвать метод. private: доступен только компоненту, объявляющему метод, и компонентам, расширяющим компонент, в котором он определён. package: доступен только компоненту, объявляющему метод, компонентам, расширяющим этот компонент, и другим компонентам пакета. public: доступен локально выполняющейся странице или методу компонента. remote: доступен локально или удалённо выполняющейся странице или методу компонента, а также удалённому клиенту через URL, Flash или веб-службу. Чтобы опубликовать функцию как веб-службу, необходимо выбрать этот параметр.

Указывает, при каких условиях функция может генерировать вывод HTML.

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

Имеет значение только для параметров методов CFC. Текст, отображаемый при использовании интроспекции для просмотра сведений о CFC. Значение атрибута hint следует за строкой синтаксиса в описании функции.

Краткое текстовое описание функции.

CF 8+ Формат возвращаемых значений для удалённого вызывающего клиента.

CF 8+ Логическое значение, указывающее, следует ли добавлять префикс безопасности перед любым значением, которое функция возвращает в формате JSON в ответ на удалённый вызов.

CF 8+ Логическое значение, указывающее, требуется ли включать в удалённые вызовы функций зашифрованный токен безопасности. Используется только с приложениями ColdFusion AJAX.

CF 10+ Укажите путь к подресурсу CFC. Путь учитывает регистр символов. Также рекомендуется избегать специальных символов в пути. В путь можно включать регулярные выражения. Подробнее о допустимых выражениях см. описание атрибута restPath в cfcomponent.

CF 10+ Используемый метод HTTP; должен быть одним из следующих. GET: запрашивает информацию у сервера. Все данные, необходимые серверу для определения запрашиваемой информации, должны находиться в URL или теге cfhttp type="URL". POST: отправляет информацию на сервер для обработки. Требует один или несколько тегов cfhttpparam. Часто используется для отправки данных формы. PUT: запрашивает сохранение сервером тела сообщения по указанному URL. Используйте этот метод для отправки файлов на сервер. DELETE: запрашивает удаление сервером указанного URL. HEAD: аналогичен методу GET, но сервер не отправляет тело сообщения в ответе. Используйте этот метод для проверки допустимости и доступности гиперссылок, определения типа документа или времени его изменения, а также определения типа сервера. Если HEAD не указан, по умолчанию вызывается метод GET. Однако тело сообщения в ответе не отправляется. OPTIONS: запрос сведений о доступных параметрах обмена данными для сервера или указанного URL. Этот метод позволяет приложению ColdFusion определить параметры и требования, связанные с URL, или возможности сервера, не запрашивая от сервера выполнения каких-либо дополнительных действий. Если OPTIONS не указан, ColdFusion отправляет ответ. Переопределяет значение, заданное на уровне компонента.

CF 10+ Разделённый запятыми список допустимых типов MIME. Используется для указания типа мультимедиа MIME представления, которое может создавать ресурс, например, {{produces="text/plain,text/html"}}. Если ресурс может создавать несколько типов мультимедиа MIME, выбирается функция, соответствующая наиболее приемлемому для клиента типу мультимедиа. Если значение не указано, по умолчанию используется /, что означает, что принимаются все типы MIME. Переопределяет значение, заданное на уровне компонента. **Примечание**Если тип MIME является шаблоном, результаты включают любые значения. Например, если выполнить вызов HTTP с produces, равным '*/xml', а затем второй вызов HTTP с produces, равным '*/json', результаты второго вызова HTTP могут также включать результат первого вызова.

CF 10+ Разделённый запятыми список допустимых типов MIME, например consumes="text/plain,text/html". Используется для указания типов мультимедиа MIME представления, которые ресурс может принимать от клиента или обрабатывать. Этот атрибут переопределяет одноимённый атрибут на уровне компонента. Если значение не указано, по умолчанию используется /, что означает, что принимаются все типы MIME. Adobe рекомендует избегать конфликтов при указании атрибутов produces и consumes. Например, избегайте следующей ситуации: в функции 1 указано produces со значением text/xml и consumes со значением text/, а в функции 2 — produces со значением text/ и consumes со значением text/xml. В этом случае обе функции подходят для запроса с accept = text/xml и consumes со значением text/xml.

Lucee 4.5+ Определяет, как вызывается локальная область этой функции, если используется переменная без указания области видимости. Допустимые значения: classic (по умолчанию): локальная область вызывается только в том случае, если ключ уже существует в ней (также называется false). modern: локальная область вызывается всегда (также называется true).

Lucee 4.5+ Возможные значения: строка "request": если исходное содержимое было создано в рамках текущего запроса, используются кэшированные данные содержимого. Интервал времени (создаётся функцией CreateTimeSpan): если дата исходного содержимого попадает в этот интервал, используются кэшированные данные содержимого. Чтобы использовать кэшированные данные, функцию необходимо вызвать с точно такими же аргументами.

Lucee 5+ используется для обозначения функции как abstract (реализация должна быть определена в расширяющем компоненте), static (не обращается к переменным экземпляра компонента) или final (реализацию нельзя расширить)