Initial commit to new repo (carried over from: https://github.com/ryancramerdesign/ProcessWire/tree/devns)

2025-08-12 17:54:44 +02:00 · 2016-09-02 14:55:17 -04:00
parent cfae5fc6f3
commit bac5b0de5d
1691 changed files with 279091 additions and 1 deletions
--- a/wire/core/Paths.php
+++ b/wire/core/Paths.php
@@ -0,0 +1,143 @@
+<?php namespace ProcessWire;
+
+/**
+ * ProcessWire Paths
+ *
+ * Maintains lists of file paths, primarily used by the ProcessWire configuration.
+ * 
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
+ * https://processwire.com
+ * 
+ * This file is licensed under the MIT license
+ * https://processwire.com/about/license/mit/
+ *
+ * @see http://processwire.com/api/variables/config/ Offical $config API variable Documentation
+ * 
+ * @property string $root Site root: /
+ * @property string $templates Site templates: /site/templates/
+ * @property string $fieldTemplates Site field templates /site/templates/fields/
+ * @property string $adminTemplates Admin theme template files: /wire/templates-admin/ or /site/templates-admin/
+ * @property string $modules Core modules: /wire/modules/
+ * @property string $siteModules Site-specific modules: /site/modules/
+ * @property string $core ProcessWire core files: /wire/core/
+ * @property string $site ProcessWire site files /site/
+ * @property string $assets Site-specific assets: /site/assets/
+ * @property string $cache Site-specific cache: /site/assets/cache/
+ * @property string $logs Site-specific logs: /site/assets/logs/
+ * @property string $files Site-specific files: /site/assets/files/
+ * @property string $tmp Temporary files: /site/assets/tmp/
+ * @property string $sessions Session files: /site/assets/sessions/
+ *
+ * The following properties are only in $config->urls
+ * ==================================================
+ * @property string $admin Admin URL
+ * @property string|null $next URL to next pagination of current page, when applicable (populated by MarkupPagerNav, after render)
+ * @property string|null $prev URL to previous pagination of current page, when applicable (populated by MarkupPagerNav, after render)
+ * 
+ * The following are in $config->urls and equivalent to previously mentioned properties, but include scheme + host
+ * ===============================================================================================================
+ * @property string $httpRoot
+ * @property string $httpTemplates
+ * @property string $httpAdminTemplates
+ * @property string $httpModules
+ * @property string $httpSiteModules
+ * @property string $httpAssets
+ * @property string $httpFiles 
+ * @property string $httpNext
+ * @property string $httpPrev
+ *
+ * The "http" may be optionally prepended to any property accessed from $config->urls (including those you add yourself).
+ *
+ */
+
+class Paths extends WireData {
+
+	/**
+	 * Cached root 
+	 * 
+	 * @var string
+	 * 
+	 */
+	protected $_root = '';
+
+	/**
+	 * Construct the Paths
+	 *
+	 * @param string $root Path of the root that will be used as a base for stored paths.
+	 *
+	 */
+	public function __construct($root) {
+		$this->_root = $root;
+		$this->useFuel(false);
+	}
+
+	/**
+	 * Given a path, normalize it to "/" style directory separators if they aren't already
+	 *
+	 * @static
+	 * @param string $path
+	 * @return string
+	 *
+	 */
+	public static function normalizeSeparators($path) {
+		if(DIRECTORY_SEPARATOR == '/') return $path; 
+		$path = str_replace(DIRECTORY_SEPARATOR, '/', $path); 
+		return $path; 
+	}
+
+	/**
+	 * Set the given path key
+	 *
+	 * @param string $key
+	 * @param mixed $value If the first character of the provided path is a slash, then that specific path will be used without modification.
+	 * 	If the first character is anything other than a slash, then the 'root' variable will be prepended to the path.
+	 * @return this
+	 *
+	 */
+	public function set($key, $value) {
+		$value = self::normalizeSeparators($value); 
+		if($key == 'root') {
+			$this->_root = $value;
+			return $this;
+		}
+		return parent::set($key, $value); 
+	}
+
+	/**
+	 * Return the requested path variable
+	 *
+	 * @param object|string $key
+	 * @return mixed|null|string The requested path variable
+	 *
+	 */
+	public function get($key) {
+		static $_http = null;
+		if($key == 'root') return $this->_root;
+		if(strpos($key, 'http') === 0) {
+			if(is_null($_http)) {
+				$scheme = $this->wire('input')->scheme;
+				if(!$scheme) $scheme = 'http';
+				$httpHost = $this->wire('config')->httpHost; 
+				if($httpHost) $_http = "$scheme://$httpHost";
+			}
+			$http = $_http;
+			$key = substr($key, 4);
+			$key[0] = strtolower($key[0]);
+		} else {
+			$http = '';
+		}
+		if($key == 'root') {
+			$value = $http . $this->_root;
+		} else {
+			$value = parent::get($key);
+			if(!is_null($value) && strlen($value)) {
+				if($value[0] == '/' || (DIRECTORY_SEPARATOR != '/' && $value[1] == ':')) {
+					$value = $http . $value;
+				} else {
+					$value = $http . $this->_root . $value;
+				}
+			}
+		}
+		return $value; 
+	}
+}