Interface exists: примеры (PHP)

Базовые примеры использования

<?
interface LoggerInterface {
    public function log(string $message);
}

$result = interface_exists('LoggerInterface');
var_dump($result);
?>

bool(true)

<?
$result = interface_exists('NonExistentInterface', false);
var_dump($result);
?>

bool(false)

<?
namespace App\Contracts;

interface PaymentGateway {
    public function process(float $amount);
}

$result = interface_exists('App\\Contracts\\PaymentGateway');
var_dump($result);
?>

bool(true)

Альтернативные функции в PHP

Проверяет существование класса. Используется аналогично interface_exists, но для классов. Предпочтительнее при работе с классами.

Проверяет существование трейта. Используется для проверки трейтов перед их применением.

Проверяет наличие метода в классе или объекте. Полезно при динамическом вызове методов.

interface_exists - для проверки интерфейсов в плагинных системах. class_exists - для проверки классов перед созданием экземпляров. trait_exists - для проверки трейтов перед использованием use.

Альтернативы в других языках

from typing import Protocol
from abc import abstractmethod

class LoggerInterface(Protocol):
    @abstractmethod
    def log(self, message: str) -> None:
        pass

# Проверка через поиск в глобальной области видимости
interface_name = 'LoggerInterface'
exists = interface_name in globals() and hasattr(globals()[interface_name], '_is_protocol')
print(exists)

False

// В JavaScript нет интерфейсов как в PHP
// TypeScript имеет интерфейсы, но проверка во время выполнения не стандартизирована
console.log(typeof MyInterface !== 'undefined');
// или для классов
console.log('MyInterface' in window);

false

try {
    Class<?> interfaceClass = Class.forName("com.example.LoggerInterface");
    boolean isInterface = interfaceClass.isInterface();
    System.out.println(isInterface);
} catch (ClassNotFoundException e) {
    System.out.println(false);
}

false

Типичные ошибки

<?
// Чувствительность к регистру
interface MyInterface {}

$result = interface_exists('myinterface');
var_dump($result);
?>

bool(false)

<?
namespace App;

interface ServiceInterface {}

// Без указания пространства имен
$result = interface_exists('ServiceInterface');
var_dump($result);
?>

bool(false)

<?
// Неоптимальное использование в цикле
foreach ($interfaceNames as $name) {
    if (interface_exists($name, true)) {
        // Автозагрузчик вызывается каждый раз
    }
}
?>

Изменения в версиях PHP

Добавлена поддержка синтаксиса именованных аргументов при вызове функции.

<?
// Можно использовать именованные аргументы
$result = interface_exists(interface: 'MyInterface', autoload: false);
?>

Улучшена обработка интерфейсов в сочетании с механизмом автозагрузки.

В PHP 5.0 функция была введена вместе с поддержкой интерфейсов в языке.

Расширенные примеры использования

<?
interface PluginInterface {
    public function execute();
}

function loadPlugin(string $pluginName): ?PluginInterface {
    $interfaceName = $pluginName . 'Interface';
    
    if (!interface_exists($interfaceName, false)) {
        // Попытка загрузки файла с интерфейсом
        $filePath = __DIR__ . '/plugins/' . $interfaceName . '.php';
        if (file_exists($filePath)) {
            require_once $filePath;
        }
    }
    
    if (interface_exists($interfaceName, false)) {
        $className = $pluginName . 'Plugin';
        if (class_exists($className)) {
            $plugin = new $className();
            if ($plugin instanceof $interfaceName) {
                return $plugin;
            }
        }
    }
    
    return null;
}

$plugin = loadPlugin('Logger');
var_dump($plugin !== null);
?>

bool(false)

<?
interface A {}
interface B {}

function checkInterfaces(array $interfaces): array {
    $results = [];
    
    foreach ($interfaces as $interface) {
        $results[$interface] = interface_exists($interface, false);
    }
    
    return $results;
}

$checked = checkInterfaces(['A', 'B', 'C', 'Iterator']);
print_r($checked);
?>

Array
(
    [A] => 1
    [B] => 1
    [C] => 
    [Iterator] => 1
)

<?
spl_autoload_register(function ($className) {
    // Преобразуем интерфейсы в особый путь
    if (strpos($className, 'Interface') !== false) {
        $file = __DIR__ . '/interfaces/' . $className . '.php';
    } else {
        $file = __DIR__ . '/classes/' . $className . '.php';
    }
    
    if (file_exists($file)) {
        require $file;
        return true;
    }
    return false;
});

// Проверка с автозагрузкой
$result = interface_exists('CustomInterface');
var_dump($result);
?>

bool(false)

<?
class InterfaceChecker {
    private static array $cache = [];
    
    public static function exists(string $interface, bool $autoload = true): bool {
        $key = $interface . '_' . (int)$autoload;
        
        if (!array_key_exists($key, self::$cache)) {
            self::$cache[$key] = interface_exists($interface, $autoload);
        }
        
        return self::$cache[$key];
    }
    
    public static function clearCache(): void {
        self::$cache = [];
    }
}

// Первый вызов - проверка
$result1 = InterfaceChecker::exists('Countable');
// Второй вызов - результат из кэша
$result2 = InterfaceChecker::exists('Countable');

var_dump($result1, $result2);
?>

bool(true)
bool(true)

<?
$splInterfaces = [
    'Traversable',
    'Iterator',
    'IteratorAggregate',
    'ArrayAccess',
    'Serializable',
    'Countable',
    'Stringable', // Добавлен в PHP 8
];

foreach ($splInterfaces as $interface) {
    echo $interface . ': ' . (interface_exists($interface) ? 'Да' : 'Нет') . "\n";
}
?>

Traversable: Да
Iterator: Да
IteratorAggregate: Да
ArrayAccess: Да
Serializable: Нет
Countable: Да
Stringable: Да