Skip to content

Commit 1fab7df

Browse files
committed
Refactor documentation: replace occurrences of Zemit with Phalcon Kit
1 parent 41a2ea0 commit 1fab7df

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+382
-382
lines changed

docs/core/application.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
# Application Component
22

3-
The MVC Application Component, `\Zemit\Mvc\Application`, plays a role in orchestrating the overall operation of your MVC
3+
The MVC Application Component, `\PhalconKit\Mvc\Application`, plays a role in orchestrating the overall operation of your MVC
44
application. This component works by leveraging the `\Phalcon\Mvc\Application` from the Phalcon framework, thereby
55
inheriting all of Phalcon's native advantages and features.
66

77
### Integration with Phalcon
88

9-
By utilizing the `\Phalcon\Mvc\Application`, Zemit ensures that the application has access to a robust and efficient
9+
By utilizing the `\Phalcon\Mvc\Application`, Phalcon Kit ensures that the application has access to a robust and efficient
1010
foundation for managing MVC operations. This integration brings several benefits:
1111

1212
- **Comprehensive MVC Support**: Phalcon's application component provides a full-stack framework, complete with all
1313
necessary services to support the MVC pattern effectively.
14-
- **Optimized Performance**: As Phalcon is known for its performance efficiency, Zemit applications benefit from this
14+
- **Optimized Performance**: As Phalcon is known for its performance efficiency, Phalcon Kit applications benefit from this
1515
optimized operation, ensuring fast response times and lower resource consumption.
1616

17-
### HMVC Enhancements in Zemit
17+
### HMVC Enhancements in Phalcon Kit
1818

19-
A significant enhancement introduced by Zemit is the `request()` method, aimed at facilitating Hierarchical
19+
A significant enhancement introduced by Phalcon Kit is the `request()` method, aimed at facilitating Hierarchical
2020
Model-View-Controller (HMVC) architecture in applications:
2121

2222
- **HMVC-Friendly Requests**: The `request()` method allows for inter-module communication, making it simpler to perform
2323
requests across different modules and namespaces within the application.
24-
- **Response Handling**: Instead of sending the response directly, Zemit's application component returns the response
24+
- **Response Handling**: Instead of sending the response directly, Phalcon Kit's application component returns the response
2525
content or value, providing more control over how responses are processed and presented.
26-
- **Dispatch State Preservation**: To ensure that the current dispatch state remains unaffected, Zemit creates a new
26+
- **Dispatch State Preservation**: To ensure that the current dispatch state remains unaffected, Phalcon Kit creates a new
2727
dispatcher based on the current one for handling these internal requests. This approach maintains application
2828
stability while supporting complex HMVC interactions.
2929

@@ -34,6 +34,6 @@ To delve deeper into the capabilities and usage of the Phalcon MVC Application C
3434
- [Phalcon MVC Application API](https://docs.phalcon.io/latest/api/phalcon_mvc/#mvcapplication){:target="_blank"}
3535
- [Phalcon Application Component Documentation](https://docs.phalcon.io/latest/application/){:target="_blank"}
3636

37-
With `\Zemit\Mvc\Application`, developers can build sophisticated and modular MVC applications that leverage both the
38-
power of Phalcon and the additional HMVC functionalities provided by Zemit, leading to more flexible, maintainable, and
37+
With `\PhalconKit\Mvc\Application`, developers can build sophisticated and modular MVC applications that leverage both the
38+
power of Phalcon and the additional HMVC functionalities provided by Phalcon Kit, leading to more flexible, maintainable, and
3939
scalable web applications.

docs/core/bootstrap.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Bootstrap Component
22

3-
The Bootstrap feature in Zemit Core is responsible for setting up and handling the
3+
The Bootstrap feature in Phalcon Kit is responsible for setting up and handling the
44
application using the Mvc design pattern or the Cli (console). It follows a series
55
of steps to ensure that the application is properly initialized and configured.
66

@@ -12,8 +12,8 @@ The Bootstrap also prepares and loads the different modules of the application b
1212
finally handling it. By using the Bootstrap, you can easily set up and manage your application.
1313

1414
## Quick Start
15-
To create a customized bootstrap with the Zemit Core framework, you will need to create
16-
a new class that extends from the `\Zemit\Bootstrap` class. This will allow you to personalize
15+
To create a customized bootstrap with the Phalcon Kit, you will need to create
16+
a new class that extends from the `\PhalconKit\Bootstrap` class. This will allow you to personalize
1717
the bootstrap to your needs by overriding any of its methods as desired. For example, you
1818
may want to initialize the configuration with your own class. Keep in mind that you are
1919
free to customize the bootstrap to fit your specific requirements and workflow.
@@ -24,7 +24,7 @@ free to customize the bootstrap to fit your specific requirements and workflow.
2424
```php title="index.php"
2525
<?php
2626

27-
use Zemit\Bootstrap;
27+
use PhalconKit\Bootstrap;
2828

2929
$bootstrap = new Bootstrap();
3030

@@ -34,9 +34,9 @@ echo $bootstrap->run();
3434
### Customizable approach
3535
```php title="index.php"
3636
<?php
37-
use Zemit\Bootstrap;
38-
use Zemit\Bootstrap\Config;
39-
use Zemit\Bootstrap\Router;
37+
use PhalconKit\Bootstrap;
38+
use PhalconKit\Bootstrap\Config;
39+
use PhalconKit\Bootstrap\Router;
4040

4141
$config = new Config();
4242
$config->set('debug', true);
@@ -53,7 +53,7 @@ echo $bootstrap->run();
5353

5454
## Method #2: Extending
5555

56-
Extending the `Zemit\Bootstrap` class will give you the most flexibility
56+
Extending the `PhalconKit\Bootstrap` class will give you the most flexibility
5757
because you can modify default behaviors at your convenience. There is mainly
5858
two phases that you can inject your own core components and services:
5959
The `initialization` phase and then the `registration` phase.
@@ -71,11 +71,11 @@ phase of the bootstrap.
7171
<?php
7272
namespace App;
7373

74-
use Zemit\Bootstrap;
74+
use PhalconKit\Bootstrap;
7575
use App\Bootstrap\Config;
7676
use App\Bootstrap\Router;
7777

78-
class Bootstrap extends \Zemit\Bootstrap
78+
class Bootstrap extends \PhalconKit\Bootstrap
7979
{
8080
public function initialize(): void
8181
{
@@ -103,17 +103,17 @@ echo (new Bootstrap())->run();
103103
### Registration phase
104104

105105
The registration phases are called after the `initialize()` method.
106-
This approach is considered more advanced and only needed if you want to keep the native Zemit
106+
This approach is considered more advanced and only needed if you want to keep the native Phalcon Kit
107107
behavior and allow sub-applications to initialize their own components and then add more business logic to it.
108108

109109
```php title="./app/Bootstrap.php"
110110
<?php
111111
namespace App;
112112

113113
use App\Provider\Config\ServiceProvider as ConfigServiceProvider;
114-
use Zemit\Config\ConfigInterface;
114+
use PhalconKit\Config\ConfigInterface;
115115

116-
class Bootstrap extends \Zemit\Bootstrap
116+
class Bootstrap extends \PhalconKit\Bootstrap
117117
{
118118
public function registerConfig(): void
119119
{

docs/core/console.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Console Component
22

3-
The Console Component in Zemit is tailored for handling Command Line Interface (CLI) or Server API (SAPI) requests. It
3+
The Console Component in Phalcon Kit is tailored for handling Command Line Interface (CLI) or Server API (SAPI) requests. It
44
is essentially a proxy class for
55
[`\Phalcon\Cli\Console`](https://docs.phalcon.io/latest/api/phalcon_cli/#cliconsole){:target="_blank"}
66
, crafted to streamline the management and execution of CLI-based
7-
tasks and operations in a Zemit application.
7+
tasks and operations in a Phalcon Kit application.
88

99
CLI applications, standing for Command Line Interface applications, are executed via command line or shell prompt. They
1010
offer distinct advantages, particularly in the absence of a graphical user interface and the ability to execute multiple
@@ -21,24 +21,24 @@ operations without user interaction.
2121

2222
### Integration with Phalcon
2323

24-
Zemit's Console Component inherits and capitalizes on all the functionalities and advantages offered by the
24+
Phalcon kit's Console Component inherits and capitalizes on all the functionalities and advantages offered by the
2525
[Phalcon Console Component](https://docs.phalcon.io/latest/application-cli/){:target="_blank"}.
2626
This inheritance brings a robust set of features optimized for CLI operations, making the development
2727
of command-line applications more intuitive and efficient.
2828

2929
### Structure
3030

31-
In Zemit, CLI applications leverage the
31+
In Phalcon Kit, CLI applications leverage the
3232
[`\Phalcon\Cli\Console`](https://docs.phalcon.io/latest/api/phalcon_cli/#cliconsole){:target="_blank"}
3333
class, following Phalcon's design principles. This
3434
approach entails:
3535

3636
- **Task-Oriented Design**: The Console Component operates within a directory structure where Task scripts reside. These
3737
scripts are classes extending `Phalcon\Cli\Task`, containing executable code for specific command-line operations.
3838

39-
- **Flexibility and Modularity**: Zemit's adaptation allows for a modular and flexible structure, accommodating a wide
39+
- **Flexibility and Modularity**: Phalcon Kit's adaptation allows for a modular and flexible structure, accommodating a wide
4040
range of command-line tasks, each encapsulated in its Task class.
4141

42-
Utilizing the Console Component in Zemit enables developers to harness the power of CLI applications effectively,
42+
Utilizing the Console Component in Phalcon Kit enables developers to harness the power of CLI applications effectively,
4343
augmenting their applications with robust, background, or automated functionalities inherent to command-line
4444
environments.

docs/core/dispatcher.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
## Overview
44

5-
The Dispatcher component in Zemit is a dynamic and essential element that acts as a liaison between the routing layer
5+
The Dispatcher component in Phalcon Kit is a dynamic and essential element that acts as a liaison between the routing layer
66
and the application's execution logic. Its primary function is to interpret and process requests as directed by the
77
Router, ensuring each request is handled by the correct module, controller, task, or action, accompanied by relevant
8-
parameters. To cater to different operational environments, Zemit employs two specialized types of dispatchers:
8+
parameters. To cater to different operational environments, Phalcon Kit employs two specialized types of dispatchers:
99

10-
- **`\Zemit\Cli\Dispatcher`**: This dispatcher is specifically designed for handling command-line interfaces (CLI) and
10+
- **`\PhalconKit\Cli\Dispatcher`**: This dispatcher is specifically designed for handling command-line interfaces (CLI) and
1111
Server API (SAPI) interactions. It extends the functionality
1212
of [`\Phalcon\Cli\Dispatcher`](https://docs.phalcon.io/latest/api/phalcon_cli/#clidispatcher){:target="_blank"},
1313
providing a tailored experience for non-web-based applications.
14-
- **`\Zemit\Mvc\Dispatcher`**: Focused on web-based applications, this dispatcher manages web requests by
14+
- **`\PhalconKit\Mvc\Dispatcher`**: Focused on web-based applications, this dispatcher manages web requests by
1515
extending [`\Phalcon\Mvc\Dispatcher`](https://docs.phalcon.io/latest/api/phalcon_mvc/#mvcdispatcher){:target="_
1616
blank"}. It ensures that web requests are routed to the appropriate controllers and actions within the MVC framework.
1717

@@ -27,9 +27,9 @@ For an in-depth understanding of the underlying concepts and capabilities, explo
2727
The issue arises from the potential mixing of parameter order, which can render the method parameters unreliable in
2828
various scenarios and use cases.
2929

30-
!!! danger "Zemit's Approach to Parameter Passing"
31-
To ensure stability and predictability in handling method parameters, Zemit modifies this behavior. Only parameters with
32-
integer keys are passed to the action method parameters in Zemit's dispatcher. This approach mitigates the risk of
30+
!!! danger " Phalcon kit's Approach to Parameter Passing"
31+
To ensure stability and predictability in handling method parameters, Phalcon Kit modifies this behavior. Only parameters with
32+
integer keys are passed to the action method parameters in Phalcon Kit's dispatcher. This approach mitigates the risk of
3333
parameter order mix-up, enhancing the reliability of your application's routing and parameter handling mechanisms.
3434

3535
### Dispatching Process
@@ -42,28 +42,28 @@ At its core, dispatching in an MVC application, as facilitated by `\Phalcon\Mvc\
4242
3. **Controller Instantiation**: The corresponding controller is instantiated based on the extracted information.
4343
4. **Action Execution**: The designated action within the controller is executed, handling the request as intended.
4444

45-
Zemit's Dispatcher enhances this process by integrating it seamlessly with the framework's architecture, ensuring
45+
Phalcon kit's Dispatcher enhances this process by integrating it seamlessly with the framework's architecture, ensuring
4646
efficient and effective handling of both web and CLI requests.
4747

4848
## Benefits and Features
4949

50-
By extending Phalcon's native dispatchers, Zemit inherits all the flexibility, performance, and features of the Phalcon
50+
By extending Phalcon's native dispatchers, Phalcon Kit inherits all the flexibility, performance, and features of the Phalcon
5151
framework while adding significant enhancements:
5252

5353
### Cyclic Routing Prevention
5454

5555
A common issue in dispatching is "_Dispatcher has detected a cyclic routing causing
56-
stability problems._" This happens when there's an endless forwarding loop in the application. Zemit's Dispatcher can
56+
stability problems._" This happens when there's an endless forwarding loop in the application. Phalcon Kit's Dispatcher can
5757
automatically detect and prevent such single-hop cyclic routing issues, enhancing application stability. However, it's
5858
important to note that it doesn’t resolve multiple-hop cycling issues, as these often involve complex scenarios that
5959
require developer intervention.
6060

61-
### Business Rule Implementation in Zemit Dispatcher
61+
### Business Rule Implementation in Phalcon Kit Dispatcher
6262

63-
The Zemit Dispatcher Service Provider is designed to automate and handle several vital aspects of application management
63+
The Phalcon Kit Dispatcher Service Provider is designed to automate and handle several vital aspects of application management
6464
and routing. This configuration not only streamlines the development process but also ensures consistent and secure
6565
application behavior across different environments. Here's a breakdown of the key business rules automatically managed
66-
by the Zemit Dispatcher:
66+
by the Phalcon Kit Dispatcher:
6767

6868
- **CORS and Preflight Requests**: The dispatcher is equipped to handle Cross-Origin Resource Sharing (CORS) and
6969
preflight requests, ensuring that your application can safely interact with resources from different domains as per
@@ -81,7 +81,7 @@ by the Zemit Dispatcher:
8181
debugging and monitoring. The dispatcher logs these events, providing valuable insights into the application's routing
8282
behavior and performance.
8383

84-
- **Support for HMVC Architecture**: Zemit's dispatcher supports forwarding in multi-module architectures, making it
84+
- **Support for HMVC Architecture**: Phalcon Kit's dispatcher supports forwarding in multi-module architectures, making it
8585
ideal for applications following a Hierarchical Model-View-Controller (HMVC) pattern. This capability allows modules
8686
to request actions from other modules, fostering a highly modular and flexible application structure.
8787

@@ -93,7 +93,7 @@ by the Zemit Dispatcher:
9393
by allowing default namespace settings. This feature streamlines the organization of controllers and models within
9494
various modules, enhancing the structure and readability of the codebase.
9595

96-
The Zemit Dispatcher's automated approach to managing crucial business rules significantly enhances the application's
96+
The Phalcon Kit Dispatcher's automated approach to managing crucial business rules significantly enhances the application's
9797
architecture on multiple fronts:
9898

9999
- **Simplified Development**: By automating complex processes like CORS handling, security enforcement, and maintenance
@@ -112,8 +112,8 @@ architecture on multiple fronts:
112112
reduces overhead and enhances efficiency. This efficiency is particularly beneficial in applications with complex
113113
routing needs, where minimizing performance bottlenecks is crucial.
114114

115-
Incorporating these advanced features, Zemit’s Dispatcher not only makes request handling more efficient but also plays
115+
Incorporating these advanced features, Phalcon Kit’s Dispatcher not only makes request handling more efficient but also plays
116116
a vital role in reducing the complexity typically associated with routing and dispatching in web applications.
117-
Developers leveraging Zemit can expect a more intuitive, secure, and manageable routing process, enabling them to build
117+
Developers leveraging Phalcon Kit can expect a more intuitive, secure, and manageable routing process, enabling them to build
118118
sophisticated web solutions with ease.
119119

docs/core/loader.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ criteria like file names, class names, and namespaces. One notable advantage of
77
is its implementation in C, which ensures minimal overhead during the setup process. This inherent
88
efficiency contributes to a performance boost for your application.
99

10-
Zemit Loader extends the native
10+
Phalcon Kit Loader extends the native
1111
[`\Phalcon\Autoload\Loader`](https://docs.phalcon.io/latest/api/phalcon_autoload/){:target="_blank"}.
12-
To further optimize speed, Zemit Loader has disabled the
12+
To further optimize speed, Phalcon Kit Loader has disabled the
1313
[file checking callback](https://docs.phalcon.io/latest/autoload/#file-checking-callback){:target="_blank"}
1414
used in Phalcon's native component, ensuring quicker response times.
1515

1616
## Constants
1717

18-
This set of constants facilitate the loading process and form the backbone of the default Zemit configuration.
18+
This set of constants facilitate the loading process and form the backbone of the default Phalcon Kit configuration.
1919
These constants can be tailored to suit the specific needs of your project.
2020

2121
| Constant | Default Value | Description |
@@ -40,15 +40,15 @@ Below is the typical structure for `loader.php`, illustrating how to register th
4040
```php title="./loader.php"
4141
<?php
4242

43-
use Zemit\Autoload\Loader;
43+
use PhalconKit\Autoload\Loader;
4444

4545
// Define the main constants used across the application
4646
const APP_NAMESPACE = 'App';
4747
const ROOT_PATH = __DIR__;
4848
const VENDOR_PATH = ROOT_PATH . '/vendor/';
4949
const APP_PATH = ROOT_PATH . '/app/';
5050

51-
// Initialize the Zemit Loader
51+
// Initialize the Phalcon Kit Loader
5252
$loader = new Loader();
5353

5454
// Register the Composer autoload file and the application namespace
@@ -66,7 +66,7 @@ This script ensures that all necessary files and namespaces are correctly autolo
6666

6767
### Global Entry Point
6868

69-
The `./index.php` file acts as the global entry point for your Zemit application.
69+
The `./index.php` file acts as the global entry point for your Phalcon Kit application.
7070
It's strategically placed in the root of the project not for direct web server access,
7171
but as a security measure to safeguard the application's root directory.
7272
This setup is designed to prevent unauthorized directory listing or exposure
@@ -81,7 +81,7 @@ Here's the typical implementation of the global entry point:
8181
```php title="./index.php"
8282
<?php
8383

84-
use Zemit\Bootstrap;
84+
use PhalconKit\Bootstrap;
8585

8686
// Load the global autoloader
8787
$loader = require 'loader.php';
@@ -93,13 +93,13 @@ echo (new Bootstrap())->run();
9393
In this script:
9494

9595
- We include the global loader.php to initialize the autoloading process.
96-
- An instance of Zemit\Bootstrap is created and executed, which kickstarts the application. This approach encapsulates
96+
- An instance of PhalconKit\Bootstrap is created and executed, which kickstarts the application. This approach encapsulates
9797
the initialization and routing in a structured manner, enhancing maintainability and security.
9898

9999
### Public Entry Point
100100

101101
The `./public/index.php` file is designated as the primary entry point for **web server**
102-
interactions with your Zemit application. This file should reside in the `public` directory
102+
interactions with your Phalcon Kit application. This file should reside in the `public` directory
103103
of your project. The purpose of this configuration is to enhance security by restricting web
104104
server access solely to the `public` directory, thereby shielding the rest of your
105105
application's structure and critical files from direct exposure.

0 commit comments

Comments
 (0)