Add dedicated Packages loader and Autoloader to init functionality
This commit is contained in:
Mike Jolley
parent
48e1dc5bec
commit
f8d6b26e2e
|
|
@ -34,6 +34,7 @@
|
|||
<rule ref="WordPress.Files.FileName.InvalidClassFileName">
|
||||
<exclude-pattern>includes/**/abstract-*.php</exclude-pattern>
|
||||
<exclude-pattern>tests/*</exclude-pattern>
|
||||
<exclude-pattern>src/*</exclude-pattern>
|
||||
</rule>
|
||||
|
||||
<rule ref="Generic.Commenting">
|
||||
|
|
@ -46,5 +47,6 @@
|
|||
|
||||
<rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
|
||||
<exclude-pattern>i18n/</exclude-pattern>
|
||||
<exclude-pattern>src/</exclude-pattern>
|
||||
</rule>
|
||||
</ruleset>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,71 @@
|
|||
<?php
|
||||
/**
|
||||
* Includes the composer Autoloader used for packages and classes in the src/ directory.
|
||||
*
|
||||
* @package Automattic/WooCommerce
|
||||
*/
|
||||
|
||||
namespace Automattic\WooCommerce;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* Autoloader class.
|
||||
*
|
||||
* @since 3.7.0
|
||||
*/
|
||||
class Autoloader {
|
||||
|
||||
/**
|
||||
* Static-only class.
|
||||
*/
|
||||
private function __construct() {}
|
||||
|
||||
/**
|
||||
* Require the autoloader and return the result.
|
||||
*
|
||||
* If the autoloader is not present, let's log the failure and display a nice admin notice.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public static function init() {
|
||||
$autoloader = dirname( __DIR__ ) . '/vendor/autoload_packages.php';
|
||||
|
||||
if ( ! is_readable( $autoloader ) ) {
|
||||
self::missing_autoloader();
|
||||
return false;
|
||||
}
|
||||
|
||||
return require $autoloader;
|
||||
}
|
||||
|
||||
/**
|
||||
* If the autoloader is missing, add an admin notice.
|
||||
*/
|
||||
protected static function missing_autoloader() {
|
||||
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
|
||||
error_log( // phpcs:ignore
|
||||
esc_html__( 'Your installation of WooCommerce is incomplete. If you installed WooCommerce from GitHub, please refer to this document to set up your development environment: https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment', 'woocommerce' )
|
||||
);
|
||||
}
|
||||
add_action(
|
||||
'admin_notices',
|
||||
function() {
|
||||
?>
|
||||
<div class="notice notice-error">
|
||||
<p>
|
||||
<?php
|
||||
printf(
|
||||
/* translators: 1: is a link to a support document. 2: closing link */
|
||||
esc_html__( 'Your installation of WooCommerce is incomplete. If you installed WooCommerce from GitHub, %1$splease refer to this document%2$s to set up your development environment.', 'woocommerce' ),
|
||||
'<a href="' . esc_url( 'https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment' ) . '" target="_blank" rel="noopener noreferrer">',
|
||||
'</a>'
|
||||
);
|
||||
?>
|
||||
</p>
|
||||
</div>
|
||||
<?php
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
<?php
|
||||
/**
|
||||
* Loads WooCommece packages from the /packages directory. These are packages developed outside of core.
|
||||
*
|
||||
* @package Automattic/WooCommerce
|
||||
*/
|
||||
|
||||
namespace Automattic\WooCommerce;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* Packages class.
|
||||
*
|
||||
* @since 3.7.0
|
||||
*/
|
||||
class Packages {
|
||||
|
||||
/**
|
||||
* Static-only class.
|
||||
*/
|
||||
private function __construct() {}
|
||||
|
||||
/**
|
||||
* Array of package names and their main package classes.
|
||||
*
|
||||
* @var array Key is the package name/directory, value is the main package class which handles init.
|
||||
*/
|
||||
protected static $packages = [
|
||||
'woocommerce-blocks' => '\\Automattic\\WooCommerce\\Blocks\\Package',
|
||||
'woocommerce-rest-api' => '\\Automattic\\WooCommerce\\RestApi\\Package',
|
||||
];
|
||||
|
||||
/**
|
||||
* Init the package loader.
|
||||
*
|
||||
* @since 3.7.0
|
||||
*/
|
||||
public static function init() {
|
||||
add_action( 'plugins_loaded', array( __CLASS__, 'on_init' ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Callback for WordPress init hook.
|
||||
*/
|
||||
public static function on_init() {
|
||||
self::load_packages();
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads packages after plugins_loaded hook.
|
||||
*
|
||||
* Each package should include an init file which loads the package so it can be used by core.
|
||||
*/
|
||||
protected static function load_packages() {
|
||||
foreach ( self::$packages as $package_name => $package_class ) {
|
||||
if ( ! self::package_exists( $package_name ) ) {
|
||||
self::missing_package( $package_name );
|
||||
continue;
|
||||
}
|
||||
call_user_func( [ $package_class, 'init' ] );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks a package exists by looking for it's directory.
|
||||
*
|
||||
* @param string $package Package name.
|
||||
* @return boolean
|
||||
*/
|
||||
protected static function package_exists( $package ) {
|
||||
return file_exists( dirname( __DIR__ ) . '/packages/' . $package );
|
||||
}
|
||||
|
||||
/**
|
||||
* If a package is missing, add an admin notice.
|
||||
*
|
||||
* @param string $package Package name.
|
||||
*/
|
||||
protected static function missing_package( $package ) {
|
||||
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
|
||||
error_log( // phpcs:ignore
|
||||
sprintf(
|
||||
/* Translators: %s package name. */
|
||||
esc_html__( 'Missing the WooCommerce %s package', 'woocommerce' ),
|
||||
'<code>' . esc_html( $package ) . '</code>'
|
||||
) . ' - ' . esc_html__( 'Your installation of WooCommerce is incomplete. If you installed WooCommerce from GitHub, please refer to this document to set up your development environment: https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment', 'woocommerce' )
|
||||
);
|
||||
}
|
||||
add_action(
|
||||
'admin_notices',
|
||||
function() use ( $package ) {
|
||||
?>
|
||||
<div class="notice notice-error">
|
||||
<p>
|
||||
<strong>
|
||||
<?php
|
||||
printf(
|
||||
/* Translators: %s package name. */
|
||||
esc_html__( 'Missing the WooCommerce %s package', 'woocommerce' ),
|
||||
'<code>' . esc_html( $package ) . '</code>'
|
||||
);
|
||||
?>
|
||||
</strong>
|
||||
<br>
|
||||
<?php
|
||||
printf(
|
||||
/* translators: 1: is a link to a support document. 2: closing link */
|
||||
esc_html__( 'Your installation of WooCommerce is incomplete. If you installed WooCommerce from GitHub, %1$splease refer to this document%2$s to set up your development environment.', 'woocommerce' ),
|
||||
'<a href="' . esc_url( 'https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment' ) . '" target="_blank" rel="noopener noreferrer">',
|
||||
'</a>'
|
||||
);
|
||||
?>
|
||||
</p>
|
||||
</div>
|
||||
<?php
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
@ -19,47 +19,26 @@ if ( ! defined( 'WC_PLUGIN_FILE' ) ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Load all the packages.
|
||||
* Load core packages and the autoloader.
|
||||
*
|
||||
* We want to fail gracefully if `composer install` has not been executed yet, so we are checking for the autoloader.
|
||||
* If the autoloader is not present, let's log the failure and display a nice admin notice.
|
||||
* The new packages and autoloader require PHP 5.6+. If this dependency is not met, do not include them. Users will be warned
|
||||
* that they are using an older version of PHP. WooCommerce will continue to load, but some functionality such as the REST API
|
||||
* and Blocks will be missing.
|
||||
*
|
||||
* This requirement will be enforced in future versions of WooCommerce.
|
||||
*/
|
||||
$autoloader = dirname( __FILE__ ) . '/vendor/autoload_packages.php';
|
||||
if ( is_readable( $autoloader ) ) {
|
||||
require $autoloader;
|
||||
} else {
|
||||
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
|
||||
error_log( // phpcs:ignore
|
||||
esc_html__( 'Your installation of WooCommerce is incomplete. If you installed WooCommerce from GitHub, please refer to this document to set up your development environment: https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment', 'woocommerce' )
|
||||
);
|
||||
if ( version_compare( PHP_VERSION, '5.6.0', '>=' ) ) {
|
||||
require __DIR__ . '/src/Autoloader.php';
|
||||
require __DIR__ . '/src/Packages.php';
|
||||
|
||||
if ( ! \Automattic\WooCommerce\Autoloader::init() ) {
|
||||
return;
|
||||
}
|
||||
/**
|
||||
* Outputs an admin notice for folks running WooCommerce without having run composer install.
|
||||
*/
|
||||
add_action(
|
||||
'admin_notices',
|
||||
function() {
|
||||
?>
|
||||
<div class="notice notice-error">
|
||||
<p>
|
||||
<?php
|
||||
printf(
|
||||
/* translators: 1: is a link to a support document. 2: closing link */
|
||||
esc_html__( 'Your installation of WooCommerce is incomplete. If you installed WooCommerce from GitHub, %1$splease refer to this document%2$s to set up your development environment.', 'woocommerce' ),
|
||||
'<a href="' . esc_url( 'https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment' ) . '" target="_blank" rel="noopener noreferrer">',
|
||||
'</a>'
|
||||
);
|
||||
?>
|
||||
</p>
|
||||
</div>
|
||||
<?php
|
||||
}
|
||||
);
|
||||
return;
|
||||
\Automattic\WooCommerce\Packages::init();
|
||||
}
|
||||
|
||||
// Include the main WooCommerce class.
|
||||
if ( ! class_exists( 'WooCommerce' ) ) {
|
||||
if ( ! class_exists( 'WooCommerce', false ) ) {
|
||||
include_once dirname( __FILE__ ) . '/includes/class-woocommerce.php';
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue