Class: Naos_VPath

Source Location: /VPath.php

Class Naos_VPath

Class Overview

Naos_VPath maps a virtual path to a real path (system path).

A naos path consists of the following three attributes * Context (Naos_VPath::C_NAOS or Naos_VPath::C_APPLICATION) * Type (any valid folder name, predefined: Naos_VPath::T_*) * Path (Sub path)

See realpath() and naospath().

Located in /VPath.php [line 33]

Author(s):

Information Tags:

Copyright:	Copyright (c) 2008 Jupiter GmbH
License:	http://www.naos-framework.com/website.naos.framework/en/license

Methods

[ Top ]

Constant Summary

C_APPLICATION
C_NAOS	Context constants
T_CACHE	Type constants
T_CONFIGURATION
T_DEFINITION
T_LAYOUT
T_LIBRARY
T_MODULE
T_TRANSLATION
T_WEB

[ Top ]

Method Summary

static Naos_VPath	naospath()	Returns a naos path object corresponding to the real path
static string	realpath()	Returns the real path of the specified context, type and path
void	__construct()	Constructor
int	getContext()	Returns the context of the naos path object
int	getPath()	Returns the path of the naos path object
string	getType()	Returns the type of the naos path object
string	resolve()	Resolves the naos path object to a real path http://www.php.net/realpath

[ Top ]

Methods

static method naospath [line 152]

static Naos_VPath naospath(

$real_path 
)

Returns a naos path object corresponding to the real path

Parameters:

$real_path:

API Tags:

Access:

public

[ Top ]

static method realpath [line 133]

static string realpath(

$context, 
$type, 
$path 
)

Returns the real path of the specified context, type and path

Parameters:

	$context:
	$type:
	$path:

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 87]

void __construct(

$context, 
$type, 
$path 
)

Constructor

Instantiates a naos path object, which consists of the following parts: * context * type * path

Parameters:

	$context:
	$type:
	$path:

API Tags:

Access:

public

[ Top ]

getContext [line 111]

int getContext(
)

Returns the context of the naos path object

API Tags:

Access:

public

[ Top ]

getPath [line 126]

int getPath(
)

Returns the path of the naos path object

API Tags:

Access:

public

[ Top ]

getType [line 118]

string getType(
)

Returns the type of the naos path object

API Tags:

Access:

public

[ Top ]

resolve [line 101]

string resolve(
)

Resolves the naos path object to a real path http://www.php.net/realpath

API Tags:

Access:

public

[ Top ]

Constants

C_APPLICATION = 'application' [line 39]

[ Top ]

C_NAOS = 'naos' [line 38]

Context constants

[ Top ]

T_CACHE = "cache" [line 44]

Type constants

[ Top ]

T_CONFIGURATION = "configuration" [line 45]

[ Top ]

T_DEFINITION = "definition" [line 46]

[ Top ]

T_LAYOUT = "layout" [line 47]

[ Top ]

T_LIBRARY = "library" [line 48]

[ Top ]

T_MODULE = "module" [line 49]

[ Top ]

T_TRANSLATION = "translation" [line 51]

[ Top ]

T_WEB = "web" [line 50]

[ Top ]

Documentation generated on Sat, 13 Sep 2008 01:41:04 -0400 by phpDocumentor 1.4.0