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

Class: ClientProjectHandler

Source Location: /client/ClientProjectHandler.php

Class Overview

ProjectHandler
   |
   --ClientProjectHandler

Project handler for the client


Variables

Constants

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: ProjectHandler

ProjectHandler::getAvailableProjects()
Returns a list of available projects.
ProjectHandler::getMapName()
ProjectHandler::getPath()
Returns path for a file, depending on projects
ProjectHandler::getProjectName()
Returns the project name
ProjectHandler::isProjectFile()
Finds out if a file or directory exists in project

Class Details

[line 33]
Project handler for the client



[ Top ]


Class Variables

$log =

[line 38]



Tags:

access:  private

Type:   Logger


[ Top ]

$projectName =

[line 44]

Used for caching the project name.



Tags:

access:  private

Type:   string


[ Top ]



Class Methods


constructor __construct [line 69]

ClientProjectHandler __construct( )

Constructor



Tags:

access:  public


[ Top ]

method getCurrentProjectCookieName [line 124]

string getCurrentProjectCookieName( )

accessor for CURRENT_PROJECT_COOKIE_NAME



Tags:

return:  CURRENT_PROJECT_COOKIE_NAME
access:  public


[ Top ]

method getProjectName [line 84]

string getProjectName( )

Returns project name

Tries to find project name in:

  • GET variable 'project'
  • Root directory, file current_project.txt
  • $_ENV, variable CW3_PROJECT
  • $_SERVER, variable CW3_PROJECT
  • $_SERVER, variable REDIRECT_CW3_PROJECT (CGI redirect)




Tags:

return:  project name
access:  public


Overrides ProjectHandler::getProjectName() (Returns the project name)

[ Top ]


Class Constants

CURRENT_PROJECT_COOKIE_NAME =  'CW3_current_project_cookie'

[line 64]

Current project cookie name


[ Top ]

CURRENT_PROJECT_FILE =  'current_project.txt'

[line 59]

Current project filename


[ Top ]

PROJECT_ENV_VAR =  'CW3_PROJECT'

[line 49]

Environment variable which contains project name


[ Top ]

PROJECT_REQUEST =  'project'

[line 54]

Request name which contains the project name


[ Top ]



Documentation generated on Thu, 04 Sep 2008 11:39:21 +0200 by phpDocumentor 1.3.0RC3