📚 Looking for current Exponential documentation? This site contains legacy SDK & API reference docs (eZ Publish era). For up-to-date 2026 product documentation, visit doc.exponential.earth.

  class / eZImage  

API Reference
 

Sections

Todo

eZImage Class Reference
[Kernel system]

The class eZImage handles registered images. More...

Inheritance diagram for eZImage: 

TODO — Image not available in archive

Title:   eZImage Class Inheritance Diagram
ID:      class-diagram-eZImage
In:      sdk/ref/view/class/eZImage.html

What this image shows:
Doxygen-generated class inheritance diagram for eZImage. Shows the class hierarchy: which classes eZImage extends and which classes inherit from it, rendered as a linked image map. The image was generated from the Exponential 3.1 PHP source code using Doxygen circa 2003 and was not captured by the Wayback Machine crawler (replaced with a 1×1 transparent spacer).

Replacement instructions:
Run Doxygen on the Exponential 3.1 PHP source (class eZImage). Place the generated PNG as the img src and retain the  block below this image for the clickable inheritance links.

See /sdk/missing.html for the full list of missing images.
eZPersistentObject List of all members.

Public Methods

& definition ()
 attributes ()
 hasAttribute ($attr)
& attribute ($attr)
& remove ($id,$version)

Detailed Description

The class eZImage handles registered images.

Definition at line ezimage.php.

Member Function Documentation

& eZImage::attribute (  $    attr ) 
 

Returns:
the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched.

Reimplemented from eZPersistentObject.

Definition at line ezimage.php.

References eZINI::instance().

eZImage::attributes (    ) 
 

Returns:
the attributes for this object, taken from the definition fields and function attributes.

Reimplemented from eZPersistentObject.

Definition at line ezimage.php.

References eZPersistentObject::attributes().

& eZImage::definition (    ) 
 

Returns:
the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.
The definition array is an associative array consists of these keys:
  • fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
  • keys - an array of fields which is used for uniquely identifying the object in the table.
  • function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
  • set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
  • increment_key - the field which is incremented on table inserts.
  • class_name - the classname which is used for instantiating new objecs when fetching from the database.
  • sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
  • name - the name of the database table
Example: 
function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line ezimage.php.

Referenced by remove().

eZImage::hasAttribute (  $    attr ) 
 

Returns:
true if the attribute $attr is part of the definition fields or function attributes.

Reimplemented from eZPersistentObject.

Definition at line ezimage.php.

References eZPersistentObject::hasAttribute().

& eZImage::remove (  $    id,
$    version
) 
 

Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. It uses removeObject to do the real job and passes the object defintion, conditions and extra conditions $extraConditions to this function.

Reimplemented from eZPersistentObject.

Definition at line ezimage.php.

References eZPersistentObject::removeObject().

Referenced by eZImageType::deleteStoredObjectAttribute().

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

Exponential Copyright © 1998 - 2026 7x