Spec-Zone.ru › ColdFusion

cfproperty

Определяет свойства компонента CFML (CFC). Используется для создания сложных типов данных для веб-служб. Атрибуты этого тега доступны в метаданных компонента и подчиняются правилам наследования.

<cfproperty name="">

  • CF6+
  • Lucee
  • Справочник по атрибутам

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

    Задает имя свойства.

    type string

    Задает тип данных ColdFusion для свойства.
    Значения:
    • any
    • array
    • binary
    • boolean
    • date
    • guid
    • numeric
    • query
    • string
    • struct
    • uuid
    • variablename

    required boolean

    Указывает, является ли параметр обязательным.

    default string

    Задает значение свойства по умолчанию, используемое при создании объекта. Для ORM-сущностей это работает только со статическими значениями. Переменные значения, например текущую временную метку, можно задать с помощью функции "preInsert" в компоненте.

    displayname string

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

    hint string

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

    fieldtype string

    Этот атрибут используется для указания типа свойства. С его помощью можно задать следующее:* Первичный ключ: укажите fieldtype = "id", чтобы связать свойство с первичным ключом таблицы. * Столбец: укажите fieldtype = "column", чтобы связать свойство со столбцом таблицы.* Связь: укажите fieldtype = "relationship_type". В качестве relationship_type можно задать one-to-one, one-to-many, many-to-one или many-to-many.* Версия: укажите fieldtype="version‚Äù, чтобы обозначить столбец, содержащий данные с версиями.* Временная метка: укажите fieldtype="timestamp", чтобы обозначить столбец, содержащий данные с временной меткой.* Коллекция: укажите fieldtype="collection", чтобы определить сопоставление коллекции.
    Значения:
    • id
    • column
    • one-to-one
    • one-to-many
    • many-to-many
    • many-to-one
    • collection
    • timestamp
    • version

    ormType string

    Используется для указания типа данных первичного ключа. Если тип данных не задан и для параметра ORM useDBForMapping=true, то значение ormtype определяется путем проверки базы данных.
    Значения:
    • string
    • character
    • char
    • short
    • integer
    • int
    • long
    • big_decimal
    • float
    • double
    • boolean
    • yes_no
    • true_false
    • text
    • date
    • timestamp
    • binary
    • serializable
    • blob
    • clob

    column string

    Используется для указания имени столбца первичного ключа.

    generator string

    Алгоритм, используемый для создания уникальных идентификаторов экземпляров сохраняемого CFC.
    Значения:
    • increment
    • identity
    • sequence
    • seqhilo
    • uuid
    • guid
    • native
    • assigned
    • select
    • foreign
    • sequence-indentity

    sequence string

    Имя последовательности в базе данных.

    selectkey string

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

    params string

    Дополнительные параметры, необходимые различным генераторам для создания идентификатора. Значение атрибута params должно соответствовать синтаксису структур CF. Например: params = {key1='value1', key2='value2'}

    length string

    Используйте этот атрибут, чтобы указать длину столбца. Этот атрибут используется только при создании таблицы.

    precision string

    Задает значение точности.

    index string

    Задает имя индекса, создаваемого для сопоставленного столбца.

    setter boolean

    Указывает, нужно ли создавать методы-сеттеры.

    getter boolean

    Указывает, нужно ли создавать методы-геттеры.

    source string
    По умолчанию: vm

    Задает источник, из которого должна извлекаться временная метка.
    Значения:
    • vm
    • db

    elementcolumn string

    Имя столбца таблицы, используемого в качестве значения в структуре.

    elementtype string

    Тип данных значения.
    Значения:
    • string
    • character
    • char
    • short
    • integer
    • int
    • long
    • big_decimal
    • float
    • double
    • boolean
    • yes_no
    • true_false
    • text
    • date
    • timestamp
    • binary
    • serializable
    • blob
    • clob

    structkeytype string

    Задает тип данных ключа, если collectiontype=struct.
    Значения:
    • string
    • character
    • char
    • short
    • integer
    • int
    • long
    • big_decimal
    • float
    • double
    • boolean
    • yes_no
    • true_false
    • text
    • date
    • timestamp
    • binary
    • serializable
    • blob
    • clob

    structkeycolumn string

    Столбец целевой таблицы, используемый в качестве ключа, если тип коллекции — struct.

    inversejoincolumn string

    Задает столбец внешнего ключа в таблице соединения, ссылающийся на столбец первичного ключа целевой таблицы.

    linkschema string

    Схема таблицы связей.

    linkcatalog string

    Каталог таблицы связей.

    linktable string

    Имя таблицы связей.

    missingRowIgnored boolean

    Если значение равно true и строка, на которую ссылается внешний ключ, отсутствует, она рассматривается как nullassociation. По умолчанию задано значение false, и в этом случае возникает исключение.

    inverse boolean

    Логическое значение, указывающее на двунаправленную связь.

    orderby string

    Задает строку Order By.

    fkcolumn string

    Задает столбец внешнего ключа.

    fetch string

    Указывает, следует ли использовать выборку с внешним соединением или последовательную выборку с помощью SELECT.
    Значения:
    • join
    • select

    cascade string

    Задает операции, которые должны каскадно передаваться от родительского объекта связанному объекту.
    Значения:
    • all
    • none
    • save-update
    • delete
    • all-delete-orphan
    • delete-orphan
    • create
    • merge
    • lock
    • refresh
    • evict
    • replicate

    constrained boolean

    Указывает, задано ли ограничение для столбца первичного ключа этой таблицы, ссылающееся на первичный ключ другой таблицы.

    unique boolean

    Указывает, должно ли для столбца быть задано ограничение уникальности.
    Значения:
    • false
    • true

    uniquekey string

    Объединяет столбцы в одно ограничение уникального ключа.

    notnull boolean

    Логическое значение, указывающее, следует ли добавить для этого столбца ограничение notnull.

    update string

    Указывает, следует ли включать столбец в инструкцию SQL UPDATE. Задайте update=false и insert=false, если столбец должен быть доступен только для чтения.

    insert boolean

    Указывает, следует ли включать столбец в инструкции SQL UPDATE и/или INSERT. Задайте update=false и insert=false, если столбец должен быть доступен только для чтения.

    generated string

    Указывает, что значение этого свойства фактически создается базой данных {never|always|insert}* never: указывает, что значение этого свойства никогда не создается базой данных* always: указывает, что значение этого свойства всегда создается базой данных* insert: указывает, что значение этого свойства создается при вставке, но не обновляется при последующих изменениях.
    Значения:
    • never
    • insert
    • always

    formula string

    Выражение SQL, определяющее значение свойства. Если указана формула, значение столбца игнорируется.

    lazy string

    Указывает, следует ли выполнять загрузку частями:
    Значения:
    • extra

    optimisticLock boolean

    Указывает, требуется ли при обновлении этого свойства получение оптимистической блокировки строки таблицы.

    scale string

    Задает значение масштаба.

    mappedby string

    Свойство целевого CFC, на которое ссылается внешний ключ в таблице соединения.

    cfc string

    Имя CFC, на который ссылаются.

    joinColumn string

    Используйте этот атрибут, чтобы определить столбец соединения для сопоставления наследования.

    validate string

    Задает валидатор, который используется для проверки данных при вызове неявного сеттера этого свойства.
    Значения:
    • string
    • boolean
    • integer
    • numeric
    • date
    • time
    • creditcard
    • email
    • eurodate
    • ssn
    • telephone
    • UUID
    • guid
    • zipcode

    validateParams string

    Принимает параметры, необходимые валидатору, указанному в атрибуте validate. Их следует задавать в неявном формате структуры, например validateparams="{min=18,max=60}">.min: минимальное значение, если для validate задано integer/numeric/max: максимальное значение, если для validate задано integer/numeric/minLength: минимальная длина строки, если для validate задано stringmaxLength: максимальная длина строки, если для validate задано stringpattern: регулярное выражение, если в атрибуте validate указан валидатор regex.

    cacheUse string

    Тип используемого кэша.
    Значения:
    • read-only
    • nonstrict-read-write
    • read-write
    • transactional

    sqlType string

    Используйте этот атрибут, чтобы указать зависящий от СУБД тип SQL, который следует использовать для столбца. Этот атрибут используется только при создании таблицы. Если атрибут не указан, ColdFusion автоматически определит тип SQL на основе ormtype, заданного для этого свойства.

    dbDefault string

    Задает значение столбца таблицы по умолчанию при экспорте схемы.

    where string

    Условие Where.

    persistent boolean

    Указывает, следует ли сохранять это свойство. Если persistent="false‚ все атрибуты, связанные с ORM, игнорируются. Задайте для этого атрибута значение false, если свойство не должно сохраняться с помощью ORM.

    unSavedValue string

    Значение свойства-идентификатора, указывающее, что экземпляр создан, но еще не сохранен в базе данных и не загружен из нее.

    serializable boolean

    Указывает, можно ли сериализовать это свойство. Если задать для этого значения false, свойство нельзя будет сериализовать, поэтому внесенные изменения не сохранятся при репликации сеанса, а на втором сервере свойство получит значение по умолчанию (если оно задано). Используйте этот атрибут, чтобы запретить сериализацию свойств в сериализуемых CFC.

    singularname string

    Используйте это свойство, чтобы задать пользовательское имя для создаваемых методов связи. Применяется к связям one-to-many и many-to-many.

    remotingFetch boolean

    Если remotingFetch равно false, значение этого атрибута не передается через Flash Remoting. По умолчанию remotingFetch равно true для всех свойств. Однако для CFC, у которых persistent = true, значение атрибута remotingFetch по умолчанию равно false для любого свойства, имеющего связь one-to-one, one-to-many, many-to-one или many-to-many.
    Значения:
    • false
    • true

    table string

    Имя таблицы.

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

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

    Spec-Zone.ru

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