From zeta-commits-return-358-apmail-incubator-zeta-commits-archive=incubator.apache.org@incubator.apache.org Sun Jul 10 17:32:56 2011 Return-Path: X-Original-To: apmail-incubator-zeta-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-zeta-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 71DE26394 for ; Sun, 10 Jul 2011 17:32:56 +0000 (UTC) Received: (qmail 21946 invoked by uid 500); 10 Jul 2011 17:32:56 -0000 Delivered-To: apmail-incubator-zeta-commits-archive@incubator.apache.org Received: (qmail 21920 invoked by uid 500); 10 Jul 2011 17:32:56 -0000 Mailing-List: contact zeta-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: zeta-dev@incubator.apache.org Delivered-To: mailing list zeta-commits@incubator.apache.org Received: (qmail 21913 invoked by uid 99); 10 Jul 2011 17:32:56 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 10 Jul 2011 17:32:56 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 10 Jul 2011 17:32:43 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 1C9302388C0E; Sun, 10 Jul 2011 17:31:33 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Date: Sun, 10 Jul 2011 17:31:24 -0000 To: zeta-commits@incubator.apache.org From: jeromer@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110710173133.1C9302388C0E@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Subject: [zeta-commits] svn commit: r1144915 [17/37] - in /incubator/zetacomponents: trunk/Authentication/docs/ trunk/AuthenticationDatabaseTiein/docs/ trunk/Base/docs/ trunk/Configuration/docs/ trunk/Document/docs/ trunk/EventLog/docs/ trunk/Feed/docs/ trunk/File/docs/ trunk... Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileApcArray.html URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileApcArray.html?rev=1144915&r1=1144914&r2=1144915&view=diff ============================================================================== --- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileApcArray.html (original) +++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileApcArray.html Sun Jul 10 17:30:59 2011 @@ -12,13 +12,13 @@ - + - + @@ -68,7 +68,10 @@
-

Creates a new cache storage in the given location. The location in case of this storage class must a valid file system directory.

-
-

Options can contain the 'ttl' (Time-To-Live). This is per default set to 1 day. The option 'permissions' can be used to define the file permissions of created cache items.

-

For details about the options see ezcCacheStorageFileApcArrayOptions.

-
+

Creates a new cache storage in the given location. The location in case of this storage class must a valid file system directory.

Options can contain the 'ttl' (Time-To-Live). This is per default set to 1 day. The option 'permissions' can be used to define the file permissions of created cache items.

For details about the options see ezcCacheStorageFileApcArrayOptions.

Parameters:
- - - +
Name
- - - - + - - - + - - -
Name Type Description
$location
$location string Path to the cache location. Must be a valid path
$options
$options array(string=>string) Options for the cache storage
-
Exceptions:
- - - - - - - +
TypeDescription
ezcBasePropertyNotFoundException
Exceptions:
+ + + - -
TypeDescription
ezcBasePropertyNotFoundException If you tried to set a non-existent option value.
-
Redefinition of:
- - - - - - - +
MethodDescription
ezcCacheStorageApc::__construct()
Redefinition of:
+ + + - -
MethodDescription
ezcCacheStorageApc::__construct() Creates a new cache storage in the given location.
- +

calcLifetime

@@ -660,46 +500,29 @@ = false] ) -

Calculates the lifetime remaining for a cache object.

-

If the TTL option is set to false, this method will always return 1 for existing items.

+

Calculates the lifetime remaining for a cache object.

If the TTL option is set to false, this method will always return 1 for existing items.

Parameters:
- - - +
Name
- - - - + - - - + - - -
Name Type Description
$filename
$filename string The file to calculate the remaining lifetime for
$useApc
$useApc bool Use APC or not
-
Redefinition of:
- - - - - - - +
MethodDescription
ezcCacheStorageMemory::calcLifetime()
Redefinition of:
+ + + - -
MethodDescription
ezcCacheStorageMemory::calcLifetime() Calculates the lifetime remaining for a cache object.
- +

delete

@@ -717,63 +540,39 @@

Deletes the data associated with $id or $attributes from the cache.

Parameters:
- - - +
Name
- - - - + - - - + - - - + - - -
Name Type Description
$id
$id string The item ID to purge
$attributes
$attributes array(string=>string) Attributes describing the data to restore
$search
$search bool Whether to search for items if not found directly
-
Exceptions:
- - - - - - - +
TypeDescription
ezcBaseFilePermissionException
Exceptions:
+ + + - -
TypeDescription
ezcBaseFilePermissionException If an already existsing cache file could not be unlinked. This exception means most likely that your cache directory has been corrupted by external influences (file permission change).
-
Redefinition of:
- - - - - - - +
MethodDescription
ezcCacheStorageMemory::delete()
Redefinition of:
+ + + - -
MethodDescription
ezcCacheStorageMemory::delete() Deletes the data associated with $id or $attributes from the cache.
- +

fetchData

@@ -789,43 +588,27 @@

Fetches the data from the cache.

Parameters:
- - - +
Name
- - - - + - - - + - - -
Name Type Description
$filename
$filename string The ID/filename from where to fetch the object
$useApc
$useApc bool Use APC or the file system
-
Redefinition of:
- - - - - - - +
MethodDescription
ezcCacheStorageApc::fetchData()
Redefinition of:
+ + + - -
MethodDescription
ezcCacheStorageApc::fetchData() Fetches data from the cache.
- +

