PHP Class eZ\Publish\Core\FieldType\Image\Value

Inheritance: extends eZ\Publish\Core\FieldType\Value
Datei anzeigen Open project: ezsystems/ezpublish-kernel Class Usage Examples

Public Properties

Property Type Description
$alternativeText string | null The alternative image text (for example "Picture of an apple.").
$fileName string Required.
$fileSize integer Required.
$height integer Original image height.
$id mixed Required.
$imageId mixed External image ID (required by REST for now, see https://jira.ez.no/browse/EZP-20831).
$inputUri string Input image file URI.
$uri string The image's HTTP URI.
$width integer Original image width.

Public Methods

Method Description
__construct ( array $imageData = [] ) Construct a new Value object.
__get ( $propertyName )
__set ( $propertyName, $propertyValue )
__toString ( )
fromString ( string $path ) : Value Creates a value only from a file path.
getFileSize ( ) : integer Returns the image file size in byte.

Method Details

__construct() public method

Construct a new Value object.
public __construct ( array $imageData = [] )
$imageData array

__get() public method

public __get ( $propertyName )

__set() public method

public __set ( $propertyName, $propertyValue )

__toString() public method

See also: eZ\Publish\Core\FieldType\Value
public __toString ( )

fromString() public static method

Creates a value only from a file path.
Deprecation: Starting with 5.3.3, handled by Image\Type::acceptValue()
public static fromString ( string $path ) : Value
$path string
return Value

getFileSize() public method

Returns the image file size in byte.
public getFileSize ( ) : integer
return integer

Property Details

$alternativeText public_oe property

The alternative image text (for example "Picture of an apple.").
public string|null $alternativeText
return string | null

$fileName public_oe property

Required.
public string $fileName
return string

$fileSize public_oe property

Required.
public int $fileSize
return integer

$height public_oe property

Original image height.
public int $height
return integer

$id public_oe property

Required.
public mixed $id
return mixed

$imageId public_oe property

External image ID (required by REST for now, see https://jira.ez.no/browse/EZP-20831).
public mixed $imageId
return mixed

$inputUri public_oe property

Input image file URI.
public string $inputUri
return string

$uri public_oe property

The image's HTTP URI.
public string $uri
return string

$width public_oe property

Original image width.
public int $width
return integer