API Reference

Complete API reference for all classes and interfaces in wpzylos-core. All method signatures are documented exactly as they exist in the source code.

Interfaces

ContextInterface

Namespace: WPZylos\Framework\Core\Contracts

Plugin identity contract. Framework packages depend on this interface, not concrete implementations. Each plugin provides its own PluginContext implementing this interface — the pattern survives PHP-Scoper namespace rewriting.

interface ContextInterface
{
    public function slug(): string;
    public function prefix(): string;
    public function textDomain(): string;
    public function version(): string;
    public function namespace(): string;
    public function file(): string;
    public function path(string $relativePath = ''): string;
    public function url(string $relativePath = ''): string;
    public function hook(string $name): string;
    public function optionKey(string $key): string;
    public function transientKey(string $key): string;
    public function cronHook(string $name): string;
    public function tableName(string $name, string $scope = 'site'): string;
    public function metaKey(string $key): string;
    public function assetHandle(string $handle): string;
}

ApplicationInterface

Namespace: WPZylos\Framework\Core\Contracts

The Application is the kernel of the framework. Each plugin has its own isolated Application instance with a private container.

interface ApplicationInterface
{
    public function context(): ContextInterface;
    public function container(): ContainerInterface;
    public function register(ServiceProviderInterface $provider): static;
    public function boot(): void;
    public function isBooted(): bool;
    public function make(string $abstract): mixed;
    public function bind(string $abstract, callable|string|null $concrete = null): void;
    public function singleton(string $abstract, callable|string|null $concrete = null): void;
}

ServiceProviderInterface

Namespace: WPZylos\Framework\Core\Contracts

Service providers are the central place to configure and bootstrap application services.

interface ServiceProviderInterface
{
    public function register(ApplicationInterface $app): void;
    public function boot(ApplicationInterface $app): void;
}

Classes

Application

Namespace: WPZylos\Framework\CoreImplements: ApplicationInterface

The central service container and provider coordinator. Each plugin has its own isolated Application instance.

Constructor

public function __construct(ContextInterface $context, ?ContainerInterface $container = null)

If no container is provided, the constructor auto-creates a WPZylos\Framework\Container\Container instance. Throws RuntimeException if the wpzylos-container package is not installed and no container is passed.

Auto-registered Bindings

The constructor automatically registers these bindings:

Methods

ServiceProvider

Namespace: WPZylos\Framework\CoreImplements: ServiceProviderInterface

Abstract base class for all service providers. Stores the $app reference on register() and provides convenient shortcut methods.

Properties

Methods

PluginContext

Namespace: WPZylos\Framework\CoreImplements: ContextInterface

Holds all plugin identity information. The single source of truth for slug, prefix, text domain, paths, and URLs.

Note: In production plugins, this class should be copied into the plugin's own namespace to survive PHP-Scoper. The framework depends on ContextInterface, not this concrete class.

Static Factory

public static function create(array $config): static

Required config keys:

Optional config keys:

Throws InvalidArgumentException if any required key is missing.

Instance Methods

Paths

Namespace: WPZylos\Framework\Core

Path and URL resolution with named alias support. Created automatically by Application and accessible via $app->paths().

Constructor

public function __construct(ContextInterface $context)

Registers the following default aliases:

Methods

CacheRepository

Namespace: WPZylos\Framework\Core\Cache

Context-prefixed caching layer using WordPress object cache with transient fallback.

Constructor

public function __construct(ContextInterface $context)

Uses the plugin slug as the cache group name.

Object Cache Methods

Transient Methods (Persistent Fallback)

Arr

Namespace: WPZylos\Framework\Core\Support

Static array helper utilities with dot-notation support.

Str

Namespace: WPZylos\Framework\Core\Support

Static string helper utilities.