Skip to the content
Documentation
Version 3.8 EOL

ezimagealiashandler

Written by Balazs Halasy, Updated by Svitlana Shatokhina Maintainers: Balazs Halasy, Svitlana Shatokhina
No ratings yet
Summary

Contains information about an image.

Persistent

No.

Attributes
Attribute Type Static* Description
alternative_text string No. The alternative image text (for example "Picture of an apple.").
original_filename string No. The original name of the image file (for example "apple.png").
is_valid string No. Returns either 1 or 0 (valid or invalid).
name of variation array No.
Attribute Type Description
name string The name of the variation (for example "original").
width string The width as number of pixels (for example "320").
height string The height as number of pixels (for example "256").
mime_type string The MIME type (for example "image/png").
filename string The name of the file (for example "my_image.png").
suffix string The file suffix (for example "png").
dirpath string The path to the image (for example "var/storage/images/test/199-2-eng-GB").
basename string The basename of the image file (for example "apple").
alternative_text string The alternative image text (for example "Picture of an apple.").
text string Contains the "alternative_text" of the original image.
original_filename string The name of the original file (for example "apple.png").
url string Complete path + name of image file (for example "var/storage/images/test/199-2-eng-GB/apple.png").
alias_key string A internal CRC32 value which is used when an alias is created. This value is based on the filters that were used (parameters included) and is checked when an alias is accessed. If this values differs from the configured filters (in image.ini or an override), the system will recreate the alias.
timestamp string A UNIX timestamp pinpointing the exact date/time when the alias was last modified. For the "original" alias, the timestamp will reveal the time when the image was originally uploaded.
full_path string Complete path + name of image file (for example "var/storage/images/test/199-2-eng-GB/apple.png").
is_valid string TRUE if the alias was created properly, that means all conversion and filters were applied without problems. It will be FALSE if the image manager is wrongly configured or if there no compatible image converters could be found.
is_new boolean Will be set to TRUE the first time the alias is created, the next time (reload of the same page) it will be FALSE. It will also be set to TRUE every time the alias is re-created due to changes in filters (see alias_key).
filesize integer The number of bytes that the image consumes.
info string Contains extra information about the image, depending on the image type. It will typically contain EXIF information from digital cameras or information about animated GIFs. If there is no information, the info will be a boolean FALSE.

* Indicates whether the attribute provides a pre-fetched value or if it needs to be computed upon request.

Contributors

Comments (3 historical)

Written by readers of the earlier documentation sites, kept as they were.

  1. Name of variation

    Radek Z ·

    Documentation doesn't says anything about 'name of variation' - it took me nearly two hours to figure out how to access listed in sub-table attributes.
    Name of variation is type of image that ez should return for user:
    small
    medium
    listitem
    articleimage
    articlethumbnail
    gallerythumbnail
    galleryline
    imagelarge
    large
    rss
    logo
    infoboximage
    billboard
    original
    With that part you can acces further attributes:
    $object.data_map.image_attribute.content.original ...
    eZp system is very powerful, but documentation is poor.

  2. Exif informations

    Alimi Nabil ·

    The actual type of the "info" property of the variation object is "array" not "string".

Comments

Add a comment

Comments are read by a moderator before they appear.