wiki.techinc.nl/includes/resourceloader/ResourceLoaderFilePath.php
Timo Tijhof a5ce1d7792 resourceloader: Add Doxygen group and improve overall docs
* Add license header where missing.
* Add missing `@since` (1.17 for most classes), except
  ResourceLoaderLessVarFileModule since 1.32 (1bc62c548c).

* Remove duplicate file-level description for class-only files,
  merge with the class description instead.

* Remove my own `@author` annotation from one file.

* Mark core's own FileModule subclasses as `@internal`, except
  for the following which we support use of in extensions:
  ResourceLoaderLessVarFileModule,
  ResourceLoaderOOUIIconPackModule, and
  ResourceLoaderWikiModule.

Change-Id: I336af2e4ccdbe2512594e8861b72628d24194e41
2019-09-14 18:37:36 +00:00

86 lines
2.1 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
*/
/**
* An object to represent a path to a JavaScript/CSS file, along with a remote
* and local base path, for use with ResourceLoaderFileModule.
*
* @ingroup ResourceLoader
* @since 1.17
*/
class ResourceLoaderFilePath {
/** @var string Local base path */
protected $localBasePath;
/** @var string Remote base path */
protected $remoteBasePath;
/**
* @var string Path to the file
*/
protected $path;
/**
* @param string $path Path to the file.
* @param string $localBasePath Base path to prepend when generating a local path.
* @param string $remoteBasePath Base path to prepend when generating a remote path.
*/
public function __construct( $path, $localBasePath, $remoteBasePath ) {
$this->path = $path;
$this->localBasePath = $localBasePath;
$this->remoteBasePath = $remoteBasePath;
}
/**
* @return string
*/
public function getLocalPath() {
return "{$this->localBasePath}/{$this->path}";
}
/**
* @return string
*/
public function getRemotePath() {
return "{$this->remoteBasePath}/{$this->path}";
}
/**
* @return string
*/
public function getLocalBasePath() {
return $this->localBasePath;
}
/**
* @return string
*/
public function getRemoteBasePath() {
return $this->remoteBasePath;
}
/**
* @return string
*/
public function getPath() {
return $this->path;
}
}