Exponential 5.x Kernel 7.5.40 Exponential New Stack (Symfony-based) Kernel — PHP Class Reference

Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
eZ\Publish\Core\FieldType\Image\Type Class Reference

The Image field type. More...

Inheritance diagram for eZ\Publish\Core\FieldType\Image\Type:

## Public Member Functions
| __construct (array $validators)
| getFieldTypeIdentifier ()
| Returns the field type identifier for this field type. More...
| getName (SPIValue $value)
| Returns the name of the given field value. More...
| getEmptyValue ()
| Returns the fallback default value of field type when no such default value is provided in the field definition in content types. More...
| validate (FieldDefinition $fieldDefinition, SPIValue $fieldValue)
| Validates a field based on the validators in the field definition. More...
| validateValidatorConfiguration ($validatorConfiguration)
| Validates the validatorConfiguration of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct. More...
| fromHash ($hash)
| Converts an $hash to the Value defined by the field type. More...
| toHash (SPIValue $value)
| Converts a $Value to a hash. More...
| toPersistenceValue (SPIValue $value)
| Converts a $value to a persistence value. More...
| fromPersistenceValue (FieldValue $fieldValue)
| Converts a persistence $fieldValue to a Value. More...
| valuesEqual (SPIValue $value1, SPIValue $value2)
Public Member Functions inherited from eZ\Publish\Core\FieldType\FieldType
| setTransformationProcessor (TransformationProcessor $transformationProcessor)
| getSettingsSchema ()
| Returns a schema for the settings expected by the FieldType. More...
| getValidatorConfigurationSchema ()
| Returns a schema for the validator configuration expected by the FieldType. More...
| applyDefaultValidatorConfiguration (&$validatorConfiguration)
| Applies the default values to the given $validatorConfiguration of a FieldDefinitionCreateStruct. More...
| validateFieldSettings ($fieldSettings)
| Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct. More...
| applyDefaultSettings (&$fieldSettings)
| Applies the default values to the fieldSettings of a FieldDefinitionCreateStruct. More...
| fromPersistenceValue (PersistenceValue $fieldValue)
| Converts a persistence $fieldValue to a Value. More...
| isSearchable ()
| Returns whether the field type is searchable. More...
| isSingular ()
| Indicates if the field definition of this type can appear only once in the same ContentType. More...
| onlyEmptyInstance ()
| Indicates if the field definition of this type can be added to a ContentType with Content instances. More...
| isEmptyValue (SPIValue $value)
| Returns if the given $value is considered empty by the field type. More...
| acceptValue ($inputValue)
| Potentially builds and checks the type and structure of the $inputValue. More...
| fieldSettingsToHash ($fieldSettings)
| Converts the given $fieldSettings to a simple hash format. More...
| fieldSettingsFromHash ($fieldSettingsHash)
| Converts the given $fieldSettingsHash to field settings of the type. More...
| validatorConfigurationToHash ($validatorConfiguration)
| Converts the given $validatorConfiguration to a simple hash format. More...
| validatorConfigurationFromHash ($validatorConfigurationHash)
| Converts the given $validatorConfigurationHash to a validator configuration of the type. More...
| getRelations (SPIValue $fieldValue)
| Returns relation data extracted from value. More...
Public Member Functions inherited from eZ\Publish\SPI\FieldType\FieldType
| getName (Value $value)
| Returns a human readable string representation from the given $value. More...
| validate (FieldDefinition $fieldDef, Value $value)
| Validates a field based on the validator configuration in the field definition. More...
| isEmptyValue (Value $value)
| Returns if the given $value is considered empty by the field type. More...
| toHash (Value $value)
| Converts the given $value into a plain hash format. More...
| toPersistenceValue (Value $value)
| Converts a $value to a persistence value. More...
| getRelations (Value $value)
| Returns relation data extracted from value. More...
Public Member Functions inherited from eZ\Publish\SPI\FieldType\Comparable
| valuesEqual (Value $value1, Value $value2)

## Protected Member Functions
| createValueFromInput ($inputValue)
| Inspects given $inputValue and potentially converts it into a dedicated value object. More...
| checkValueStructure (BaseValue $value)
| Throws an exception if value structure is not of expected format. More...
| getSortInfo (BaseValue $value)
| {} More...
Protected Member Functions inherited from eZ\Publish\Core\FieldType\FieldType
| getSortInfo (Value $value)
| Returns information for FieldValue->$sortKey relevant to the field type. More...
| checkValueStructure (Value $value)
| Throws an exception if value structure is not of expected format. More...

