Common

# Element index for package Common [ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ k ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ w ] [ x ] [ y ] [ _ ] ## _ __construct in file Message.php, method Message::__construct() Constructor __construct in file MapInfoCache.php, method MapInfoCache::__construct() Constructor __construct in file CwSerializable.php, method CwSerializable::__construct() Constructor __construct in file PluginBase.php, method PluginBase::__construct() Constructor __construct in file PluginManager.php, method PluginManager::__construct() Constructor __construct in file ServerProjectHandler.php, method ServerProjectHandler::__construct() Constructor __construct in file SecurityManager.php, method SecurityManager::__construct() Constructor __construct in file ResourceHandler.php, method ResourceHandler::__construct() Constructor __construct in file Config.php, method PluginConfig::__construct() Constructor __construct in file Config.php, method Config::__construct() Constructor __construct in file BasicTypes.php, method Dimension::__construct() Constructor __construct in file BasicTypes.php, method Bbox::__construct() Constructor __construct in file Accounting.php, method DummyAccounting::__construct() Constructor __construct in file BasicTypes.php, method GeoDimension::__construct() Constructor __construct in file BasicTypes.php, method Point::__construct() Constructor __construct in file Common.php, method SoapFault::__construct() __construct in file Common.php, method CartowebException::__construct() Constructor __construct in file Accounting.php, method Accounting::__construct() Constructor. Can't be called directly, use getInstance() instead. __get in file Config.php, method Config::__get() Property access method __toString in file BasicTypes.php, method Bbox::__toString() Converts Bbox to string for display top ## a $accountings in file Accounting.php, variable Accounting::$accountings Hash of accounting messages. Indexed by labels $active in file Accounting.php, variable Accounting::$active True when accounting is active. Used to shut down accounting temporarily $aggregate in file Layers.php, variable LayerGroup::$aggregate If true, children won't be displayed account in file PluginBase.php, method PluginBase::account() Records an accounting message for plugins account in file Accounting.php, method Accounting::account() Records an accounting message Accounting in file Accounting.php, class Accounting Abstract base class for accounting management. addslashes in file Utils.php, method Utils::addslashes() Escapes special characters taking into account if magic_quotes_gpc is ON or not. Multidimensional arrays are accepted. Accounting.php procedural page Accounting.php top ## b $basePath in file PluginBase.php, variable PluginBase::$basePath Root path for plugin files $bbox in file BasicTypes.php, variable GeoDimension::$bbox $bbox in file MapInfo.php, variable Location::$bbox backtrace in file Common.php, method CartowebException::backtrace() Transforms a backtrace structure into a readable html string Bbox in file BasicTypes.php, class Bbox A bounding box (bbox) BboxConverter in file ShapeConverter.php, class BboxConverter Abstract class for ShapeConverters bt in file Utils.php, function bt() For debugging purpose only BasicTypes.php procedural page BasicTypes.php top ## c $cacheHit in file Accounting.php, variable Accounting::$cacheHit True when a cache hit on server occured, to prevent error message of $cacheTimestamp in file MapInfoCache.php, variable MapInfoCache::$cacheTimestamp $cartoclientBaseUrl in file ResourceHandler.php, variable ResourceHandler::$cartoclientBaseUrl The URL to the cartoclient base $cartoserverBaseUrl in file ResourceHandler.php, variable ResourceHandler::$cartoserverBaseUrl The URL to the cartoserver base. $channel in file Message.php, variable Message::$channel The channel identifier of this message. See the constants named CHANNEL_... . $children in file Layers.php, variable LayerContainer::$children Key-values list of ChildrenSwitch $className in file CwSerializable.php, variable CwSerializable::$className $config in file MapInfoCache.php, variable MapInfoCache::$config cacheMapInfo in file MapInfoCache.php, method MapInfoCache::cacheMapInfo() Writes MapInfo cache file and returns MapInfo. It can be used by implementing classes to refill the cache when not valid anymore. callEnabledPluginImplementing in file PluginManager.php, method PluginManager::callEnabledPluginImplementing() Calls a function on a plugin implementing an interface IF the plugin is enabled. callEnabledPluginsImplementing in file PluginManager.php, method PluginManager::callEnabledPluginsImplementing() Calls a function on enabled plugins implementing an interface. callPluginImplementing in file PluginManager.php, method PluginManager::callPluginImplementing() Calls a function on the given plugin that implements the given interface. callPlugins in file PluginManager.php, method PluginManager::callPlugins() Calls a function on plugins callPluginsImplementing in file PluginManager.php, method PluginManager::callPluginsImplementing() Calls a function on plugins implementing an interface CARTOCLIENT_HOME in file Common.php, constant CARTOCLIENT_HOME Cartocommon in file Common.php, class Cartocommon Base class shared by Cartoclient and ServerContext CartocommonException in file Common.php, class CartocommonException Exception for common classes CARTOCOMMON_HOME in file Common.php, constant CARTOCOMMON_HOME CARTOSERVER_HOME in file Common.php, constant CARTOSERVER_HOME cartowebErrorHandler in file Common.php, method Common::cartowebErrorHandler() Error handler for cartoweb. CartowebException in file Common.php, class CartowebException Base exception for cartoweb CARTOWEB_HOME in file Common.php, constant CARTOWEB_HOME checkDbError in file Utils.php, method Utils::checkDbError() Wrapper for PEAR::isError, which throws an exception in case of failure checkUser in file SecurityManager.php, method SecurityContainer::checkUser() Check if a username, password pair is valid. It must return false if the user is unknown or its password is invalid. checkUser in file SecurityManager.php, method SecurityManager::checkUser() Check if a username, password pair is valid. ChildrenSwitch in file Layers.php, class ChildrenSwitch Class containing children for children switching Circle in file BasicTypes.php, class Circle A circle CircleConverter in file ShapeConverter.php, class CircleConverter Abstract class for ShapeConverters clearSecurityContainer in file SecurityManager.php, method SecurityManager::clearSecurityContainer() Removes the current SecurityConainer. No user will be authenticated since then. Common in file Common.php, class Common Class containing general common code shared by client and server. computeMapInfo in file MapInfoCache.php, method 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. Config in file Config.php, class Config Main configuration ConfigParser in file Utils.php, class ConfigParser Tools for configuration files parsing convertCoordinates in file ShapeConverter.php, method CircleConverter::convertCoordinates() convertCoordinates in file ShapeConverter.php, method PointConverter::convertCoordinates() convertCoordinates in file ShapeConverter.php, method LineConverter::convertCoordinates() convertCoordinates in file ShapeConverter.php, method BboxConverter::convertCoordinates() convertXhtml in file ResourceHandler.php, method ResourceHandler::convertXhtml() Replaces some URL characters by XHTML-proof ones. copyAllVars in file CwSerializable.php, method CwSerializable::copyAllVars() Copy all properties from one object to another (overwriting previous ones) copyProperties in file Utils.php, method Utils::copyProperties() Copies values from an objet to another. It uses reflection for reading the properties of each objects. copyVars in file Utils.php, method Utils::copyVars() Copies values from an objet to another. It only updates if destination var exists. Does not use reflection. CwSerializable in file CwSerializable.php, class CwSerializable Abstract class for all classes that can be serialized ClientAccounting.php procedural page ClientAccounting.php Common.php procedural page Common.php Config.php procedural page Config.php CwSerializable.php procedural page CwSerializable.php top ## d $dimension in file BasicTypes.php, variable GeoDimension::$dimension $directAccess in file ResourceHandler.php, variable ResourceHandler::$directAccess True if the client is in direct access mode. deepClone in file StructHandler.php, method StructHandler::deepClone() Performs full object cloning. Dimension in file BasicTypes.php, class Dimension Represents an image's dimension DummyAccounting in file Accounting.php, class DummyAccounting Dummy accounting implementation used in case Cartoclient/server is not loaded top ## e $extent in file MapInfo.php, variable MapInfo::$extent DEFAULT_PROJECT in file ProjectHandler.php, class constant ProjectHandler::DEFAULT_PROJECT DEFAULT_SWITCH in file Layers.php, class constant ChildrenSwitch::DEFAULT_SWITCH SERVER in file PluginManager.php, class constant PluginManager::SERVER top ## f $faultstring in file Common.php, variable SoapFault::$faultstring $frozen in file MapInfo.php, variable LayerState::$frozen Feature in file BasicTypes.php, class Feature A feature top ## g generateMetaHash in file Layers.php, method LayerBase::generateMetaHash() Fills the $metaHash property from the metadata values in metadata field GeoDimension in file BasicTypes.php, class GeoDimension Represents an image's dimension and bbox getAllMetadata in file Layers.php, method LayerBase::getAllMetadata() Returns an associative array of all metadata variables containted in this layer. getArea in file BasicTypes.php, method Bbox::getArea() getArea in file BasicTypes.php, method Line::getArea() getArea in file BasicTypes.php, method Circle::getArea() getArea in file BasicTypes.php, method Polygon::getArea() getArea in file BasicTypes.php, method Point::getArea() getArea in file BasicTypes.php, method Shape::getArea() Computes the shape's area getAvailableProjects in file ProjectHandler.php, method ProjectHandler::getAvailableProjects() Returns a list of available projects. getBasePath in file PluginBase.php, method PluginBase::getBasePath() getBasePath in file Config.php, method Config::getBasePath() Returns the client or server root path getBasePluginPath in file PluginManager.php, method PluginManager::getBasePluginPath() Returns full plugin base path getCacheTimestamp in file MapInfoCache.php, method MapInfoCache::getCacheTimestamp() Returns the timestamp of the last MapInfo from cache getCartowebMessage in file Common.php, method CartowebException::getCartowebMessage() Gets the current message getCenter in file BasicTypes.php, method Line::getCenter() getCenter in file BasicTypes.php, method Shape::getCenter() Computes the shape's center getCenter in file BasicTypes.php, method Bbox::getCenter() getCenter in file BasicTypes.php, method Circle::getCenter() getCenter in file BasicTypes.php, method Polygon::getCenter() getCenter in file BasicTypes.php, method Point::getCenter() getChildren in file Layers.php, method LayerContainer::getChildren() Returns children depending on current switch getClassName in file PluginManager.php, method PluginManager::getClassName() Constructs a plugin class name getCommonPath in file PluginManager.php, method PluginManager::getCommonPath() Returns plugin's common file path getConfig in file Accounting.php, method DummyAccounting::getConfig() getConfig in file Accounting.php, method Accounting::getConfig() Returns the client or server configuration object getCorePluginNames in file Common.php, method Cartocommon::getCorePluginNames() Returns the names of core plugins shared by client and server getCurrentPlugin in file PluginManager.php, method PluginManager::getCurrentPlugin() Returns current plugin objet getDb in file Utils.php, method Utils::getDb() Affects and returns a PEAR::DB object. getExtendedName in file PluginBase.php, method PluginBase::getExtendedName() getFinalUrl in file ResourceHandler.php, method ResourceHandler::getFinalUrl() Processes a relative URL to a resource, and convert it so that it is accessible on the client templates. getGeneratedUrl in file ResourceHandler.php, method ResourceHandler::getGeneratedUrl() Returns an URL to access files inside the directory of generated files (like generated mapserver images, pdf files, ...) This can be used for server or client resources. getHeight in file BasicTypes.php, method Bbox::getHeight() Computes Bbox height getHtdocsUrl in file ResourceHandler.php, method ResourceHandler::getHtdocsUrl() Returns the URL for resources in htdocs directory (may be in projects and plugins) This is only relevent for client resources. getIconUrl in file ResourceHandler.php, method ResourceHandler::getIconUrl() Returns an URL to access icon images inside icons subdirectory where the mapfile is located. getIniArray in file Config.php, method Config::getIniArray() Returns protected var $ini_array. getInitialMapStateById in file MapInfo.php, method MapInfo::getInitialMapStateById() Returns a map state identified by its ID getInstance in file SecurityManager.php, method SecurityManager::getInstance() Returns the instance of this class. There is only one during the cartoclient/server lifetime. getInstance in file Accounting.php, method Accounting::getInstance() Returns the instance of this class. getKind in file Accounting.php, method Accounting::getKind() Returns type of Accoungint ('client' or 'server') getKind in file Config.php, method Config::getKind() Returns type of config ('client' or 'server') getKind in file Accounting.php, method DummyAccounting::getKind() getMapId in file Accounting.php, method DummyAccounting::getMapId() getMapId in file Accounting.php, method Accounting::getMapId() Returns the mapId of the current map. getMapId in file MapInfoCache.php, method MapInfoCache::getMapId() Returns the current mapId getMapInfo in file MapInfoCache.php, method MapInfoCache::getMapInfo() Returns MapInfo using cache getMapInfoFile in file MapInfoCache.php, method MapInfoCache::getMapInfoFile() Gets MapInfo cache file name getMapName in file ProjectHandler.php, method ProjectHandler::getMapName() getMetadata in file Layers.php, method LayerBase::getMetadata() Returns a metadata valued from its key, or null if it does not exists. getName in file PluginBase.php, method PluginBase::getName() getPath in file ProjectHandler.php, method ProjectHandler::getPath() Returns path for a file, depending on projects getPath in file Config.php, method PluginConfig::getPath() Returns directory where .ini are located getPathOrAbsoluteUrl in file ResourceHandler.php, method ResourceHandler::getPathOrAbsoluteUrl() From a relative resource URL, returns either a path to the corresponding file on the file system, if accessible (only for client resources, or server in direct access mode). Otherwise, it will return the absolute URL to the resource. getPlugin in file PluginManager.php, method PluginManager::getPlugin() Returns plugin object for a plugin name or NULL if this plugin getPluginFilename in file PluginManager.php, method PluginManager::getPluginFilename() Returns plugin's main class file name getPlugins in file PluginManager.php, method PluginManager::getPlugins() Returns the plugins objects list. getPredefinedRoles in file SecurityManager.php, method SecurityManager::getPredefinedRoles() Returns the pre-defined roles for a user. getProfileParameters in file Config.php, method Config::getProfileParameters() Return the name of the parameters which will be automatically set from the current profile (overriding the one from configuration). getProjectName in file ProjectHandler.php, method ProjectHandler::getProjectName() Returns the project name getProjectName in file ServerProjectHandler.php, method ServerProjectHandler::getProjectName() getRelativePath in file PluginManager.php, method PluginManager::getRelativePath() Returns the relative path to the plugin parent directory. The directory layout is as follow: getRequest in file PluginBase.php, method PluginBase::getRequest() Get plugin's request or result out of MapRequest or MapResult getRoles in file SecurityManager.php, method SecurityManager::getRoles() getRoles in file SecurityManager.php, method SecurityContainer::getRoles() Returns the list of rules belonging to a user. getUser in file SecurityManager.php, method SecurityManager::getUser() getValue in file CwSerializable.php, method CwSerializable::getValue() Returns structure's property value if property exists getWidth in file BasicTypes.php, method Bbox::getWidth() Computes Bbox width getX in file BasicTypes.php, method Point::getX() getY in file BasicTypes.php, method Point::getY() gt in file Common.php, method I18nNoop::gt() guessClassName in file CwSerializable.php, method CwSerializable::guessClassName() Tries to guess the class to use from the property being unserialised. top ## h $height in file BasicTypes.php, variable Dimension::$height Height of the image $helpers in file PluginManager.php, variable PluginManager::$helpers $hidden in file MapInfo.php, variable LayerState::$hidden CHANNEL_DEVELOPER in file Message.php, class constant Message::CHANNEL_DEVELOPER CHANNEL_USER in file Message.php, class constant Message::CHANNEL_USER Constants to define the different the purpose of the message. Used for instance to distinguate user and developer targeted messages. hasRole in file SecurityManager.php, method SecurityManager::hasRole() Check if the current user has the given role, or at least one role among the one given, if it is an array. top ## i $icon in file Layers.php, variable LayerBase::$icon Icon to display for layer $id in file MapInfo.php, variable InitialMapState::$id State's ID $id in file MapInfo.php, variable LayerState::$id State's ID $id in file Layers.php, variable ChildrenSwitch::$id Switch's Id $id in file Layers.php, variable LayerBase::$id $id in file BasicTypes.php, variable Feature::$id feature id $imagesRequest in file Request.php, variable MapRequest::$imagesRequest $initialMapStates in file MapInfo.php, variable MapInfo::$initialMapStates $ini_array in file Config.php, variable Config::$ini_array Array of string which contains contents of .ini configuration file $instance in file Accounting.php, variable Accounting::$instance Singleton $instance in file SecurityManager.php, variable SecurityManager::$instance Singleton HIDDEN_PROJECTS in file ProjectHandler.php, class constant ProjectHandler::HIDDEN_PROJECTS I18nNoop in file Common.php, class I18nNoop Internationalization methods for automatic strings retrieving includeClassFiles in file PluginManager.php, method PluginManager::includeClassFiles() Tries to include plugin PHP scripts initialize in file PluginBase.php, method PluginBase::initialize() Plugin initialization (can be extended in custom plugins) initializeApd in file Common.php, method Common::initializeApd() Initialization of the "advanced php debugger" stuff. initializeCartoweb in file Common.php, method Common::initializeCartoweb() Perform various cartoweb initializations. initializeConfig in file PluginBase.php, method PluginBase::initializeConfig() Initializes plugin initializeLog4php in file Log4phpInit.php, function initializeLog4php() Initializes the log4php library InitialLocation in file MapInfo.php, class InitialLocation Initial position InitialMapState in file MapInfo.php, class InitialMapState Initial display state for a mapfile invertImage in file Utils.php, method Utils::invertImage() Inverts and saves image. isActive in file Accounting.php, method Accounting::isActive() Returns true if accounting is active and enabled isCacheValid in file MapInfoCache.php, method 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. isErrorIgnored in file Common.php, method Common::isErrorIgnored() Ananlyzes errors, and eventually ignores some. isInteger in file Utils.php, method Utils::isInteger() Tests if argument is an integer. isProjectFile in file ProjectHandler.php, method ProjectHandler::isProjectFile() Finds out if a file or directory exists in project isRelativePath in file Utils.php, method Utils::isRelativePath() Tells if given path is relative. top ## k $keymapGeoDimension in file MapInfo.php, variable MapInfo::$keymapGeoDimension $kind in file PluginManager.php, variable PluginManager::$kind top ## l $label in file Layers.php, variable LayerBase::$label $layerIds in file Layers.php, variable LayerContainer::$layerIds Layer Ids cache $layers in file MapInfo.php, variable InitialMapState::$layers Array of layer states. $layers in file Layers.php, variable ChildrenSwitch::$layers Array of LayerBase ids $layersRequest in file Request.php, variable MapRequest::$layersRequest $link in file Layers.php, variable LayerBase::$link External link to be added to label $loadPlugins in file MapInfo.php, variable MapInfo::$loadPlugins IDs of plugins to be loaded $location in file MapInfo.php, variable InitialMapState::$location Initial position on map $location in file MapInfo.php, variable MapInfo::$location $locationRequest in file Request.php, variable MapRequest::$locationRequest $log in file PluginBase.php, variable PluginBase::$log $log in file MapInfoCache.php, variable MapInfoCache::$log $log in file PluginManager.php, variable PluginManager::$log ALL_ROLE in file SecurityManager.php, class constant SecurityManager::ALL_ROLE Constants for pre-defined roles. CLIENT in file PluginManager.php, class constant PluginManager::CLIENT Log4phpInit.php procedural page Log4phpInit.php l in file Utils.php, function l() For debugging purpose only Layer in file Layers.php, class Layer Layer linked to a MapServer layer LayerBase in file Layers.php, class LayerBase Base class for layers LayerClass in file Layers.php, class LayerClass Layer class LayerContainer in file Layers.php, class LayerContainer Layer with children LayerGroup in file Layers.php, class LayerGroup Layer node LayerState in file MapInfo.php, class LayerState Layer display state Line in file BasicTypes.php, class Line A (poly)line LineConverter in file ShapeConverter.php, class LineConverter Abstract class for ShapeConverters loadFromArray in file StructHandler.php, method StructHandler::loadFromArray() Returns a structure from an array loaded from a .ini loadFromIni in file StructHandler.php, method StructHandler::loadFromIni() Returns a structure with content of a .ini file loadPlugins in file PluginManager.php, method PluginManager::loadPlugins() Loads plugins Location in file MapInfo.php, class Location Position on a map top ## m $mapId in file Request.php, variable MapRequest::$mapId $mapId in file ServerProjectHandler.php, variable ServerProjectHandler::$mapId $mapId in file MapInfoCache.php, variable MapInfoCache::$mapId $mapLabel in file MapInfo.php, variable MapInfo::$mapLabel $mapName in file ProjectHandler.php, variable ProjectHandler::$mapName Map name without the project prefix $maxScale in file Layers.php, variable LayerBase::$maxScale Maximum scale where layer is visible $maxx in file BasicTypes.php, variable Bbox::$maxx $maxy in file BasicTypes.php, variable Bbox::$maxy $message in file Message.php, variable Message::$message The text of the message to show to the user. $messageId in file Message.php, variable Message::$messageId Optional message identifier for machine parsing of messages. For $metadata in file Layers.php, variable LayerBase::$metadata A map of metadata values, in the form "key=value" $metaHash in file Layers.php, variable LayerBase::$metaHash A map for metadata, it is lazyly constructed from $metadata when requested. $minScale in file Layers.php, variable LayerBase::$minScale Minimum scale where layer is visible $minx in file BasicTypes.php, variable Bbox::$minx $miny in file BasicTypes.php, variable Bbox::$miny $msg in file Common.php, variable CartowebException::$msg The current exception message $msLayer in file Layers.php, variable Layer::$msLayer MapServer layer MapInfo.php procedural page MapInfo.php Message.php procedural page Message.php makeDirectoryWithPerms in file Utils.php, method Utils::makeDirectoryWithPerms() Creates a directory recursively. The permissions of the newly created directories are the same as the permission of the given $permsFrom file or directory. MapInfo in file MapInfo.php, class MapInfo Main MapInfo class MapInfoCache in file MapInfoCache.php, class MapInfoCache Class to manage the caching of the MapInfo server returned value. MapRequest in file Request.php, class MapRequest Request sent from client to server MapResult in file Request.php, class MapResult Result sent from server to client mergeOverride in file StructHandler.php, method StructHandler::mergeOverride() Merges two objects Message in file Message.php, class Message A class for messages top ## n $name in file PluginBase.php, variable PluginBase::$name ANONYMOUS_ROLE in file SecurityManager.php, class constant SecurityManager::ANONYMOUS_ROLE negativeRad2Deg in file Utils.php, method Utils::negativeRad2Deg() Converts radians angle to degrees even if value is < 0. ngt in file Common.php, method I18nNoop::ngt() top ## o $overriddenRequest in file PluginBase.php, variable PluginBase::$overriddenRequest Request overridden by other plugin CONTEXT_INI in file StructHandler.php, class constant StructHandler::CONTEXT_INI CONTEXT_OBJ in file StructHandler.php, class constant StructHandler::CONTEXT_OBJ LOGGED_IN_ROLE in file SecurityManager.php, class constant SecurityManager::LOGGED_IN_ROLE top ## p $plugin in file Config.php, variable PluginConfig::$plugin $plugin in file Message.php, variable Message::$plugin The name of the plugin generation this message, or null if not created $pluginLoaded in file Accounting.php, variable Accounting::$pluginLoaded Used to track if accounting plugin is loaded $plugins in file PluginManager.php, variable PluginManager::$plugins Plugin objects storage $points in file BasicTypes.php, variable Polygon::$points Array of points $points in file BasicTypes.php, variable Line::$points Array of points $projectHandler in file ResourceHandler.php, variable ResourceHandler::$projectHandler The project handler to use for getting current project name $projectHandler in file Config.php, variable Config::$projectHandler $projectHandler in file PluginManager.php, variable PluginManager::$projectHandler $projectName in file ServerProjectHandler.php, variable ServerProjectHandler::$projectName PluginBase.php procedural page PluginBase.php PluginManager.php procedural page PluginManager.php ProjectHandler.php procedural page ProjectHandler.php parseArray in file Utils.php, method Utils::parseArray() Converts a character-separated string to an array. parseObjectArray in file Utils.php, method ConfigParser::parseObjectArray() Converts a list of values taken from a configuration file to an array of objects pathToPlatform in file Utils.php, method Utils::pathToPlatform() Converts a path with any delimitors to a path with delimitors used by the current platform. pathToUnix in file Utils.php, method Utils::pathToUnix() Converts a path to unix path delmitors. PluginBase in file PluginBase.php, class PluginBase Base class for plugins PluginConfig in file Config.php, class PluginConfig Configuration for plugins pluginLoaded in file Accounting.php, method Accounting::pluginLoaded() Needs to be called by accounting plugin, to detect case when the accounting plugin was not enabled and accouting is turned on. PluginManager in file PluginManager.php, class PluginManager Class used to manage pool of plugins Point in file BasicTypes.php, class Point A single point PointConverter in file ShapeConverter.php, class PointConverter Abstract class for ShapeConverters Polygon in file BasicTypes.php, class Polygon A closed polygon PolygonConverter in file ShapeConverter.php, class PolygonConverter Abstract class for ShapeConverters pre in file Utils.php, function pre() For debugging purpose only preInitialize in file PluginBase.php, method PluginBase::preInitialize() Plugin pre initialization. In most cases, plugins should use preInitializeCartoweb in file Common.php, method Common::preInitializeCartoweb() This function initializes cartoweb in the very beginning. It sets the include path, for instance. ProjectHandler in file ProjectHandler.php, class ProjectHandler Handler for specific project files top ## r $radius in file BasicTypes.php, variable Circle::$radius Radius $rendering in file Layers.php, variable LayerGroup::$rendering Type of rendering for children (tree, dropdown, radio) $replacePlugin in file PluginManager.php, variable PluginManager::$replacePlugin $roles in file SecurityManager.php, variable SecurityManager::$roles The list of roles associated to the current authenticated user. Request.php procedural page Request.php ResourceHandler.php procedural page ResourceHandler.php PROJECT_DIR in file ProjectHandler.php, class constant ProjectHandler::PROJECT_DIR readCachedMapInfo in file MapInfoCache.php, method MapInfoCache::readCachedMapInfo() Reads MapInfo from file and unserializes it Rectangle in file BasicTypes.php, class Rectangle A rectangle RectangleConverter in file ShapeConverter.php, class RectangleConverter Abstract class for ShapeConverters replacePlugin in file PluginBase.php, method PluginBase::replacePlugin() Returns name of parent plugin in case of plugin extension replacePlugin in file PluginManager.php, method PluginManager::replacePlugin() Tells what plugin the current one replaces. reset in file Accounting.php, method Accounting::reset() Resets accounting messages ResourceHandler in file ResourceHandler.php, class ResourceHandler Class to manage resource accesses roundParams in file BasicTypes.php, method Bbox::roundParams() Returns the rounded values of an array of values to specified precision top ## s $securityContainer in file SecurityManager.php, variable SecurityManager::$securityContainer Current security container $selected in file MapInfo.php, variable LayerState::$selected $serverMessages in file Request.php, variable MapResult::$serverMessages Array of Message SecurityManager.php procedural page SecurityManager.php StructHandler.php procedural page StructHandler.php ServerAccounting.php procedural page ServerAccounting.php ServerProjectHandler.php procedural page ServerProjectHandler.php ShapeConverter.php procedural page ShapeConverter.php save in file Accounting.php, method Accounting::save() Saves all accounting messages to persistent storage. This should be called only once per request (client or server). saveDb in file Accounting.php, method Accounting::saveDb() Saves an accounting packet (merge of all accounting messages) to database saveFile in file Accounting.php, method Accounting::saveFile() Saves an accounting packet (merge of all accounting messages) to file SecurityContainer in file SecurityManager.php, class SecurityContainer Abstract class for accessing list of users, checking their passwords and SecurityManager in file SecurityManager.php, class SecurityManager Class which manages security in Cartoweb ServerProjectHandler in file ServerProjectHandler.php, class ServerProjectHandler Project handler for the server setActive in file Accounting.php, method Accounting::setActive() Sets whether accounting is active or not. Can be used to disable setBasePath in file PluginBase.php, method PluginBase::setBasePath() setByMapId in file ServerProjectHandler.php, method ServerProjectHandler::setByMapId() Sets projectName and mapName, extracted from mapId value. setCacheHit in file Accounting.php, method Accounting::setCacheHit() Tells accounting that a cache hit occured. This is used to prevent false error message in some situations. setChildren in file Layers.php, method LayerContainer::setChildren() Sets children given an array of layerIds setDeveloperIniConfig in file Common.php, method Common::setDeveloperIniConfig() Sets ini directives useful during development setExtendedName in file PluginBase.php, method PluginBase::setExtendedName() setFrom2Points in file BasicTypes.php, method Bbox::setFrom2Points() Sets Bbox from two points setFromBbox in file BasicTypes.php, method Bbox::setFromBbox() Sets Bbox from min/max setFromMsExtent in file BasicTypes.php, method Bbox::setFromMsExtent() Sets Bbox from a Mapserver extent setFromString in file BasicTypes.php, method Bbox::setFromString() Converts a string to the Bbox (format "11, 22, 33, 44") setIncludePath in file Common.php, method Common::setIncludePath() Sets the include path, to contain include directory. setMapId in file Config.php, method Config::setMapId() Sets mapId setName in file PluginBase.php, method PluginBase::setName() setSecurityContainer in file SecurityManager.php, method SecurityManager::setSecurityContainer() Sets the current SecurityContainer database setUser in file SecurityManager.php, method SecurityManager::setUser() Sets the current authenticated user. Its roles will be fetched from the setUserAndRoles in file SecurityManager.php, method SecurityManager::setUserAndRoles() Sets the username and its associated roles for the current authenticated user. setXY in file BasicTypes.php, method Point::setXY() Shape in file BasicTypes.php, class Shape Abstract class for shapes shutdownCartoweb in file Common.php, method Common::shutdownCartoweb() Restores the php context to what it was before calling skipCache in file MapInfoCache.php, method MapInfoCache::skipCache() Returns true if cache is disabled. It can be used by implementing classes to check if they should skip the caching. SoapFault in file Common.php, class SoapFault StructHandler in file StructHandler.php, class StructHandler Structure management class switchColorToRgb in file Utils.php, method Utils::switchColorToRgb() Converts passed color in RGB codes. switchHexColorToRgb in file Utils.php, method Utils::switchHexColorToRgb() Converts #xxyyzz hexadecimal color codes into RGB. top ## t $timestamp in file Request.php, variable MapResult::$timestamp $timestamp in file MapInfo.php, variable MapInfo::$timestamp Timestamp for cache check $transparency in file Layers.php, variable Layer::$transparency toBbox in file BasicTypes.php, method Point::toBbox() Converts the Point to a Bbox toRemoteString in file BasicTypes.php, method Bbox::toRemoteString() Converts Bbox to a character-separated string to request remote layer toString in file Common.php, method SoapFault::toString() top ## u $unfolded in file MapInfo.php, variable LayerState::$unfolded $username in file SecurityManager.php, variable SecurityManager::$username The current authenticated username, or empty if none. Utils.php procedural page Utils.php unserialize in file Request.php, method MapRequest::unserialize() Sets object properties from $struct data. unserialize in file BasicTypes.php, method Bbox::unserialize() Unserializes a Bbox unserialize in file MapInfo.php, method Location::unserialize() unserialize in file Layers.php, method ChildrenSwitch::unserialize() unserialize in file Layers.php, method Layer::unserialize() unserialize in file MapInfo.php, method InitialMapState::unserialize() unserialize in file Layers.php, method LayerGroup::unserialize() unserialize in file Layers.php, method LayerContainer::unserialize() unserialize in file Layers.php, method LayerBase::unserialize() unserialize in file MapInfo.php, method MapInfo::unserialize() unserialize in file CwSerializable.php, method CwSerializable::unserialize() Unserializes from a stdClass structure unserialize in file BasicTypes.php, method Line::unserialize() unserialize in file BasicTypes.php, method GeoDimension::unserialize() unserialize in file BasicTypes.php, method Dimension::unserialize() unserialize in file BasicTypes.php, method Circle::unserialize() unserialize in file BasicTypes.php, method Point::unserialize() unserialize in file BasicTypes.php, method Polygon::unserialize() unserialize in file MapInfo.php, method LayerState::unserialize() unserialize in file Request.php, method MapResult::unserialize() Sets object properties from $struct data. unserialize in file BasicTypes.php, method Shape::unserialize() unserialize in file BasicTypes.php, method Rectangle::unserialize() unserialize in file Message.php, method Message::unserialize() Sets object properties from $struct data. unserializeArray in file CwSerializable.php, method CwSerializable::unserializeArray() Returns an array of typed values unserializeObject in file CwSerializable.php, method CwSerializable::unserializeObject() Returns an unserialized object from a stdClass structure unserializeObjectMap in file CwSerializable.php, method CwSerializable::unserializeObjectMap() Returns an array of unserialized objects from a stdClass structure unserializeStringArray in file CwSerializable.php, method CwSerializable::unserializeStringArray() Returns an array of typed values from a string unserializeValue in file CwSerializable.php, method CwSerializable::unserializeValue() Returns a typed value from a structure property updateProfileParameters in file Config.php, method Config::updateProfileParameters() Set parameters values according to the current profile utf8_decode in file Common.php, function utf8_decode() utf8_encode in file Common.php, function utf8_encode() Utils in file Utils.php, class Utils Utility class containing static methods for various common tasks. top ## w $width in file BasicTypes.php, variable Dimension::$width Width of the image $WKTString in file BasicTypes.php, variable Feature::$WKTString WKT string of the feature top ## x $x in file BasicTypes.php, variable Circle::$x Center x $x in file BasicTypes.php, variable Point::$x x in file Utils.php, function x() For debugging purpose only x1 in file Utils.php, function x1() For debugging purpose only top ## y $y in file BasicTypes.php, variable Point::$y $y in file BasicTypes.php, variable Circle::$y Center y top Documentation generated on Fri, 21 Sep 2007 13:30:27 +0200 by phpDocumentor 1.3.0RC3