remove commited vendor dir added to gitignore
parent
12da01136a
commit
0fd7161292
@ -1,7 +0,0 @@
|
||||
<?php
|
||||
|
||||
// autoload.php @generated by Composer
|
||||
|
||||
require_once __DIR__ . '/composer' . '/autoload_real.php';
|
||||
|
||||
return ComposerAutoloaderInit22f37628aeb6bdf37979bf902b8ee9cd::getLoader();
|
||||
@ -1 +0,0 @@
|
||||
../pds/skeleton/bin/pds-skeleton
|
||||
@ -1,413 +0,0 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of Composer.
|
||||
*
|
||||
* (c) Nils Adermann <naderman@naderman.de>
|
||||
* Jordi Boggiano <j.boggiano@seld.be>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Composer\Autoload;
|
||||
|
||||
/**
|
||||
* ClassLoader implements a PSR-0, PSR-4 and classmap class loader.
|
||||
*
|
||||
* $loader = new \Composer\Autoload\ClassLoader();
|
||||
*
|
||||
* // register classes with namespaces
|
||||
* $loader->add('Symfony\Component', __DIR__.'/component');
|
||||
* $loader->add('Symfony', __DIR__.'/framework');
|
||||
*
|
||||
* // activate the autoloader
|
||||
* $loader->register();
|
||||
*
|
||||
* // to enable searching the include path (eg. for PEAR packages)
|
||||
* $loader->setUseIncludePath(true);
|
||||
*
|
||||
* In this example, if you try to use a class in the Symfony\Component
|
||||
* namespace or one of its children (Symfony\Component\Console for instance),
|
||||
* the autoloader will first look for the class under the component/
|
||||
* directory, and it will then fallback to the framework/ directory if not
|
||||
* found before giving up.
|
||||
*
|
||||
* This class is loosely based on the Symfony UniversalClassLoader.
|
||||
*
|
||||
* @author Fabien Potencier <fabien@symfony.com>
|
||||
* @author Jordi Boggiano <j.boggiano@seld.be>
|
||||
* @see http://www.php-fig.org/psr/psr-0/
|
||||
* @see http://www.php-fig.org/psr/psr-4/
|
||||
*/
|
||||
class ClassLoader
|
||||
{
|
||||
// PSR-4
|
||||
private $prefixLengthsPsr4 = array();
|
||||
private $prefixDirsPsr4 = array();
|
||||
private $fallbackDirsPsr4 = array();
|
||||
|
||||
// PSR-0
|
||||
private $prefixesPsr0 = array();
|
||||
private $fallbackDirsPsr0 = array();
|
||||
|
||||
private $useIncludePath = false;
|
||||
private $classMap = array();
|
||||
|
||||
private $classMapAuthoritative = false;
|
||||
|
||||
public function getPrefixes()
|
||||
{
|
||||
if (!empty($this->prefixesPsr0)) {
|
||||
return call_user_func_array('array_merge', $this->prefixesPsr0);
|
||||
}
|
||||
|
||||
return array();
|
||||
}
|
||||
|
||||
public function getPrefixesPsr4()
|
||||
{
|
||||
return $this->prefixDirsPsr4;
|
||||
}
|
||||
|
||||
public function getFallbackDirs()
|
||||
{
|
||||
return $this->fallbackDirsPsr0;
|
||||
}
|
||||
|
||||
public function getFallbackDirsPsr4()
|
||||
{
|
||||
return $this->fallbackDirsPsr4;
|
||||
}
|
||||
|
||||
public function getClassMap()
|
||||
{
|
||||
return $this->classMap;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $classMap Class to filename map
|
||||
*/
|
||||
public function addClassMap(array $classMap)
|
||||
{
|
||||
if ($this->classMap) {
|
||||
$this->classMap = array_merge($this->classMap, $classMap);
|
||||
} else {
|
||||
$this->classMap = $classMap;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a set of PSR-0 directories for a given prefix, either
|
||||
* appending or prepending to the ones previously set for this prefix.
|
||||
*
|
||||
* @param string $prefix The prefix
|
||||
* @param array|string $paths The PSR-0 root directories
|
||||
* @param bool $prepend Whether to prepend the directories
|
||||
*/
|
||||
public function add($prefix, $paths, $prepend = false)
|
||||
{
|
||||
if (!$prefix) {
|
||||
if ($prepend) {
|
||||
$this->fallbackDirsPsr0 = array_merge(
|
||||
(array) $paths,
|
||||
$this->fallbackDirsPsr0
|
||||
);
|
||||
} else {
|
||||
$this->fallbackDirsPsr0 = array_merge(
|
||||
$this->fallbackDirsPsr0,
|
||||
(array) $paths
|
||||
);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$first = $prefix[0];
|
||||
if (!isset($this->prefixesPsr0[$first][$prefix])) {
|
||||
$this->prefixesPsr0[$first][$prefix] = (array) $paths;
|
||||
|
||||
return;
|
||||
}
|
||||
if ($prepend) {
|
||||
$this->prefixesPsr0[$first][$prefix] = array_merge(
|
||||
(array) $paths,
|
||||
$this->prefixesPsr0[$first][$prefix]
|
||||
);
|
||||
} else {
|
||||
$this->prefixesPsr0[$first][$prefix] = array_merge(
|
||||
$this->prefixesPsr0[$first][$prefix],
|
||||
(array) $paths
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a set of PSR-4 directories for a given namespace, either
|
||||
* appending or prepending to the ones previously set for this namespace.
|
||||
*
|
||||
* @param string $prefix The prefix/namespace, with trailing '\\'
|
||||
* @param array|string $paths The PSR-4 base directories
|
||||
* @param bool $prepend Whether to prepend the directories
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
*/
|
||||
public function addPsr4($prefix, $paths, $prepend = false)
|
||||
{
|
||||
if (!$prefix) {
|
||||
// Register directories for the root namespace.
|
||||
if ($prepend) {
|
||||
$this->fallbackDirsPsr4 = array_merge(
|
||||
(array) $paths,
|
||||
$this->fallbackDirsPsr4
|
||||
);
|
||||
} else {
|
||||
$this->fallbackDirsPsr4 = array_merge(
|
||||
$this->fallbackDirsPsr4,
|
||||
(array) $paths
|
||||
);
|
||||
}
|
||||
} elseif (!isset($this->prefixDirsPsr4[$prefix])) {
|
||||
// Register directories for a new namespace.
|
||||
$length = strlen($prefix);
|
||||
if ('\\' !== $prefix[$length - 1]) {
|
||||
throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
|
||||
}
|
||||
$this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
|
||||
$this->prefixDirsPsr4[$prefix] = (array) $paths;
|
||||
} elseif ($prepend) {
|
||||
// Prepend directories for an already registered namespace.
|
||||
$this->prefixDirsPsr4[$prefix] = array_merge(
|
||||
(array) $paths,
|
||||
$this->prefixDirsPsr4[$prefix]
|
||||
);
|
||||
} else {
|
||||
// Append directories for an already registered namespace.
|
||||
$this->prefixDirsPsr4[$prefix] = array_merge(
|
||||
$this->prefixDirsPsr4[$prefix],
|
||||
(array) $paths
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a set of PSR-0 directories for a given prefix,
|
||||
* replacing any others previously set for this prefix.
|
||||
*
|
||||
* @param string $prefix The prefix
|
||||
* @param array|string $paths The PSR-0 base directories
|
||||
*/
|
||||
public function set($prefix, $paths)
|
||||
{
|
||||
if (!$prefix) {
|
||||
$this->fallbackDirsPsr0 = (array) $paths;
|
||||
} else {
|
||||
$this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a set of PSR-4 directories for a given namespace,
|
||||
* replacing any others previously set for this namespace.
|
||||
*
|
||||
* @param string $prefix The prefix/namespace, with trailing '\\'
|
||||
* @param array|string $paths The PSR-4 base directories
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
*/
|
||||
public function setPsr4($prefix, $paths)
|
||||
{
|
||||
if (!$prefix) {
|
||||
$this->fallbackDirsPsr4 = (array) $paths;
|
||||
} else {
|
||||
$length = strlen($prefix);
|
||||
if ('\\' !== $prefix[$length - 1]) {
|
||||
throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
|
||||
}
|
||||
$this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
|
||||
$this->prefixDirsPsr4[$prefix] = (array) $paths;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Turns on searching the include path for class files.
|
||||
*
|
||||
* @param bool $useIncludePath
|
||||
*/
|
||||
public function setUseIncludePath($useIncludePath)
|
||||
{
|
||||
$this->useIncludePath = $useIncludePath;
|
||||
}
|
||||
|
||||
/**
|
||||
* Can be used to check if the autoloader uses the include path to check
|
||||
* for classes.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function getUseIncludePath()
|
||||
{
|
||||
return $this->useIncludePath;
|
||||
}
|
||||
|
||||
/**
|
||||
* Turns off searching the prefix and fallback directories for classes
|
||||
* that have not been registered with the class map.
|
||||
*
|
||||
* @param bool $classMapAuthoritative
|
||||
*/
|
||||
public function setClassMapAuthoritative($classMapAuthoritative)
|
||||
{
|
||||
$this->classMapAuthoritative = $classMapAuthoritative;
|
||||
}
|
||||
|
||||
/**
|
||||
* Should class lookup fail if not found in the current class map?
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isClassMapAuthoritative()
|
||||
{
|
||||
return $this->classMapAuthoritative;
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers this instance as an autoloader.
|
||||
*
|
||||
* @param bool $prepend Whether to prepend the autoloader or not
|
||||
*/
|
||||
public function register($prepend = false)
|
||||
{
|
||||
spl_autoload_register(array($this, 'loadClass'), true, $prepend);
|
||||
}
|
||||
|
||||
/**
|
||||
* Unregisters this instance as an autoloader.
|
||||
*/
|
||||
public function unregister()
|
||||
{
|
||||
spl_autoload_unregister(array($this, 'loadClass'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the given class or interface.
|
||||
*
|
||||
* @param string $class The name of the class
|
||||
* @return bool|null True if loaded, null otherwise
|
||||
*/
|
||||
public function loadClass($class)
|
||||
{
|
||||
if ($file = $this->findFile($class)) {
|
||||
includeFile($file);
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds the path to the file where the class is defined.
|
||||
*
|
||||
* @param string $class The name of the class
|
||||
*
|
||||
* @return string|false The path if found, false otherwise
|
||||
*/
|
||||
public function findFile($class)
|
||||
{
|
||||
// work around for PHP 5.3.0 - 5.3.2 https://bugs.php.net/50731
|
||||
if ('\\' == $class[0]) {
|
||||
$class = substr($class, 1);
|
||||
}
|
||||
|
||||
// class map lookup
|
||||
if (isset($this->classMap[$class])) {
|
||||
return $this->classMap[$class];
|
||||
}
|
||||
if ($this->classMapAuthoritative) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$file = $this->findFileWithExtension($class, '.php');
|
||||
|
||||
// Search for Hack files if we are running on HHVM
|
||||
if ($file === null && defined('HHVM_VERSION')) {
|
||||
$file = $this->findFileWithExtension($class, '.hh');
|
||||
}
|
||||
|
||||
if ($file === null) {
|
||||
// Remember that this class does not exist.
|
||||
return $this->classMap[$class] = false;
|
||||
}
|
||||
|
||||
return $file;
|
||||
}
|
||||
|
||||
private function findFileWithExtension($class, $ext)
|
||||
{
|
||||
// PSR-4 lookup
|
||||
$logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext;
|
||||
|
||||
$first = $class[0];
|
||||
if (isset($this->prefixLengthsPsr4[$first])) {
|
||||
foreach ($this->prefixLengthsPsr4[$first] as $prefix => $length) {
|
||||
if (0 === strpos($class, $prefix)) {
|
||||
foreach ($this->prefixDirsPsr4[$prefix] as $dir) {
|
||||
if (file_exists($file = $dir . DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $length))) {
|
||||
return $file;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// PSR-4 fallback dirs
|
||||
foreach ($this->fallbackDirsPsr4 as $dir) {
|
||||
if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) {
|
||||
return $file;
|
||||
}
|
||||
}
|
||||
|
||||
// PSR-0 lookup
|
||||
if (false !== $pos = strrpos($class, '\\')) {
|
||||
// namespaced class name
|
||||
$logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1)
|
||||
. strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR);
|
||||
} else {
|
||||
// PEAR-like class name
|
||||
$logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext;
|
||||
}
|
||||
|
||||
if (isset($this->prefixesPsr0[$first])) {
|
||||
foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) {
|
||||
if (0 === strpos($class, $prefix)) {
|
||||
foreach ($dirs as $dir) {
|
||||
if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
|
||||
return $file;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// PSR-0 fallback dirs
|
||||
foreach ($this->fallbackDirsPsr0 as $dir) {
|
||||
if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
|
||||
return $file;
|
||||
}
|
||||
}
|
||||
|
||||
// PSR-0 include paths.
|
||||
if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) {
|
||||
return $file;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Scope isolated include.
|
||||
*
|
||||
* Prevents access to $this/self from included files.
|
||||
*/
|
||||
function includeFile($file)
|
||||
{
|
||||
include $file;
|
||||
}
|
||||
@ -1,21 +0,0 @@
|
||||
|
||||
Copyright (c) 2016 Nils Adermann, Jordi Boggiano
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is furnished
|
||||
to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
<?php
|
||||
|
||||
// autoload_classmap.php @generated by Composer
|
||||
|
||||
$vendorDir = dirname(dirname(__FILE__));
|
||||
$baseDir = dirname($vendorDir);
|
||||
|
||||
return array(
|
||||
);
|
||||
@ -1,9 +0,0 @@
|
||||
<?php
|
||||
|
||||
// autoload_namespaces.php @generated by Composer
|
||||
|
||||
$vendorDir = dirname(dirname(__FILE__));
|
||||
$baseDir = dirname($vendorDir);
|
||||
|
||||
return array(
|
||||
);
|
||||
@ -1,11 +0,0 @@
|
||||
<?php
|
||||
|
||||
// autoload_psr4.php @generated by Composer
|
||||
|
||||
$vendorDir = dirname(dirname(__FILE__));
|
||||
$baseDir = dirname($vendorDir);
|
||||
|
||||
return array(
|
||||
'Pds\\Skeleton\\' => array($vendorDir . '/pds/skeleton/src'),
|
||||
'BSR\\Lib\\' => array($baseDir . '/Lib'),
|
||||
);
|
||||
@ -1,52 +0,0 @@
|
||||
<?php
|
||||
|
||||
// autoload_real.php @generated by Composer
|
||||
|
||||
class ComposerAutoloaderInit22f37628aeb6bdf37979bf902b8ee9cd
|
||||
{
|
||||
private static $loader;
|
||||
|
||||
public static function loadClassLoader($class)
|
||||
{
|
||||
if ('Composer\Autoload\ClassLoader' === $class) {
|
||||
require __DIR__ . '/ClassLoader.php';
|
||||
}
|
||||
}
|
||||
|
||||
public static function getLoader()
|
||||
{
|
||||
if (null !== self::$loader) {
|
||||
return self::$loader;
|
||||
}
|
||||
|
||||
spl_autoload_register(array('ComposerAutoloaderInit22f37628aeb6bdf37979bf902b8ee9cd', 'loadClassLoader'), true, true);
|
||||
self::$loader = $loader = new \Composer\Autoload\ClassLoader();
|
||||
spl_autoload_unregister(array('ComposerAutoloaderInit22f37628aeb6bdf37979bf902b8ee9cd', 'loadClassLoader'));
|
||||
|
||||
$useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION');
|
||||
if ($useStaticLoader) {
|
||||
require_once __DIR__ . '/autoload_static.php';
|
||||
|
||||
call_user_func(\Composer\Autoload\ComposerStaticInit22f37628aeb6bdf37979bf902b8ee9cd::getInitializer($loader));
|
||||
} else {
|
||||
$map = require __DIR__ . '/autoload_namespaces.php';
|
||||
foreach ($map as $namespace => $path) {
|
||||
$loader->set($namespace, $path);
|
||||
}
|
||||
|
||||
$map = require __DIR__ . '/autoload_psr4.php';
|
||||
foreach ($map as $namespace => $path) {
|
||||
$loader->setPsr4($namespace, $path);
|
||||
}
|
||||
|
||||
$classMap = require __DIR__ . '/autoload_classmap.php';
|
||||
if ($classMap) {
|
||||
$loader->addClassMap($classMap);
|
||||
}
|
||||
}
|
||||
|
||||
$loader->register(true);
|
||||
|
||||
return $loader;
|
||||
}
|
||||
}
|
||||
@ -1,39 +0,0 @@
|
||||
<?php
|
||||
|
||||
// autoload_static.php @generated by Composer
|
||||
|
||||
namespace Composer\Autoload;
|
||||
|
||||
class ComposerStaticInit22f37628aeb6bdf37979bf902b8ee9cd
|
||||
{
|
||||
public static $prefixLengthsPsr4 = array (
|
||||
'P' =>
|
||||
array (
|
||||
'Pds\\Skeleton\\' => 13,
|
||||
),
|
||||
'B' =>
|
||||
array (
|
||||
'BSR\\Lib\\' => 8,
|
||||
),
|
||||
);
|
||||
|
||||
public static $prefixDirsPsr4 = array (
|
||||
'Pds\\Skeleton\\' =>
|
||||
array (
|
||||
0 => __DIR__ . '/..' . '/pds/skeleton/src',
|
||||
),
|
||||
'BSR\\Lib\\' =>
|
||||
array (
|
||||
0 => __DIR__ . '/../..' . '/Lib',
|
||||
),
|
||||
);
|
||||
|
||||
public static function getInitializer(ClassLoader $loader)
|
||||
{
|
||||
return \Closure::bind(function () use ($loader) {
|
||||
$loader->prefixLengthsPsr4 = ComposerStaticInit22f37628aeb6bdf37979bf902b8ee9cd::$prefixLengthsPsr4;
|
||||
$loader->prefixDirsPsr4 = ComposerStaticInit22f37628aeb6bdf37979bf902b8ee9cd::$prefixDirsPsr4;
|
||||
|
||||
}, null, ClassLoader::class);
|
||||
}
|
||||
}
|
||||
@ -1,35 +0,0 @@
|
||||
[
|
||||
{
|
||||
"name": "pds/skeleton",
|
||||
"version": "1.0.0",
|
||||
"version_normalized": "1.0.0.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/php-pds/skeleton.git",
|
||||
"reference": "95e476e5d629eadacbd721c5a9553e537514a231"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/php-pds/skeleton/zipball/95e476e5d629eadacbd721c5a9553e537514a231",
|
||||
"reference": "95e476e5d629eadacbd721c5a9553e537514a231",
|
||||
"shasum": ""
|
||||
},
|
||||
"time": "2017-01-25 23:30:41",
|
||||
"bin": [
|
||||
"bin/pds-skeleton"
|
||||
],
|
||||
"type": "standard",
|
||||
"installation-source": "dist",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Pds\\Skeleton\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"CC-BY-SA-4.0"
|
||||
],
|
||||
"description": "Standard for PHP package skeletons.",
|
||||
"homepage": "https://github.com/php-pds/skeleton"
|
||||
}
|
||||
]
|
||||
@ -1 +0,0 @@
|
||||
/vendor/
|
||||
@ -1,7 +0,0 @@
|
||||
# Change Log
|
||||
|
||||
All notable changes to this publication will be documented in this file.
|
||||
|
||||
## 1.0.0 - 2017-25-01
|
||||
|
||||
First stable release.
|
||||
@ -1,427 +0,0 @@
|
||||
Attribution-ShareAlike 4.0 International
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||
does not provide legal services or legal advice. Distribution of
|
||||
Creative Commons public licenses does not create a lawyer-client or
|
||||
other relationship. Creative Commons makes its licenses and related
|
||||
information available on an "as-is" basis. Creative Commons gives no
|
||||
warranties regarding its licenses, any material licensed under their
|
||||
terms and conditions, or any related information. Creative Commons
|
||||
disclaims all liability for damages resulting from their use to the
|
||||
fullest extent possible.
|
||||
|
||||
Using Creative Commons Public Licenses
|
||||
|
||||
Creative Commons public licenses provide a standard set of terms and
|
||||
conditions that creators and other rights holders may use to share
|
||||
original works of authorship and other material subject to copyright
|
||||
and certain other rights specified in the public license below. The
|
||||
following considerations are for informational purposes only, are not
|
||||
exhaustive, and do not form part of our licenses.
|
||||
|
||||
Considerations for licensors: Our public licenses are
|
||||
intended for use by those authorized to give the public
|
||||
permission to use material in ways otherwise restricted by
|
||||
copyright and certain other rights. Our licenses are
|
||||
irrevocable. Licensors should read and understand the terms
|
||||
and conditions of the license they choose before applying it.
|
||||
Licensors should also secure all rights necessary before
|
||||
applying our licenses so that the public can reuse the
|
||||
material as expected. Licensors should clearly mark any
|
||||
material not subject to the license. This includes other CC-
|
||||
licensed material, or material used under an exception or
|
||||
limitation to copyright. More considerations for licensors:
|
||||
wiki.creativecommons.org/Considerations_for_licensors
|
||||
|
||||
Considerations for the public: By using one of our public
|
||||
licenses, a licensor grants the public permission to use the
|
||||
licensed material under specified terms and conditions. If
|
||||
the licensor's permission is not necessary for any reason--for
|
||||
example, because of any applicable exception or limitation to
|
||||
copyright--then that use is not regulated by the license. Our
|
||||
licenses grant only permissions under copyright and certain
|
||||
other rights that a licensor has authority to grant. Use of
|
||||
the licensed material may still be restricted for other
|
||||
reasons, including because others have copyright or other
|
||||
rights in the material. A licensor may make special requests,
|
||||
such as asking that all changes be marked or described.
|
||||
Although not required by our licenses, you are encouraged to
|
||||
respect those requests where reasonable. More_considerations
|
||||
for the public:
|
||||
wiki.creativecommons.org/Considerations_for_licensees
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons Attribution-ShareAlike 4.0 International Public
|
||||
License
|
||||
|
||||
By exercising the Licensed Rights (defined below), You accept and agree
|
||||
to be bound by the terms and conditions of this Creative Commons
|
||||
Attribution-ShareAlike 4.0 International Public License ("Public
|
||||
License"). To the extent this Public License may be interpreted as a
|
||||
contract, You are granted the Licensed Rights in consideration of Your
|
||||
acceptance of these terms and conditions, and the Licensor grants You
|
||||
such rights in consideration of benefits the Licensor receives from
|
||||
making the Licensed Material available under these terms and
|
||||
conditions.
|
||||
|
||||
|
||||
Section 1 -- Definitions.
|
||||
|
||||
a. Adapted Material means material subject to Copyright and Similar
|
||||
Rights that is derived from or based upon the Licensed Material
|
||||
and in which the Licensed Material is translated, altered,
|
||||
arranged, transformed, or otherwise modified in a manner requiring
|
||||
permission under the Copyright and Similar Rights held by the
|
||||
Licensor. For purposes of this Public License, where the Licensed
|
||||
Material is a musical work, performance, or sound recording,
|
||||
Adapted Material is always produced where the Licensed Material is
|
||||
synched in timed relation with a moving image.
|
||||
|
||||
b. Adapter's License means the license You apply to Your Copyright
|
||||
and Similar Rights in Your contributions to Adapted Material in
|
||||
accordance with the terms and conditions of this Public License.
|
||||
|
||||
c. BY-SA Compatible License means a license listed at
|
||||
creativecommons.org/compatiblelicenses, approved by Creative
|
||||
Commons as essentially the equivalent of this Public License.
|
||||
|
||||
d. Copyright and Similar Rights means copyright and/or similar rights
|
||||
closely related to copyright including, without limitation,
|
||||
performance, broadcast, sound recording, and Sui Generis Database
|
||||
Rights, without regard to how the rights are labeled or
|
||||
categorized. For purposes of this Public License, the rights
|
||||
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||
Rights.
|
||||
|
||||
e. Effective Technological Measures means those measures that, in the
|
||||
absence of proper authority, may not be circumvented under laws
|
||||
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||
Treaty adopted on December 20, 1996, and/or similar international
|
||||
agreements.
|
||||
|
||||
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||
any other exception or limitation to Copyright and Similar Rights
|
||||
that applies to Your use of the Licensed Material.
|
||||
|
||||
g. License Elements means the license attributes listed in the name
|
||||
of a Creative Commons Public License. The License Elements of this
|
||||
Public License are Attribution and ShareAlike.
|
||||
|
||||
h. Licensed Material means the artistic or literary work, database,
|
||||
or other material to which the Licensor applied this Public
|
||||
License.
|
||||
|
||||
i. Licensed Rights means the rights granted to You subject to the
|
||||
terms and conditions of this Public License, which are limited to
|
||||
all Copyright and Similar Rights that apply to Your use of the
|
||||
Licensed Material and that the Licensor has authority to license.
|
||||
|
||||
j. Licensor means the individual(s) or entity(ies) granting rights
|
||||
under this Public License.
|
||||
|
||||
k. Share means to provide material to the public by any means or
|
||||
process that requires permission under the Licensed Rights, such
|
||||
as reproduction, public display, public performance, distribution,
|
||||
dissemination, communication, or importation, and to make material
|
||||
available to the public including in ways that members of the
|
||||
public may access the material from a place and at a time
|
||||
individually chosen by them.
|
||||
|
||||
l. Sui Generis Database Rights means rights other than copyright
|
||||
resulting from Directive 96/9/EC of the European Parliament and of
|
||||
the Council of 11 March 1996 on the legal protection of databases,
|
||||
as amended and/or succeeded, as well as other essentially
|
||||
equivalent rights anywhere in the world.
|
||||
|
||||
m. You means the individual or entity exercising the Licensed Rights
|
||||
under this Public License. Your has a corresponding meaning.
|
||||
|
||||
|
||||
Section 2 -- Scope.
|
||||
|
||||
a. License grant.
|
||||
|
||||
1. Subject to the terms and conditions of this Public License,
|
||||
the Licensor hereby grants You a worldwide, royalty-free,
|
||||
non-sublicensable, non-exclusive, irrevocable license to
|
||||
exercise the Licensed Rights in the Licensed Material to:
|
||||
|
||||
a. reproduce and Share the Licensed Material, in whole or
|
||||
in part; and
|
||||
|
||||
b. produce, reproduce, and Share Adapted Material.
|
||||
|
||||
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||
Exceptions and Limitations apply to Your use, this Public
|
||||
License does not apply, and You do not need to comply with
|
||||
its terms and conditions.
|
||||
|
||||
3. Term. The term of this Public License is specified in Section
|
||||
6(a).
|
||||
|
||||
4. Media and formats; technical modifications allowed. The
|
||||
Licensor authorizes You to exercise the Licensed Rights in
|
||||
all media and formats whether now known or hereafter created,
|
||||
and to make technical modifications necessary to do so. The
|
||||
Licensor waives and/or agrees not to assert any right or
|
||||
authority to forbid You from making technical modifications
|
||||
necessary to exercise the Licensed Rights, including
|
||||
technical modifications necessary to circumvent Effective
|
||||
Technological Measures. For purposes of this Public License,
|
||||
simply making modifications authorized by this Section 2(a)
|
||||
(4) never produces Adapted Material.
|
||||
|
||||
5. Downstream recipients.
|
||||
|
||||
a. Offer from the Licensor -- Licensed Material. Every
|
||||
recipient of the Licensed Material automatically
|
||||
receives an offer from the Licensor to exercise the
|
||||
Licensed Rights under the terms and conditions of this
|
||||
Public License.
|
||||
|
||||
b. Additional offer from the Licensor -- Adapted Material.
|
||||
Every recipient of Adapted Material from You
|
||||
automatically receives an offer from the Licensor to
|
||||
exercise the Licensed Rights in the Adapted Material
|
||||
under the conditions of the Adapter's License You apply.
|
||||
|
||||
c. No downstream restrictions. You may not offer or impose
|
||||
any additional or different terms or conditions on, or
|
||||
apply any Effective Technological Measures to, the
|
||||
Licensed Material if doing so restricts exercise of the
|
||||
Licensed Rights by any recipient of the Licensed
|
||||
Material.
|
||||
|
||||
6. No endorsement. Nothing in this Public License constitutes or
|
||||
may be construed as permission to assert or imply that You
|
||||
are, or that Your use of the Licensed Material is, connected
|
||||
with, or sponsored, endorsed, or granted official status by,
|
||||
the Licensor or others designated to receive attribution as
|
||||
provided in Section 3(a)(1)(A)(i).
|
||||
|
||||
b. Other rights.
|
||||
|
||||
1. Moral rights, such as the right of integrity, are not
|
||||
licensed under this Public License, nor are publicity,
|
||||
privacy, and/or other similar personality rights; however, to
|
||||
the extent possible, the Licensor waives and/or agrees not to
|
||||
assert any such rights held by the Licensor to the limited
|
||||
extent necessary to allow You to exercise the Licensed
|
||||
Rights, but not otherwise.
|
||||
|
||||
2. Patent and trademark rights are not licensed under this
|
||||
Public License.
|
||||
|
||||
3. To the extent possible, the Licensor waives any right to
|
||||
collect royalties from You for the exercise of the Licensed
|
||||
Rights, whether directly or through a collecting society
|
||||
under any voluntary or waivable statutory or compulsory
|
||||
licensing scheme. In all other cases the Licensor expressly
|
||||
reserves any right to collect such royalties.
|
||||
|
||||
|
||||
Section 3 -- License Conditions.
|
||||
|
||||
Your exercise of the Licensed Rights is expressly made subject to the
|
||||
following conditions.
|
||||
|
||||
a. Attribution.
|
||||
|
||||
1. If You Share the Licensed Material (including in modified
|
||||
form), You must:
|
||||
|
||||
a. retain the following if it is supplied by the Licensor
|
||||
with the Licensed Material:
|
||||
|
||||
i. identification of the creator(s) of the Licensed
|
||||
Material and any others designated to receive
|
||||
attribution, in any reasonable manner requested by
|
||||
the Licensor (including by pseudonym if
|
||||
designated);
|
||||
|
||||
ii. a copyright notice;
|
||||
|
||||
iii. a notice that refers to this Public License;
|
||||
|
||||
iv. a notice that refers to the disclaimer of
|
||||
warranties;
|
||||
|
||||
v. a URI or hyperlink to the Licensed Material to the
|
||||
extent reasonably practicable;
|
||||
|
||||
b. indicate if You modified the Licensed Material and
|
||||
retain an indication of any previous modifications; and
|
||||
|
||||
c. indicate the Licensed Material is licensed under this
|
||||
Public License, and include the text of, or the URI or
|
||||
hyperlink to, this Public License.
|
||||
|
||||
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||
reasonable manner based on the medium, means, and context in
|
||||
which You Share the Licensed Material. For example, it may be
|
||||
reasonable to satisfy the conditions by providing a URI or
|
||||
hyperlink to a resource that includes the required
|
||||
information.
|
||||
|
||||
3. If requested by the Licensor, You must remove any of the
|
||||
information required by Section 3(a)(1)(A) to the extent
|
||||
reasonably practicable.
|
||||
|
||||
b. ShareAlike.
|
||||
|
||||
In addition to the conditions in Section 3(a), if You Share
|
||||
Adapted Material You produce, the following conditions also apply.
|
||||
|
||||
1. The Adapter's License You apply must be a Creative Commons
|
||||
license with the same License Elements, this version or
|
||||
later, or a BY-SA Compatible License.
|
||||
|
||||
2. You must include the text of, or the URI or hyperlink to, the
|
||||
Adapter's License You apply. You may satisfy this condition
|
||||
in any reasonable manner based on the medium, means, and
|
||||
context in which You Share Adapted Material.
|
||||
|
||||
3. You may not offer or impose any additional or different terms
|
||||
or conditions on, or apply any Effective Technological
|
||||
Measures to, Adapted Material that restrict exercise of the
|
||||
rights granted under the Adapter's License You apply.
|
||||
|
||||
|
||||
Section 4 -- Sui Generis Database Rights.
|
||||
|
||||
Where the Licensed Rights include Sui Generis Database Rights that
|
||||
apply to Your use of the Licensed Material:
|
||||
|
||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||
to extract, reuse, reproduce, and Share all or a substantial
|
||||
portion of the contents of the database;
|
||||
|
||||
b. if You include all or a substantial portion of the database
|
||||
contents in a database in which You have Sui Generis Database
|
||||
Rights, then the database in which You have Sui Generis Database
|
||||
Rights (but not its individual contents) is Adapted Material,
|
||||
|
||||
including for purposes of Section 3(b); and
|
||||
c. You must comply with the conditions in Section 3(a) if You Share
|
||||
all or a substantial portion of the contents of the database.
|
||||
|
||||
For the avoidance of doubt, this Section 4 supplements and does not
|
||||
replace Your obligations under this Public License where the Licensed
|
||||
Rights include other Copyright and Similar Rights.
|
||||
|
||||
|
||||
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||
|
||||
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||
|
||||
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||
|
||||
c. The disclaimer of warranties and limitation of liability provided
|
||||
above shall be interpreted in a manner that, to the extent
|
||||
possible, most closely approximates an absolute disclaimer and
|
||||
waiver of all liability.
|
||||
|
||||
|
||||
Section 6 -- Term and Termination.
|
||||
|
||||
a. This Public License applies for the term of the Copyright and
|
||||
Similar Rights licensed here. However, if You fail to comply with
|
||||
this Public License, then Your rights under this Public License
|
||||
terminate automatically.
|
||||
|
||||
b. Where Your right to use the Licensed Material has terminated under
|
||||
Section 6(a), it reinstates:
|
||||
|
||||
1. automatically as of the date the violation is cured, provided
|
||||
it is cured within 30 days of Your discovery of the
|
||||
violation; or
|
||||
|
||||
2. upon express reinstatement by the Licensor.
|
||||
|
||||
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||
right the Licensor may have to seek remedies for Your violations
|
||||
of this Public License.
|
||||
|
||||
c. For the avoidance of doubt, the Licensor may also offer the
|
||||
Licensed Material under separate terms or conditions or stop
|
||||
distributing the Licensed Material at any time; however, doing so
|
||||
will not terminate this Public License.
|
||||
|
||||
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||
License.
|
||||
|
||||
|
||||
Section 7 -- Other Terms and Conditions.
|
||||
|
||||
a. The Licensor shall not be bound by any additional or different
|
||||
terms or conditions communicated by You unless expressly agreed.
|
||||
|
||||
b. Any arrangements, understandings, or agreements regarding the
|
||||
Licensed Material not stated herein are separate from and
|
||||
independent of the terms and conditions of this Public License.
|
||||
|
||||
|
||||
Section 8 -- Interpretation.
|
||||
|
||||
a. For the avoidance of doubt, this Public License does not, and
|
||||
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||
conditions on any use of the Licensed Material that could lawfully
|
||||
be made without permission under this Public License.
|
||||
|
||||
b. To the extent possible, if any provision of this Public License is
|
||||
deemed unenforceable, it shall be automatically reformed to the
|
||||
minimum extent necessary to make it enforceable. If the provision
|
||||
cannot be reformed, it shall be severed from this Public License
|
||||
without affecting the enforceability of the remaining terms and
|
||||
conditions.
|
||||
|
||||
c. No term or condition of this Public License will be waived and no
|
||||
failure to comply consented to unless expressly agreed to by the
|
||||
Licensor.
|
||||
|
||||
d. Nothing in this Public License constitutes or may be interpreted
|
||||
as a limitation upon, or waiver of, any privileges and immunities
|
||||
that apply to the Licensor or You, including from the legal
|
||||
processes of any jurisdiction or authority.
|
||||
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons is not a party to its public
|
||||
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||
its public licenses to material it publishes and in those instances
|
||||
will be considered the “Licensor.” The text of the Creative Commons
|
||||
public licenses is dedicated to the public domain under the CC0 Public
|
||||
Domain Dedication. Except for the limited purpose of indicating that
|
||||
material is shared under a Creative Commons public license or as
|
||||
otherwise permitted by the Creative Commons policies published at
|
||||
creativecommons.org/policies, Creative Commons does not authorize the
|
||||
use of the trademark "Creative Commons" or any other trademark or logo
|
||||
of Creative Commons without its prior written consent including,
|
||||
without limitation, in connection with any unauthorized modifications
|
||||
to any of its public licenses or any other arrangements,
|
||||
understandings, or agreements concerning use of licensed material. For
|
||||
the avoidance of doubt, this paragraph does not form part of the
|
||||
public licenses.
|
||||
|
||||
Creative Commons may be contacted at creativecommons.org.
|
||||
@ -1,164 +0,0 @@
|
||||
# pds/skeleton
|
||||
|
||||
This publication describes a standard filesystem skeleton suitable for all PHP
|
||||
packages.
|
||||
|
||||
Please see <https://github.com/php-pds/skeleton_research> for background
|
||||
information.
|
||||
|
||||
Command-line tools included with this standard are documented [here](./docs/tools.md).
|
||||
|
||||
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
|
||||
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this publication are to be
|
||||
interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119).
|
||||
|
||||
## Summary
|
||||
|
||||
A package MUST use these names for these root-level directories:
|
||||
|
||||
| If a package has a root-level directory for ... | ... then it MUST be named: |
|
||||
| ----------------------------------------------- | -------------------------- |
|
||||
| command-line executables | `bin/` |
|
||||
| configuration files | `config/` |
|
||||
| documentation files | `docs/` |
|
||||
| web server files | `public/` |
|
||||
| other resource files | `resources/` |
|
||||
| PHP source code | `src/` |
|
||||
| test code | `tests/` |
|
||||
|
||||
A package MUST use these names for these root-level files:
|
||||
|
||||
| If a package has a root-level file for ... | ... then it MUST be named: |
|
||||
| ----------------------------------------------- | -------------------------- |
|
||||
| a log of changes between releases | `CHANGELOG(.*)` |
|
||||
| guidelines for contributors | `CONTRIBUTING(.*)` |
|
||||
| licensing information | `LICENSE(.*)` |
|
||||
| information about the package itself | `README(.*)` |
|
||||
|
||||
A package SHOULD include a root-level file indicating the licensing and
|
||||
copyright terms of the package contents.
|
||||
|
||||
## Root-Level Directories
|
||||
|
||||
### bin/
|
||||
|
||||
If the package provides a root-level directory for command-line executable
|
||||
files, it MUST be named `bin/`.
|
||||
|
||||
This publication does not otherwise define the structure and contents of the
|
||||
directory.
|
||||
|
||||
### config/
|
||||
|
||||
If the package provides a root-level directory for configuration files, it MUST
|
||||
be named `config/`.
|
||||
|
||||
This publication does not otherwise define the structure and contents of the
|
||||
directory.
|
||||
|
||||
### docs/
|
||||
|
||||
If the package provides a root-level directory for documentation files, it MUST
|
||||
be named `docs/`.
|
||||
|
||||
This publication does not otherwise define the structure and contents of the
|
||||
directory.
|
||||
|
||||
### public/
|
||||
|
||||
If the package provides a root-level directory for web server files, it MUST be
|
||||
named `public/`.
|
||||
|
||||
This publication does not otherwise define the structure and contents of the
|
||||
directory.
|
||||
|
||||
> N.b.: This directory MAY be intended as a web server document root.
|
||||
> Alternatively, it MAY be that the files will be served dynamically via other
|
||||
> code, copied or symlinked to the "real" document root, or otherwise managed so
|
||||
> that they become publicly available on the web.
|
||||
|
||||
### resources/
|
||||
|
||||
If the package provides a root-level directory for other resource files, it MUST
|
||||
be named `resources/`.
|
||||
|
||||
This publication does not otherwise define the structure and contents of the
|
||||
directory.
|
||||
|
||||
### src/
|
||||
|
||||
If the package provides a root-level directory for PHP source code files, it
|
||||
MUST be named `src/`.
|
||||
|
||||
This publication does not otherwise define the structure and contents of the
|
||||
directory.
|
||||
|
||||
### tests/
|
||||
|
||||
If the package provides a root-level directory for test files, it MUST be named
|
||||
`tests/`.
|
||||
|
||||
This publication does not otherwise define the structure and contents of the
|
||||
directory.
|
||||
|
||||
### Other Directories
|
||||
|
||||
The package MAY contain other root-level directories for purposes not described
|
||||
by this publication.
|
||||
|
||||
This publication does not define the structure and contents of the other
|
||||
root-level directories.
|
||||
|
||||
## Root-Level Files
|
||||
|
||||
### CHANGELOG
|
||||
|
||||
If the package provides a root-level file with a list of changes since the last
|
||||
release or version, it MUST be named `CHANGELOG`.
|
||||
|
||||
It MAY have a lowercase filename extension indicating the file format.
|
||||
|
||||
This publication does not otherwise define the structure and contents of the
|
||||
file.
|
||||
|
||||
### CONTRIBUTING
|
||||
|
||||
If the package provides a root-level file that describes how to contribute to
|
||||
the package, it MUST be named `CONTRIBUTING`.
|
||||
|
||||
It MAY have a lowercase filename extension indicating the file format.
|
||||
|
||||
This publication does not otherwise define the structure and contents of the
|
||||
file.
|
||||
|
||||
### LICENSE
|
||||
|
||||
Whereas package consumers might be in violation of copyright law when copying
|
||||
unlicensed intellectual property, the package SHOULD include a root-level file
|
||||
indicating the licensing and copyright terms of the package contents.
|
||||
|
||||
If the package provides a root-level file indicating the licensing and copyright
|
||||
terms of the package contents, it MUST be named `LICENSE`.
|
||||
|
||||
It MAY have a lowercase filename extension indicating the file format.
|
||||
|
||||
This publication does not otherwise define the structure and contents of the
|
||||
file.
|
||||
|
||||
### README
|
||||
|
||||
If the package provides a root-level file with information about the package
|
||||
itself, it MUST be named `README`.
|
||||
|
||||
It MAY have a lowercase filename extension indicating the file format.
|
||||
|
||||
This publication does not otherwise define the structure and contents of the
|
||||
file.
|
||||
|
||||
### Other Files
|
||||
|
||||
The package MAY contain other root-level files for purposes not described in
|
||||
this publication.
|
||||
|
||||
This publication does not define the structure and contents of the other
|
||||
root-level files.
|
||||
@ -1,25 +0,0 @@
|
||||
#!/usr/bin/env php
|
||||
<?php
|
||||
$autoload = null;
|
||||
|
||||
$autoloadFiles = [
|
||||
__DIR__ . '/../vendor/autoload.php',
|
||||
__DIR__ . '/../../../autoload.php'
|
||||
];
|
||||
|
||||
foreach ($autoloadFiles as $autoloadFile) {
|
||||
if (file_exists($autoloadFile)) {
|
||||
$autoload = $autoloadFile;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (! $autoload) {
|
||||
echo "Autoload file not found; try 'composer dump-autoload' first." . PHP_EOL;
|
||||
exit(1);
|
||||
}
|
||||
|
||||
require $autoload;
|
||||
|
||||
$console = new \Pds\Skeleton\Console();
|
||||
$console->execute($argv);
|
||||
@ -1,18 +0,0 @@
|
||||
{
|
||||
"name": "pds/skeleton",
|
||||
"type": "standard",
|
||||
"description": "Standard for PHP package skeletons.",
|
||||
"homepage": "https://github.com/php-pds/skeleton",
|
||||
"license": "CC-BY-SA-4.0",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Pds\\Skeleton\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"Pds\\Skeleton\\": "tests/"
|
||||
}
|
||||
},
|
||||
"bin": ["bin/pds-skeleton"]
|
||||
}
|
||||
@ -1,19 +0,0 @@
|
||||
# Command-Line Tools
|
||||
|
||||
## Validator
|
||||
|
||||
Validate your project's compliance by following these steps:
|
||||
|
||||
- Install package in your project: `composer require pds/skeleton @dev`
|
||||
- Run the validator: `vendor/bin/pds-skeleton validate [path]`
|
||||
|
||||
If no path is specified, the project in which pds-skeleton is installed will be used.
|
||||
|
||||
## Generator
|
||||
|
||||
Generate a compliant package skeleton by following these steps:
|
||||
|
||||
- Install package in your project: `composer require pds/skeleton @dev`
|
||||
- Run the generator: `vendor/bin/pds-skeleton generate [path]`
|
||||
|
||||
If no path is specified, the project in which pds-skeleton is installed will be used.
|
||||
@ -1,318 +0,0 @@
|
||||
<?php
|
||||
namespace Pds\Skeleton;
|
||||
|
||||
class ComplianceValidator
|
||||
{
|
||||
const STATE_OPTIONAL_NOT_PRESENT = 1;
|
||||
const STATE_CORRECT_PRESENT = 2;
|
||||
const STATE_RECOMMENDED_NOT_PRESENT = 3;
|
||||
const STATE_INCORRECT_PRESENT = 4;
|
||||
|
||||
protected $files = null;
|
||||
|
||||
public function execute($root = null)
|
||||
{
|
||||
$lines = $this->getFiles($root);
|
||||
$results = $this->validate($lines);
|
||||
$this->outputResults($results);
|
||||
return true;
|
||||
}
|
||||
|
||||
public function validate($lines)
|
||||
{
|
||||
$complianceTests = [
|
||||
"Command-line executables" => $this->checkBin($lines),
|
||||
"Configuration files" => $this->checkConfig($lines),
|
||||
"Documentation files" => $this->checkDocs($lines),
|
||||
"Web server files" => $this->checkPublic($lines),
|
||||
"Other resource files" => $this->checkResources($lines),
|
||||
"PHP source code" => $this->checkSrc($lines),
|
||||
"Test code" => $this->checkTests($lines),
|
||||
"Log of changes between releases" => $this->checkChangelog($lines),
|
||||
"Guidelines for contributors" => $this->checkContributing($lines),
|
||||
"Licensing information" => $this->checkLicense($lines),
|
||||
"Information about the package itself" => $this->checkReadme($lines),
|
||||
];
|
||||
|
||||
$results = [];
|
||||
foreach ($complianceTests as $label => $complianceResult) {
|
||||
$state = $complianceResult[0];
|
||||
$expected = $complianceResult[1];
|
||||
$actual = $complianceResult[2];
|
||||
$results[$expected] = [
|
||||
'label' => $label,
|
||||
'state' => $state,
|
||||
'expected' => $expected,
|
||||
'actual' => $actual,
|
||||
];
|
||||
}
|
||||
return $results;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get list of files and directories previously set, or generate from parent project.
|
||||
*/
|
||||
public function getFiles($root = null)
|
||||
{
|
||||
$root = $root ?: __DIR__ . '/../../../../';
|
||||
$root = realpath($root);
|
||||
|
||||
if ($this->files == null) {
|
||||
$files = scandir($root);
|
||||
foreach ($files as $i => $file) {
|
||||
if (is_dir("$root/$file")) {
|
||||
$files[$i] .= "/";
|
||||
}
|
||||
}
|
||||
$this->files = $files;
|
||||
}
|
||||
|
||||
return $this->files;
|
||||
}
|
||||
|
||||
public function outputResults($results)
|
||||
{
|
||||
foreach ($results as $result) {
|
||||
$this->outputResultLine($result['label'], $result['state'], $result['expected'], $result['actual']);
|
||||
}
|
||||
}
|
||||
|
||||
protected function outputResultLine($label, $complianceState, $expected, $actual)
|
||||
{
|
||||
$messages = [
|
||||
self::STATE_OPTIONAL_NOT_PRESENT => "Optional {$expected} not present",
|
||||
self::STATE_CORRECT_PRESENT => "Correct {$actual} present",
|
||||
self::STATE_INCORRECT_PRESENT => "Incorrect {$actual} present",
|
||||
self::STATE_RECOMMENDED_NOT_PRESENT => "Recommended {$expected} not present",
|
||||
];
|
||||
echo $this->colorConsoleText("- " . $label . ": " . $messages[$complianceState], $complianceState) . PHP_EOL;
|
||||
}
|
||||
|
||||
protected function colorConsoleText($text, $complianceState)
|
||||
{
|
||||
$colors = [
|
||||
self::STATE_OPTIONAL_NOT_PRESENT => "\033[43;30m",
|
||||
self::STATE_CORRECT_PRESENT => "\033[42;30m",
|
||||
self::STATE_INCORRECT_PRESENT => "\033[41m",
|
||||
self::STATE_RECOMMENDED_NOT_PRESENT => "\033[41m",
|
||||
];
|
||||
if (!array_key_exists($complianceState, $colors)) {
|
||||
return $text;
|
||||
}
|
||||
return $colors[$complianceState] . " " . $text . " \033[0m";
|
||||
}
|
||||
|
||||
protected function checkDir($lines, $pass, array $fail)
|
||||
{
|
||||
foreach ($lines as $line) {
|
||||
$line = trim($line);
|
||||
if ($line == $pass) {
|
||||
return [self::STATE_CORRECT_PRESENT, $pass, $line];
|
||||
}
|
||||
if (in_array($line, $fail)) {
|
||||
return [self::STATE_INCORRECT_PRESENT, $pass, $line];
|
||||
}
|
||||
}
|
||||
return [self::STATE_OPTIONAL_NOT_PRESENT, $pass, null];
|
||||
}
|
||||
|
||||
protected function checkFile($lines, $pass, array $fail, $state = self::STATE_OPTIONAL_NOT_PRESENT)
|
||||
{
|
||||
foreach ($lines as $line) {
|
||||
$line = trim($line);
|
||||
if (preg_match("/^{$pass}(\.[a-z]+)?$/", $line)) {
|
||||
return [self::STATE_CORRECT_PRESENT, $pass, $line];
|
||||
}
|
||||
foreach ($fail as $regex) {
|
||||
if (preg_match($regex, $line)) {
|
||||
return [self::STATE_INCORRECT_PRESENT, $pass, $line];
|
||||
}
|
||||
}
|
||||
}
|
||||
return [$state, $pass, null];
|
||||
}
|
||||
|
||||
protected function checkChangelog($lines)
|
||||
{
|
||||
return $this->checkFile($lines, 'CHANGELOG', [
|
||||
'/^.*CHANGLOG.*$/i',
|
||||
'/^.*CAHNGELOG.*$/i',
|
||||
'/^WHATSNEW(\.[a-z]+)?$/i',
|
||||
'/^RELEASE((_|-)?NOTES)?(\.[a-z]+)?$/i',
|
||||
'/^RELEASES(\.[a-z]+)?$/i',
|
||||
'/^CHANGES(\.[a-z]+)?$/i',
|
||||
'/^CHANGE(\.[a-z]+)?$/i',
|
||||
'/^HISTORY(\.[a-z]+)?$/i',
|
||||
]);
|
||||
}
|
||||
|
||||
protected function checkContributing($lines)
|
||||
{
|
||||
return $this->checkFile($lines, 'CONTRIBUTING', [
|
||||
'/^DEVELOPMENT(\.[a-z]+)?$/i',
|
||||
'/^README\.CONTRIBUTING(\.[a-z]+)?$/i',
|
||||
'/^DEVELOPMENT_README(\.[a-z]+)?$/i',
|
||||
'/^CONTRIBUTE(\.[a-z]+)?$/i',
|
||||
'/^HACKING(\.[a-z]+)?$/i',
|
||||
]);
|
||||
}
|
||||
|
||||
protected function checkLicense($lines)
|
||||
{
|
||||
return $this->checkFile(
|
||||
$lines,
|
||||
'LICENSE',
|
||||
[
|
||||
'/^.*EULA.*$/i',
|
||||
'/^.*(GPL|BSD).*$/i',
|
||||
'/^([A-Z-]+)?LI(N)?(S|C)(E|A)N(S|C)(E|A)(_[A-Z_]+)?(\.[a-z]+)?$/i',
|
||||
'/^COPY(I)?NG(\.[a-z]+)?$/i',
|
||||
'/^COPYRIGHT(\.[a-z]+)?$/i',
|
||||
],
|
||||
self::STATE_RECOMMENDED_NOT_PRESENT
|
||||
);
|
||||
}
|
||||
|
||||
protected function checkReadme($lines)
|
||||
{
|
||||
return $this->checkFile($lines, 'README', [
|
||||
'/^USAGE(\.[a-z]+)?$/i',
|
||||
'/^SUMMARY(\.[a-z]+)?$/i',
|
||||
'/^DESCRIPTION(\.[a-z]+)?$/i',
|
||||
'/^IMPORTANT(\.[a-z]+)?$/i',
|
||||
'/^NOTICE(\.[a-z]+)?$/i',
|
||||
'/^GETTING(_|-)STARTED(\.[a-z]+)?$/i',
|
||||
]);
|
||||
}
|
||||
|
||||
protected function checkBin($lines)
|
||||
{
|
||||
return $this->checkDir($lines, 'bin/', [
|
||||
'cli/',
|
||||
'scripts/',
|
||||
'console/',
|
||||
'shell/',
|
||||
'script/',
|
||||
]);
|
||||
}
|
||||
|
||||
protected function checkConfig($lines)
|
||||
{
|
||||
return $this->checkDir($lines, 'config/', [
|
||||
'etc/',
|
||||
'settings/',
|
||||
'configuration/',
|
||||
'configs/',
|
||||
'_config/',
|
||||
'conf/',
|
||||
]);
|
||||
}
|
||||
|
||||
protected function checkDocs($lines)
|
||||
{
|
||||
return $this->checkDir($lines, 'docs/', [
|
||||
'manual/',
|
||||
'documentation/',
|
||||
'usage/',
|
||||
'doc/',
|
||||
'guide/',
|
||||
'phpdoc/',
|
||||
'apidocs/',
|
||||
'apidoc/',
|
||||
'api-reference/',
|
||||
'user_guide/',
|
||||
'manuals/',
|
||||
'phpdocs/',
|
||||
]);
|
||||
}
|
||||
|
||||
protected function checkPublic($lines)
|
||||
{
|
||||
return $this->checkDir($lines, 'public/', [
|
||||
'assets/',
|
||||
'static/',
|
||||
'html/',
|
||||
'httpdocs/',
|
||||
'media/',
|
||||
'docroot/',
|
||||
'css/',
|
||||
'fonts/',
|
||||
'styles/',
|
||||
'style/',
|
||||
'js/',
|
||||
'javascript/',
|
||||
'images/',
|
||||
'site/',
|
||||
'mysite/',
|
||||
'img/',
|
||||
'web/',
|
||||
'pub/',
|
||||
'webroot/',
|
||||
'www/',
|
||||
'htdocs/',
|
||||
'asset/',
|
||||
'public_html/',
|
||||
'publish/',
|
||||
'pages/',
|
||||
'javascripts/',
|
||||
'icons/',
|
||||
'imgs/',
|
||||
'wwwroot/',
|
||||
'font/',
|
||||
]);
|
||||
}
|
||||
|
||||
protected function checkSrc($lines)
|
||||
{
|
||||
return $this->checkDir($lines, 'src/', [
|
||||
'exception/',
|
||||
'exceptions/',
|
||||
'src-files/',
|
||||
'traits/',
|
||||
'interfaces/',
|
||||
'common/',
|
||||
'sources/',
|
||||
'php/',
|
||||
'inc/',
|
||||
'libraries/',
|
||||
'autoloads/',
|
||||
'autoload/',
|
||||
'source/',
|
||||
'includes/',
|
||||
'include/',
|
||||
'lib/',
|
||||
'libs/',
|
||||
'library/',
|
||||
'code/',
|
||||
'classes/',
|
||||
'func/',
|
||||
'src-dev/',
|
||||
]);
|
||||
}
|
||||
|
||||
protected function checkTests($lines)
|
||||
{
|
||||
return $this->checkDir($lines, 'tests/', [
|
||||
'test/',
|
||||
'unit-tests/',
|
||||
'phpunit/',
|
||||
'testing/',
|
||||
'unittest/',
|
||||
'unit_tests/',
|
||||
'unit_test/',
|
||||
'phpunit-tests/',
|
||||
]);
|
||||
}
|
||||
|
||||
protected function checkResources($lines)
|
||||
{
|
||||
return $this->checkDir($lines, 'resources/', [
|
||||
'Resources/',
|
||||
'res/',
|
||||
'resource/',
|
||||
'Resource/',
|
||||
'ressources/',
|
||||
'Ressources/',
|
||||
]);
|
||||
}
|
||||
}
|
||||
@ -1,44 +0,0 @@
|
||||
<?php
|
||||
namespace Pds\Skeleton;
|
||||
|
||||
class Console
|
||||
{
|
||||
protected $commandsWhitelist = [
|
||||
'validate' => 'Pds\Skeleton\ComplianceValidator',
|
||||
'generate' => 'Pds\Skeleton\PackageGenerator',
|
||||
'test' => 'Pds\Skeleton\TestRunner',
|
||||
];
|
||||
|
||||
public function execute($args)
|
||||
{
|
||||
if (count($args) > 1) {
|
||||
|
||||
$executable = array_shift($args);
|
||||
$commandName = array_shift($args);
|
||||
|
||||
if (array_key_exists($commandName, $this->commandsWhitelist)) {
|
||||
return $this->executeCommand($this->commandsWhitelist[$commandName], $args);
|
||||
}
|
||||
|
||||
$this->outputHelp();
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->outputHelp();
|
||||
return false;
|
||||
}
|
||||
|
||||
protected function executeCommand($commandClass, $args)
|
||||
{
|
||||
$command = new $commandClass();
|
||||
return $command->execute(...$args);
|
||||
}
|
||||
|
||||
protected function outputHelp()
|
||||
{
|
||||
echo 'Available commands:' . PHP_EOL;
|
||||
foreach ($this->commandsWhitelist as $key => $value) {
|
||||
echo 'pds-skeleton ' . $key . PHP_EOL;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,61 +0,0 @@
|
||||
<?php
|
||||
namespace Pds\Skeleton;
|
||||
|
||||
class PackageGenerator
|
||||
{
|
||||
public function execute($root = null)
|
||||
{
|
||||
$validator = new ComplianceValidator();
|
||||
$lines = $validator->getFiles();
|
||||
$validatorResults = $validator->validate($lines);
|
||||
$files = $this->createFiles($validatorResults, $root);
|
||||
$this->outputResults($files);
|
||||
return true;
|
||||
}
|
||||
|
||||
public function createFiles($validatorResults, $root = null)
|
||||
{
|
||||
$root = $root ?: __DIR__ . '/../../../../';
|
||||
$root = realpath($root);
|
||||
|
||||
$files = $this->createFileList($validatorResults);
|
||||
$createdFiles = [];
|
||||
|
||||
foreach ($files as $i => $file) {
|
||||
$isDir = substr($file, -1, 1) == '/';
|
||||
if ($isDir) {
|
||||
$path = $root . '/' . substr($file, 0, -1);
|
||||
$createdFiles[$file] = $path;
|
||||
mkdir($path, 0755);
|
||||
continue;
|
||||
}
|
||||
$path = $root . '/' . $file . '.md';
|
||||
$createdFiles[$file] = $file . '.md';
|
||||
file_put_contents($path, '');
|
||||
chmod($path, 0644);
|
||||
}
|
||||
|
||||
return $createdFiles;
|
||||
}
|
||||
|
||||
public function createFileList($validatorResults)
|
||||
{
|
||||
$files = [];
|
||||
foreach ($validatorResults as $label => $complianceResult) {
|
||||
if (in_array($complianceResult['state'], [
|
||||
ComplianceValidator::STATE_OPTIONAL_NOT_PRESENT,
|
||||
ComplianceValidator::STATE_RECOMMENDED_NOT_PRESENT,
|
||||
])) {
|
||||
$files[$label] = $complianceResult['expected'];
|
||||
}
|
||||
}
|
||||
return $files;
|
||||
}
|
||||
|
||||
public function outputResults($results)
|
||||
{
|
||||
foreach ($results as $file) {
|
||||
echo "Created {$file}" . PHP_EOL;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,11 +0,0 @@
|
||||
<?php
|
||||
namespace Pds\Skeleton;
|
||||
|
||||
class TestRunner
|
||||
{
|
||||
public function execute()
|
||||
{
|
||||
ComplianceValidatorTest::run();
|
||||
PackageGeneratorTest::run();
|
||||
}
|
||||
}
|
||||
@ -1,54 +0,0 @@
|
||||
<?php
|
||||
namespace Pds\Skeleton;
|
||||
|
||||
class ComplianceValidatorTest
|
||||
{
|
||||
public $numErrors = 0;
|
||||
|
||||
public static function run()
|
||||
{
|
||||
$tester = new ComplianceValidatorTest();
|
||||
$tester->testValidate_WithIncorrectBin_ReturnsIncorrectBin();
|
||||
echo __CLASS__ . " errors: {$tester->numErrors}" . PHP_EOL;
|
||||
}
|
||||
|
||||
public function testValidate_WithIncorrectBin_ReturnsIncorrectBin()
|
||||
{
|
||||
$paths = [
|
||||
'cli/',
|
||||
'src/',
|
||||
];
|
||||
|
||||
$validator = new ComplianceValidator();
|
||||
$results = $validator->validate($paths);
|
||||
|
||||
foreach ($results as $expected => $result) {
|
||||
if ($expected == "bin/") {
|
||||
if ($result['state'] != ComplianceValidator::STATE_INCORRECT_PRESENT) {
|
||||
$this->numErrors++;
|
||||
echo __FUNCTION__ . ": Expected state of {$result['expected']} to be STATE_INCORRECT_PRESENT" . PHP_EOL;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
if ($expected == "src/") {
|
||||
if ($result['state'] != ComplianceValidator::STATE_CORRECT_PRESENT) {
|
||||
$this->numErrors++;
|
||||
echo __FUNCTION__ . ": Expected state of {$result['expected']} to be STATE_CORRECT_PRESENT" . PHP_EOL;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
if ($expected == "LICENSE") {
|
||||
if ($result['state'] != ComplianceValidator::STATE_RECOMMENDED_NOT_PRESENT) {
|
||||
$this->numErrors++;
|
||||
echo __FUNCTION__ . ": Expected state of {$result['expected']} to be STATE_RECOMMENDED_NOT_PRESENT" . PHP_EOL;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
if ($result['state'] != ComplianceValidator::STATE_OPTIONAL_NOT_PRESENT) {
|
||||
$this->numErrors++;
|
||||
echo __FUNCTION__ . ": Expected state of {$result['expected']} to be STATE_OPTIONAL_NOT_PRESENT" . PHP_EOL;
|
||||
continue;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,41 +0,0 @@
|
||||
<?php
|
||||
namespace Pds\Skeleton;
|
||||
|
||||
class PackageGeneratorTest
|
||||
{
|
||||
public $numErrors = 0;
|
||||
|
||||
public static function run()
|
||||
{
|
||||
$tester = new PackageGeneratorTest();
|
||||
$tester->testGenerate_WithMissingBin_ReturnsBin();
|
||||
echo __CLASS__ . " errors: {$tester->numErrors}" . PHP_EOL;
|
||||
}
|
||||
|
||||
public function testGenerate_WithMissingBin_ReturnsBin()
|
||||
{
|
||||
$validatorResults = [
|
||||
'bin/' => [
|
||||
'state' => ComplianceValidator::STATE_OPTIONAL_NOT_PRESENT,
|
||||
'expected' => 'bin/',
|
||||
],
|
||||
'config/' => [
|
||||
'state' => ComplianceValidator::STATE_INCORRECT_PRESENT,
|
||||
'expected' => 'config/',
|
||||
],
|
||||
];
|
||||
|
||||
$generator = new PackageGenerator();
|
||||
$files = $generator->createFileList($validatorResults);
|
||||
|
||||
if (!array_key_exists('bin/', $files)) {
|
||||
$this->numErrors++;
|
||||
echo __FUNCTION__ . ": Expected bin/ to be present" . PHP_EOL;
|
||||
}
|
||||
|
||||
if (array_key_exists('config/', $files)) {
|
||||
$this->numErrors++;
|
||||
echo __FUNCTION__ . ": Expected config/ to be absent" . PHP_EOL;
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue