Skip to content
Snippets Groups Projects
Commit a44588d7 authored by Jaime Perez Crespo's avatar Jaime Perez Crespo
Browse files

Move the two PSR 0 and PSR 4 module autoloader functions to SimpleSAML_Module.

parent 07b68312
Branches
Tags
No related merge requests found
...@@ -4,12 +4,91 @@ ...@@ -4,12 +4,91 @@
/** /**
* Helper class for accessing information about modules. * Helper class for accessing information about modules.
* *
* @author Olav Morken, UNINETT AS. * @author Olav Morken <olav.morken@uninett.no>, UNINETT AS.
* @author Boy Baukema, SURFnet.
* @author Jaime Perez <jaime.perez@uninett.no>, UNINETT AS.
* @package SimpleSAMLphp * @package SimpleSAMLphp
*/ */
class SimpleSAML_Module class SimpleSAML_Module
{ {
/**
* Autoload function for SimpleSAMLphp modules following PSR-0.
*
* @param string $className Name of the class.
*
* TODO: this autoloader should be removed once everything has been migrated to namespaces.
*/
public static function autoloadPSR0($className)
{
$modulePrefixLength = strlen('sspmod_');
$classPrefix = substr($className, 0, $modulePrefixLength);
if ($classPrefix !== 'sspmod_') {
return;
}
$modNameEnd = strpos($className, '_', $modulePrefixLength);
$module = substr($className, $modulePrefixLength, $modNameEnd - $modulePrefixLength);
$path = explode('_', substr($className, $modNameEnd + 1));
if (!self::isModuleEnabled($module)) {
return;
}
$file = self::getModuleDir($module).'/lib/'.join('/', $path).'.php';
if (file_exists($file)) {
require_once($file);
}
if (!class_exists($className, false)) {
// the file exists, but the class is not defined. Is it using namespaces?
$nspath = join('\\', $path);
if (class_exists('SimpleSAML\Module\\'.$module.'\\'.$nspath)) {
// the class has been migrated, create an alias and warn about it
SimpleSAML_Logger::warning(
"The class '$className' is now using namespaces, please use 'SimpleSAML\\Module\\$module\\".
"$nspath' instead."
);
class_alias("SimpleSAML\\Module\\$module\\$nspath", $className);
}
}
}
/**
* Autoload function for SimpleSAMLphp modules following PSR-4.
*
* @param string $className Name of the class.
*/
public static function autoloadPSR4($className)
{
$elements = explode('\\', $className);
if ($elements[0] === '') { // class name starting with /, ignore
array_shift($elements);
}
if (count($elements) < 4) {
return; // it can't be a module
}
if (array_shift($elements) !== 'SimpleSAML') {
return; // the first element is not "SimpleSAML"
}
if (array_shift($elements) !== 'Module') {
return; // the second element is not "module"
}
// this is a SimpleSAMLphp module following PSR-4
$module = array_shift($elements);
if (!self::isModuleEnabled($module)) {
return; // module not enabled, avoid giving out any information at all
}
$file = self::getModuleDir($module).'/lib/'.implode('/', $elements).'.php';
if (file_exists($file)) {
require_once($file);
}
}
/** /**
* Retrieve the base directory for a module. * Retrieve the base directory for a module.
...@@ -32,7 +111,7 @@ class SimpleSAML_Module ...@@ -32,7 +111,7 @@ class SimpleSAML_Module
/** /**
* Determine whether a module is enabled. * Determine whether a module is enabled.
* *
* Will return false if the given module doesn't exists. * Will return false if the given module doesn't exist.
* *
* @param string $module Name of the module * @param string $module Name of the module
* *
......
<?php <?php
/** /**
* This file implements a autoloader for SimpleSAMLphp modules. * This file registers an autoloader for SimpleSAMLphp modules.
* *
* @author Boy Baukema, SURFnet * @author Boy Baukema, SURFnet
* @author Jaime Perez <jaime.perez@uninett.no>, UNINETT * @author Jaime Perez <jaime.perez@uninett.no>, UNINETT
* @package SimpleSAMLphp * @package SimpleSAMLphp
*/ */
/** spl_autoload_register(array('SimpleSAML_Module', 'autoloadPSR0'));
* Autoload function for SimpleSAMLphp modules following PSR-0. spl_autoload_register(array('SimpleSAML_Module', 'autoloadPSR4'));
*
* @param string $className Name of the class.
*
* TODO: this autoloader should be removed once everything has been migrated to namespaces.
*/
function SimpleSAML_autoload_psr0($className)
{
$modulePrefixLength = strlen('sspmod_');
$classPrefix = substr($className, 0, $modulePrefixLength);
if ($classPrefix !== 'sspmod_') {
return;
}
$modNameEnd = strpos($className, '_', $modulePrefixLength);
$module = substr($className, $modulePrefixLength, $modNameEnd - $modulePrefixLength);
$path = explode('_', substr($className, $modNameEnd + 1));
if (!SimpleSAML_Module::isModuleEnabled($module)) {
return;
}
$file = SimpleSAML_Module::getModuleDir($module).'/lib/'.join('/', $path).'.php';
if (file_exists($file)) {
require_once($file);
}
if (!class_exists($className, false)) {
// the file exists, but the class is not defined. Is it using namespaces?
$nspath = join('\\', $path);
if (class_exists('SimpleSAML\Module\\'.$module.'\\'.$nspath)) {
// the class has been migrated, create an alias and warn about it
SimpleSAML_Logger::warning(
"The class '$className' is now using namespaces, please use 'SimpleSAML\\Module\\$module\\".
"$nspath' instead."
);
class_alias("SimpleSAML\\Module\\$module\\$nspath", $className);
}
}
}
/**
* Autoload function for SimpleSAMLphp modules following PSR-4.
*
* @param string $className Name of the class.
*/
function SimpleSAML_autoload_psr4($className)
{
$elements = explode('\\', $className);
if ($elements[0] === '') { // class name starting with /, ignore
array_shift($elements);
}
if (count($elements) < 4) {
return; // it can't be a module
}
if (array_shift($elements) !== 'SimpleSAML') {
return; // the first element is not "SimpleSAML"
}
if (array_shift($elements) !== 'Module') {
return; // the second element is not "module"
}
// this is a SimpleSAMLphp module following PSR-4
$module = array_shift($elements);
if (!SimpleSAML_Module::isModuleEnabled($module)) {
return; // module not enabled, avoid giving out any information at all
}
$file = SimpleSAML_Module::getModuleDir($module).'/lib/'.implode('/', $elements).'.php';
if (file_exists($file)) {
require_once($file);
}
}
spl_autoload_register('SimpleSAML_autoload_psr0');
spl_autoload_register('SimpleSAML_autoload_psr4');
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment