Server

# Class: ServerMapInfoCache Source Location: /server/ServerMapInfoCache.php
### Class Overview
    MapInfoCache
       |
       --ServerMapInfoCache
Server side MapInfo cache implementation #### Author(s): Sylvain Pasche <sylvain.pasche@camptocamp.com> | ### Variables $log $mapInfoHandler | ### Methods __construct computeMapInfo getMapInfoFile isCacheValid
### Inherited Variables #### Class: MapInfoCache MapInfoCache::$cacheTimestamp MapInfoCache::$config MapInfoCache::$mapId | ### Inherited Methods #### Class: MapInfoCache MapInfoCache::__construct() Constructor MapInfoCache::cacheMapInfo() Writes MapInfo cache file and returns MapInfo. It can be used by implementing classes to refill the cache when not valid anymore. MapInfoCache::computeMapInfo() Method called to fetch the Mapinfo. On the client, it will issue a SOAP request, and on the server, it will build the structure out of configuration files. MapInfoCache::getCacheTimestamp() Returns the timestamp of the last MapInfo from cache MapInfoCache::getMapId() Returns the current mapId MapInfoCache::getMapInfo() Returns MapInfo using cache MapInfoCache::getMapInfoFile() Gets MapInfo cache file name MapInfoCache::isCacheValid() This method may be overrided by sublclasses to assert the validity if the MapInfo object read from cache (typically by comparing the timestamp field: see getCacheTimestamp() ). If it returns false, The MapInfo will be requested again, and put into the cache. MapInfoCache::readCachedMapInfo() Reads MapInfo from file and unserializes it MapInfoCache::skipCache() Returns true if cache is disabled. It can be used by implementing classes to check if they should skip the caching.
### Class Details [line 32] Server side MapInfo cache implementation #### Tags:
author: | Sylvain Pasche <sylvain.pasche@camptocamp.com>
[ Top ] ### Class Variables #### $log = [line 37] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] #### $mapInfoHandler = [line 42] #### Tags:
access: | private
Type: | MapInfoHandler
[ Top ] ### Class Methods ### constructor __construct [line 73]
`ServerMapInfoCache __construct( MapInfoHandler $mapInfoHandler)`
Constructor #### Tags:
access: | public
Overrides MapInfoCache::__construct() (Constructor) #### Parameters:
Cartoclient | $mapInfoHandler |
[ Top ] ### method computeMapInfo [line 47]
`void computeMapInfo( )`
#### Tags:
access: | protected
see: | MapInfoCache::computeMapInfo()
Overrides MapInfoCache::computeMapInfo() (Method called to fetch the Mapinfo. On the client, it will issue a SOAP request, and on the server, it will build the structure out of configuration files.) [ Top ] ### method getMapInfoFile [line 55]
`void getMapInfoFile( )`
#### Tags:
access: | protected
see: | MapInfoCache::getMapInfoFile()
Overrides MapInfoCache::getMapInfoFile() (Gets MapInfo cache file name) [ Top ] ### method isCacheValid [line 63]
`void isCacheValid( )`
#### Tags:
access: | protected
see: | MapInfoCache::computeMapInfo()
Overrides MapInfoCache::isCacheValid() (This method may be overrided by sublclasses to assert the validity if the MapInfo object read from cache (typically by comparing the timestamp field: see getCacheTimestamp() ). If it returns false, The MapInfo will be requested again, and put into the cache.) [ Top ] Documentation generated on Fri, 21 Sep 2007 13:31:04 +0200 by phpDocumentor 1.3.0RC3