1#@!#!123s

: / opt / psa / admin / plib / vendor / plesk / laminas-mail / src / Protocol /
Filename : SmtpPluginManager.php
back
<?php

namespace Laminas\Mail\Protocol;

use Laminas\ServiceManager\AbstractPluginManager;
use Laminas\ServiceManager\ConfigInterface;
use Laminas\ServiceManager\Exception\InvalidServiceException;
use Laminas\ServiceManager\Factory\InvokableFactory;

use function gettype;
use function is_object;
use function sprintf;

/**
 * Plugin manager implementation for SMTP extensions.
 *
 * Enforces that SMTP extensions retrieved are instances of Smtp. Additionally,
 * it registers a number of default extensions available.
 *
 * @link ConfigInterface
 *
 * @psalm-import-type FactoriesConfigurationType from ConfigInterface
 *
 * @extends AbstractPluginManager<Smtp>
 * @final
 */
class SmtpPluginManager extends AbstractPluginManager
{
    /**
     * Service aliases
     *
     * @var array<array-key, class-string>
     */
    protected $aliases = [
        'crammd5' => Smtp\Auth\Crammd5::class,
        'cramMd5' => Smtp\Auth\Crammd5::class,
        'CramMd5' => Smtp\Auth\Crammd5::class,
        'cramMD5' => Smtp\Auth\Crammd5::class,
        'CramMD5' => Smtp\Auth\Crammd5::class,
        'login'   => Smtp\Auth\Login::class,
        'Login'   => Smtp\Auth\Login::class,
        'plain'   => Smtp\Auth\Plain::class,
        'Plain'   => Smtp\Auth\Plain::class,
        'xoauth2' => Smtp\Auth\Xoauth2::class,
        'Xoauth2' => Smtp\Auth\Xoauth2::class,
        'smtp'    => Smtp::class,
        'Smtp'    => Smtp::class,
        'SMTP'    => Smtp::class,
        // Legacy Zend Framework aliases
        'Zend\Mail\Protocol\Smtp\Auth\Crammd5' => Smtp\Auth\Crammd5::class,
        'Zend\Mail\Protocol\Smtp\Auth\Login'   => Smtp\Auth\Login::class,
        'Zend\Mail\Protocol\Smtp\Auth\Plain'   => Smtp\Auth\Plain::class,
        'Zend\Mail\Protocol\Smtp'              => Smtp::class,
        // v2 normalized FQCNs
        'zendmailprotocolsmtpauthcrammd5'    => Smtp\Auth\Crammd5::class,
        'zendmailprotocolsmtpauthlogin'      => Smtp\Auth\Login::class,
        'zendmailprotocolsmtpauthplain'      => Smtp\Auth\Plain::class,
        'zendmailprotocolsmtp'               => Smtp::class,
        'laminasmailprotocolsmtpauthcrammd5' => Smtp\Auth\Crammd5::class,
        'laminasmailprotocolsmtpauthlogin'   => Smtp\Auth\Login::class,
        'laminasmailprotocolsmtpauthplain'   => Smtp\Auth\Plain::class,
        'laminasmailprotocolsmtp'            => Smtp::class,
    ];

    /**
     * Service factories
     *
     * @var FactoriesConfigurationType
     */
    protected $factories = [
        Smtp\Auth\Crammd5::class => InvokableFactory::class,
        Smtp\Auth\Login::class   => InvokableFactory::class,
        Smtp\Auth\Plain::class   => InvokableFactory::class,
        Smtp\Auth\Xoauth2::class => InvokableFactory::class,
        Smtp::class              => InvokableFactory::class,
    ];

    /**
     * Plugins must be an instance of the Smtp class
     *
     * @var class-string<Smtp>
     */
    protected $instanceOf = Smtp::class;

    /**
     * Validate a retrieved plugin instance (v3).
     *
     * {@inheritDoc}
     */
    public function validate(mixed $instance)
    {
        if (! $instance instanceof $this->instanceOf) {
            throw new InvalidServiceException(sprintf(
                'Plugin of type %s is invalid; must extend %s',
                is_object($instance) ? $instance::class : gettype($instance),
                $this->instanceOf
            ));
        }
    }

    /**
     * Validate a retrieved plugin instance (v2).
     *
     * @deprecated
     *
     * @param object $plugin
     * @throws Exception\InvalidArgumentException
     */
    public function validatePlugin(mixed $plugin)
    {
        try {
            $this->validate($plugin);
        } catch (InvalidServiceException $e) {
            throw new Exception\InvalidArgumentException(
                $e->getMessage(),
                $e->getCode(),
                $e
            );
        }
    }
}