PHP: полный мануал с примерами, функциями и ООП

<?php
declare(strict_types=1);

class Delivery {}
class Courier extends Delivery {}
class ExpressDelivery extends Courier {}
echo get_parent_class(ExpressDelivery::class), "\n";
var_dump(get_parent_class(Delivery::class));

Courier
bool(false)

У самого Delivery родителя нет. var_dump показывает логическое false, которое echo было бы трудно заметить.

<?php
declare(strict_types=1);

class Importer {}
class FileImporter extends Importer {}
class CsvImporter extends FileImporter {}
$name = CsvImporter::class;
$chain = [$name];
while (($parent = get_parent_class($name)) !== false) {
    $chain[] = $parent;
    $name = $parent;
}
echo implode(' -> ', $chain), "\n";

CsvImporter -> FileImporter -> Importer

while повторяет шаг, пока найден родитель. !== false отличает окончание цепочки от имени; [] дописывает элемент. Начальная строка взята из известного класса, а не из HTTP. Для готового списка предков есть SPL class_parents; интерфейсы перечисляет class_implements.

<?php
declare(strict_types=1);

try {
    get_parent_class('MissingImporter');
} catch (TypeError $error) {
    echo "В конфигурации нет такого класса\n";
}

В конфигурации нет такого класса

try/catch здесь специально показывает современный сбой контракта. В обычной конфигурации проверяйте разрешённую карту обработчиков при запуске; не скрывайте так произвольные ошибки их конструктора.

<?php
declare(strict_types=1);

class Report
{
    public static function label(): void
    {
        echo self::class, ' / ', get_called_class(), "\n";
    }
}
class CsvReport extends Report {}
CsvReport::label();

Report / CsvReport

self::class фиксирован местом объявления. get_called_class читает текущий контекст позднего связывания, а не имя файла и не весь стек.

<?php
declare(strict_types=1);

class Report
{
    protected static function auditLabel(): string
    {
        return 'Сборка ' . get_called_class();
    }
    public static function build(): string
    {
        return static::auditLabel();
    }
}
class SalesReport extends Report {}
class StockReport extends Report {}
echo SalesReport::build(), "\n";
echo StockReport::build(), "\n";

Сборка SalesReport
Сборка StockReport

Общий код получает нужную подпись для двух отчётов. Вызов static::auditLabel сохраняет late binding. Здесь нет файла журнала и секретных данных; реальный журнал передавайте отдельной зависимостью.

<?php
declare(strict_types=1);

interface Delivery {}
class Courier implements Delivery {}
$delivery = new Courier;
var_dump(is_a($delivery, Delivery::class));
var_dump(is_a($delivery, Courier::class));

bool(true)
bool(true)

implements означает выполнение интерфейсного контракта. Для известного объекта оператор $delivery instanceof Delivery часто проще. is_a полезна, когда имя целевого типа хранится в переменной.

<?php
declare(strict_types=1);

interface Exporter { public function export(): string; }
class CsvExporter implements Exporter
{
    public function export(): string { return "Название;Цена\nЧай;25900"; }
}
$formats = ['csv' => CsvExporter::class];
$selected = $formats['csv'];
if (!is_a($selected, Exporter::class, true)) { throw new LogicException('Неподходящий экспортёр'); }
echo (new $selected())->export(), "\n";

Название;Цена
Чай;25900

Третий аргумент true разрешает строковое имя класса. По умолчанию is_a не проверяет такую строку как экземпляр. Имя берётся из своей карты, а не из URL. Проверка соответствия интерфейсу не заменяет авторизацию пользователя на сам экспорт.

<?php
declare(strict_types=1);

class ShippingClient
{
    public function label(): string { return 'Доставка заказа готова'; }
}
if (!class_alias(ShippingClient::class, 'DeliveryClient', false)) {
    throw new RuntimeException('Не удалось зарегистрировать старое имя');
}
$legacyClient = new DeliveryClient();
echo $legacyClient->label(), "\n";
echo 'Реальный класс: ', get_class($legacyClient), "\n";

Доставка заказа готова
Реальный класс: ShippingClient

class_alias регистрирует второе имя того же класса. Старый код может создавать DeliveryClient, но объект имеет исходную идентичность класса ShippingClient. Это не наследование и не новая реализация. Третий false запрещает попытку автозагрузки исходного имени.

<?php
declare(strict_types=1);

namespace Shop\Shipping { class Client {} }
namespace {
    $legacy = 'LegacyDeliveryClient';
    if (!class_exists($legacy, false)) {
        class_alias(\Shop\Shipping\Client::class, $legacy, false);
    }
    $client = new LegacyDeliveryClient;
    echo get_class($client), "\n";
    var_dump(is_subclass_of($client, \Shop\Shipping\Client::class));
}

Shop\Shipping\Client
bool(false)

Проверка предотвращает повторную регистрацию в этом учебном bootstrap. В реальном проекте имя может быть занято чужим типом: не продолжайте молча, а проверьте контракт и завершите настройку с понятной ошибкой. Это не наследование, поэтому is_subclass_of относительно исходного типа даёт false.

<?php
declare(strict_types=1);

set_error_handler(static function (int $level, string $message): bool {
    echo $level === E_WARNING ? "warning\n" : "другая ошибка\n";
    return true;
});
try {
    var_dump(class_alias('MissingClient', 'LegacyClient', false));
} finally {
    restore_error_handler();
}

warning
bool(false)

Пример намеренно подавляет стандартный текст только в собственном временном обработчике, затем обязательно восстанавливает его. Нельзя принимать warning за успешный alias. Не регистрируйте псевдонимы из пользовательского ввода.

<?php
declare(strict_types=1);

class Client
{
    public function listOrders(): array { return []; }
    private function token(): string { return 'demo'; }
}
$methods = get_class_methods(Client::class);
sort($methods);
echo implode(', ', $methods), "\n";

listOrders

Метод token объявлен, но недоступен внешнему коду. Строка listOrders не означает, что запрос был отправлен: тело метода вообще не запускалось.

<?php
declare(strict_types=1);

class BaseClient { public function ping(): void {} }
class Client extends BaseClient
{
    private function sign(): void {}
    public static function internalNames(): array
    {
        $names = get_class_methods(self::class);
        sort($names);
        return $names;
    }
}
$outside = get_class_methods(Client::class);
sort($outside);
echo implode(', ', $outside), "\n";
echo implode(', ', Client::internalNames()), "\n";

internalNames, ping
internalNames, ping, sign

Внутренний вызов выполняется в области Client и видит sign. ping пришёл от родителя. Поэтому кеш такого списка, построенный внутри класса, нельзя бездумно выдавать как внешнее API.

<?php
declare(strict_types=1);

class Delivery
{
    public $fee = 300;
    public static $count = 0;
}
$delivery = new Delivery;
$delivery->fee = 700;
Delivery::$count = 2;
$defaults = get_class_vars(Delivery::class);
echo $defaults['fee'], ' / ', $defaults['count'], "\n";
echo $delivery->fee, ' / ', Delivery::$count, "\n";

300 / 0
700 / 2

::$count читает общее static-свойство. get_class_vars возвращает default 0, а не текущие 2. ->fee относится к конкретному экземпляру.

<?php
declare(strict_types=1);

class ExportSettings
{
    public $format = 'csv';
    private $separator = ';';
    public static function defaultSeparator(): string
    {
        $defaults = get_class_vars(self::class);
        return $defaults['separator'];
    }
}
$outside = get_class_vars(ExportSettings::class);
echo implode(', ', array_keys($outside)), "\n";
echo ExportSettings::defaultSeparator(), "\n";

format
;

Внутри класса доступен его private default. В реальном экспортере обычный метод или константа чаще яснее отражения всех полей; пример объясняет область доступа и почему результаты двух вызовов отличаются.

<?php
declare(strict_types=1);

class Order { public int $number; }
$defaults = get_class_vars(Order::class);
echo $defaults['number'] === null ? "В описании нет присвоенного начального номера\n" : "Начальный номер задан\n";
$order = new Order();
$property = new ReflectionProperty(Order::class, 'number');
echo $property->isInitialized($order) ? "Номер можно читать\n" : "Экземпляр ещё требует инициализации номера\n";

В описании нет присвоенного начального номера
Экземпляр ещё требует инициализации номера

get_class_vars представляет такое поле через null в своём массиве, но int-свойство экземпляра не получило null и не стало читаемым. Для конкретного экземпляра используйте isInitialized, а обязательные данные передавайте конструктору.

<?php
declare(strict_types=1);

class Delivery
{
    public $label = 'Курьер';
    protected $zone = 'A';
    private $cost = 300;
}
$values = get_mangled_object_vars(new Delivery);
foreach ($values as $key => $value) {
    echo str_replace("\0", '|', $key), '=', $value, "\n";
}

label=Курьер
|*|zone=A
|Delivery|cost=300

Замена NUL на | нужна только для видимого учебного вывода; это не безопасная сериализация. Обычный внешний get_object_vars вернул бы только label.

<?php
declare(strict_types=1);

class BaseClient { private $mode = 'base'; }
class ReportClient extends BaseClient { private $mode = 'report'; }
$values = get_mangled_object_vars(new ReportClient);
echo $values["\0BaseClient\0mode"], "\n";
echo $values["\0ReportClient\0mode"], "\n";

base
report

Класс-владелец является частью ключа. Если отрезать префикс и оставить mode, одно значение перезапишет другое. Для конвертации в модель пишите явное отображение полей, а не угадывайте структуру чужого объекта.

<?php
declare(strict_types=1);

class Label
{
    public string $text = 'shop' {
        get => strtoupper($this->text);
    }
    public string $caption { get => 'Заголовок'; }
}
$label = new Label;
$raw = get_mangled_object_vars($label);
echo $raw['text'], "\n";
echo implode(', ', array_keys($raw)), "\n";
echo get_object_vars($label)['text'], "\n";

shop
text
SHOP

PHP 8.4+. text имеет хранилище и getter; raw читает shop напрямую. caption — virtual и в raw отсутствует. Высокоуровневый get_object_vars читает вычисляемое SHOP. Выбирать нужно нужный смысл данных, а не «короткую функцию».

<?php
declare(strict_types=1);

class Order { public int $number; }
$order = (new ReflectionClass(Order::class))->newLazyGhost(
    static function (Order $order): void { $order->number = 41; }
);
var_dump(property_exists($order, 'number'));
var_dump(get_mangled_object_vars($order));
echo get_object_vars($order)['number'], "\n";

bool(true)
array(0) {
}
41

PHP 8.4+. Структура number уже существует, но значение ещё не загружено. Сырой снимок не запускает initializer. get_object_vars после этого запрашивает значения и инициализирует объект.

<?php
declare(strict_types=1);

interface Delivery {}
class Courier implements Delivery {}
var_dump(interface_exists(Delivery::class, false));
var_dump(interface_exists(Courier::class, false));
var_dump(class_exists(Delivery::class, false));

bool(true)
bool(false)
bool(false)

Имя класса и имя интерфейса относятся к разным видам объявления. Наличие Courier не превращает его имя в интерфейс.

<?php
declare(strict_types=1);

$contract = 'OptionalVendor\\AuditSink';
if (interface_exists($contract, false)) {
    echo "Контракт внешнего аудита загружен\n";
} else {
    echo "Работаем с локальным учебным журналом\n";
}

Работаем с локальным учебным журналом

Имя вымышленное, режим выбран сознательно. false означает «ещё не объявлен», а не «не установлен». Если подключён Composer и разрешена загрузка, используйте default true. Для обязательного аудита нельзя молча выбирать запасной режим: завершите настройку с понятной ошибкой.

<?php
declare(strict_types=1);

trait DemoLog { public function label(): string { return 'demo'; } }
class Client { use DemoLog; }
var_dump(trait_exists(DemoLog::class, false));
var_dump(class_exists(DemoLog::class, false));
echo (new Client)->label(), "\n";

bool(true)
bool(false)
demo

use внутри класса включает методы трейта. Это другое употребление use, чем импорт имени namespace.

<?php
declare(strict_types=1);

trait DemoLog {}
class LoggedClient { use DemoLog; }
class PlainClient {}
var_dump(trait_exists(DemoLog::class));
foreach ([LoggedClient::class, PlainClient::class] as $name) {
    $used = class_uses($name);
    echo $name, ': ', isset($used[DemoLog::class]) ? 'есть' : 'нет', "\n";
}

bool(true)
LoggedClient: есть
PlainClient: нет

SPL class_uses возвращает непосредственно используемые трейты и не обходит автоматически родителей и вложенные трейты. Для полного дерева нужен отдельный обход. Нельзя делать is_a($client, DemoLog::class) вместо такой диагностики.

<?php
declare(strict_types=1);

enum Status { case Paid; }
class Settings {}
var_dump(enum_exists(Status::class, false));
var_dump(class_exists(Status::class, false));
var_dump(enum_exists(Settings::class, false));

