Application
Interfaces, Classes and Traits
- VersionInterface
- Cipher
- An authenticated cipher behind Encryption. Implementations must detect a wrong key or a modified payload, so only AEAD algorithms qualify.
- Checkpointable
- Contract for classes that want checkpoint/restore of their state.
- MigrationNamingConventionChange
- LegacyViewConverter
- Converts a legacy ZubZet view/layout (the "return type" syntax) into a Katana .blade.php document, as part of the 1.3.0 upgrade.
- AbortRequiringUserAction
- Issue
- BaseModifier
- CommandModifier
- ComposerModifier
- FileContent
- Folder
- FolderContent
- IncludedFile
- JsonModifier
- MatchingModifier
- RemoveFile
- RenameModifier
- SettingsIni
- ViewMigration
- Migrates legacy "return type" views (and layouts) to Katana .blade.php documents. Introduced for the 1.3.0 render-engine change.
- ReleaseState
- Upgrade
- BaseVersion
- V0_11_0
- V1_0_0
- V1_1_0
- V1_2_0
- V1_3_0
- APIKey
- 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.
- LoginToken
- 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
- Totp
- Time based one time passwords as authenticator apps expect them (RFC 6238): HMAC-SHA1, six digits, a new code every 30 seconds.
- User
- The User class holds the user of the current request (user() helper, alias User), identified on construction by bearer token or the z_login_token cookie; not Permission\User
- ActionDiscovery
- Application
- CommandDiscovery
- 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.
- RepairCollation
- Connection
- Endpoint
- Where and how the database is reached, read from the booter settings and shared by the runtime connection and the migrations' Doctrine DBAL connection: `dbhost`, `dbport` and the transport encryption (`db_ssl`).
- Migrate
- Seed
- Status
- Sync
- UnlockMigration
- Migration
- MigrationFile
- MigrationPHP
- MigrationSQL
- SeedPHP
- SeedSQL
- Seed
- SqlSplitter
- TimeStamp
- StatementFailure
- One failed statement attempt: what execWithRecovery() classifies on, plus the exception to throw.
- BehaviorOption
- MonologCollector
- QueryCollector
- ResolutionCollector
- Provenance for every convention lookup the Registry performed this request: which root (userspace, a module, or the framework) won each controller, model, and route file. Makes shadowing visible per page.
- 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 requests to /index; root requests run the controller from the config defaultIndex (default DashboardController)
- LoginController
- The Login controller handles all login/logout stuff
- ZController
- The ZController contains actions for the admin dashboard / panel
- ZOrganizationController
- ZubZetController
- z_organizationModel
- BacktraceProcessor
- JsonFormatter
- LogEventType
- Logger
- LoggerFactory
- DatabaseLogger
- StreamLogger
- State
- State
- Request
- The incoming request: input, URL parts, permission checks and form helpers
- 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.
- ModuleSetup
- Proof of concept: copies MISSING default settings from each installed module's z_config/z_settings.ini into the app's settings file. Existing keys are never touched, existing lines are never rewritten; the merge is append-only and idempotent. Run manually, never at boot.
- Kind
- Describes one resolvable kind of framework component: where it lives in userspace, inside a module, and inside the framework itself.
- Kinds
- Static table of the framework's built-in kinds. New kinds are added via register(), so framework features (or later, modules) can join the userspace -> modules -> framework resolution without new plumbing.
- Modules
- Discovery and ordering of installed modules (composer type "zubzet-module").
- Registry
- Central resolver for everything the framework loads by convention.
- RootIndex
- Lazy recursive filename index of one root directory. This is the slow path behind Registry::find(): it is only built after every direct probe missed, and is memoized per (root, extensions) for the request.
- Engine
- Thin adapter around the Katana Blade engine.
- Hooks
- Framework hooks bound into the Katana engine: directives and callbacks tied to the request context. Today this is only @auth / @guest, but this is the home for every future framework directive/callback, so it is expected to grow.
- 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.
- MimeType
- The content type of an asset, read off its file extension.
- 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
- CSRF
- AesGcmCipher
- AES-256-GCM through OpenSSL. Payload layout: iv (12) . tag (16) . ciphertext.
- DecryptionException
- Thrown when a value cannot be decrypted: a wrong key, or a malformed or modified value.
- Encryption
- Symmetric encryption for secrets that have to be stored and read back, like third-party credentials in the database. The key is the `encryption_key` setting of z_settings.ini.
- File
- Checkpoint
- Handle returned by CanCheckpoint::checkpointCurrentState().
- IncludeInCheckpoint
- Marks a property for CanCheckpoint snapshots; checkpointCurrentState() takes the properties carrying it unless told otherwise.
- Install
- Startup
- Filesystem
- The part of symfony/filesystem the framework needs, with the signatures and the behavior of its Filesystem class for local files. The methods are static, PHP also accepts them on an instance: (new Filesystem())->remove($path) works like Filesystem::remove($path).
- Rest
- The rest class is used to provide raw JSON API data to the client
- CoverageCommand
- Start
- Stop
- Translation
- ZubZet
- DashboardController
- ExampleController
- ExampleModel
- AppGuestbookGreetCommand
- QaHelloCommand
- AdminController
- AdvancedController
- AssetProxyController
- AuthProbeController
- CollationProbeController
- CompatController
- Exercises Blade/Katana compatibility guarantees through the real render path: - action_probe: a migrated legacy view whose literal {{ }}, {!! !!} and {{-- --}} markers must survive verbatim (see Views/compat/probe).
- ComponentNamespaceController
- Renders renderprobe/namespace, which places the framework's namespaced <x-zubzet::head/> next to a plain app <x-head/> so the test can prove the two never shadow each other (katanaphp/blade#66).
- ConnectionProbeController
- ConsoleController
- CoreController
- CsrfProbeController
- DashboardController
- DatabaseClusterProbeController
- DatabaseProbeController
- DatabaseRetryProbeController
- ExceptionController
- FileController
- FormController
- FrameworkApiController
- FrameworkViewProbeController
- FrontendController
- GroupController
- HelperController
- Probes for global references used by tests/cypress/e2e/support/global-references.cy.js.
- LayoutConstructorController
- LayoutMiddlewareController
- LayoutResolutionController
- Exercises the layout resolution chain from Resolver\DefaultLayout: explicit arg > instance default > global default > framework default
- LoggerController
- MigrationController
- ModuleHostController
- Probes the app-side view of the module system: composer autoloading of a module namespace, module-contributed config defaults, and a module view shadowing a framework view.
- MultipleFormController
- OrganizationController
- RenderDirectiveController
- Renders renderprobe/directives, which exercises the @auth / @guest Blade directives bound by Rendering\Katana\Hooks. The view is layout-free (layout/empty) so the test reads only the directive branches.
- RenderingController
- RenderProbeController
- Drives the Katana render engine's resolution + $opt contract through the real render path (Rendering\CanRenderView -> Rendering\Katana\Engine).
- ResponseController
- RoleController
- RoutingController
- Test fixtures for tests/cypress/e2e/core/routing.cy.js.
- SessionController
- TranslationController
- TwoFactorProbeController
- 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
- GuestbookGreetCommand
- GuestbookStatsCommand
- GuestbookAdminController
- GuestbookController
- GuestbookModel
- GuestbookStatsModel
- EntryFormatter
- Migration_2025_10_01_MigrationDrySideEffect
- 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
- AliasesTest
- The base of every unit test that needs more than the class under test.
- AuthenticationEntityTest
- The base of every unit test that needs more than the class under test.
- CanUseSessionTest
- The base of every unit test that needs more than the class under test.
- PasswordTest
- The base of every unit test that needs more than the class under test.
- VerificationTest
- The base of every unit test that needs more than the class under test.
- WordPressBcryptHashTest
- The base of every unit test that needs more than the class under test.
- WordPressPortableHashTest
- The base of every unit test that needs more than the class under test.
- UserTest
- The base of every unit test that needs more than the class under test.
- TotpTest
- ConfigurationTest
- The base of every unit test that needs more than the class under test.
- ComposerRequirementsTest
- CanRetrieveBooterSettingsTest
- The base of every unit test that needs more than the class under test.
- FunctionConflictResolutionTest
- The base of every unit test that needs more than the class under test.
- ConnectionTest
- The base of every unit test that needs more than the class under test.
- DatabaseEntityTest
- The base of every unit test that needs more than the class under test.
- EndpointTest
- The base of every unit test that needs more than the class under test.
- InteractionTest
- The base of every unit test that needs more than the class under test.
- SqlSplitterTest
- The base of every unit test that needs more than the class under test.
- MonologCollectorTest
- The base of every unit test that needs more than the class under test.
- QueryCollectorTest
- The base of every unit test that needs more than the class under test.
- TemplateCollectorTest
- The base of every unit test that needs more than the class under test.
- DebugBarBridgeTest
- The base of every unit test that needs more than the class under test.
- CanValidateFormTest
- The base of every unit test that needs more than the class under test.
- CanValidateMultiFormTest
- The base of every unit test that needs more than the class under test.
- z_loginModelTest
- The base of every unit test that needs more than the class under test.
- z_migrationModelTest
- The base of every unit test that needs more than the class under test.
- LoggerTest
- The base of every unit test that needs more than the class under test.
- CanRetrieveFromInputTest
- The base of every unit test that needs more than the class under test.
- StateHttpTest
- State::fromRequest() against real HTTP requests. PHP's built-in web server runs fixtures/state-server.php, which answers with PHP's own view of the request next to the state, so the two can be compared for whatever a client sends.
- StateTest
- The base of every unit test that needs more than the class under test.
- RequestTest
- The base of every unit test that needs more than the class under test.
- ResponseOutputTest
- What the response prints. json() and the cookie functions send headers, which PHP refuses once the test runner has printed anything, so every test runs in a process of its own. The headers themselves are not visible on the command line, the e2e suite asserts them.
- ResponseTest
- The base of every unit test that needs more than the class under test.
- ZubZetValueBinderTest
- The base of every unit test that needs more than the class under test.
- CanRenderViewTest
- The base of every unit test that needs more than the class under test.
- HooksTest
- The base of every unit test that needs more than the class under test.
- DefaultLayoutTest
- The base of every unit test that needs more than the class under test.
- ViewPathTest
- The base of every unit test that needs more than the class under test.
- AssetProxyTest
- serve() sets the response code, which PHP refuses once the test runner has printed anything. In a process of its own nothing was printed before the test.
- MimeTypeTest
- MountTest
- The base of every unit test that needs more than the class under test.
- RerouteTest
- A reroute forks the input of the current request, points it to the new path and dispatches it. The dispatch needs routes and controllers, so the framework of these tests only records the request it would dispatch.
- RecordingFramework
- CSRFTest
- The base of every unit test that needs more than the class under test.
- EncryptionTest
- The base of every unit test that needs more than the class under test.
- FileTest
- The base of every unit test that needs more than the class under test.
- CheckpointTest
- InstallTest
- The base of every unit test that needs more than the class under test.
- StartupTest
- The base of every unit test that needs more than the class under test.
- FilesystemTest
- GlobalReferencesTest
- The base of every unit test that needs more than the class under test.
- HasDynamicAttributesTest
- The base of every unit test that needs more than the class under test.
- HelpersTest
- The base of every unit test that needs more than the class under test.
- RestTest
- The base of every unit test that needs more than the class under test.
- RuntimeCacheTest
- TestCase
- The base of every unit test that needs more than the class under test.
- CollectorCleanupTest
- CommandInteraction
- CanUseSession
- HandleTrait
- Permission
- RetrievalTrait
- Configuration
- CanRetrieveBooterSettings
- CanRetrieveModel
- Interaction
- IsInternalModel
- ChecksDuplicateBasenames
- Executed migration state is keyed on the basename, so two files sharing one basename across roots (or subdirectories) would silently swallow one of them. Commands assembling multi-root migration sets refuse to run.
- DatabaseConnection
- DbalConnection
- Platform
- CanCollect
- CanFormatValue
- ExceptionBehavior
- CanValidateForm
- CanValidateMultiForm
- CanRetrieveFromInput
- CanBuildQuery
- CanRenderView
- DefaultLayout
- Default-layout management for Response.
- HttpMethod
- Router
- CanCheckpoint
- Snapshot / Restore selected instance properties via a Checkpoint handle.
- HasDynamicAttributes
Table of Contents
- FRAMEWORK_ROOT = dirname(__DIR__, 3)
- The folder of the framework, without a trailing slash. For a test that has to name a file of the framework:
- db() : mysqli
- import() : mixed
- drop() : mixed
- getFiles() : array<string|int, mixed>
- importFolder() : mixed
Constants
FRAMEWORK_ROOT
The folder of the framework, without a trailing slash. For a test that has to name a file of the framework:
public
mixed
FRAMEWORK_ROOT
= dirname(__DIR__, 3)
require_once FRAMEWORK_ROOT . "/src/IncludedComponents/models/z_migrationModel.php";
Functions
db()
db() : mysqli
Return values
mysqli —import()
import(string $file) : mixed
Parameters
- $file : string
Return values
mixed —drop()
drop() : mixed
Return values
mixed —getFiles()
getFiles(string $path) : array<string|int, mixed>
Parameters
- $path : string
Return values
array<string|int, mixed> —importFolder()
importFolder(string $path) : mixed
Parameters
- $path : string