cfargument

Создает определение параметра в определении компонента. Определяет аргумент функции. Используется внутри тега cffunction.

<cfargument name="">

myFunction(required any myArgument){}

CF6+

Lucee

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

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

Имя аргумента.

type string

имя типа; тип данных аргумента.

Значения:

any
array
binary
boolean
component
date
email
function
float
guid
integer
numeric
query
string
struct
uuid
xml
variablename
(component name)

required boolean
По умолчанию: `no`

Требуется ли параметр для выполнения метода компонента.

Значения:

true
false

default string

Если аргумент не передан, задает значение аргумента по умолчанию.

displayname string

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

hint string

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

Примеры
Пример кода с использованием тега cfargument

Синтаксис скрипта

В синтаксисе скрипта аргумент указывается внутри ()

public boolean function myFunction(required any myArgument) {
    // Some function bits
    return true;
}

Синтаксис тегов

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

<cffunction access="public" returntype="boolean" name="myFunction">
    <cfargument required="true" type="any" name="myArgument">
    <!--- Some function bits --->
    <cfreturn true>
</cffunction>

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