This documentation is for a version that has reached its End Of Life. Such versions are no longer supported and don't receive security updates. Consider updating to a newer version.
Author Field Type¶
This Field Type allows the storage and retrieval of one or more authors. For each author, it can handle a name and an email address. It is typically used to store information about additional authors who have written/created different parts of a content item.
Name | Internal name | Expected input | Output |
---|---|---|---|
Author |
ezauthor |
mixed | string |
PHP API Field Type¶
Value Object¶
Properties¶
Attribute | Type | Description | Example |
---|---|---|---|
authors |
\Ibexa\Core\FieldType\Author\Author[] |
List of authors. | See below |
Example:
1 2 3 4 5 6 7 8 9 10 11 12 |
|
Hash format¶
The hash format mostly matches the value object. It has the following key authors
.
Example
1 2 3 4 5 6 7 8 9 10 11 12 |
|
String representation¶
The string contains all the authors with their names and emails.
Example: John Doe [email protected]
Validation¶
This Field Type does not perform any special validation of the input value.
Settings¶
The Field definition of this Field Type can be configured with a single option:
Name | Type | Default value | Description |
---|---|---|---|
defaultAuthor |
mixed |
Type::DEFAULT_VALUE_EMPTY |
One of the DEFAULT_* constants, used by the administration interface for setting the default Field value. See below for more details. |
Following defaultAuthor
default value options are available as constants in the Ibexa\Core\FieldType\Author\Type
class:
Constant | Description |
---|---|
DEFAULT_VALUE_EMPTY |
Default value will be empty. |
DEFAULT_CURRENT_USER |
Default value will use currently logged user. |
1 2 3 4 5 6 7 |
|