bool(true)
bool(true)
bool(false)

PHP 8.1+. class_exists включает enum; для точного вопроса выбирайте enum_exists.

<?php
declare(strict_types=1);

enum Status: string { case New = 'new'; case Paid = 'paid'; }
$enum = Status::class;
if (enum_exists($enum, false)) {
    foreach (['paid', 'unknown'] as $value) {
        $status = Status::tryFrom($value);
        echo $status?->name ?? 'Недопустимый статус', "\n";
    }
}

Paid
Недопустимый статус

PHP 8.1+. : string связывает case со строковым значением; tryFrom возвращает case или null. ?-> не читает свойство у null, ?? даёт запасной текст. Проверка наличия enum сама по себе не валидирует unknown. Для параметризованного произвольного enum отдельно проверьте BackedEnum и ожидаемый тип значений.

<?php
declare(strict_types=1);

class Delivery {}
$names = get_declared_classes();
var_dump(in_array(Delivery::class, $names, true));

bool(true)

in_array с true проверяет точное совпадение строки. Полный массив зависит от установленных расширений, поэтому тестирует только собственное объявление.

<?php
declare(strict_types=1);

$before = get_declared_classes();
require __DIR__ . '/exporters.php';
$added = array_values(array_diff(get_declared_classes(), $before));
sort($added);
echo implode(', ', $added), "\n";

CsvExporter, XmlExporter

array_diff оставляет новые значения, array_values пересобирает числовые ключи. Объявления намеренно вынесены в отдельный файл: без этого раннее объявление в том же файле могло бы уже присутствовать в первом снимке. Реальный подключаемый файл способен объявить и другие классы.

<?php
declare(strict_types=1);

interface Delivery {}
var_dump(in_array(Delivery::class, get_declared_interfaces(), true));

bool(true)

Объявление interface добавило имя в таблицу; new и implements здесь ещё не было.

<?php
declare(strict_types=1);

$before = get_declared_interfaces();
require __DIR__ . '/contracts.php';
$added = array_values(array_diff(get_declared_interfaces(), $before));
sort($added);
echo implode(', ', $added), "\n";

Delivery, PaymentGateway

Такой контроль полезен при исследовании bootstrap. В приложении обычно обращаются к известному имени напрямую; не выполняют полный обход интерфейсов на каждом HTTP-запросе.

<?php
declare(strict_types=1);

trait DemoLog {}
var_dump(in_array(DemoLog::class, get_declared_traits(), true));

bool(true)

Трейт объявлен, хотя ни один класс его пока не использует.

<?php
declare(strict_types=1);

$before = get_declared_traits();
require __DIR__ . '/diagnostics.php';
$added = array_values(array_diff(get_declared_traits(), $before));
sort($added);
echo implode(', ', $added), "\n";

DemoLog, RequestLabel

Временный fixture не пишет настоящий журнал. В большом проекте список служит диагностике: для явной зависимости подключите пакет и используйте его контракт.

<?php
declare(strict_types=1);

$loader = static function (string $name): void {
    if ($name === 'Delivery') {
        require __DIR__ . '/Delivery.php';
    }
};
spl_autoload_register($loader);
try {
    $delivery = new Delivery;
    echo $delivery->label(), "\n";
} finally {
    spl_autoload_unregister($loader);
}

Курьер

Callback сохранён в $loader, register добавляет его в очередь. Он не создаёт Delivery: исходное new продолжает работу после загрузки. __DIR__ означает каталог данного файла. unregister в finally убирает только наш callback после опыта.

<?php
declare(strict_types=1);

$first = static function (string $name): void {
    if ($name === 'Shop\\Delivery') {
        require __DIR__ . '/Delivery.php';
    }
};
$second = static function (string $name): void {
    if ($name === 'Reports\\Sales') {
        require __DIR__ . '/Sales.php';
    }
};
spl_autoload_register($first);
spl_autoload_register($second);
try {
    echo get_class(new Shop\Delivery), "\n";
    echo get_class(new Reports\Sales), "\n";
} finally {
    spl_autoload_unregister($second);
    spl_autoload_unregister($first);
}

Shop\Delivery
Reports\Sales

Первый callback игнорирует чужое имя, поэтому второй получает шанс загрузить Reports\Sales. Для неизвестного собственного класса не требуется выдавать произвольный успешный результат. Не строите путь require напрямую из HTTP: здесь карта двух точных имён.