Documentation

Application

Interfaces, Classes and Traits

Checkpointable

Contract for classes that want checkpoint/restore of their state.

AuthenticationObject

HashingAlgorithmMigration

Wraps every `legacy` password hash in a fresh native hash (the "onion"), protecting dormant accounts at rest against a future breach without needing the plaintext. Idempotent and reusable: it only touches rows still on the `legacy` scheme, so re-running (or running after some users have already logged in and been upgraded) is safe and does no redundant work.

Organization

Password

Password hashing on PHP's native Argon2id (at PHP's default cost), the public entry point for the framework's password handling. A `password_scheme` marker lets legacy and onion-wrapped hashes coexist and self-heal to native on login.

Verification

The outcome of a {@see Password::verify()} call; read it via {@see isCorrect()}.

Group

Role

User

Session

User

The User class holds information about the user

ActionDiscovery

Application

RunCommand

Controller

Base class for all controllers. Controllers should inherit from this class.

FunctionConflictResolution

Model

Base class for all models. Models should inherit from this.

Connection

Migrate

Seed

Status

Sync

UnlockMigration

Migration

MigrationFile

MigrationPHP

MigrationSQL

SeedPHP

SeedSQL

Seed

TimeStamp

BehaviorOption

MonologCollector

QueryCollector

TemplateCollector

Mirrors the API of DebugBar\DataCollector\TemplateCollector (shipped in php-debugbar v3.x) so we feed PhpDebugBar.Widgets.TemplatesWidget the same shape it expects, without forcing the v3 dependency bump.

DebugBarBridge

NotInstantiatedException

WhoopsHandler

Upload

Class that handles file uploads and checking types

Field

Represents an input field of a form on the server side

Result

Holds the result of a validation of a form

ErrorController

The error controller handles all bad requests. Other controllers can redirect to this one.

IndexController

The index controller handles by default all requests without a specified controller

LoginController

The Login controller handles all login/logout stuff

ZController

The ZController contains actions for the admin dashboard / panel

z_organizationModel

BacktraceProcessor

JsonFormatter

LogEventType

Logger

LoggerFactory

DatabaseLogger

StreamLogger

State

State

Request

Base class for Response and Request

RequestResponseHandler

Base class for the response and request objects

Response

The Response class provides functions used by controllers to respond to requests

ZubZetValueBinder

This class extends CakePHP`s ValueBinder to change the placeholder format to '?' and to change the bind method to match that of mysqli.

ViewNotFoundException

AssetProxy

BundledAssets

Registers the framework's vendored frontend libraries (jQuery, Bootstrap, Font Awesome) with an AssetProxy at the URL paths the framework historically exposed.

BundledPackage

One Composer-installed frontend library that should be exposed via the AssetProxy. Resolves its on-disk path through Composer at mount time.

Mount

Maps an asset URL onto a directory on disk, optionally scoped to a URL prefix. All filesystem work is deferred to resolve(); construction is just a string trim.

PendingAction

PendingGroup

PendingRoute

PendingRoutingState

Route

Checkpoint

Handle returned by CanCheckpoint::checkpointCurrentState().

IncludeInCheckpoint

Marks a property for inclusion in CanCheckpoint's default snapshot.

Startup

Rest

The rest class is used to provide raw JSON API data to the client

StaticCache

Start

Stop

ZubZet

AdminController

AdvancedController

AliasController

ApiCompatProbeController

Guards the framework's password API against breaking changes for consuming apps. They call model("z_login")->checkPassword($pw, $hash, $salt) with the 3-argument shape (no scheme) on their own user tables, and rely on legacy hashes still verifying. See jouri's Authentication/UserController.

AssetProxyController

AuthProbeController

ConnectionProbeController

ConsoleController

CoreController

DashboardController

DatabaseProbeController

ExceptionController

FormController

FrameworkApiController

FrameworkViewProbeController

FrontendController

GroupController

HelperController

Probes for global references and pure helper functions used by tests/cypress/e2e/support/.

LayoutConstructorController

LayoutMiddlewareController

LayoutResolutionController

Exercises the layout resolution chain from HandlesDefaultLayout: explicit arg > instance default > global default > framework default

LoggerController

MigrationController

OrganizationController

PasswordHashProbeController

RenderingController

ResponseController

RoleController

RoutingController

Test fixtures for tests/cypress/e2e/core/routing.cy.js.

SessionController

StateProbeController

SupportProbeController

UserController

VisualController

Renders deterministic kitchen-sink pages used as the source-of-truth for our visual-regression specs (tests/cypress/e2e/visual/...).

Migration_2026_05_08_TimeStampType

Permanent test fixture: exercises the framework's custom TimeStamp DBAL type (src/Database/Migration/Type/TimeStamp.php). Doctrine resolves `'timestamp'` to that type when generating CREATE TABLE SQL, so this migration's apply path runs both `getSQLDeclaration()` and `getName()`.

Test

CoreModel

FormModel

HelperModel

LoggerModel

MigrationModel

QueryBuilderModel

Migration_2025_10_01_MigrationEnv

Migration_2025_10_01_MigrationEnv1

Migration_2025_10_01_MigrationImport

Migration_2025_10_01_MigrationManual

Migration_2025_10_01_MigrationPHPImport

Migration_2025_10_01_MigrationSkip

TestSeeding

Migration_2005_01_10_3_Syn_File

HandleTrait

Permission

RetrievalTrait

Configuration

CanRetrieveBooterSettings

CanRetrieveModel

Interaction

IsInternalModel

DatabaseConnection

DbalConnection

Platform

CanCollect

CanFormatValue

ExceptionBehavior

CanValidateForm

CanValidateMultiForm

CanRetrieveFromInput

CanBuildQuery

CanRenderView

HandlesDefaultLayout

Default-layout management for Response.

HttpMethod

Router

CanCheckpoint

Snapshot / Restore selected instance properties via a Checkpoint handle.

HasDynamicAttributes

Table of Contents

essentialsHead()  : mixed

Call this to paste the essential head part of a page into the layout

essentialsBody()  : mixed

Call this to paste the essential body part of a page into the layout

model()  : mixed