📚 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 / eZExpiryHandler  

API Reference
 

Sections

Todo

eZExpiryHandler Class Reference

Keeps track of expiry keys and their timestamps. More...

List of all members.


Public Methods

 eZExpiryHandler ()
 restore ()
 store ()
 setTimestamp ($name,$value)
 hasTimestamp ($name)
 timestamp ($name)
 isModified ()

Static Public Methods

& instance ()

Public Attributes

 Timestamps
 \privatesection

Detailed Description

Keeps track of expiry keys and their timestamps.

Definition at line ezexpiryhandler.php.

Constructor & Destructor Documentation

eZExpiryHandler::eZExpiryHandler (    ) 
 

Constructor

Definition at line ezexpiryhandler.php.

References Timestamps.

Referenced by instance().

Member Function Documentation

eZExpiryHandler::hasTimestamp (  $    name ) 
 

Returns:
true if the expiry key $name exists.

Definition at line ezexpiryhandler.php.

& eZExpiryHandler::instance (    )  [static]
 

Returns:
the unique instance of the expiry handler.

Definition at line ezexpiryhandler.php.

References eZExpiryHandler().

Referenced by eZTemplateCacheFunction::process().

eZExpiryHandler::isModified (    ) 
 

Returns:
true if the expiry handler has modified data.

Definition at line ezexpiryhandler.php.

eZExpiryHandler::restore (    ) 
 

Will load timestamp values from disk.

Definition at line ezexpiryhandler.php.

References Timestamps.

Referenced by eZExpiryHandler().

eZExpiryHandler::setTimestamp (  $    name,
$    value
) 
 

Sets the timestamp value $value for expiry key $name.

Definition at line ezexpiryhandler.php.

References Timestamps.

eZExpiryHandler::store (    ) 
 

Will store the current timestamp values to disk.

Definition at line ezexpiryhandler.php.

References Timestamps.

eZExpiryHandler::timestamp (  $    name ) 
 

Returns:
the timestamp value for the expiry key $name if it exists or false if not,

Definition at line ezexpiryhandler.php.

References eZDebug::writeError().

Referenced by timestamp().

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

Exponential Copyright © 1998 - 2026 7x