Diviner Tech Docs DiffusionPathIDQuery

final class DiffusionPathIDQuery
Phorge Technical Documentation (Diffusion)

This class is not documented.

Tasks

Path Utilities

public static function normalizePath($path) — Convert a path to the canonical, absolute representation used by Diffusion.
public static function getParentPath($path) — Return the canonical parent directory for a path. Note, returns "/" when passed "/".
public static function expandPathToRoot($path) — Generate a list of parents for a repository path. The path itself is included.

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
public function __construct($paths)
public function loadPathIDs()

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public function __construct($paths)

This method is not documented.

Parameters

array

$paths

Return

this	//Implicit.//

public function loadPathIDs()

This method is not documented.

Return

wild

public static function normalizePath($path)

Convert a path to the canonical, absolute representation used by Diffusion.

Parameters

string

$path

Some repository path.

Return

string

Canonicalized Diffusion path.

public static function getParentPath($path)

Return the canonical parent directory for a path. Note, returns "/" when passed "/".

Parameters

string

$path

Some repository path.

Return

string

That path's canonical parent directory.

public static function expandPathToRoot($path)

Generate a list of parents for a repository path. The path itself is included.

Parameters

string

$path

Some repository path.

Return

list	List of canonical paths between the path and the root.

Defined: src/applications/diffusion/query/pathid/DiffusionPathIDQuery.php:6
Extends: Phobject

final class DiffusionPathIDQueryPhorge Technical Documentation (Diffusion)

Tasks

Path Utilities

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function __construct($paths)

public function loadPathIDs()

public static function normalizePath($path)

public static function getParentPath($path)

public static function expandPathToRoot($path)

final class DiffusionPathIDQuery
Phorge Technical Documentation (Diffusion)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited