ElegantMedia\PHPToolkit\Path

Complexity

Total Complexity

9

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	canonical()	0	20	4
A	withoutEndingSlash()	0	3	1
A	withStartingSlash()	0	3	1
A	withoutStartingSlash()	0	9	2
A	withEndingSlash()	0	3	1

<?php

namespace ElegantMedia\PHPToolkit;

class Path
{
	/**
	 * Add a trailing slash to the end of a string (if it doesn't exist).
	 *
	 * @param $path
	 *
	 * @return string
	 */
	public static function withEndingSlash($path): string
	{
		return rtrim($path, '/') . '/';
	}

	/**
	 * Remove the trailing slash from a string (if exists).
	 *
	 * @param $path
	 *
	 * @return string
	 */
	public static function withoutEndingSlash($path): string
	{
		return rtrim($path, '/');
	}

	/**
	 * Remove the leading slash of a string (if exists).
	 *
	 * @param $path
	 *
	 * @return string
	 */
	public static function withoutStartingSlash($path): string
	{
		$firstChar = $path[0];
		$hasLeadingSlash = $firstChar === '/';
		if (!$hasLeadingSlash) {
			return $path;
		}

		return ltrim($path, $firstChar);
	}

	/**
	 * Add a leading slash to a string (if it doesn't exist).
	 *
	 * @param $path
	 *
	 * @return string
	 */
	public static function withStartingSlash($path): string
	{
		return '/' . ltrim($path, '/');
	}

	/**
	 * Remove dot segments from paths.
	 *
	 * @see https://tools.ietf.org/html/rfc3986#section-5.2.4
	 * @see https://stackoverflow.com/a/21486848/1234452
	 *
	 * @param $path
	 *
	 * @return string
	 */
	public static function canonical($path): string
	{
		$path = explode('/', $path);
		$stack = [];
		foreach ($path as $seg) {
			if ($seg == '..') {
				// Ignore this segment, remove last segment from stack
				array_pop($stack);
				continue;
			}

			if ($seg == '.') {
				// Ignore this segment
				continue;
			}

			$stack[] = $seg;
		}

		return implode('/', $stack);
	}
}