File Manager

Editing File: /home/eticmes/www/wp-content/plugins/the-events-calendar/common/src/Common/Contracts/Container.php

<?php

namespace TEC\Common\Contracts;

use TEC\Common\StellarWP\ContainerContract\ContainerInterface;
use TEC\Common\Exceptions\Not_Bound_Exception;
use TEC\Common\Contracts\Provider\Controller;

use TEC\Common\lucatume\DI52\Container as DI52_Container;

/**
 * Container contract.
 *
 * @since 5.1.0
 *
 * @method void singleton( string $id, mixed $implementation = null, ?array $afterBuildMethods = null )
 * @method void bind( string $id, mixed $implementation = null, ?array $afterBuildMethods = null )
 */
class Container extends DI52_Container implements ContainerInterface {
	/**
	 * Finds an entry of the container by its identifier and returns it.
	 *
	 * @since 5.1.1.2
	 *
	 * @param string $id A fully qualified class or interface name or an already built object.
	 *
	 * @return mixed The entry for an id.
	 * @throws Not_Bound_Exception Error while retrieving the entry.
	 */
	public function get( $id ) {
		try {
			return parent::get( $id );
		} catch ( \Exception $e ) {
			// Do not chain the previous exception into ours, as it makes the error log confusing.
			throw new Not_Bound_Exception( $e->getMessage(), $e->getCode() );
		}
	}

/**
	 * Overrides the parent method to fire an action when a service provider is registered.
	 *
	 * @since 5.1.4
	 * @since 6.5.1 - Ensure registration actions are fired only once and ONLY for active controllers.
	 *
	 * @param string $service_provider_class The service provider class name.
	 * @param string ...$alias               Optional. The alias(es) to register the service provider with.
	 *
	 * @return void
	 *
	 * @throws \TEC\Common\lucatume\DI52\ContainerException If the provider class is marked as deferred but
	 *                                                      does not provide a set of deferred registrations.
	 */
	public function register( $service_provider_class, ...$alias ) {
		// Function is_a can be used with strings but instanceof only with objects!
		$is_controller = is_a( $service_provider_class, Controller::class, true ); // phpcs:ignore StellarWP.PHP.IsAFunction.Found

if ( $is_controller && $this->getVar( $service_provider_class . '_registered', false ) ) {
			// If the controller is already registered, bail.
			return;
		}

// Register the provider with the parent container.
		parent::register( $service_provider_class, ...$alias );

if ( $is_controller && ! $this->getVar( $service_provider_class . '_registered', false ) ) {
			// If the controller did not register, DO NOT fire registration actions AT ALL. Instead silently return.
			return;
		}

/**
		 * Fires when a service provider is registered by the container.
		 *
		 * @since 5.1.4
		 *
		 * @param string        $service_provider_class The service provider class name.
		 * @param array<string> $alias                  The alias(es) the service provider was registered with.
		 */
		do_action( 'tec_container_registered_provider', $service_provider_class, $alias );

/**
		 * Fires a class-specific action when a service provider is registered by the container.
		 *
		 * @since 5.1.4
		 *
		 * @param array<string> $alias The alias(es) the service provider was registered with.
		 */
		do_action( 'tec_container_registered_provider_' . $service_provider_class, $alias );

if (
			// Back compat with older definition of Service Provider.
			! property_exists( $service_provider_class, 'registration_action' )
			// New definition of Service Provider: default action is empty.
			|| empty( $service_provider_class::$registration_action )
		) {
			return;
		}

/**
		 * Fires a custom action defined by the Service Provider when it's registered.
		 *
		 * @since 5.1.4
		 */
		do_action( $service_provider_class::$registration_action, $service_provider_class, $alias );
	}

/**
	 * Registers a service provider on a given action is dispatched.
	 *
	 * @since 5.1.4
	 *
	 * @param string $action The action to register the provider on.
	 * @param string $class The service provider class name.
	 * @param string ...$alias Optional. The alias(es) to register the service provider with.
	 *
	 * @return void The Service Provider is registered when the action fires,
	 *               or immediately if the action has already fired.
	 *
	 * @throws \TEC\Common\lucatume\DI52\ContainerException If the provider class is marked as deferred but
	 *                                                      does not provide a set of deferred registrations.
	 */
	public function register_on_action( string $action, string $class, string ...$alias ): void {
		if ( did_action( $action ) ) {
			// If the action has already fired, register the provider immediately.
			$this->register( $class, ...$alias );

return;
		}

// If the action has not fired yet, register the provider when it does.
		$registration_closure = function () use ( $action, $class, $alias, &$registration_closure ) {
			// Remove the closure from the action to avoid calling it again.
			remove_action( $action, $registration_closure );
			$this->register( $class, ...$alias );
		};
		add_action( $action, $registration_closure );
	}
}

Back to Directory File Manager