Zymba Documentation

Path

Text

object @Path() {
	DIRECTORYSEPARATOR;
	MAXLENGTH;
	PATHSEPARATOR;
	fromURI(string $uri): string {}
	getBase(string $path): string {}
	getDirectory(string $path): string {}
	getExtension(string $path): string {}
	getFile(string $path): string {}
	getTempDirectory(): string {}
	getWorkingDirectory(): string {}
	hasExtension(string $path): bool {}
	isAbsolute(string $path): bool {}
	normalize(string $path): string {}
	parse(string $path): object {}
	setWorkingDirectory(string $path) {}
	toAbsolutePath(string $path): string {}
	toRealPath(string $path): string {}
	toURI(string $path): string {}
}

Static path related constants and functions.

Functions

Converts a file URI to a path.

CODE

@Path.fromURI(string $uri): string

Parameters

Name	Type	Value	Default
uri	string		""

Returns

Type	Value
string

Gets the base name component of a path (including extension).

CODE

@Path.getBase(string $path): string

Parameters

Name	Type	Value	Default
path	string		""

Returns

Type	Value
string

Gets the directory name component of a path.

CODE

@Path.getDirectory(string $path): string

Parameters

Name	Type	Value	Default
path	string		""

Returns

Type	Value
string

Gets the file extension component of a path.

CODE

@Path.getExtension(string $path): string

Parameters

Name	Type	Value	Default
path	string		""

Returns

Type	Value
string

Gets the filename component of a path (excluding extension).

CODE

@Path.getFile(string $path): string

Parameters

Name	Type	Value	Default
path	string		""

Returns

Type	Value
string

Gets the absolute path of the system's directory for temporary files.

CODE

@Path.getTempDirectory(): string

Returns

Type	Value
string

Gets the absolute path of the current working directory.

CODE

@Path.getWorkingDirectory(): string

Returns

Type	Value
string

Determines whether a path has a file extension component.

CODE

@Path.hasExtension(string $path): bool

Parameters

Name	Type	Value	Default
path	string		""

Returns

Type	Value
bool

Determines whether a path is absolute.

CODE

@Path.isAbsolute(string $path): bool

Parameters

Name	Type	Value	Default
path	string		""

Returns

Type	Value
bool

Normalizes a path to its canonicalized representation.

CODE

@Path.normalize(string $path): string

Parameters

Name	Type	Value	Default
path	string		""

Returns

Type	Value
string

CODE

@Path.parse(string $path): object

Parameters

Name	Type	Value	Default
path	string		""

Returns

Type	Value
object	["directory": ..., "file": ..., "extension": ...]

Sets the path of the working directory.

CODE

@Path.setWorkingDirectory(string $path): void

Parameters

Name	Type	Value	Default
path	string		""

Converts a path to its canonicalized absolute path.

CODE

@Path.toAbsolutePath(string $path): string

Parameters

Name	Type	Value	Default
path	string		""

Returns

Type	Value
string

Converts a path to the canonicalized absolute path of an existing file, resolving all symbolic links.

CODE

@Path.toRealPath(string $path): string

Parameters

Name	Type	Value	Default
path	string		""

Returns

Type	Value
string

Converts a path to a file URI.

CODE

@Path.toURI(string $path): string

Parameters

Name	Type	Value	Default
path	string		""

Returns

Type	Value
string