Client
[ class tree: Client ] [ index: Client ] [ all elements ]

Class: ClientMapInfoCache

Source Location: /client/ClientMapInfoCache.php

Class Overview

MapInfoCache
   |
   --ClientMapInfoCache

Client side MapInfo cache implementation


Author(s):

Variables

Methods


Inherited Variables

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]
Client side MapInfo cache implementation



Tags:

author:  Sylvain Pasche <sylvain.pasche@camptocamp.com>


[ Top ]


Class Variables

$cartoclient =

[line 42]



Tags:

access:  private

Type:   Cartoclient


[ Top ]

$log =

[line 37]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]



Class Methods


constructor __construct [line 48]

ClientMapInfoCache __construct( Cartoclient $cartoclient)

Constructor



Tags:

access:  public


Overrides MapInfoCache::__construct() (Constructor)

Parameters:

Cartoclient   $cartoclient  

[ Top ]

method checkMapInfoTimestamp [line 76]

void checkMapInfoTimestamp( int $timestamp, string 1)

Checks if MapInfo is up-to-date, reload it from server if it's not



Tags:

access:  public


Parameters:

string   1   mapId
int   $timestamp   timestamp

[ Top ]

method computeMapInfo [line 58]

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 66]

void getMapInfoFile( )



Tags:

access:  protected
see:  MapInfoCache::getMapInfoFile()


Overrides MapInfoCache::getMapInfoFile() (Gets MapInfo cache file name)

[ Top ]


Documentation generated on Mon, 09 Sep 2013 13:30:39 +0200 by phpDocumentor 1.3.0RC3