mirror of
https://github.com/joomla/joomla-cms.git
synced 2024-08-24 03:59:49 +00:00
e25f92d41e
* Cleanup classmap and include it properly for stubs generation * Replace import.legacy.php with bootstrap.php * Remove cms.php * Add back NotAllowed
88 lines
2.9 KiB
PHP
88 lines
2.9 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Build
|
|
*
|
|
* @copyright Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
// Set flag that this is a parent file.
|
|
const _JEXEC = 1;
|
|
|
|
// Import namespaced classes
|
|
use Joomla\CMS\Application\CliApplication;
|
|
|
|
// Load system defines
|
|
if (file_exists(dirname(__DIR__) . '/defines.php'))
|
|
{
|
|
require_once dirname(__DIR__) . '/defines.php';
|
|
}
|
|
|
|
if (!defined('_JDEFINES'))
|
|
{
|
|
define('JPATH_BASE', dirname(__DIR__));
|
|
require_once JPATH_BASE . '/includes/defines.php';
|
|
}
|
|
|
|
// Get the Platform with legacy libraries.
|
|
require_once JPATH_LIBRARIES . '/bootstrap.php';
|
|
|
|
// Configure error reporting to maximum for CLI output.
|
|
error_reporting(E_ALL);
|
|
ini_set('display_errors', 1);
|
|
|
|
/**
|
|
* Utility CLI to generate a stubs file holding mapped classes.
|
|
*
|
|
* As Joomla transitions its core classes from residing in the global PHP namespace to using namespaced PHP classes, it will be a common
|
|
* occurrence for developers to work in an environment where their code is still using the old class names which may not exist in newer
|
|
* Joomla releases except for in PHP's autoloader as a class alias. This script therefore allows developers to generate a mapping
|
|
* file they can use in their local environment which will create "real" classes for the aliased class names and allow things like
|
|
* IDE auto completion to work normally.
|
|
*
|
|
* When this script is run, a `stubs.php` file will be generated at the root of your Joomla installation holding all of the mapping
|
|
* information. Note that this file will raise some IDE errors as it will generate stub classes extending a final class (something
|
|
* not allowed in PHP). Therefore it is suggested that inspections on this file are disabled.
|
|
*
|
|
* @since 3.0
|
|
*/
|
|
class StubGenerator extends CliApplication
|
|
{
|
|
/**
|
|
* Entry point for CLI script
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 3.0
|
|
*/
|
|
public function doExecute()
|
|
{
|
|
// Get the aliased class names via Reflection as the property is protected
|
|
$refl = new ReflectionClass('JLoader');
|
|
$property = $refl->getProperty('classAliases');
|
|
$property->setAccessible(true);
|
|
$aliases = $property->getValue();
|
|
|
|
$file = "<?php\n";
|
|
|
|
// Loop the aliases to generate the stubs data
|
|
foreach ($aliases as $oldName => $newName)
|
|
{
|
|
// Figure out if the alias is for a class or interface
|
|
$reflection = new ReflectionClass($newName);
|
|
$type = $reflection->isInterface() ? 'interface' : 'class';
|
|
$modifier = ($reflection->isAbstract() && !$reflection->isInterface()) ? 'abstract ' : '';
|
|
|
|
$file .= "$modifier$type $oldName extends $newName {}\n";
|
|
}
|
|
|
|
// And save the file locally
|
|
file_put_contents(JPATH_ROOT . '/stubs.php', $file);
|
|
|
|
$this->out('Stubs file written', true);
|
|
}
|
|
}
|
|
|
|
// Instantiate the application and execute it
|
|
CliApplication::getInstance('StubGenerator')->execute();
|