## Protected Attributes
| $validatorConfigurationSchema
Protected Attributes inherited from eZ\Publish\Core\FieldType\FieldType
| $settingsSchema = []
| $validatorConfigurationSchema = []
| $transformationProcessor

## Private Attributes
| $validators

## Additional Inherited Members
Static Protected Member Functions inherited from eZ\Publish\Core\FieldType\FieldType
static | checkValueType ($value)
| Throws an exception if the given $value is not an instance of the supported value subtype. More...

## Detailed Description

The Image field type.

Definition at line 20 of file Core/FieldType/Image/Type.php.

## Constructor & Destructor Documentation

## ◆ __construct()

eZ\Publish\Core\FieldType\Image\Type::__construct | ( | array | $validators | ) |

Parameters

  \eZ\Publish\Core\FieldType\Validator[] | $validators |

Definition at line 46 of file Core/FieldType/Image/Type.php.

References eZ\Publish\Core\FieldType\Image\Type\$validators.

## Member Function Documentation

## ◆ checkValueStructure()

eZ\Publish\Core\FieldType\Image\Type::checkValueStructure | ( | BaseValue | $value | ) |
| protected

Throws an exception if value structure is not of expected format.

Exceptions

Definition at line 121 of file Core/FieldType/Image/Type.php.

## ◆ createValueFromInput()

eZ\Publish\Core\FieldType\Image\Type::createValueFromInput | ( |  | $inputValue | ) |
| protected

Inspects given $inputValue and potentially converts it into a dedicated value object.

Parameters

  string | array | \eZ\Publish\Core\FieldType\Image\Value | $inputValue |

Returns
  \eZ\Publish\Core\FieldType\Image\Value The potentially converted and structurally plausible value.

Reimplemented from eZ\Publish\Core\FieldType\FieldType.

Definition at line 94 of file Core/FieldType/Image/Type.php.

## ◆ fromHash()

eZ\Publish\Core\FieldType\Image\Type::fromHash | ( |  | $hash | ) |

Converts an $hash to the Value defined by the field type.

Parameters

  mixed | $hash |

Returns
  \eZ\Publish\Core\FieldType\Image\Value $value

Implements eZ\Publish\SPI\FieldType\FieldType.

Definition at line 296 of file Core/FieldType/Image/Type.php.

References eZ\Publish\Core\FieldType\Image\Type\getEmptyValue().

Referenced by eZ\Publish\Core\FieldType\Image\Type\fromPersistenceValue().

## ◆ fromPersistenceValue()

eZ\Publish\Core\FieldType\Image\Type::fromPersistenceValue | ( | FieldValue | $fieldValue | ) |

Converts a persistence $fieldValue to a Value.

Parameters

  \eZ\Publish\SPI\Persistence\Content\FieldValue | $fieldValue |

Returns
  \eZ\Publish\Core\FieldType\Image\Value

Implements eZ\Publish\SPI\FieldType\FieldType.

Definition at line 358 of file Core/FieldType/Image/Type.php.

References eZ\Publish\Core\FieldType\Image\Type\fromHash(), and eZ\Publish\Core\FieldType\Image\Type\getEmptyValue().

## ◆ getEmptyValue()

eZ\Publish\Core\FieldType\Image\Type::getEmptyValue | ( |  | ) |

Returns the fallback default value of field type when no such default value is provided in the field definition in content types.

Returns
  \eZ\Publish\Core\FieldType\Image\Value

Implements eZ\Publish\SPI\FieldType\FieldType.

Definition at line 82 of file Core/FieldType/Image/Type.php.

Referenced by eZ\Publish\Core\FieldType\Image\Type\fromHash(), and eZ\Publish\Core\FieldType\Image\Type\fromPersistenceValue().

## ◆ getFieldTypeIdentifier()

eZ\Publish\Core\FieldType\Image\Type::getFieldTypeIdentifier | ( |  | ) |

Returns the field type identifier for this field type.

Returns
  string

Implements eZ\Publish\SPI\FieldType\FieldType.

Definition at line 56 of file Core/FieldType/Image/Type.php.

## ◆ getName()

eZ\Publish\Core\FieldType\Image\Type::getName | ( | SPIValue | $value | ) |

Returns the name of the given field value.

It will be used to generate content name and url alias if current field is designated to be used in the content name/urlAlias pattern.

Parameters

  \eZ\Publish\Core\FieldType\Image\Value | $value |

Returns
  string

Definition at line 71 of file Core/FieldType/Image/Type.php.

## ◆ getSortInfo()

eZ\Publish\Core\FieldType\Image\Type::getSortInfo | ( | BaseValue | $value | ) |
| protected

{}

Definition at line 284 of file Core/FieldType/Image/Type.php.

Referenced by eZ\Publish\Core\FieldType\Image\Type\toPersistenceValue().

## ◆ toHash()

eZ\Publish\Core\FieldType\Image\Type::toHash | ( | SPIValue | $value | ) |

Converts a $Value to a hash.

Parameters

  \eZ\Publish\Core\FieldType\Image\Value | $value |

Returns
  mixed

Definition at line 312 of file Core/FieldType/Image/Type.php.

References eZ\Publish\Core\FieldType\FieldType\isEmptyValue().

Referenced by eZ\Publish\Core\FieldType\Image\Type\toPersistenceValue(), and eZ\Publish\Core\FieldType\Image\Type\valuesEqual().

## ◆ toPersistenceValue()

eZ\Publish\Core\FieldType\Image\Type::toPersistenceValue | ( | SPIValue | $value | ) |

Converts a $value to a persistence value.

Parameters

  \eZ\Publish\Core\FieldType\Image\Value | $value |

Returns
  \eZ\Publish\SPI\Persistence\Content\FieldValue

Reimplemented from eZ\Publish\Core\FieldType\FieldType.

Definition at line 339 of file Core/FieldType/Image/Type.php.

References eZ\Publish\Core\FieldType\Image\Type\getSortInfo(), and eZ\Publish\Core\FieldType\Image\Type\toHash().

## ◆ validate()

eZ\Publish\Core\FieldType\Image\Type::validate | ( | FieldDefinition | $fieldDefinition,
|  | SPIValue | $fieldValue
| ) |  |

Validates a field based on the validators in the field definition.

Exceptions

Reimplemented from eZ\Publish\Core\FieldType\FieldType.

Definition at line 164 of file Core/FieldType/Image/Type.php.

References eZ\Publish\API\Repository\Values\ContentType\FieldDefinition\getValidatorConfiguration(), and eZ\Publish\Core\FieldType\FieldType\isEmptyValue().

## ◆ validateValidatorConfiguration()

eZ\Publish\Core\FieldType\Image\Type::validateValidatorConfiguration | ( |  | $validatorConfiguration | ) |

Validates the validatorConfiguration of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct.

Parameters

  mixed | $validatorConfiguration |

Returns
  \eZ\Publish\SPI\FieldType\ValidationError[]

Reimplemented from eZ\Publish\Core\FieldType\FieldType.

Definition at line 221 of file Core/FieldType/Image/Type.php.

## ◆ valuesEqual()

eZ\Publish\Core\FieldType\Image\Type::valuesEqual | ( | SPIValue | $value1,
|  | SPIValue | $value2
| ) |  |

Reimplemented from eZ\Publish\Core\FieldType\FieldType.

Definition at line 398 of file Core/FieldType/Image/Type.php.

References eZ\Publish\Core\FieldType\Image\Type\toHash().

## Member Data Documentation

## ◆ $validatorConfigurationSchema

eZ\Publish\Core\FieldType\Image\Type::$validatorConfigurationSchema
| protected

Initial value:
= [
'FileSizeValidator' => [
'maxFileSize' => [
'type' => 'int',
'default' => null,
],
],
'AlternativeTextValidator' => [
'required' => [
'type' => 'bool',
'default' => false,
],
],
]

See also
  eZ\Publish\Core\FieldType::$validatorConfigurationSchema

Definition at line 25 of file Core/FieldType/Image/Type.php.

## ◆ $validators

eZ\Publish\Core\FieldType\Image\Type::$validators
| private

Definition at line 41 of file Core/FieldType/Image/Type.php.

Referenced by eZ\Publish\Core\FieldType\Image\Type\__construct().

The documentation for this class was generated from the following file:

- Core/FieldType/Image/Type.php

Copyright © 1998 – 2026 7x. All rights reserved. Licensed under the GNU GPLv2+.