10805be34b
Follows-up I56a0ee74595404e1, I38a0761ae4633 and I6c3d186de1877f73d4. Remove most "Usage" examples as these are internal and mostly-normalized class fields. This is not where end-users should look for documentation. Besides, many of the examples were wrong or outdated, and almost all were incomplete. It also had an inherent dilimma between describing all possible valid input and describing what we actually store in that instance variable after normalization in the class constructor. The usage docs have long been moved to the MW config file, so we can omit that. In its stead, place more complete and accurate type hints for Phan to understand the possible code paths, in particular to reflect the use of FilePath objects. Change-Id: I1cc002f350785d3f46f79be5defb7b3cadbebf34
102 lines
3.2 KiB
PHP
102 lines
3.2 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\ResourceLoader;
|
|
|
|
use RuntimeException;
|
|
|
|
/**
|
|
* A path to a bundled file (such as JavaScript or CSS), along with a remote and local base path.
|
|
*
|
|
* This is for use with FileModule. Base path may be `null`, which indicates that the
|
|
* path is expanded relative to the corresponding base path of the FileModule object instead.
|
|
*
|
|
* @ingroup ResourceLoader
|
|
* @since 1.17
|
|
*/
|
|
class FilePath {
|
|
/** @var string|null Local base path */
|
|
protected $localBasePath;
|
|
|
|
/** @var string|null Remote base path */
|
|
protected $remoteBasePath;
|
|
|
|
/** @var string Path to the file */
|
|
protected $path;
|
|
|
|
/**
|
|
* @param string $path Relative path to the file, no leading slash.
|
|
* @param string|null $localBasePath Base path to prepend when generating a local path.
|
|
* @param string|null $remoteBasePath Base path to prepend when generating a remote path.
|
|
* Should not have a trailing slash unless at web document root.
|
|
*/
|
|
public function __construct( $path, $localBasePath = null, $remoteBasePath = null ) {
|
|
$this->path = $path;
|
|
$this->localBasePath = $localBasePath;
|
|
$this->remoteBasePath = $remoteBasePath;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
* @throws RuntimeException If the base path was not provided. You must either provide the base
|
|
* path in the constructor, or use getPath() instead and add the base path from a FileModule.
|
|
*/
|
|
public function getLocalPath() {
|
|
if ( $this->localBasePath === null ) {
|
|
throw new RuntimeException( 'Base path was not provided' );
|
|
}
|
|
return "{$this->localBasePath}/{$this->path}";
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
* @throws RuntimeException If the base path was not provided. You must either provide the base
|
|
* path in the constructor, or use getPath() instead and add the base path from a FileModule.
|
|
*/
|
|
public function getRemotePath() {
|
|
if ( $this->remoteBasePath === null ) {
|
|
throw new RuntimeException( 'Base path was not provided' );
|
|
}
|
|
if ( $this->remoteBasePath === '/' ) {
|
|
// In document root
|
|
// Don't insert another slash (T284391).
|
|
return $this->remoteBasePath . $this->path;
|
|
}
|
|
return "{$this->remoteBasePath}/{$this->path}";
|
|
}
|
|
|
|
/** @return string|null */
|
|
public function getLocalBasePath() {
|
|
return $this->localBasePath;
|
|
}
|
|
|
|
/** @return string|null */
|
|
public function getRemoteBasePath() {
|
|
return $this->remoteBasePath;
|
|
}
|
|
|
|
/** @return string */
|
|
public function getPath() {
|
|
return $this->path;
|
|
}
|
|
}
|
|
|
|
/** @deprecated since 1.39 */
|
|
class_alias( FilePath::class, 'ResourceLoaderFilePath' );
|