Page MenuHomeWickedGov Phorge
Files F6009545

ExactMatch.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

ExactMatch.php
View Options

<?php
/**
* An abstract filter class for checking files and folders against exact matches.
*
* Supports both allowed files and disallowed files.
*
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Filters;
use PHP_CodeSniffer\Util\Common;
abstract class ExactMatch extends Filter
{
/**
* A list of files to exclude.
*
* @var array
*/
private $disallowedFiles = null;
/**
* A list of files to include.
*
* If the allowed files list is empty, only files in the disallowed files list will be excluded.
*
* @var array
*/
private $allowedFiles = null;
/**
* Check whether the current element of the iterator is acceptable.
*
* If a file is both disallowed and allowed, it will be deemed unacceptable.
*
* @return bool
*/
public function accept()
{
if (parent::accept() === false) {
return false;
}
if ($this->disallowedFiles === null) {
$this->disallowedFiles = $this->getDisallowedFiles();
// BC-layer.
if ($this->disallowedFiles === null) {
$this->disallowedFiles = $this->getBlacklist();
}
}
if ($this->allowedFiles === null) {
$this->allowedFiles = $this->getAllowedFiles();
// BC-layer.
if ($this->allowedFiles === null) {
$this->allowedFiles = $this->getWhitelist();
}
}
$filePath = Common::realpath($this->current());
// If a file is both disallowed and allowed, the disallowed files list takes precedence.
if (isset($this->disallowedFiles[$filePath]) === true) {
return false;
}
if (empty($this->allowedFiles) === true && empty($this->disallowedFiles) === false) {
// We are only checking the disallowed files list, so everything else should be allowed.
return true;
}
return isset($this->allowedFiles[$filePath]);
}//end accept()
/**
* Returns an iterator for the current entry.
*
* Ensures that the disallowed files list and the allowed files list are preserved so they don't have
* to be generated each time.
*
* @return \RecursiveIterator
*/
public function getChildren()
{
$children = parent::getChildren();
$children->disallowedFiles = $this->disallowedFiles;
$children->allowedFiles = $this->allowedFiles;
return $children;
}//end getChildren()
/**
* Get a list of file paths to exclude.
*
* @deprecated 3.9.0 Implement the `getDisallowedFiles()` method instead.
* The `getDisallowedFiles()` method will be made abstract and therefore required
* in v4.0 and this method will be removed.
* If both methods are implemented, the new `getDisallowedFiles()` method will take precedence.
*
* @return array
*/
abstract protected function getBlacklist();
/**
* Get a list of file paths to include.
*
* @deprecated 3.9.0 Implement the `getAllowedFiles()` method instead.
* The `getAllowedFiles()` method will be made abstract and therefore required
* in v4.0 and this method will be removed.
* If both methods are implemented, the new `getAllowedFiles()` method will take precedence.
*
* @return array
*/
abstract protected function getWhitelist();
/**
* Get a list of file paths to exclude.
*
* @since 3.9.0 Replaces the deprecated `getBlacklist()` method.
*
* @return array|null
*/
protected function getDisallowedFiles()
{
return null;
}//end getDisallowedFiles()
/**
* Get a list of file paths to include.
*
* @since 3.9.0 Replaces the deprecated `getWhitelist()` method.
*
* @return array|null
*/
protected function getAllowedFiles()
{
return null;
}//end getAllowedFiles()
}//end class

File Metadata

Mime Type
text/x-php
Expires
Oct 4 2026, 09:27 (5 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
04/4b/382140332dcd12b8a0a647e40722
Default Alt Text
ExactMatch.php (4 KB)

Event Timeline