fetchObject

@@ -839,21 +622,15 @@

Fetches the object from the cache.

Parameters:
- - - +
Name
- - - + - -
Name Type Description
$filename
$filename string The ID/filename from where to fetch the data
- +

prepareData

@@ -869,56 +646,34 @@

Wraps the data in order to be stored in APC ($useApc = true) or on the file system ($useApc = false).

Parameters:
- - - +
Name
- - - - + - - - + - - -
Name Type Description
$data
$data mixed Simple type or array
$useApc
$useApc bool Use APC or not
-
Exceptions:
- - - - - - - +
TypeDescription
ezcCacheInvalidDataException
Exceptions:
+ + + - -
TypeDescription
ezcCacheInvalidDataException If the data submitted can not be handled by this storage (object, resource).
-
Redefinition of:
- - - - - - - +
MethodDescription
ezcCacheStorageApc::prepareData()
Redefinition of:
+ + + - -
MethodDescription
ezcCacheStorageApc::prepareData() Prepares the data for storing.
- +

restore

@@ -936,50 +691,32 @@

Restores the data from the cache.

Parameters:
- - - +
Name
- - - - + - - - + - - - + - - -
Name Type Description
$id
$id string The item ID to restore
$attributes
$attributes array(string=>string) Attributes describing the data to restore
$search
$search bool Whether to search for items if not found directly
-
Redefinition of:
- - - - - - - +
MethodDescription
ezcCacheStorageMemory::restore()
Redefinition of:
+ + + - -
MethodDescription
ezcCacheStorageMemory::restore() Restores the data from the cache.
- +

store

@@ -997,83 +734,51 @@

Stores data to the cache storage.

Parameters:
- - - +
Name
- - - - + - - - + - - - + - - -
Name Type Description
$id
$id string Unique identifier
$data
$data mixed The data to store
$attributes
$attributes array(string=>string) Attributes describing the cached data
-
Exceptions:
- - - - - - - - +
TypeDescription
ezcBaseFilePermissionException
Exceptions:
+ + + - - - + - - - + - - - - - - -
TypeDescription
ezcBaseFilePermissionException If the directory to store the cache file could not be created. This exception means most likely that your cache directory has been corrupted by external influences (file permission change).
ezcCacheApcException
ezcCacheApcException If the data could not be stored in APC.
ezcBaseFileIoException
ezcBaseFileIoException If an error occured while writing the data to the cache. If this exception occurs, a serious error occured and your storage might be corruped (e.g. broken network connection, file system broken, ...).
ezcCacheInvalidDataException - If the data submitted can not be handled by the implementation of ezcCacheStorageFile. Most implementations can not handle objects and resources. -
-
Redefinition of:
- - - - - - - + + +
MethodDescription
ezcCacheStorageMemory::store()
ezcCacheInvalidDataException + If the data submitted can not be handled by the implementation of ezcCacheStorageFile. Most implementations can not handle objects and resources. +
Redefinition of:
+ + + - -
MethodDescription
ezcCacheStorageMemory::store() Stores data to the cache storage under the key $id.
- +

validateLocation

@@ -1086,46 +791,28 @@

Checks the path in the location property exists, and is read-/writable. It throws an exception if not.

Exceptions:
- - - - - - - - - - - - - - - - - - - -
TypeDescription
ezcBaseFileNotFoundException - If the storage location does not exist. This should usually not happen, since ezcCacheManager::createCache() already performs sanity checks for the cache location. In case this exception is thrown, your cache location has been corrupted after the cache was configured. -
ezcBaseFileNotFoundException - If the storage location is not a directory. This should usually not happen, since ezcCacheManager::createCache() already performs sanity checks for the cache location. In case this exception is thrown, your cache location has been corrupted after the cache was configured. -
ezcBaseFilePermissionException - If the storage location is not writeable. This should usually not happen, since ezcCacheManager::createCache() already performs sanity checks for the cache location. In case this exception is thrown, your cache location has been corrupted after the cache was configured. -
-
Redefinition of:
- - - - - - - +
MethodDescription
ezcCacheStorageMemory::validateLocation()
+ + + + + + + +
TypeDescription
ezcBaseFileNotFoundException + If the storage location does not exist. This should usually not happen, since ezcCacheManager::createCache() already performs sanity checks for the cache location. In case this exception is thrown, your cache location has been corrupted after the cache was configured. +
ezcBaseFileNotFoundException + If the storage location is not a directory. This should usually not happen, since ezcCacheManager::createCache() already performs sanity checks for the cache location. In case this exception is thrown, your cache location has been corrupted after the cache was configured. +
ezcBaseFilePermissionException + If the storage location is not writeable. This should usually not happen, since ezcCacheManager::createCache() already performs sanity checks for the cache location. In case this exception is thrown, your cache location has been corrupted after the cache was configured. +
Redefinition of:
+ + + - -
MethodDescription
ezcCacheStorageMemory::validateLocation() Checks if the location property is valid.
-
+
Documentation generated by phpDocumentor 1.4.3
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileApcArrayDataStruct.html URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileApcArrayDataStruct.html?rev=1144915&r1=1144914&r2=1144915&view=diff ============================================================================== --- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileApcArrayDataStruct.html (original) +++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileApcArrayDataStruct.html Sun Jul 10 17:30:59 2011 @@ -12,13 +12,13 @@ - + - + @@ -68,7 +68,10 @@