API Documentation
Namespaces
Interfaces, Classes and Traits
- 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
- 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
- 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
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