Home
This is an automatically generated documentation for Phalcon Kit Documentation.
Namespaces
### \
| Function | Description |
|---|---|
array_unset_recursive() | Remove selected keys from an array at every nesting level. |
dump() | Dump values in a CLI-safe or browser-safe representation. |
exit_500() | Terminate execution with a 500 Internal Server Error response code. |
dd() | Dump values and terminate execution as an error. |
vdd() | Dump values through native var_dump() and terminate execution. |
implode_sprintf() | Format every non-null array value and join the formatted parts. |
implode_mb_sprintf() | Multibyte-safe variant of implode_sprintf(). |
sprintfn() | Format a string with named placeholders backed by vsprintf(). |
mb_sprintf() | Return a formatted multibyte string. |
mb_vsprintf() | Return a formatted string with multibyte-aware %s handling. |
\PhalconKit
| Class | Description |
|---|---|
Bootstrap | Coordinates PhalconKit runtime setup for MVC, CLI, and WebSocket entrypoints. |
Exception | Base checked category for general PhalconKit framework exceptions. |
Locale | Allow to manage and lookup the locale for the localisation |
Tag | This file is part of the Phalcon Kit. |
\PhalconKit\Acl
| Class | Description |
|---|---|
Acl | Builds native Phalcon ACL instances from PhalconKit permission config. |
PermissionName | Normalizes controller and action names used by ACL permissions. |
| Interface | Description |
|---|---|
AclInterface | Contract for ACL builders backed by PhalconKit permission arrays. |
\PhalconKit\Assets
| Class | Description |
|---|---|
Manager | PhalconKit asset manager wrapper. |
\PhalconKit\Autoload
| Class | Description |
|---|---|
Loader | Phalcon autoloader optimized for framework bootstrap usage. |
\PhalconKit\Bootstrap
| Class | Description |
|---|---|
Config | Default framework configuration used by PhalconKit bootstraps. |
Deployment | Default database deployment/scaffolding configuration. |
Devtools | Config adapter shape expected by Phalcon DevTools. |
Router | Bootstrap router with PhalconKit's default frontend routes. |
\PhalconKit\Bootstrap\Permissions
| Class | Description |
|---|---|
ColumnConfig | Default permission fragment for column metadata resources. |
DynamicConfig | Default permission fragment for dynamic-model access. |
RecordConfig | Default permission fragment for generic record resources. |
TableConfig | Default permission fragment for table metadata resources. |
TemplateConfig | Default permission fragment for template resources. |
WorkspaceConfig | Default permission fragment for workspace resources. |
\PhalconKit\Cache
| Class | Description |
|---|---|
Cache | PhalconKit cache service type. |
\PhalconKit\Cli
| Class | Description |
|---|---|
Console | PhalconKit CLI console wrapper. |
Dispatcher | CLI dispatcher with PhalconKit diagnostic state export. |
ExceptionHandler | Minimal CLI exception/message writer. |
Module | Default CLI module definition. |
Router | CLI router with PhalconKit diagnostic state export. |
Task | Base class for PhalconKit CLI tasks. |
| Interface | Description |
|---|---|
DispatcherInterface | Combined dispatcher contract for PhalconKit CLI dispatchers. |
TaskInterface | Marker contract for PhalconKit CLI task handlers. |
\PhalconKit\Config
| Class | Description |
|---|---|
Config | PhalconKit config wrapper with framework merge and typed-path helpers. |
| Interface | Description |
|---|---|
ConfigInterface | PhalconKit configuration contract. |
\PhalconKit\Db
| Class | Description |
|---|---|
Column | |
Profiler | Database profiler with null-safe profile access and array diagnostics. |
\PhalconKit\Db\Adapter\Pdo
| Class | Description |
|---|---|
Mysql |
\PhalconKit\Db\Dialect
| Class | Description |
|---|---|
Mysql | MySQL dialect with PhalconKit query helpers. |
\PhalconKit\Db\Events
| Class | Description |
|---|---|
Logger | Responsible for logging database query events. |
Profiler | Database event listener that feeds executed queries into the profiler. |
\PhalconKit\Di
| Class | Description |
|---|---|
Di | Minimal PhalconKit DI container. |
FactoryDefault | MVC/default-service PhalconKit DI container. |
Injectable | |
ServiceResolver | Shared typed service resolver for static helpers and native Phalcon bridges. |
| Trait | Description |
|---|---|
AbstractInjectable | Trait AbstractInjectable |
InjectableProperties | |
InjectableTrait | The InjectableTrait trait provides methods for using dependency injection within an object. |
TypedServicesTrait | Implements typed service lookups for PhalconKit DI containers. |
| Interface | Description |
|---|---|
DiInterface | PhalconKit dependency injection contract. |
\PhalconKit\Di\FactoryDefault
| Class | Description |
|---|---|
Cli | CLI default-service PhalconKit DI container. |
\PhalconKit\Dispatcher
| Class | Description |
|---|---|
AbstractDispatcher | Generic PhalconKit dispatcher helper. |
| Trait | Description |
|---|---|
DispatcherTrait | Shared dispatcher behavior for MVC and CLI dispatchers. |
| Interface | Description |
|---|---|
DispatcherInterface | Shared dispatcher contract for PhalconKit MVC, CLI, and WebSocket dispatchers. |
\PhalconKit\Encryption
| Class | Description |
|---|---|
Security | Security service with PhalconKit random generation and Argon2 defaults. |
\PhalconKit\Encryption\Security
| Class | Description |
|---|---|
Random |
\PhalconKit\Events
| Class | Description |
|---|---|
ConfiguredEventListeners | Attaches config-declared listeners to a Phalcon events manager. |
| Trait | Description |
|---|---|
EventsAwareTrait | The EventsAwareTrait provides methods for managing events within a class. |
\PhalconKit\Exception
| Class | Description |
|---|---|
CliException | Raised for command-line task and console dispatch failures. |
ConfigurationException | Raised when framework configuration is present but invalid. |
HttpException | Raised for HTTP/request-level failures handled by PhalconKit controllers. |
InvalidArgumentException | Raised when a caller passes an invalid argument to PhalconKit code. |
LogicException | Raised when PhalconKit detects an impossible or inconsistent framework state. |
RuntimeException | Raised when a PhalconKit operation fails at runtime outside DI resolution. |
ServiceException | Raised when a framework service cannot be resolved or used safely. |
WsException | Raised for WebSocket bootstrap, routing, or request-handling failures. |
| Interface | Description |
|---|---|
ExceptionInterface | Marker contract for exceptions raised by PhalconKit framework code. |
\PhalconKit\Filter
| Class | Description |
|---|---|
Filter | Phalcon filter service with PhalconKit sanitizers registered by default. |
FilterFactory | Factory for filter locators that include PhalconKit sanitizer aliases. |
Validation | PhalconKit validation service type. |
\PhalconKit\Filter\Sanitize
| Class | Description |
|---|---|
IPv4 | Sanitizer that accepts only valid IPv4 address strings. |
IPv6 | Sanitizer that accepts only valid IPv6 address strings. |
Json | Sanitizer that keeps only syntactically valid JSON strings. |
Md5 | Sanitizer for md5-style lowercase hexadecimal strings. |
\PhalconKit\Filter\Validation\Validator
| Class | Description |
|---|---|
Color | Validate CSS-style hexadecimal color strings. |
Json | Validate that a field contains a syntactically valid JSON string. |
\PhalconKit\Fractal
| Class | Description |
|---|---|
Manager | Framework-scoped League Fractal manager. |
ModelTransformer | Default Fractal transformer for Phalcon models. |
Transformer | Base transformer for Fractal resources backed by Phalcon models. |
\PhalconKit\Fractal\Serializer
| Class | Description |
|---|---|
RawArraySerializer | Fractal serializer that returns payload arrays without a resource envelope. |
\PhalconKit\Html
| Class | Description |
|---|---|
Escaper | HTML escaper with PhalconKit JSON-attribute support. |
TagFactory | Framework HTML tag factory. |
\PhalconKit\Html\Escaper
| Interface | Description |
|---|---|
EscaperInterface | Escaper contract with PhalconKit's JSON attribute escaping helper. |
\PhalconKit\Http
| Class | Description |
|---|---|
Request | HTTP request implementation with PhalconKit request helpers. |
Response | HTTP response implementation used by PhalconKit services. |
StatusCode | HTTP status-code constants and reason-phrase lookup helpers. |
| Interface | Description |
|---|---|
RequestInterface | HTTP request contract extended with PhalconKit request helpers. |
ResponseInterface | HTTP response contract used by PhalconKit services. |
\PhalconKit\Identity
| Class | Description |
|---|---|
Manager | Coordinates authentication state for PhalconKit applications. |
| Interface | Description |
|---|---|
ManagerInterface | Public contract for the default PhalconKit identity manager. |
\PhalconKit\Identity\Traits
| Trait | Description |
|---|---|
Acl | Builds the ACL role objects used by PhalconKit permission checks. |
Impersonation | Implements session-based user impersonation. |
Jwt | Resolves identity claims from JWTs, bearer authorization, or session fallback. |
Oauth2 | Links provider OAuth2 identities to local users. |
Role | Provides role matching and configured role inheritance. |
Session | Stores the lightweight identity payload for the active manager. |
User | Resolves identity users from the configured user model. |
\PhalconKit\Identity\Traits\Abstracts
| Trait | Description |
|---|---|
AbstractAcl | Declares ACL role methods required by traits composed into the identity manager. |
AbstractImpersonation | Declares impersonation methods required by composed identity traits. |
AbstractJwt | Declares JWT claim methods required by session and identity helpers. |
AbstractOauth2 | Declares OAuth2 linking methods required by composed identity traits. |
AbstractRole | Declares role matching methods required by ACL and impersonation helpers. |
AbstractSession | Declares identity session methods required by JWT, OAuth2, and user helpers. |
AbstractUser | Declares user-resolution methods required by identity behavior traits. |
\PhalconKit\Identity\Traits\Interfaces
| Interface | Description |
|---|---|
AclInterface | Contract for building the effective ACL roles of an identity. |
ImpersonationInterface | Contract for switching an authenticated session into and out of impersonation. |
JwtInterface | Contract for JWT-backed identity claims and token generation. |
Oauth2Interface | Contract for linking OAuth2 identities to local PhalconKit users. |
RoleInterface | Contract for role matching and configured role inheritance. |
SessionInterface | Contract for storing identity payloads under the current claim key. |
UserInterface | Contract for resolving the effective and impersonating identity users. |
\PhalconKit\Locales
| Class | Description |
|---|---|
En | Built-in English translation adapter for framework messages. |
Fr | Built-in French translation adapter for framework messages. |
\PhalconKit\Logger
| Class | Description |
|---|---|
Loggers | Factory and registry for named Phalcon logger instances. |
\PhalconKit\Models
| Class | Description |
|---|---|
AbstractModel | Events |
| - afterCreate | |
| - afterDelete | |
| - afterFetch | |
| - afterSave | |
| - afterUpdate | |
| - afterValidation | |
| - afterValidationOnCreate | |
| - afterValidationOnUpdate | |
| - beforeDelete | |
| - beforeCreate | |
| - beforeSave | |
| - beforeUpdate | |
| - beforeValidation | |
| - beforeValidationOnCreate | |
| - beforeValidationOnUpdate | |
| - notDeleted | |
| - notSaved | |
| - onValidationFails | |
| - prepareSave | |
| - validation | |
Audit | Class Audit |
AuditDetail | Class AuditDetail |
Backup | Class Backup |
Category | Class Category |
Column | Class Column |
Data | Class Data |
Email | Class Email |
EmailFile | Class EmailFile |
Feature | Class Feature |
File | Class File |
FileRelation | Class FileRelation |
Flag | Class Flag |
Group | Class Group |
GroupFeature | Class GroupFeature |
GroupRole | Class GroupRole |
GroupType | Class GroupType |
Job | Class Job |
JobScheduler | Class JobScheduler |
Lang | Class Lang |
Log | Class Log |
Menu | Class Menu |
Meta | Class Meta |
Oauth2 | Class Oauth2 |
Page | Class Page |
PhalconMigrations | Class PhalconMigrations |
Post | Class Post |
PostCategory | Class PostCategory |
Profile | Class Profile |
Record | Class Record |
Role | Class Role |
RoleFeature | Class RoleFeature |
RoleRole | Class RoleRole |
Session | Class Session |
Setting | Class Setting |
Site | Class Site |
SiteLang | Class SiteLang |
Table | Class Table |
Template | Class Template |
Translate | Class Translate |
Type | Class Type |
User | Class User |
UserFeature | Class UserFeature |
UserGroup | Class UserGroup |
UserRole | Class UserRole |
UserType | Class UserType |
Validator | Class Validator |
Workspace | Class Workspace |
WorkspaceLang | Class WorkspaceLang |
\PhalconKit\Models\Abstracts
| Class | Description |
|---|---|
AuditAbstract | Class AuditAbstract |
AuditDetailAbstract | Class AuditDetailAbstract |
BackupAbstract | Class BackupAbstract |
CategoryAbstract | Class CategoryAbstract |
ColumnAbstract | Class ColumnAbstract |
DataAbstract | Class DataAbstract |
EmailAbstract | Class EmailAbstract |
EmailFileAbstract | Class EmailFileAbstract |
FeatureAbstract | Class FeatureAbstract |
FileAbstract | Class FileAbstract |
FileRelationAbstract | Class FileRelationAbstract |
FlagAbstract | Class FlagAbstract |
GroupAbstract | Class GroupAbstract |
GroupFeatureAbstract | Class GroupFeatureAbstract |
GroupRoleAbstract | Class GroupRoleAbstract |
GroupTypeAbstract | Class GroupTypeAbstract |
JobAbstract | Class JobAbstract |
JobSchedulerAbstract | Class JobSchedulerAbstract |
LangAbstract | Class LangAbstract |
LogAbstract | Class LogAbstract |
MenuAbstract | Class MenuAbstract |
MetaAbstract | Class MetaAbstract |
Oauth2Abstract | Class Oauth2Abstract |
PageAbstract | Class PageAbstract |
PhalconMigrationsAbstract | Class PhalconMigrationsAbstract |
PostAbstract | Class PostAbstract |
PostCategoryAbstract | Class PostCategoryAbstract |
ProfileAbstract | Class ProfileAbstract |
RecordAbstract | Class RecordAbstract |
RoleAbstract | Class RoleAbstract |
RoleFeatureAbstract | Class RoleFeatureAbstract |
RoleRoleAbstract | Class RoleRoleAbstract |
SessionAbstract | Class SessionAbstract |
SettingAbstract | Class SettingAbstract |
SiteAbstract | Class SiteAbstract |
SiteLangAbstract | Class SiteLangAbstract |
TableAbstract | Class TableAbstract |
TemplateAbstract | Class TemplateAbstract |
TranslateAbstract | Class TranslateAbstract |
TypeAbstract | Class TypeAbstract |
UserAbstract | Class UserAbstract |
UserFeatureAbstract | Class UserFeatureAbstract |
UserGroupAbstract | Class UserGroupAbstract |
UserRoleAbstract | Class UserRoleAbstract |
UserTypeAbstract | Class UserTypeAbstract |
ValidatorAbstract | Class ValidatorAbstract |
WorkspaceAbstract | Class WorkspaceAbstract |
WorkspaceLangAbstract | Class WorkspaceLangAbstract |
\PhalconKit\Models\Abstracts\Interfaces
\PhalconKit\Models\Behaviors
| Interface | Description |
|---|---|
BlameableInterface | |
SoftDeleteInterface |
\PhalconKit\Models\Behaviors\Blameable
| Interface | Description |
|---|---|
CreatedInterface | |
DeletedInterface | |
RestoredInterface | |
UpdateInterface |
\PhalconKit\Models\Interfaces
\PhalconKit\Modules\Admin
| Class | Description |
|---|---|
Controller | Base MVC controller for PhalconKit applications. |
Module | Base MVC module definition used by PhalconKit web modules. |
\PhalconKit\Modules\Admin\Controllers
| Class | Description |
|---|---|
AbstractController | Base MVC controller for PhalconKit applications. |
ErrorController | Base MVC controller for PhalconKit applications. |
IndexController | Base MVC controller for PhalconKit applications. |
\PhalconKit\Modules\Api
| Class | Description |
|---|---|
Controller | Base MVC controller for PhalconKit applications. |
Module | Base MVC module definition used by PhalconKit web modules. |
\PhalconKit\Modules\Api\Controllers
| Class | Description |
|---|---|
AbstractController | Base MVC controller for PhalconKit applications. |
AuditController | Base MVC controller for PhalconKit applications. |
AuditDetailController | Base MVC controller for PhalconKit applications. |
AuthController | Base MVC controller for PhalconKit applications. |
CategoryController | Base MVC controller for PhalconKit applications. |
ClamavController | Base MVC controller for PhalconKit applications. |
ColumnController | Base MVC controller for PhalconKit applications. |
DataController | Base MVC controller for PhalconKit applications. |
EmailController | Base MVC controller for PhalconKit applications. |
ErrorController | API error endpoint without model-backed REST actions. |
FieldController | Base MVC controller for PhalconKit applications. |
FileController | Base MVC controller for PhalconKit applications. |
FlagController | Base MVC controller for PhalconKit applications. |
GroupController | Base MVC controller for PhalconKit applications. |
IndexController | Base MVC controller for PhalconKit applications. |
LangController | Base MVC controller for PhalconKit applications. |
LogController | Base MVC controller for PhalconKit applications. |
MenuController | Base MVC controller for PhalconKit applications. |
MetaController | Base MVC controller for PhalconKit applications. |
PageController | Base MVC controller for PhalconKit applications. |
PhalconMigrationsController | Base MVC controller for PhalconKit applications. |
PostController | Base MVC controller for PhalconKit applications. |
ProfileController | Base MVC controller for PhalconKit applications. |
RecordController | Base MVC controller for PhalconKit applications. |
RoleController | Base MVC controller for PhalconKit applications. |
SessionController | Base MVC controller for PhalconKit applications. |
SettingController | Base MVC controller for PhalconKit applications. |
TableController | Base MVC controller for PhalconKit applications. |
TemplateController | Base MVC controller for PhalconKit applications. |
TestController | Base MVC controller for PhalconKit applications. |
TranslateController | Base MVC controller for PhalconKit applications. |
TranslateFieldController | Base MVC controller for PhalconKit applications. |
TranslateTableController | Base MVC controller for PhalconKit applications. |
TypeController | Base MVC controller for PhalconKit applications. |
UserController | Base MVC controller for PhalconKit applications. |
WorkspaceController | Base MVC controller for PhalconKit applications. |
\PhalconKit\Modules\Api\Transformers
| Class | Description |
|---|---|
RecordTransformer | Base transformer for Fractal resources backed by Phalcon models. |
\PhalconKit\Modules\Cli
| Class | Description |
|---|---|
Module | Default CLI module definition. |
Task | Base class for PhalconKit CLI tasks. |
\PhalconKit\Modules\Cli\Tasks
| Class | Description |
|---|---|
AbstractTask | Base class for PhalconKit CLI tasks. |
CacheTask | Base class for PhalconKit CLI tasks. |
CronTask | Base class for PhalconKit CLI tasks. |
DatabaseTask | Base class for PhalconKit CLI tasks. |
DataLifeCycleTask | Base class for PhalconKit CLI tasks. |
ErrorTask | Base class for PhalconKit CLI tasks. |
FakerTask | Base class for PhalconKit CLI tasks. |
HelpTask | Base class for PhalconKit CLI tasks. |
ScaffoldTask | Base class for PhalconKit CLI tasks. |
TsScaffoldTask | Base class for PhalconKit CLI tasks. |
UserTask | Base class for PhalconKit CLI tasks. |
\PhalconKit\Modules\Cli\Tasks\Traits
| Trait | Description |
|---|---|
DatabaseTrait | |
DescribesTrait | Trait DescribesTrait |
ScaffoldTrait | Trait DescribesTrait |
UserTrait |
\PhalconKit\Modules\Frontend
| Class | Description |
|---|---|
Controller | Base MVC controller for PhalconKit applications. |
Module | Base MVC module definition used by PhalconKit web modules. |
\PhalconKit\Modules\Frontend\Controllers
| Class | Description |
|---|---|
AbstractController | Base MVC controller for PhalconKit applications. |
ErrorController | Base MVC controller for PhalconKit applications. |
IndexController | Base MVC controller for PhalconKit applications. |
\PhalconKit\Modules\Oauth2
| Class | Description |
|---|---|
Controller | Base MVC controller for PhalconKit applications. |
Module | Base MVC module definition used by PhalconKit web modules. |
\PhalconKit\Modules\Oauth2\Controllers
| Class | Description |
|---|---|
AbstractController | Base MVC controller for PhalconKit applications. |
ClientController | Base MVC controller for PhalconKit applications. |
FacebookController | Base MVC controller for PhalconKit applications. |
GithubController | Base MVC controller for PhalconKit applications. |
GoogleController | Base MVC controller for PhalconKit applications. |
InstagramController | Base MVC controller for PhalconKit applications. |
LinkedinController | Base MVC controller for PhalconKit applications. |
\PhalconKit\Modules\Ws
| Class | Description |
|---|---|
Module | WebSocket module definition backed by Phalcon's CLI-style dispatcher. |
Task | Base class for WebSocket tasks. |
\PhalconKit\Modules\Ws\Tasks
| Class | Description |
|---|---|
AbstractTask | Base class for WebSocket tasks. |
ErrorTask | Base class for WebSocket tasks. |
\PhalconKit\Mvc
| Class | Description |
|---|---|
Application | MVC application with PhalconKit's typed DI boundary and HMVC helper. |
Controller | Base MVC controller for PhalconKit applications. |
Dispatcher | MVC dispatcher with PhalconKit's shared dispatcher safeguards. |
Model | Events |
| - afterCreate | |
| - afterDelete | |
| - afterFetch | |
| - afterSave | |
| - afterUpdate | |
| - afterValidation | |
| - afterValidationOnCreate | |
| - afterValidationOnUpdate | |
| - beforeDelete | |
| - beforeCreate | |
| - beforeSave | |
| - beforeUpdate | |
| - beforeValidation | |
| - beforeValidationOnCreate | |
| - beforeValidationOnUpdate | |
| - notDeleted | |
| - notSaved | |
| - onValidationFails | |
| - prepareSave | |
| - validation | |
Module | Base MVC module definition used by PhalconKit web modules. |
Router | Framework router with config-backed module and locale route registration. |
Url | URL service that normalizes generated local paths. |
View | MVC view wrapper with PhalconKit path normalization and optional minification. |
| Interface | Description |
|---|---|
ModelInterface |
\PhalconKit\Mvc\Controller
| Class | Description |
|---|---|
Error | Base MVC controller for PhalconKit applications. |
Rest | Base MVC controller for PhalconKit applications. |
Restful | Base MVC controller for PhalconKit applications. |
| Interface | Description |
|---|---|
RestfulInterface | Contract for full resource controllers. |
RestInterface | Base contract for PhalconKit REST controllers. |
\PhalconKit\Mvc\Controller\Attributes
| Class | Description |
|---|---|
AllowRoles | Grants controller actions directly to one or more ACL roles. |
AttachBehavior | Attaches controller behaviors through role or feature permissions. |
PermissionAttributeResolver | Compiles controller PHP attributes into PhalconKit permission config arrays. |
PermissionFeature | Declares controller actions that belong to one or more permission features. |
\PhalconKit\Mvc\Controller\Behavior\Model
| Class | Description |
|---|---|
Create | Reserved controller behavior marker for create-oriented model workflows. |
Delete | Reserved controller behavior marker for delete-oriented model workflows. |
Restore | Reserved controller behavior marker for restore-oriented model workflows. |
Update | Reserved controller behavior marker for update-oriented model workflows. |
\PhalconKit\Mvc\Controller\Behavior\Query
| Class | Description |
|---|---|
RemoveBind | Clears all prepared bind values after REST bind initialization. |
RemoveCacheConfig | Clears REST cache options after cache configuration is initialized. |
RemoveColumn | Clears configured query columns after column initialization. |
RemoveConditions | Clears the combined condition collection after REST conditions are initialized. |
RemoveDefaultLimit | Disables default pagination before REST query initialization. |
RemoveDistinct | Clears distinct query expressions after distinct initialization. |
RemoveGroup | Clears group-by expressions after group initialization. |
RemoveHaving | Clears HAVING predicates after HAVING initialization. |
RemoveJoins | Clears configured and dynamic joins after join initialization. |
RemoveLimit | Resets the current limit to the configured maximum after limit initialization. |
RemoveMaxLimit | Disables the maximum pagination limit before REST query initialization. |
RemoveOffset | Resets request/configured pagination offset after offset initialization. |
RemoveWith | Clears eager-loading relation requests after with initialization. |
\PhalconKit\Mvc\Controller\Behavior\Query\Conditions
| Class | Description |
|---|---|
RemoveDefaultFilterCondition | Removes only the default request-filter condition after condition initialization. |
RemoveDefaultIdentityCondition | Removes only the default identity-scope condition after initialization. |
RemoveDefaultPermissionCondition | Removes only the default permission condition after initialization. |
RemoveDefaultSearchCondition | Removes only the default search condition after initialization. |
RemoveDefaultSoftDeleteCondition | Removes only the default soft-delete condition after initialization. |
RemoveDefaultSoftDeleteConditionWhileFiltering | Removes the default soft-delete condition only when the request filters by deletion state. |
RemoveFilterConditions | Clears all request-filter conditions after condition initialization. |
RemoveIdentityConditions | Clears all identity-scope conditions after condition initialization. |
RemovePermissionConditions | Clears all permission conditions after condition initialization. |
RemoveSearchConditions | Clears all search conditions after condition initialization. |
RemoveSoftDeleteConditions | Clears all soft-delete conditions after condition initialization. |
RemoveSoftDeleteConditionsWhileFiltering | Clears all soft-delete conditions only when the request filters by deletion state. |
\PhalconKit\Mvc\Controller\Behavior\Query\Fields
| Class | Description |
|---|---|
RemoveExposeFields | Clears exposed-field rules after REST field initialization. |
RemoveFilterFields | Clears filterable-field rules after REST field initialization. |
RemoveMapFields | Clears API-to-model field mapping rules after field initialization. |
RemoveSaveFields | Clears saveable-field rules after REST field initialization. |
RemoveSearchFields | Clears searchable-field rules after REST field initialization. |
\PhalconKit\Mvc\Controller\Behavior\Skip
| Class | Description |
|---|---|
SkipBind | Behavior flag that disables REST query bind initialization for an action. |
SkipBindTypes | Behavior flag that disables REST query bind-type initialization. |
SkipCache | Behavior flag that disables REST query cache-option initialization. |
SkipColumns | Behavior flag that disables selected-column initialization. |
SkipConditions | Behavior flag that disables the combined REST condition collection. |
SkipDistinct | Behavior flag that disables distinct-expression initialization. |
SkipFilterCondition | Behavior flag that disables request-filter condition initialization. |
SkipGroup | Behavior flag that disables group-by initialization. |
SkipHaving | Behavior flag that disables HAVING-clause initialization. |
SkipIdentityCondition | Behavior flag that disables identity-scope condition initialization. |
SkipJoins | Behavior flag that disables REST join initialization. |
SkipLimit | Behavior flag that disables limit initialization. |
SkipOffset | Behavior flag that disables offset initialization. |
SkipOrder | Behavior flag that disables order-by initialization. |
SkipPermissionCondition | Behavior flag that disables permission condition initialization. |
SkipSearchCondition | Behavior flag that disables search condition initialization. |
SkipSoftDeleteCondition | Removes the default soft-delete condition after condition assembly. |
SkipWhiteList | Behavior flag that disables whitelist initialization. |
\PhalconKit\Mvc\Controller\Traits
| Trait | Description |
|---|---|
Behavior | |
Debug | |
Export | Provides some utility methods to export data |
Expose | |
Fractal | This trait provides methods for working with Fractal, a library for transforming data structures. |
Model | |
Params | |
Query | Shared REST query builder for PhalconKit controllers. |
RestResponse | |
StatusCode | Set the status code to the response |
\PhalconKit\Mvc\Controller\Traits\Abstracts
| Trait | Description |
|---|---|
AbstractBehavior | |
AbstractDebug | |
AbstractExport | |
AbstractExpose | |
AbstractFractal | |
AbstractInjectable | Trait AbstractInjectable |
AbstractModel | |
AbstractParams | |
AbstractQuery | Abstract contract consumed by traits that delegate to the REST query layer. |
AbstractRestResponse | |
AbstractStatusCode |
\PhalconKit\Mvc\Controller\Traits\Abstracts\Query
| Trait | Description |
|---|---|
AbstractBind | Abstract contract for query bind values and bind types. |
AbstractCache | Abstract contract for query result cache options. |
AbstractColumn | Abstract contract for aggregate column selection. |
AbstractConditions | Abstract contract for the composed REST query condition collections. |
AbstractDistinct | Abstract contract for SELECT DISTINCT configuration. |
AbstractFields | Abstract contract that groups all REST field-policy collections. |
AbstractGroup | Abstract contract for GROUP BY query configuration. |
AbstractHaving | Abstract contract for HAVING query conditions. |
AbstractJoins | Abstract contract for configured PHQL join definitions. |
AbstractLimit | Abstract contract for REST query limit policy. |
AbstractOffset | Abstract contract for REST query offset configuration. |
AbstractOrder | Abstract contract for ORDER BY query configuration. |
AbstractSave | Abstract contract for REST persistence helpers. |
AbstractWith | Abstract contract for eager-loading relation configuration. |
\PhalconKit\Mvc\Controller\Traits\Abstracts\Query\Conditions
| Trait | Description |
|---|---|
AbstractFilterConditions | Abstract contract for request-filter query conditions. |
AbstractIdentityConditions | Abstract contract for identity-based query conditions. |
AbstractPermissionConditions | Abstract contract for permission-based query conditions. |
AbstractSearchConditions | Abstract contract for search-based query conditions. |
AbstractSoftDeleteConditions | Abstract contract for soft-delete query conditions. |
\PhalconKit\Mvc\Controller\Traits\Abstracts\Query\Fields
| Trait | Description |
|---|---|
AbstractExposeFields | Abstract contract for list/detail exposure field policies. |
AbstractFilterFields | Abstract contract for fields that may appear in request filters. |
AbstractMapFields | Abstract contract for public-field to model-field mapping. |
AbstractOrderFields | Abstract contract for REST order-field policy configuration. |
AbstractSaveFields | Abstract contract for fields that may be assigned during save operations. |
AbstractSearchFields | Abstract contract for fields that may participate in text search. |
\PhalconKit\Mvc\Controller\Traits\Actions
| Trait | Description |
|---|---|
AuthActions | |
ClamavActions | |
ErrorActions | Default Error Actions |
RestActions |
\PhalconKit\Mvc\Controller\Traits\Actions\Rest
| Trait | Description |
|---|---|
AverageAction | |
CountAction | |
DeleteAction | |
DistinctAction | |
ExportAction | |
FindAction | |
FindFirstAction | |
IndexAction | |
MaximumAction | |
MinimumAction | |
NewAction | |
ReorderAction | |
RestoreAction | |
SaveAction | REST save / create / update actions. |
SumAction |
\PhalconKit\Mvc\Controller\Traits\Interfaces
| Interface | Description |
|---|---|
BehaviorInterface | Contract for attaching controller behavior listeners. |
CacheInterface | Contract for REST query cache-key helpers. |
DebugInterface | Contract for controller debug-mode checks. |
ExportInterface | Contract for REST file export helpers. |
ExposeInterface | Contract for controller payload exposure helpers. |
FractalInterface | Contract for Fractal-backed REST response transformation. |
ModelInterface | Contract for resolving the model managed by a REST controller. |
ParamsInterface | Contract for filtered REST request parameter access. |
RestResponseInterface | Contract for normalizing REST response payloads. |
StatusCodeInterface | Contract for setting HTTP status codes on controller responses. |
\PhalconKit\Mvc\Controller\Traits\Query
| Trait | Description |
|---|---|
Bind | |
Cache | This trait provides methods for caching data for the query. |
Column | |
Compiler | Find-definition compiler. |
Conditions | |
Distinct | |
DynamicJoins | |
Fields | Groups REST field-policy initialization for query controllers. |
Group | |
Having | |
Joins | |
Limit | The Limit trait provides methods to handle query limits. |
Offset | This trait provides functionality to set and get an offset value for a query. |
Order | Parses REST order parameters into Phalcon-compatible query expressions. |
Save | REST persistence trait (controller-side). |
With |
\PhalconKit\Mvc\Controller\Traits\Query\Conditions
| Trait | Description |
|---|---|
ExistentialConditions | |
FilterConditions | |
FilterSemantics | |
IdentityConditions | IdentityConditions |
PermissionConditions | Permission-based query condition provider. |
SearchConditions | Search-based query condition provider. |
SoftDeleteConditions | Soft-delete query condition provider. |
\PhalconKit\Mvc\Controller\Traits\Query\Fields
| Trait | Description |
|---|---|
ExposeFields | |
FilterFields | |
MapFields | |
OrderFields | Stores the REST order-field allow-list used by the query order parser. |
SaveFields | |
SearchFields |
\PhalconKit\Mvc\Dispatcher
| Class | Description |
|---|---|
Camelize | Normalizes dispatched controller and action names to framework method names. |
Error | Dispatcher listener that maps request and runtime exceptions to error routes. |
Logger | Dispatcher listener that logs route resolution metadata. |
Maintenance | Dispatcher listener that redirects traffic while maintenance mode is enabled. |
Module | Dispatcher listener that keeps the module name synchronized during forwards. |
Preflight | Dispatcher listener for CORS and preflight requests. |
Rest | Pass-through dispatcher listener reserved for REST dispatch customization. |
Security | Dispatcher listener that enforces configured ACL permissions. |
\PhalconKit\Mvc\Model
| Class | Description |
|---|---|
Dynamic | Runtime model whose source and metadata can change per instance. |
Manager |
| Interface | Description |
|---|---|
ManagerInterface |
\PhalconKit\Mvc\Model\Behavior
| Class | Description |
|---|---|
Action | |
Blameable | Blameable Behavior |
Conditional | PhalconKit\Mvc\Model\Traits\Behavior\Conditional |
Position | |
Security | Enforces ACL permissions for model lifecycle operations. |
Snapshot | |
SoftDelete | {@inheritDoc} |
Transformable | Applies configured attribute transformations during model lifecycle events. |
\PhalconKit\Mvc\Model\Behavior\Traits
| Trait | Description |
|---|---|
ProgressTrait | Allow to enable or disable trait |
| on the current model instance ($progress) | |
| or globally for every model instance ($staticProgress) | |
SkippableTrait | Allow to enable or disable trait |
| on the current model instance ($enabled) | |
| or globally for every model instance ($staticEnabled) |
\PhalconKit\Mvc\Model\EagerLoading
| Class | Description |
|---|---|
EagerLoad | Represents a level in the relations tree to be eagerly loaded |
Loader | |
QueryBuilder |
\PhalconKit\Mvc\Model\Interfaces
| Interface | Description |
|---|---|
AttributeInterface | |
BehaviorInterface | |
BlameableInterface | |
EagerLoadInterface | |
ExposeInterface | |
HashInterface | |
IdentityInterface | |
InstanceInterface | |
JsonInterface | |
LocaleInterface | |
MetaDataInterface | |
OptionsInterface | |
PositionInterface | |
RelationshipInterface | Defines PhalconKit's relationship assignment and export contract. |
ReplicationInterface | |
SecurityInterface | |
SlugInterface | |
SnapshotInterface | |
SoftDeleteInterface | |
ValidateInterface |
\PhalconKit\Mvc\Model\Interfaces\Blameable
| Interface | Description |
|---|---|
BlameAtInterface | |
CreatedInterface | |
DeletedInterface | |
RestoredInterface | |
UpdatedInterface |
\PhalconKit\Mvc\Model\Traits
| Trait | Description |
|---|---|
Attribute | This trait provides methods to get and set attributes in a model using the get/set methods |
Behavior | Adds named behavior registration helpers to PhalconKit models. |
Blameable | Installs audit/user attribution behavior and user relationships on models. |
Cache | Registers model-cache flushing behavior for mutable models. |
Count | Provides count helpers for queries that need a subquery wrapper. |
EagerLoad | |
Events | |
Expose | |
FindIn | Provides small IN (...) helpers for models with an integer id column. |
Hash | |
Identity | Provides model-level access to the current PhalconKit identity service. |
Instance | |
Json | Trait Json |
LifeCycle | Provides static query helpers for data-retention lifecycle tasks. |
Locale | Adds locale-aware field and method fallbacks to models. |
MetaData | The MetaData trait provides methods for retrieving metadata information about a model or entity. |
Options | The Options trait provides methods for managing options using an options manager. |
Position | The Position trait is used to manage the position behavior of an object. |
Relationship | Adds relationship-aware assignment, persistence, and export helpers. |
Replication | Coordinates read/write connection selection around replica lag. |
Security | The Security trait provides methods to handle security-related functionalities. |
Slug | |
Snapshot | Trait that provides snapshot functionality for a model. |
SoftDelete | This trait provides soft delete functionality to a model class. |
Uuid | Installs UUID generation behavior for model create operations. |
Validate |
\PhalconKit\Mvc\Model\Traits\Abstracts
| Trait | Description |
|---|---|
AbstractBehavior | |
AbstractBlameable | |
AbstractEntity | |
AbstractEventsManager | |
AbstractIdentity | Abstract identity contract required by model traits that need user context. |
AbstractInjectable | |
AbstractInstance | |
AbstractLocale | |
AbstractMetaData | |
AbstractModelsCache | Shared typed accessor for the model cache service. |
AbstractModelsManager | Shared models-manager contract helpers for model traits. |
AbstractOptions | |
AbstractSave |
\PhalconKit\Mvc\Model\Traits\Blameable
| Trait | Description |
|---|---|
BlameAt | |
Created | |
Deleted | |
Restored | |
Updated |
\PhalconKit\Mvc\Router
| Class | Description |
|---|---|
ModuleRoute | Route group for one MVC module, optionally scoped by hostname and locale. |
\PhalconKit\Mvc\View
| Class | Description |
|---|---|
Error | View event listener reserved for framework-level view errors. |
\PhalconKit\Provider
| Class | Description |
|---|---|
AbstractServiceProvider | Base implementation for PhalconKit DI service providers. |
| Interface | Description |
|---|---|
ServiceProviderInterface | Contract for services that register PhalconKit runtime dependencies. |
\PhalconKit\Provider\Acl
| Class | Description |
|---|---|
ServiceProvider | Registers the access-control service. |
\PhalconKit\Provider\Annotations
| Class | Description |
|---|---|
ServiceProvider | Registers the annotations reader service. |
\PhalconKit\Provider\Application
| Class | Description |
|---|---|
ServiceProvider | Registers the MVC application service. |
\PhalconKit\Provider\Assets
| Class | Description |
|---|---|
ServiceProvider | Registers the assets manager service. |
\PhalconKit\Provider\Aws
| Class | Description |
|---|---|
ServiceProvider | Registers the AWS SDK service. |
\PhalconKit\Provider\Cache
| Class | Description |
|---|---|
ServiceProvider | Registers the application cache service. |
\PhalconKit\Provider\Clamav
| Class | Description |
|---|---|
ServiceProvider | Registers the ClamAV client service. |
\PhalconKit\Provider\Config
| Class | Description |
|---|---|
ServiceProvider | Registers the framework configuration service. |
\PhalconKit\Provider\Console
| Class | Description |
|---|---|
ServiceProvider | Registers the CLI console service. |
\PhalconKit\Provider\Cookies
| Class | Description |
|---|---|
ServiceProvider | Registers the response cookies service. |
\PhalconKit\Provider\Crypt
| Class | Description |
|---|---|
ServiceProvider | Registers the encryption service. |
\PhalconKit\Provider\Database
| Class | Description |
|---|---|
ServiceProvider | Registers a configured PDO database connection. |
\PhalconKit\Provider\DatabaseDynamic
| Class | Description |
|---|---|
ServiceProvider | Registers the dynamic-model database connection service. |
\PhalconKit\Provider\DatabaseReadOnly
| Class | Description |
|---|---|
ServiceProvider | Registers the read-only database connection service. |
\PhalconKit\Provider\Debug
| Class | Description |
|---|---|
ServiceProvider | Registers the debug helper service. |
\PhalconKit\Provider\Dispatcher
| Class | Description |
|---|---|
ServiceProvider | Registers the mode-specific dispatcher and core dispatch listeners. |
\PhalconKit\Provider\Env
| Class | Description |
|---|---|
ServiceProvider | Registers the environment helper service. |
\PhalconKit\Provider\Escaper
| Class | Description |
|---|---|
ServiceProvider | Registers the HTML escaper service. |
\PhalconKit\Provider\EventsManager
| Class | Description |
|---|---|
ServiceProvider | Registers the shared events manager service. |
\PhalconKit\Provider\FileSystem
| Class | Description |
|---|---|
ServiceProvider | Registers the local filesystem service. |
\PhalconKit\Provider\Filter
| Class | Description |
|---|---|
ServiceProvider | Registers the PhalconKit filter locator. |
\PhalconKit\Provider\Flash
| Class | Description |
|---|---|
ServiceProvider | Registers the direct flash messaging service. |
\PhalconKit\Provider\Helper
| Class | Description |
|---|---|
ServiceProvider | Registers the helper factory service. |
\PhalconKit\Provider\Identity
| Class | Description |
|---|---|
ServiceProvider | Registers the identity manager service. |
\PhalconKit\Provider\Imap
| Class | Description |
|---|---|
ServiceProvider | Registers the IMAP mailbox service. |
\PhalconKit\Provider\Jwt
| Class | Description |
|---|---|
Jwt | Helper around Phalcon's JWT builder, parser, signer, and validator services. |
ServiceProvider | Registers the JWT helper service. |
\PhalconKit\Provider\Locale
| Class | Description |
|---|---|
ServiceProvider | Registers the locale resolver service. |
\PhalconKit\Provider\Logger
| Class | Description |
|---|---|
ServiceProvider | Registers the default logger service. |
\PhalconKit\Provider\Loggers
| Class | Description |
|---|---|
ServiceProvider | Registers the named logger registry service. |
\PhalconKit\Provider\LoremIpsum
| Class | Description |
|---|---|
ServiceProvider | Registers the lorem ipsum generator service. |
\PhalconKit\Provider\Mailer
| Class | Description |
|---|---|
ServiceProvider | Registers the mailer manager service. |
\PhalconKit\Provider\Models
| Class | Description |
|---|---|
ServiceProvider | Registers the framework model class-map service. |
\PhalconKit\Provider\ModelsCache
| Class | Description |
|---|---|
ServiceProvider | Registers the model-result cache service. |
\PhalconKit\Provider\ModelsManager
| Class | Description |
|---|---|
ServiceProvider | Registers the model manager service. |
\PhalconKit\Provider\ModelsMetadata
| Class | Description |
|---|---|
ServiceProvider | Registers the model metadata service. |
\PhalconKit\Provider\OCR
| Class | Description |
|---|---|
ServiceProvider | Registers the OCR service. |
\PhalconKit\Provider\Oauth2Client
| Class | Description |
|---|---|
ServiceProvider | Registers a generic OAuth2 client provider. |
\PhalconKit\Provider\Oauth2Facebook
| Class | Description |
|---|---|
ServiceProvider | Registers the Facebook OAuth2 provider. |
\PhalconKit\Provider\Oauth2Google
| Class | Description |
|---|---|
ServiceProvider | Registers the Google OAuth2 provider. |
\PhalconKit\Provider\OpenAi
| Class | Description |
|---|---|
ServiceProvider | Registers the OpenAI API client service. |
\PhalconKit\Provider\Profiler
| Class | Description |
|---|---|
ServiceProvider | Registers the database profiler service. |
\PhalconKit\Provider\ReCaptcha
| Class | Description |
|---|---|
ServiceProvider | Registers the ReCaptcha verifier service. |
\PhalconKit\Provider\Redis
| Class | Description |
|---|---|
ServiceProvider | Registers the native Redis client service. |
\PhalconKit\Provider\Request
| Class | Description |
|---|---|
ServiceProvider | Registers the HTTP request service. |
\PhalconKit\Provider\Response
| Class | Description |
|---|---|
ServiceProvider | Registers the HTTP response service. |
\PhalconKit\Provider\Router
| Class | Description |
|---|---|
ServiceProvider | Registers the mode-specific router service. |
\PhalconKit\Provider\Security
| Class | Description |
|---|---|
ServiceProvider | Registers the password hashing and token security service. |
\PhalconKit\Provider\Session
| Class | Description |
|---|---|
ServiceProvider | Registers the session manager service. |
\PhalconKit\Provider\Swoole
| Class | Description |
|---|---|
ServiceProvider | Registers the Swoole WebSocket server service. |
\PhalconKit\Provider\Tag
| Class | Description |
|---|---|
ServiceProvider | Registers the PhalconKit tag helper service. |
\PhalconKit\Provider\Translate
| Class | Description |
|---|---|
ServiceProvider | Registers the translation adapter service. |
\PhalconKit\Provider\Url
| Class | Description |
|---|---|
ServiceProvider | Registers the URL generation service. |
\PhalconKit\Provider\Utils
| Class | Description |
|---|---|
ServiceProvider | Registers the utility helper service. |
\PhalconKit\Provider\Version
| Class | Description |
|---|---|
ServiceProvider | Registers the framework version helper service. |
\PhalconKit\Provider\View
| Class | Description |
|---|---|
ServiceProvider | Registers the MVC view service. |
\PhalconKit\Provider\Volt
| Class | Description |
|---|---|
ServiceProvider | Registers the Volt template engine service. |
\PhalconKit\Provider\WebSocket
| Class | Description |
|---|---|
ServiceProvider | Registers the WebSocket application service. |
\PhalconKit\Router
| Interface | Description |
|---|---|
RouterInterface | Shared contract for PhalconKit routers. |
\PhalconKit\Support
| Class | Description |
|---|---|
CollectionPolicy | Merge/intersection helpers for nullable collection policy sets. |
Debug | Customizes Phalcon's debug renderer for PhalconKit applications. |
Env | Loads dotenv files and exposes normalized environment values. |
Helper | Static facade for native Phalcon and PhalconKit helper services. |
HelperFactory | Helper factory with PhalconKit-specific array/string helpers. |
Models | Resolves configured PhalconKit model instances without magic methods. |
Php | Small PHP runtime helpers used during bootstrap. |
Slug | |
Utils | Miscellaneous low-level utility helpers. |
Version | Exposes the installed PhalconKit core version through Phalcon's version API. |
| Trait | Description |
|---|---|
ModelsMap | Provides explicit accessors for configurable framework model classes. |
\PhalconKit\Support\Debug\Renderer
| Class | Description |
|---|---|
HtmlRenderer | Renders Phalcon 5.16+ debug reports with PhalconKit's inline theme. |
\PhalconKit\Support\Exposer
| Class | Description |
|---|---|
Builder | Mutable state container used by {@see Exposer} during exposure traversal. |
Exposer | Deterministic exposure engine built on top of a mutable Builder. |
| Interface | Description |
|---|---|
BuilderInterface | Contract for the mutable state carrier used by the Exposer engine. |
\PhalconKit\Support\Helper\Arr
| Class | Description |
|---|---|
FlattenKeys | Flatten nested arrays into dot-path keyed rule maps. |
RecursiveMap | Apply a callback to every scalar value in a nested array. |
RecursiveStrReplace | Replace string fragments throughout a nested array. |
\PhalconKit\Support\Helper\Str
| Class | Description |
|---|---|
NormalizeLineBreaks | Normalize line-break sequences in text. |
RemoveNonPrintable | Remove non-printable characters from text. |
SanitizeUTF8 | Normalize input text to UTF-8 and remove invalid characters. |
Slugify | Create URL-friendly slugs through the shared slug generator. |
\PhalconKit\Support\Options
| Class | Description |
|---|---|
Manager | Default in-memory option manager. |
| Trait | Description |
|---|---|
Options | Reusable implementation for mutable service/object options. |
| Interface | Description |
|---|---|
ManagerInterface | Minimal mutable key/value option manager contract. |
OptionsInterface | Contract for objects that expose mutable runtime options. |
\PhalconKit\Translate\Adapter
| Class | Description |
|---|---|
NestedNativeArray | Translation adapter backed by a nested PHP array. |
\PhalconKit\Ws
| Class | Description |
|---|---|
Dispatcher | WebSocket task dispatcher. |
Module | WebSocket module definition backed by Phalcon's CLI-style dispatcher. |
Router | WebSocket router built on Phalcon's CLI routing model. |
Task | Base class for WebSocket tasks. |
WebSocket | Console runtime used for WebSocket task dispatching. |
| Interface | Description |
|---|---|
DispatcherInterface | Contract for WebSocket task dispatchers. |
TaskInterface | Marker contract for WebSocket task classes. |