lib/ezutils/classes/ezexpiryhandler.php
inherited
Classes
File containing the eZExpiryHandler class.
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- lib
- Version
- 4.6.0
\eZExpiryHandler
Keeps track of expiry keys and their timestamps
- Class
- eZExpiryHandler ezexpiryhandler.php
Properties
bool
$IsModified= ''
Wether data has been modified or not
- Type
- bool
array
$Timestamps= ''
Holds the expiry timestamps array
- Type
- array
bool
$isShutdownFunctionRegistered= 'false'
Indicates if thre shutdown function has been registered
falseDetails- Type
- bool
Methods
eZExpiryHandler(
)
:
voidConstructor
fetchData(
string $path
)
:
voidIncludes the expiry file and extracts the $Timestamps variable from it.
| Name | Type | Description |
|---|---|---|
| $path | string |
getTimestamp(
string $name, int $default
=
false
)
:
mixedReturns the expiry timestamp for a key, or a default value if it isn't set
| Name | Type | Description |
|---|---|---|
| $name | string | Expiry key name |
| $default | int | Default value that will be returned if the key isn't set |
| Type | Description |
|---|---|
| mixed | The expiry timestamp, or $default |
hasInstance(
)
:
boolChecks if a shared instance of eZExpiryHandler exists
| Type | Description |
|---|---|
| bool | true if an instance exists, false otherwise |
hasTimestamp(
string $name
)
:
boolChecks if an expiry timestamp exist
| Name | Type | Description |
|---|---|---|
| $name | string | Expiry key name |
| Type | Description |
|---|---|
| bool | true if the timestamp exists, false otherwise |
instance(
)
:
\eZExpiryHandlerReturns a shared instance of the eZExpiryHandler class
| Type | Description |
|---|---|
| \eZExpiryHandler |
isModified(
)
:
boolReturns the data modification status
| Type | Description |
|---|---|
| bool | true if data was modified, false if it wasn't |
- Deprecated
- 4.2 will be removed in 4.3
registerShutdownFunction(
)
:
voidRegisters the shutdown function.
restore(
)
:
voidLoad the expiry timestamps from cache
setTimestamp(
string $name, int $value
)
:
voidSets the expiry timestamp for a key
| Name | Type | Description |
|---|---|---|
| $name | string | Expiry key |
| $value | int | Expiry timestamp value |
shutdown(
)
:
voidCalled at the end of execution and will store the data if it is modified.
store(
)
:
voidStores the current timestamps values to cache
timestamp(
string $name
)
:
int | falseReturns the expiry timestamp for a key
| Name | Type | Description |
|---|---|---|
| $name | string | Expiry key |
| Type | Description |
|---|---|
| int | false | The timestamp if it exists, false otherwise |