/htdocs/`. This is the path where it will serve the files. This is also the path where the entry point of your application (usually `index.php`) needs to reside.
82 |
83 | Some frameworks however, store files and content in nested directories of unknown levels. It is therefore impossible to set this as a pre-set for the environment. You will therefore have to manually set a symlink back to the expected path that your framework requires.
84 |
85 | ```bash
86 | devilbox@php-8.0 in /shared/httpd/my-phalcon $ ln -s phalconphp/public/ htdocs
87 | ```
88 |
89 | The directory structure looks like this after the installation:
90 |
91 | ```bash
92 | devilbox@php-8.0 in /shared/httpd/my-phalcon $ tree -L 1
93 | .
94 | ├── phalconphp
95 | └── htdocs -> phalconphp/public
96 |
97 | 2 directories, 0 files
98 | ```
99 |
100 | As you can see in the above listing, the `htdocs` folder that is required by the web server is now pointing to the entry point of your framework.
101 |
102 | !!! warning "NOTE"
103 |
104 | When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
105 |
106 | ### DNS Record
107 |
108 | If you **have** Auto DNS configured already, you can skip this section, because DNS entries will be available automatically by the bundled DNS server.
109 |
110 | If you **do not have** Auto DNS configured, you will need to add the following line to your host operating system `/etc/hosts` file (or `C:\Windows\System32\drivers\etc` on Windows):
111 |
112 | ```bash
113 | 127.0.0.1 my-phalcon.loc
114 | ```
115 |
116 | ### Open your Browser
117 |
118 | Open your browser and navigate to `http://my-phalcon.loc` or `https://my-phalcon.loc`
119 |
120 |
121 | ### Create Custom Vhost Config File (Nginx Only)
122 |
123 | By default routes will not work if using Nginx. To fix this, you will need to create a custom vhost configuration.
124 |
125 | In your project folder, you will need to create a folder called `.devilbox` unless you changed `HTTPD_TEMPLATE_DIR` in your `.env`
126 |
127 | Copy the default nginx config from `./cfg/vhost-gen/nginx.yml-example-vhost` to `./data/www/my-project/.devilbox/nginx.yml`
128 |
129 | Carefully edit the nginx.yml file and change:
130 |
131 | `try_files $uri $uri/ /index.php$is_args$args;`
132 |
133 | to
134 |
135 | `try_files $uri $uri/ /index.php?_url=$uri&$args;`
136 |
137 | and
138 |
139 | `location ~ \.php?$ {`
140 |
141 | to
142 |
143 | `location ~ [^/]\.php(/|$) {`
144 |
145 | Save the file as `nginx.yml` and ensure not to use any tabs in the file or devilbox will not use the custom configuration. You can use `yamllint nginx.yml` whilst inside the Devilbox shell to check the file before restarting devilbox.
146 |
147 | ## References
148 | - [Devilbox.com][devilbox]
149 | - [Devilbox Documentation][devilbox-documentation]
150 | - [HOST_PATH_HTTPD_DATADIR][host-path-httpd-datadir]
151 | - [Enter the PHP container][enter-container]
152 | - [Work inside the PHP container][work-in-container]
153 | - [Available tools][available-tools]
154 | - [TLD_SUFFIX][tld-suffix]
155 | - [Docker Toolbox and Symlinks][docker-toolbox-symlinks]
156 | - [Add project hosts entry on MacOS][hosts-mac]
157 | - [Add project hosts entry on Windows][hosts-windows]
158 | - [Setup Auto DNS][auto-dns]
159 |
160 | [devilbox]: https://devilbox.org
161 | [devilbox-documentation]: https://devilbox.readthedocs.io/en/latest/examples/setup-phalcon.html
162 | [host-path-httpd-datadir]: https://devilbox.readthedocs.io/en/latest/configuration-files/env-file.html#env-httpd-datadir
163 | [enter-container]: https://devilbox.readthedocs.io/en/latest/getting-started/enter-the-php-container.html#enter-the-php-container
164 | [work-in-container]: https://devilbox.readthedocs.io/en/latest/intermediate/work-inside-the-php-container.html#work-inside-the-php-container
165 | [available-tools]: https://devilbox.readthedocs.io/en/latest/readings/available-tools.html#available-tools
166 | [tld-suffix]: https://devilbox.readthedocs.io/en/latest/configuration-files/env-file.html#env-tld-suffix
167 | [docker-toolbox-symlinks]: https://devilbox.readthedocs.io/en/latest/howto/docker-toolbox/docker-toolbox-and-the-devilbox.html#howto-docker-toolbox-and-the-devilbox-windows-symlinks
168 | [hosts-mac]: https://devilbox.readthedocs.io/en/latest/howto/dns/add-project-dns-entry-on-mac.html#howto-add-project-hosts-entry-on-mac
169 | [hosts-windows]: https://devilbox.readthedocs.io/en/latest/howto/dns/add-project-dns-entry-on-win.html#howto-add-project-hosts-entry-on-win
170 | [auto-dns]: https://devilbox.readthedocs.io/en/latest/intermediate/setup-auto-dns.html#setup-auto-dns
171 |
--------------------------------------------------------------------------------
/docs/environments-nanobox.md:
--------------------------------------------------------------------------------
1 | # Environments
2 | - - -
3 |
4 | !!! info "NOTE"
5 |
6 | [Nanobox][nanobox] has been discontinued.
7 |
8 | [nanobox]: https://nanobox.io
9 |
--------------------------------------------------------------------------------
/docs/generating-backtrace.md:
--------------------------------------------------------------------------------
1 | # Generating a Backtrace
2 | - - -
3 |
4 | Phalcon is compiled into a C extension loaded on your web server. Because of that, bugs lead to segmentation faults, causing Phalcon to crash some of your web server processes.
5 |
6 | For debugging these segmentation faults a stacktrace is required. Creating a stack trace requires a special build of php and some steps need to be done to generate a trace that allows the Phalcon team to debug this behavior.
7 |
8 | Please follow this guide to understand how to generate the backtrace.
9 |
10 | [https://bugs.php.net/bugs-generating-backtrace.php](https://bugs.php.net/bugs-generating-backtrace.php)
11 |
12 | [https://bugs.php.net/bugs-generating-backtrace-win32.php](https://bugs.php.net/bugs-generating-backtrace-win32.php)
13 |
--------------------------------------------------------------------------------
/docs/html-attributes.md:
--------------------------------------------------------------------------------
1 | # HTML Components
2 | - - -
3 |
4 | ## Overview
5 | The [Phalcon\Html\Attributes][html-attributes] is a wrapper of [Phalcon\Support\Collection][support-collection]. It also contains two more methods `render()` and `__toString()`. `render()` uses [Phalcon\Html\TagFactory][html-tagfactory] internally to render the attributes that an HTML element has. These HTML attributes are defined in the object itself.
6 |
7 | The component can be used on its own if you want to collect HTML attributes in an object and then _render_ them (return them as a string) in a `key=value` format.
8 |
9 | This component is used internally by [Phalcon\Forms\Form][forms] to store the attributes of form elements.
10 |
11 | [html-attributes]: api/phalcon_html.md#html-attributes
12 | [html-attributes-attributesinterface]: api/phalcon_html.md#html-attributes-attributesinterface
13 | [html-attributes-renderinterface]: api/phalcon_html.md#html-attributes-renderinterface
14 | [html-tagfactory]: api/phalcon_html.md#html-tagfactory
15 | [support-collection]: support-collection.md
16 | [forms]: forms.md
17 |
--------------------------------------------------------------------------------
/docs/html-breadcrumbs.md:
--------------------------------------------------------------------------------
1 | # HTML Components
2 | - - -
3 |
4 | ## Overview
5 | A common piece of HTML that is present in many web applications is the breadcrumbs. These are links separated by a space or by the `/` character usually, that represent the tree structure of an application. The purpose is to give users another easy visual way to navigate throughout the application.
6 |
7 | An example is an application that has an `admin` module, an `invoices` area and a `view invoice` page. Usually, you would select the `admin` module, then from the links you will choose `invoices` (list) and then clicking on one of the invoices in the list, you can view it. To represent this tree like structure, the breadcrumbs displayed could be:
8 |
9 | ```php
10 | Home / Admin / Invoices / Viewing Invoice [1234]
11 | ```
12 | Each of the words above (apart from the last one) are links to the respective pages. This way the user can quickly navigate back to a different area without having to click the back button or use another menu.
13 |
14 | [Phalcon\Html\Breadcrumbs][html-breadcrumbs] offers functionality to add text and URLs. The resulting HTML when calling `render()` will have each breadcrumb enclosed in `` tags, while the whole string is enclosed in `` tags.
15 |
16 | ### Methods
17 | ```php
18 | public function add(
19 | string $label,
20 | string $link = ""
21 | ): Breadcrumbs
22 | ```
23 | Adds a new crumb.
24 |
25 | In the example below, add a crumb with a link and then add a crumb without a link (normally the last one)
26 |
27 | ```php
28 | $breadcrumbs
29 | ->add("Home", "/")
30 | ->add("Users")
31 | ;
32 | ```
33 |
34 | ```php
35 | public function clear(): void
36 | ```
37 | Clears the crumbs
38 |
39 | ```php
40 | $breadcrumbs->clear()
41 | ```
42 |
43 | ```php
44 | public function getSeparator(): string
45 | ```
46 | Returns the separator used for the breadcrumbs
47 |
48 | ```php
49 | public function remove(string $link): void
50 | ```
51 | Removes crumb by url.
52 |
53 | In the example below remove a crumb by URL and also remove a crumb without an url (last link)
54 |
55 | ```php
56 | $breadcrumbs->remove("/admin/user/create");
57 | $breadcrumbs->remove();
58 | ```
59 |
60 | ```php
61 | public function render(): string
62 | ```
63 | Renders and outputs breadcrumbs HTML. The template used is:
64 |
65 | ```html
66 |
67 | - Text
/
68 | - Text
/
69 | - Text
70 |
71 | ```
72 | The last set crumb will not have a link and will only have its text displayed. Each crumb is wrapped in `` tags. The whole collection is wrapped in `
` tags. You can use them in conjunction with CSS to format the crumbs on screen according to the needs of your application.
73 |
74 | ```php
75 | echo $breadcrumbs->render();
76 | ```
77 |
78 | ```php
79 | public function setSeparator(string $separator)
80 | ```
81 | The default separator between the crumbs is `/`. You can set a different one if you wish using this method.
82 |
83 | ```php
84 | $breadcrumbs->setSeparator('-');
85 | ```
86 |
87 | ```php
88 | public function toArray(): array
89 | ```
90 | Returns the internal breadcrumbs array
91 |
92 | [html-breadcrumbs]: api/phalcon_html.md#html-breadcrumbs
93 | [html-exception]: api/phalcon_html.md#html-exception
94 | [html-tagfactory]: api/phalcon_html.md#html-tagfactory
95 |
--------------------------------------------------------------------------------
/docs/html-link.md:
--------------------------------------------------------------------------------
1 | # HTML Link
2 | - - -
3 |
4 | ## Overview
5 | [Phalcon\Html\Link\EvolvableLink][html-link-evolvablelink], [Phalcon\Html\Link\EvolvableLinkProvider][html-link-evolvablelinkprovider], [Phalcon\Html\Link\Link][html-link-link] and [Phalcon\Html\Link\LinkProvider][html-link-linkprovider] are classes that implement the interfaces based on [PSR-13][psr-13], but with much stricter types
6 |
7 | !!! info "NOTE"
8 |
9 | This component does not generate any HTML links. It just stores the links. You will need to create your own serializers that will parse these objects and generate the necessary output. The [Phalcon\Html\Link\Serializer\Header][html-link-serializer-header] serializer is available for you to use.
10 |
11 | ### Operations
12 | The `Phalcon\Html\Link\*` components implement methods that are inline with [PSR-13][psr-13], but do not implement the particular interface. A package that implements [PSR-13][psr-13] is available, that uses the `Phalcon\Html\Link\*` components. The package is located [here][proxy-psr13]. To use it, you will need to have Phalcon installed and then using composer you can install the proxy package.
13 |
14 | ```sh
15 | composer require phalcon/proxy-psr13
16 | ```
17 |
18 | Using the proxy classes allows you to follow [PSR-13][psr-13] and use it with any other package that needs that interface.
19 |
20 | ## Link
21 | The [Phalcon\Html\Link\Link][html-link-link] is used to create a link and assign attributes to it upon construction.
22 |
23 | ```php
24 | true,
31 | 'two' => 123,
32 | 'three' => 'four',
33 | 'five' => [
34 | 'six',
35 | 'seven',
36 | ],
37 | ];
38 |
39 | $link = new Link('payment', $href, $attributes);
40 | ```
41 |
42 | ## LinkProvider
43 | The [Phalcon\Html\Link\LinkProvider][html-link-linkprovider] is used as a container of [Phalcon\Html\Link\Link][html-link-link] objects. You can add them in the provider and then access them as a whole or retrieve them by `rel`.
44 |
45 | ```php
46 | getLinksByRel('cite-as')
60 | );
61 |
62 | // [
63 | // Link('cite-as', 'https://test.phalcon.ld'),
64 | // ]
65 | ```
66 |
67 | ## EvolvableLink
68 | Link objects are immutable. However, there is a need to manipulate them based on your application needs. The [Phalcon\Html\Link\EvolvableLink][html-link-evolvablelink] is available, allowing you to manipulate the link.
69 |
70 | ```php
71 | true];
77 |
78 | $link = new EvolvableLink('payment', $href, $attributes);
79 |
80 | $newInstance = $link->withAttribute('two', 'three');
81 |
82 | var_dump(
83 | $newInstance->getAttributes()
84 | );
85 |
86 | // [
87 | // 'one' => true,
88 | // 'two' => 'three',
89 | // ];
90 | ```
91 |
92 | ## EvolvableLinkProvider
93 | The [Phalcon\Html\Link\LinkProvider][html-link-linkprovider] is used as a container of [Phalcon\Html\Link\EvolvableLink][html-link-evolvablelink] objects. You can add them in the provider and then access them as a whole or retrieve them by `rel`.
94 |
95 | ```php
96 | getLinksByRel('cite-as')
110 | );
111 |
112 | // [
113 | // Link('cite-as', 'https://test.phalcon.ld'),
114 | // ]
115 | ```
116 |
117 | ## Serializers
118 | ### Header
119 | You can use a serializer to parse the `Phalcon\Html\Link\*` objects and create the necessary headers. Phalcon comes with the [Phalcon\Html\Link\Serializer\Header][html-link-serializer-header] serializer, to help with the task of serializing links for the headers:
120 |
121 | ```php
122 | serialize([$link]);
132 | // ; rel="prefetch"';
133 |
134 |
135 | $links = [
136 | (new EvolvableLink('preload', '/1'))
137 | ->withAttribute('as', 'image')
138 | ->withAttribute('nopush', true),
139 | (new EvolvableLink('alternate', '/2'))
140 | ->withRel('next')
141 | ->withAttribute('hreflang', ['en', 'es'])
142 | ];
143 |
144 | echo $serializer->serialize([$link]);
145 | // ; rel="preload"; as="image"; nopush,
146 | // ; rel="alternate next"; hreflang="en"; hreflang="es"
147 | ;
148 | ```
149 |
150 | ### Custom
151 | You can create your own serializers for relevant links by extending the [Phalcon\Html\Link\Serializer\SerializerInterface][html-link-serializer-serializerinterface]
152 |
153 | ```php
154 | format([4560]);
53 |
54 | // USD$ 4,560.5
55 | $formatter = new MessageFormatter('en_US', 'USD$ {0, number}');
56 | echo $formatter->format([4560.50]);
57 |
58 | // ARS$ 1.250,25
59 | $formatter = new MessageFormatter('es_AR', 'ARS$ {0, number}');
60 | echo $formatter->format([1250.25]);
61 | ```
62 |
63 | Message formatting using time and date patterns:
64 |
65 | ```php
66 | format($values);
77 |
78 | // 'À 15:53:01 le 19 avr. 2015, il y avait une perturbation sur la planète 7.'
79 | $pattern = 'À {1, time} le {1, date}, il y avait une perturbation sur la planète {0, number}.';
80 | $formatter = new MessageFormatter('fr_FR', $pattern);
81 | echo $formatter->format($values);
82 | ```
83 |
84 | ## Locale-Sensitive Comparison
85 | The [Collator][collator] class provides string comparison capability with support for appropriate locale-sensitive sort orderings. Check the examples below on the usage of this class:
86 |
87 | ```php
88 | setStrength(Collator::PRIMARY);
97 |
98 | var_dump(
99 | $collator->compare('una canción', 'una cancion')
100 | );
101 |
102 | // Returns that the strings are not equal
103 | $collator->setStrength(Collator::DEFAULT_VALUE);
104 |
105 | var_dump(
106 | $collator->compare('una canción', 'una cancion')
107 | );
108 | ```
109 |
110 | ## Transliteration
111 | [Transliterator][transliterator] provides transliteration of strings:
112 |
113 | ```php
114 | transliterate($string); // garconetudiantoulecole
123 | ```
124 |
125 | [intl]: https://pecl.php.net/package/intl
126 | [intl-manual]: https://www.php.net/manual/en/intro.intl.php
127 | [intl-book]: https://www.php.net/manual/en/book.intl.php
128 | [messageformatter]: https://www.php.net/manual/en/class.messageformatter.php
129 | [collator]: https://www.php.net/manual/en/class.collator.php
130 | [transliterator]: https://www.php.net/manual/en/class.transliterator.php
131 |
--------------------------------------------------------------------------------
/docs/introduction.md:
--------------------------------------------------------------------------------
1 |
2 | # Phalcon Framework: A PHP framework built as an extension for PHP
3 |
4 | **A full-stack PHP framework delivered as a C-extension**
5 |
6 | [](https://github.com/phalcon/cphalcon/actions/workflows/main.yml)
7 |
8 | ## Mission :rocket:
9 |
10 | Our mission is to empower developers with an advanced, feature-rich tool: Phalcon. This framework is designed to facilitate the development of powerful applications with minimal server resource consumption and optimal performance.
11 |
12 | ## What is Phalcon :question:
13 |
14 | Phalcon is an open-source full-stack framework for PHP, distinguished by its unique architecture written as a C-extension. This means that it is implemented in C and directly integrated into PHP for enhanced performance.
15 |
16 | Its innovative architecture ensures that the framework is always memory-resident, providing functionality on demand without the overhead of file stats and reads typical in traditional PHP frameworks.
17 |
18 | ## Usage :memo:
19 |
20 | Phalcon is designed to be developer-friendly, and you don't need to be familiar with the C language to utilize its power. The framework's interface is exposed as PHP classes under the `Phalcon` namespace, making it accessible and easy to use.
21 |
22 | Phalcon is loosely coupled, allowing developers to use only the objects that they need as glue components based in the needs of their applications.
23 |
24 | !!! info "NOTE"
25 |
26 | The translation of the documentation is driven by enthusiasts and contributors. We invite and appreciate your participation in the translation effort. Contribute new translations or corrections via [GitHub][github_docs] for English or [Crowdin][crowdin] for other languages.
27 |
28 | You can check our [GitHub][github] project for the code and browse through these documents for usage and functionality.
29 |
30 | Since this is a community driven project, you can share your thoughts and requests for functionality you need by issuing a [New Feature Request][new-feature-request] and if you wish vote in GitHub for [existing NFRs][new-feature-request-list].
31 |
32 | Feel free to connect with us using our social media accounts:
33 |
34 |
35 |
36 | - :octicons-discussion-closed-16:{ .lg .middle } __Chat - QA__
37 |
38 | ---
39 |
40 | [:octicons-chevron-right-12: Discord Chat][discord]
41 |
42 | [:octicons-chevron-right-12: Discussions][discussions]
43 |
44 | - :octicons-question-16:{ .lg .middle } __Support__
45 |
46 | ---
47 |
48 | [:octicons-chevron-right-12: GitHub Sponsors - Support Us][github_sponsors]
49 |
50 | [:octicons-chevron-right-12: OpenCollective - Support Us][opencollective_sponsors]
51 |
52 | - :octicons-megaphone-16:{ .lg .middle } __Social Media__
53 |
54 | ---
55 |
56 | [:octicons-chevron-right-12: Telegram][telegram]
57 |
58 | [:octicons-chevron-right-12: Gab][gab]
59 |
60 | [:octicons-chevron-right-12: MeWe][mewe]
61 |
62 | [:octicons-chevron-right-12: Reddit][reddit]
63 |
64 | [:octicons-chevron-right-12: Facebook][fb]
65 |
66 | [:octicons-chevron-right-12: Twitter][t]
67 |
68 |
69 | - :octicons-video-16:{ .lg .middle } __Videos__
70 |
71 | ---
72 |
73 | [:octicons-chevron-right-12: BitChute][bitchute]
74 |
75 | [:octicons-chevron-right-12: LBRY][lbry]
76 |
77 | [:octicons-chevron-right-12: YouTube][youtube]
78 |
79 |
80 |
81 |
82 | [github]: https://github.com/phalcon/cphalcon
83 | [github_docs]: https://github.com/phalcon/docs
84 | [new-feature-request]: new-feature-request.md
85 | [new-feature-request-list]: new-feature-request-list.md
86 | [discord]: https://phalcon.io/discord
87 | [discussions]: https://phalcon.io/discussions
88 | [github_sponsors]: https://github.com/sponsors/phalcon
89 | [opencollective_sponsors]: https://phalcon.io/fund
90 | [telegram]: https://phalcon.io/telegram
91 | [gab]: https://phalcon.io/gab
92 | [mewe]: https://phalcon.io/mewe
93 | [reddit]: https://phalcon.io/reddit
94 | [fb]: https://phalcon.io/fb
95 | [t]: https://phalcon.io/t
96 |
97 |
98 | - :octicons-video-16:{ .lg .middle } __Videos__
99 |
100 | ---
101 |
102 | [:octicons-chevron-right-12: BitChute](https://phalcon.io/bitchute)
103 |
104 | [:octicons-chevron-right-12: LBRY](https://phalcon.io/lbry)
105 |
106 | [:octicons-chevron-right-12: YouTube](https://phalcon.io/youtube)
107 |
--------------------------------------------------------------------------------
/docs/mvc.md:
--------------------------------------------------------------------------------
1 | # MVC - Model View Controller
2 | - - -
3 |
4 | ## Overview
5 | Model View Controller ([MVC][wiki-mvc]) is a software architectural pattern, which divides the application logic into three interconnected elements, separating internal representations of information of the application.
6 |
7 | Phalcon offers the object-oriented classes, necessary to implement the Model View Controller in your application. This design pattern is widely used by other web frameworks and desktop applications.
8 |
9 | MVC benefits include:
10 |
11 | * Isolation of business logic from the user interface and the database layer
12 | * Making it clear where different types of code belong for easier maintenance
13 |
14 | If you decide to use MVC, every request to your application resources will be managed by the MVC architecture. Phalcon classes are written in Zephir, which is translated to C, offering a high performance implementation of the MVC pattern in PHP applications.
15 |
16 | ## Models
17 | A model represents the information (data) of the application and the rules to manipulate that data. Models are primarily used for managing the rules of interaction with a corresponding database table. In most cases, each table in your database will correspond to one model in your application. The bulk of your application's business logic will be concentrated in the models. [more...][db-models]
18 |
19 | ## Views
20 | Views represent the user interface of your application. Views are often HTML files with embedded PHP code that perform tasks related solely to the presentation of the data. Views handle the job of providing data to the web browser or other tool that is used to make requests from your application. [more...][views]
21 |
22 | ## Controllers
23 | The controllers provide the _flow_ between models and views. Controllers are responsible for processing the incoming requests from the web browser, interrogating the models for data, and passing that data on to the views for presentation. [more...][controllers]
24 |
25 | [wiki-mvc]: https://en.wikipedia.org/wiki/Model–view–controller
26 | [db-models]: db-models.md
27 | [views]: views.md
28 | [controllers]: controllers.md
29 |
--------------------------------------------------------------------------------
/docs/namespaces.md:
--------------------------------------------------------------------------------
1 | # Namespaces
2 | - - -
3 |
4 | ## Overview
5 | [Namespaces][namespaces] can be used to avoid class name collisions. This means that if you have two controllers in an application with the same name, a namespace can be used help PHP understand that they are two different classes. Namespaces are also useful when creating bundles or modules.
6 |
7 | ## Activation
8 | If you decided to use namespaces for your application, you will need to instruct your autoloader on where your namespaces reside. This is the most common way to distinguish between namespaces in your application. If you chose to use the [Phalcon\Autoload\Loader][autoload] component, then you will need to register your namespaces accordingly:
9 |
10 | ```php
11 | registerNamespaces(
14 | [
15 | 'MyApp\Admin\Controllers' => '/app/web/admin/controllers/',
16 | 'MyApp\Admin\Models' => '/app/web/admin/models/',
17 | ]
18 | );
19 | ```
20 |
21 | You can also specify the namespace when defining your routes, using the [Router][routing] component:
22 |
23 | ```php
24 | add(
27 | '/admin/invoices/list',
28 | [
29 | 'namespace' => 'MyApp\Admin',
30 | 'controller' => 'Invoices',
31 | 'action' => 'list',
32 | ]
33 | );
34 | ```
35 |
36 | or passing it as part of the route as a parameter
37 |
38 | ```php
39 | add(
42 | '/:namespace/invoices/list',
43 | [
44 | 'namespace' => 1,
45 | 'controller' => 'Invoices',
46 | 'action' => 'list',
47 | ]
48 | );
49 | ```
50 |
51 | Finally, if you are only working with the same namespace for every controller, you can define a default namespace in your [Dispatcher][dispatcher]. Doing so, you will not need to specify the full class in the router path:
52 |
53 | ```php
54 | set(
59 | 'dispatcher',
60 | function () {
61 | $dispatcher = new Dispatcher();
62 |
63 | $dispatcher->setDefaultNamespace(
64 | 'MyApp\Admin\Controllers'
65 | );
66 |
67 | return $dispatcher;
68 | }
69 | );
70 | ```
71 |
72 | ## Controllers
73 | The following example shows how to implement a controller that uses namespaces:
74 |
75 | ```php
76 | hasMany(
126 | 'inv_cst_id',
127 | Customers::class,
128 | 'cst_id',
129 | [
130 | 'alias' => 'customers',
131 | ]
132 | );
133 | }
134 | }
135 | ```
136 |
137 | In PHQL you must write the statements including namespaces:
138 |
139 | ```php
140 | '/tmp',
28 | ]
29 | );
30 |
31 | $session->setHandler($adapter);
32 |
33 | $session->start();
34 |
35 | return $session;
36 | };
37 |
38 | $container['cookies'] = function() {
39 | $cookies = new Cookies();
40 |
41 | $cookies->useEncryption(false);
42 |
43 | return $cookies;
44 | };
45 |
46 | class SomeClass extends Injectable
47 | {
48 | public function someMethod()
49 | {
50 | $cookies = $this->getDI()->getCookies();
51 |
52 | $cookies->set(
53 | 'mycookie',
54 | 'test',
55 | time() + 3600,
56 | '/'
57 | );
58 | }
59 | }
60 |
61 | $class = new MyClass();
62 |
63 | $class->setDI($container);
64 |
65 | $class->someMethod();
66 |
67 | $container['cookies']->send();
68 |
69 | var_dump($_SESSION);
70 | var_dump($_COOKIE);
71 | ```
72 |
73 | ### Database
74 |
75 | !!! info "NOTE"
76 |
77 | Remember to include the register information for your `db` service, i.e. adapter, connection parameters etc.
78 |
79 | ```php
80 | setShared(
88 | 'db',
89 | function () {
90 | return new Mysql(
91 | [
92 | 'host' => '127.0.0.1',
93 | 'username' => 'root',
94 | 'password' => '',
95 | 'dbname' => 'test',
96 | 'charset' => 'utf8',
97 | ]
98 | );
99 | }
100 | );
101 |
102 | $result = $container['db']->query('SELECT * FROM customers');
103 | ```
104 |
105 | ### Single/Multi-Module Applications
106 |
107 | !!! info "NOTE"
108 |
109 | Remember to add to the script how you are creating the `Phalcon\Mvc\Application` instance and how you register your modules
110 |
111 | ```php
112 | setDI($container);
124 |
125 | // register modules if any
126 |
127 | $response = $application->handle(
128 | $_SERVER["REQUEST_URI"]
129 | );
130 |
131 | echo $response->getContent();
132 | ```
133 |
134 | Include models and controllers as part of the test:
135 |
136 | ```php
137 | setDI($container);
151 |
152 | class IndexController extends Controller
153 | {
154 | public function indexAction() {
155 | /* your content here */
156 | }
157 | }
158 |
159 | class Users extends Model
160 | {
161 | }
162 |
163 | $response = $application->handle(
164 | $_SERVER["REQUEST_URI"]
165 | );
166 |
167 | echo $response->getContent();
168 | ```
169 |
170 | ### Micro Application
171 | For micro applications, you can use the skeleton script below:
172 |
173 | ```php
174 | handle(
188 | $_SERVER["REQUEST_URI"]
189 | );
190 | ```
191 |
192 | ### ORM
193 |
194 | !!! info "NOTE"
195 |
196 | You can provide your own database schema or even better, use any of the existing schemas in our testing suite (located in `tests/_data/assets/db/schemas/` in the repository).
197 |
198 | ```php
199 | 'localhost',
213 | 'username' => 'root',
214 | 'password' => '',
215 | 'dbname' => 'test',
216 | ]
217 | );
218 |
219 | $connection->setEventsManager($eventsManager);
220 |
221 | $eventsManager->attach(
222 | 'db:beforeQuery',
223 | function ($event, $connection) {
224 | echo $connection->getSqlStatement(), '
' . PHP_EOL;
225 | }
226 | );
227 |
228 | $container['db'] = $connection;
229 | $container['modelsManager'] = new ModelsManager();
230 | $container['modelsMetadata'] = new ModelsMetadata();
231 |
232 | if (true !== $connection->tableExists('user', 'test')) {
233 | $connection->execute(
234 | 'CREATE TABLE user (
235 | id integer primary key auto_increment,
236 | email varchar(120) not null
237 | )'
238 | );
239 | }
240 |
241 | class User extends Model
242 | {
243 | public $id;
244 |
245 | public $email;
246 |
247 | public static function createNewUserReturnId()
248 | {
249 | $newUser = new User();
250 |
251 | $newUser->email = 'test';
252 |
253 | if (false === $newUser->save()) {
254 | return false;
255 | }
256 |
257 | return $newUser->id;
258 | }
259 | }
260 |
261 | echo User::createNewUserReturnId();
262 | ```
263 |
264 | [issues]: https://github.com/phalcon/cphalcon/issues
265 | [gist]: https://gist.github.com/
266 |
--------------------------------------------------------------------------------
/docs/sponsors.md:
--------------------------------------------------------------------------------
1 | # Becoming a Sponsor
2 |
3 | For those that wish to sponsor our work and further the development of Phalcon, we offer various sponsorship options that will fit any budget. Sponsoring our work allows us to devote more time to the project, offer faster responses to bugs and features and ensure the project's stability.
4 |
5 | # Sponsors and Supporters
6 |
7 | {% include sponsors.html %}
8 |
--------------------------------------------------------------------------------
/docs/static-analysis.md:
--------------------------------------------------------------------------------
1 | # Static Analysis
2 | - - -
3 |
4 | ## Overview
5 |
6 | Using a static analysis tool in your project can dramatically increase your code quality and highlight potential bugs before they are exposed.
7 |
8 | ## Integrating Psalm with Phalcon
9 |
10 | ```bash
11 | composer require --dev vimeo/psalm
12 | ```
13 |
14 | or by manually adding it to `composer.json`:
15 |
16 | ```json
17 | {
18 | "require-dev": {
19 | "vimeo/psalm": "^4.7"
20 | }
21 | }
22 | ```
23 |
24 | ### Phalcon IDE Stubs
25 |
26 | Phalcon provides a stub library that provides support for most IDEs. Psalm requires these stubs in order to properly analyze the codebase. These files exist in the [Phalcon IDE Stubs](https://github.com/phalcon/ide-stubs) repository.
27 |
28 | You can use the IDE Stubs library by adding it as a dependency:
29 |
30 | ```bash
31 | composer require --dev phalcon/ide-stubs:^v5.0
32 | ```
33 |
34 | or by manually adding it to `composer.json`:
35 |
36 | ```json
37 | {
38 | "require-dev": {
39 | "phalcon/ide-stubs": ",^v5.0"
40 | }
41 | }
42 | ```
43 |
44 | ## Initializing Psalm
45 |
46 | Run the command `vendor/bin/psalm --init` in the root of your project to initialize Psalm. Psalm will create a default project configuration file called `psalm.xml` at the root of your project.
47 |
48 | ### Sample Configuration with Phalcon Stubs
49 |
50 | The configuration file below serves as a good base to use in your project. Replace the contents in `psalm.xml` with the contents below and update any parameters applicable to your project settings.
51 |
52 | If you find that you need to stub additional Phalcon components, add them to the stub section of the configuration with the full path to their location in the `ide-stubs` package.
53 |
54 | ```xml
55 |
56 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 | ```
96 |
97 | ### Running Psalm
98 |
99 | When you execute `vendor/bin/psalm` in your command-line, you will a get similar output depending on your errors:
100 |
101 | ```bash
102 | Scanning files...
103 | Analyzing files...
104 |
105 | ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 60 / 95 (63%)
106 | ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
107 | ------------------------------
108 | No errors found!
109 | ------------------------------
110 |
111 | Checks took 0.80 seconds and used 214.993MB of memory
112 | Psalm was able to infer types for 92.9630% of the codebase
113 | ```
114 |
115 | Fix your errors, and re-run Psalm!
116 |
117 | ## Resources
118 | - [Psalm Documentation](https://psalm.dev/docs/)
119 | - [Static Analysis with Psalm PHP](https://www.twilio.com/blog/static-analysis-with-psalm-php)
120 | - [What Is Static Code Analysis?](https://www.perforce.com/blog/sca/what-static-analysis)
121 |
--------------------------------------------------------------------------------
/docs/support-version.md:
--------------------------------------------------------------------------------
1 | # Version Component
2 | - - -
3 |
4 | ## Overview
5 | [Phalcon\Support\Version][version] is a small but handy class, that returns the current version of Phalcon installed in your system.
6 |
7 |
8 | ## Constants
9 |
10 | | Name | Value | Description |
11 | |--------------------------|:-------:|----------------------------------------|
12 | | `VERSION_MAJOR` | 0 | The major version |
13 | | `VERSION_MEDIUM` | 1 | The medium version |
14 | | `VERSION_MINOR` | 2 | The minor version |
15 | | `VERSION_SPECIAL` | 3 | The special version (alpha, beta etc.) |
16 | | `VERSION_SPECIAL_NUMBER` | 4 | The special version number |
17 |
18 | ## Methods
19 |
20 | ```php
21 | protected function getVersion(): array
22 | ```
23 | Return an array with each version part as an element.
24 |
25 | ```php
26 | getVersion);
33 | // 5.0.0RC4
34 | // [5, 0, 0, 3, 4]
35 | ```
36 |
37 | ```php
38 | protected function get(): string
39 | ```
40 | Return the version
41 |
42 | ```php
43 | get();
50 | // 5.0.0RC4
51 | ```
52 |
53 | ```php
54 | protected function getId(): string
55 | ```
56 | Return the version as a number string
57 |
58 | ```php
59 | getId();
66 | // 5000034
67 | ```
68 |
69 | [version]: api/phalcon_support.md#support-version
70 |
--------------------------------------------------------------------------------
/docs/unit-testing.md:
--------------------------------------------------------------------------------
1 | # Unit Testing
2 | - - -
3 |
4 | ## Overview
5 |
6 | Writing proper tests can assist in writing better software. If you set up proper test cases you can eliminate most functional bugs and better maintain your software.
7 |
8 | ## Integrating PHPUnit with Phalcon
9 |
10 | ```bash
11 | composer require --dev phpunit/phpunit:^9.0
12 | ```
13 |
14 | or by manually adding it to `composer.json`:
15 |
16 | ```json
17 | {
18 | "require-dev": {
19 | "phpunit/phpunit": "^9.0"
20 | }
21 | }
22 | ```
23 |
24 | Once PHPUnit is installed, create a directory called `tests` in project root directory with a subdirectory called `Unit`:
25 |
26 | ```
27 | app/
28 | src/
29 | public/
30 | tests/Unit/
31 | ```
32 |
33 | ### Configure Test Namespace
34 |
35 | In order to autoload our test directory, we must add our test namespace to composer. Add the below to composer and modify it to fit your needs.
36 |
37 | ```json
38 | {
39 | "autoload-dev": {
40 | "psr-4": {
41 | "Tests\\": "tests"
42 | }
43 | }
44 | }
45 | ```
46 |
47 | Now, create a `phpunit.xml` file as follows:
48 |
49 | ### The `phpunit.xml` file
50 |
51 | Modify the `phpunit.xml` below to fit your needs and save it in your project root directory. This will run any tests under the `tests/Unit` directory.
52 |
53 | ```xml
54 |
55 |
56 |
65 |
66 |
67 | ./tests/Unit
68 |
69 |
70 | ```
71 |
72 | ### Phalcon Incubator Test
73 |
74 | Phalcon provides a test library that provides few abstract classes you can use to bootstrap the Unit Tests themselves. These files exist in [Phalcon Incubator Test](https://github.com/phalcon/incubator-test) repository.
75 |
76 | You can use the Incubator test library by adding it as a dependency:
77 |
78 | ```bash
79 | composer require --dev phalcon/incubator-test:^v1.0.0-alpha.1
80 | ```
81 |
82 | or by manually adding it to `composer.json`:
83 |
84 | ```json
85 | {
86 | "require-dev": {
87 | "phalcon/incubator-test": "^v1.0.0-alpha.1"
88 | }
89 | }
90 | ```
91 |
92 | ## Creating a Unit Test
93 |
94 | It is always wise to autoload your classes using namespaces. The configuration below assumes that you are using PSR-4 to autoload your project classes via a composer configuration. Doing so, the autoloader will make sure the proper files are loaded so all you need to do is create the files and phpunit will run the tests for you.
95 |
96 | This example does not contain a config file, as most cases you should be mocking your dependencies. If you happen to need one, you can add to the `DI` in the `AbstractUnitTest`.
97 |
98 | ### Abstract Unit Test
99 | First create a base Unit Test called `AbstractUnitTest.php` in your `tests/Unit` directory:
100 |
101 | ```php
102 | loaded = true;
127 | }
128 |
129 | public function __destruct()
130 | {
131 | if (!$this->loaded) {
132 | throw new IncompleteTestError(
133 | "Please run parent::setUp()."
134 | );
135 | }
136 | }
137 | }
138 | ```
139 |
140 | ### Your First Test
141 |
142 | Create the test below and save it in your `tests/Unit` directory.
143 |
144 | ```php
145 | assertEquals(
156 | "roman",
157 | "roman",
158 | "This will pass"
159 | );
160 |
161 | $this->assertEquals(
162 | "hope",
163 | "ava",
164 | "This will fail"
165 | );
166 | }
167 | }
168 | ```
169 |
170 | If you need to overload the `setUp` method, it is important you call the parent or Phalcon will not properly initialize.
171 |
172 | ```php
173 | protected function setUp(): void
174 | {
175 | parent::setUp();
176 |
177 | //...
178 | }
179 | ````
180 |
181 | ### Running Unit Tests
182 |
183 | When you execute `vendor/bin/phpunit` in your command-line, you will get the following output:
184 |
185 | ```bash
186 | $ phpunit
187 | PHPUnit 9.5.23 by Sebastian Bergmann and contributors.
188 |
189 | Runtime: PHP 8.1.8 with Xdebug 3.1.5
190 | Configuration: /var/www//phpunit.xml
191 |
192 | Time: 3 ms, Memory: 3.25Mb
193 |
194 | There was 1 failure:
195 |
196 | 1) Test\Unit\UnitTest::testTestCase
197 | This will fail
198 | Failed asserting that two strings are equal.
199 | --- Expected
200 | +++ Actual
201 | @@ @@
202 | -'hope'
203 | +'ava'
204 |
205 | /var/www/tests/Unit/UnitTest.php:25
206 |
207 | FAILURES!
208 | Tests: 1, Assertions: 2, Failures: 1.
209 | ```
210 |
211 | ## Resources
212 | - [PHPUnit Documentation](https://phpunit.de/documentation.html)
213 | - [Getting Started with TDD in PHP](https://www.sitepoint.com/re-introducing-phpunit-getting-started-tdd-php/)
214 | - [Writing Great Unit Tests](https://blog.stevensanderson.com/2009/08/24/writing-great-unit-tests-best-and-worst-practises/)
215 | - [What Is Mocking In PHP Unit Testing](https://www.clariontech.com/blog/what-is-mocking-in-php-unit-testing)
216 |
--------------------------------------------------------------------------------
/docs/use-case.md:
--------------------------------------------------------------------------------
1 | # Use Case
2 |
3 | Throughout this documentation we are going to assume that we are building an accounting application.
4 |
5 | ## Requirements
6 | - MVC application using [Phalcon\Mvc\Application][application]
7 | - Store data in a database (MariaDB/MySQL)
8 | - Offer a UI for users to work
9 | - Login page
10 | - Administration area
11 | - Cache management
12 | - Permissions
13 | - Products CRUD
14 | - Users CRUD
15 | - Accounting department area
16 | - Invoices
17 | - Customers
18 | - Payments
19 | - Customer portal area
20 | - Invoices (view)
21 | - Payment
22 | - Reports
23 |
24 | ## Groups - User Roles
25 |
26 | | Group | Description |
27 | |----------------|----------------------------------------------------|
28 | | Guests | Users that are not logged in, visitors to the site |
29 | | Customers | Users that have purchased products |
30 | | Accounting | Users of the accounting department |
31 | | Managers | Accounting department managers |
32 | | Administrators | Full access to the whole application |
33 |
34 | ## Endpoints
35 |
36 | | Endpoint | Description |
37 | |-----------------------------------|--------------------------------------------------------------|
38 | | `/login` | Path `/session/login`. Presents the login screen |
39 | | `/logout` | Path `/session/logout`. Logs user out, redirects to `/login` |
40 | | `/portal/invoices/list` | List invoices for the currently logged in customer |
41 | | `/portal/invoices/view/{0-9}` | View invoice for the currently logged in customer |
42 | | `/portal/invoices/pay/{0-9}` | Pay invoice (payment gateway) |
43 | | `/portal/reports/list` | List available reports for the logged in customer |
44 | | `/portal/reports/view/{0-9}` | View report for this customer |
45 | | `/accounting/invoices/add` | Add new invoice |
46 | | `/accounting/invoices/edit/{0-9}` | Edit an invoice |
47 | | `/accounting/invoices/view/{0-9}` | View an invoice |
48 | | `/accounting/invoices/list` | List all invoices |
49 | | `/accounting/invoices/void/{0-9}` | Void an invoice |
50 | | `/admin/cache/view` | View all cache items |
51 | | `/admin/cache/delete/{0-9}` | Delete a cache item |
52 | | `/admin/cache/void` | Void the whole cache |
53 | | `/admin/permissions/list` | Show the current permissions |
54 | | `/admin/permissions/add` | Add a new permission |
55 | | `/admin/permissions/edit/{0-9}` | Edit a permission |
56 | | `/admin/products/list` | List all products |
57 | | `/admin/products/add` | Add a product |
58 | | `/admin/products/edit/{0-9}` | Edit a product |
59 | | `/admin/products/delete/{0-9}` | Delete a product |
60 | | `/admin/products/view/{0-9}` | View a product |
61 | | `/admin/users/list` | List all users |
62 | | `/admin/users/add` | Add a user |
63 | | `/admin/users/edit/{0-9}` | Edit a user |
64 | | `/admin/users/delete/{0-9}` | Delete a user |
65 | | `/admin/users/view/{0-9}` | View a user |
66 |
67 | [application]: application.md
68 |
--------------------------------------------------------------------------------
/mkdocs.yml:
--------------------------------------------------------------------------------
1 |
2 | # Project information
3 | site_name: Phalcon Documentation
4 | site_url: https://docs.phalcon.io
5 | site_author: Phalcon Team
6 | site_description: >-
7 | Phalcon Framework. A full-stack PHP framework delivered as a PHP extension,
8 | offering lower resource consumption and high performance.
9 |
10 | # Repository
11 | repo_name: phalcon/docs
12 | repo_url: https://github.com/phalcon/docs
13 |
14 | # Copyright
15 | copyright: Copyright © 2012 - present Phalcon Team
16 |
17 | # Configuration
18 | theme:
19 | name: material
20 | # custom_dir: material/overrides
21 | features:
22 | - announce.dismiss
23 | - content.action.edit
24 | - content.action.view
25 | - content.code.annotate
26 | - content.code.copy
27 | - content.code.select
28 | # - content.tabs.link
29 | - content.tooltips
30 | # - header.autohide
31 | # - navigation.expand
32 | - navigation.footer
33 | - navigation.indexes
34 | - navigation.instant
35 | - navigation.instant.progress
36 | # - navigation.prune
37 | - navigation.sections
38 | - navigation.tabs
39 | - navigation.tabs.sticky
40 | - navigation.top
41 | - navigation.tracking
42 | - search.highlight
43 | - search.share
44 | - search.suggest
45 | - toc.follow
46 | # - toc.integrate
47 | palette:
48 | - media: "(prefers-color-scheme)"
49 | toggle:
50 | icon: material/link
51 | name: Switch to light mode
52 | - media: "(prefers-color-scheme: light)"
53 | scheme: default
54 | primary: teal
55 | accent: teal
56 | toggle:
57 | icon: material/toggle-switch
58 | name: Switch to dark mode
59 | - media: "(prefers-color-scheme: dark)"
60 | scheme: slate
61 | primary: black
62 | accent: teal
63 | toggle:
64 | icon: material/toggle-switch-off
65 | name: Switch to system preference
66 | font:
67 | text: Titillium Web
68 | code: Source Code Pro
69 | favicon: assets/images/favicon.ico
70 | logo: https://assets.phalcon.io/phalcon/images/svg/phalcon-logo-white-105x40.svg
71 |
72 | # Plugins
73 | plugins:
74 | - search:
75 | separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
76 | - minify:
77 | minify_html: true
78 | - redirects:
79 | redirect_maps:
80 | 'index.md': 'introduction.md'
81 | 'loader.md': 'autoload.md'
82 | 'collection.md': 'support-collection.md'
83 | 'helper.md': 'support-helper.md'
84 | 'registry.md': 'support-registry.md'
85 | 'version.md': 'support-version.md'
86 |
87 | # Hooks
88 | #hooks:
89 | # - material/overrides/hooks/shortcodes.py
90 | # - material/overrides/hooks/translations.py
91 |
92 | # Additional configuration
93 | extra:
94 | version:
95 | default: 5.4.0
96 | provider: mike
97 | annotate:
98 | json: [ .s2 ]
99 | social:
100 | - icon: fontawesome/brands/github
101 | link: https://github.com/phalcon
102 | - icon: fontawesome/brands/twitter
103 | link: https://twitter.com/phalconphp
104 |
105 | # Extensions
106 | markdown_extensions:
107 | - admonition
108 | - attr_list
109 | - footnotes
110 | - md_in_html
111 | - pymdownx.inlinehilite
112 | - pymdownx.snippets
113 | - pymdownx.extra
114 | - pymdownx.tabbed
115 | - pymdownx.emoji:
116 | emoji_index: !!python/name:material.extensions.emoji.twemoji
117 | emoji_generator: !!python/name:material.extensions.emoji.to_svg
118 | - pymdownx.superfences:
119 | custom_fences:
120 | - name: mermaid
121 | class: mermaid
122 | format: !!python/name:pymdownx.superfences.fence_code_format
123 |
124 | - pymdownx.highlight:
125 | anchor_linenums: true
126 | extend_pygments_lang:
127 | - name: php
128 | lang: php
129 | options:
130 | startinline: true
131 | - toc:
132 | permalink: true
133 |
134 | # Page tree
135 | nav:
136 | - Home:
137 | - Introduction: introduction.md
138 | - Changelog:
139 | - Current Version: https://github.com/phalcon/cphalcon/blob/5.0.x/CHANGELOG-5.0.md
140 | - How to upgrade: upgrade.md
141 | - Contributing:
142 | - Contributions: contributions.md
143 | - Asking a question: https://phalcon.io/discussions
144 | - Requesting a change: new-feature-request.md
145 | - Issuing a Pull Request: new-pull-request.md
146 | - Guides:
147 | - Backtrace Generation: generating-backtrace.md
148 | - Reproducible Tests: reproducible-tests.md
149 | - Testing environment: testing-environment.md
150 | - Sponsoring: sponsors.md
151 | - Getting Started:
152 | - Installation: installation.md
153 | - Webserver Setup: webserver-setup.md
154 | - Environments:
155 | - Devilbox: environments-devilbox.md
156 | - Nanobox: environments-nanobox.md
157 | - Development Tools:
158 | - Devtools: devtools.md
159 | - Debug: support-debug.md
160 | - Migrations: db-migrations.md
161 | - Unit Testing: unit-testing.md
162 | - Tutorials:
163 | - Basic: tutorial-basic.md
164 | - Invo: tutorial-invo.md
165 | - REST: tutorial-rest.md
166 | - Vokuro: tutorial-vokuro.md
167 | - Use case: use-case.md
168 | - Performance: performance.md
169 | - Core:
170 | - Application: application.md
171 | - Micro: application-micro.md
172 | - CLI: application-cli.md
173 | - DI Container: di.md
174 | - MVC: mvc.md
175 | - Namespaces: namespaces.md
176 | - API Index: api/index.md
177 | - Database:
178 | - Layer: db-layer.md
179 | - PHQL: db-phql.md
180 | - ODM: db-odm.md
181 | - Models: db-models.md
182 | - Behaviors: db-models-behaviors.md
183 | - Cache: db-models-cache.md
184 | - Events: db-models-events.md
185 | - Metadata: db-models-metadata.md
186 | - Relationships: db-models-relationships.md
187 | - Transactions: db-models-transactions.md
188 | - Validators: db-models-validation.md
189 | - Pagination: db-pagination.md
190 | - Migrations: db-migrations.md
191 | - Front End:
192 | - Assets: assets.md
193 | - Flash Messenger: flash.md
194 | - Forms: forms.md
195 | - Image: image.md
196 | - HTML:
197 | - Attributes: html-attributes.md
198 | - Breadcrumbs: html-breadcrumbs.md
199 | - Escaper: html-escaper.md
200 | - Link: html-link.md
201 | - Tag Factory: html-tagfactory.md
202 | - Tag (legacy): tag.md
203 | - View: views.md
204 | - Volt: volt.md
205 | - Business Logic:
206 | - Access Control Lists: acl.md
207 | - Annotations: annotations.md
208 | - Controllers: controllers.md
209 | - Dispatcher: dispatcher.md
210 | - Event Manager: events.md
211 | - Filters: filter-filter.md
212 | - Routing: routing.md
213 | - Sessions: session.md
214 | - Url: mvc-url.md
215 | - Validation: filter-validation.md
216 | - Services:
217 | - Cache: cache.md
218 | - Config: config.md
219 | - Escaper: html-escaper.md
220 | - HTTP:
221 | - Cookies: response.md#cookies
222 | - Request: request.md
223 | - Response: response.md
224 | - Loader: autoload.md
225 | - Logger: logger.md
226 | - i18n:
227 | - Internationalization: i18n.md
228 | - Translate: translate.md
229 | - Queue: queue.md
230 | - Security:
231 | - Cryptography: encryption-crypt.md
232 | - Security: encryption-security.md
233 | - JWT: encryption-security-jwt.md
234 | - Storage: storage.md
235 | - Utility:
236 | - Collection: support-collection.md
237 | - Domain: domain.md
238 | - Helper: support-helper.md
239 | - Registry: support-registry.md
240 | - Version: support-version.md
241 | - Discussions: https://github.com/orgs/phalcon/discussions
242 | - Discussions(v6): https://github.com/phalcon/phalcon/discussions
243 | - Blog: https://blog.phalcon.io/
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | mkdocs
2 | mkdocs-material
3 | mkdocs-material-extensions
4 | mkdocs-minify-plugin
5 | mkdocs-redirects
6 | mike
7 |
--------------------------------------------------------------------------------
3 | 
26 |
27 |
28 | ## Backers
29 |
30 | Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/phalcon#backer)]
31 |
32 |
33 | 
34 |
35 |
36 |
37 | ## License
38 |
39 | This work licensed under the New BSD License. See the [LICENSE][10] file for more information.
40 |
41 | [0]: https://phalcon.io
42 | [1]: https://docs.phalcon.io
43 | [3]: https://github.com/phalcon/cphalcon
44 | [4]: https://phalcon.io/fb
45 | [5]: https://phalcon.io/t
46 | [6]: https://phalcon.io/gab
47 | [7]: https://phalcon.io/discord
48 | [8]: https://phalcon.io/discussions
49 | [9]: https://github.com/phalcon/cphalcon/blob/master/CONTRIBUTING.md
50 | [10]: https://github.com/phalcon/cphalcon/blob/master/LICENSE.txt
51 |
--------------------------------------------------------------------------------
/docs/api/index.md:
--------------------------------------------------------------------------------
1 | # API Index
2 | - - -
3 |
4 | - [Phalcon Acl](phalcon_acl.md)
5 | - [Phalcon Annotations](phalcon_annotations.md)
6 | - [Phalcon Application](phalcon_application.md)
7 | - [Phalcon Assets](phalcon_assets.md)
8 | - [Phalcon Autoload](phalcon_autoload.md)
9 | - [Phalcon Cache](phalcon_cache.md)
10 | - [Phalcon Cli](phalcon_cli.md)
11 | - [Phalcon Config](phalcon_config.md)
12 | - [Phalcon Datamapper](phalcon_datamapper.md)
13 | - [Phalcon Db](phalcon_db.md)
14 | - [Phalcon Di](phalcon_di.md)
15 | - [Phalcon Dispatcher](phalcon_dispatcher.md)
16 | - [Phalcon Domain](phalcon_domain.md)
17 | - [Phalcon Encryption](phalcon_encryption.md)
18 | - [Phalcon Events](phalcon_events.md)
19 | - [Phalcon Factory](phalcon_factory.md)
20 | - [Phalcon Filter](phalcon_filter.md)
21 | - [Phalcon Flash](phalcon_flash.md)
22 | - [Phalcon Forms](phalcon_forms.md)
23 | - [Phalcon Html](phalcon_html.md)
24 | - [Phalcon Http](phalcon_http.md)
25 | - [Phalcon Image](phalcon_image.md)
26 | - [Phalcon Logger](phalcon_logger.md)
27 | - [Phalcon Messages](phalcon_messages.md)
28 | - [Phalcon Mvc](phalcon_mvc.md)
29 | - [Phalcon Paginator](phalcon_paginator.md)
30 | - [Phalcon Session](phalcon_session.md)
31 | - [Phalcon Storage](phalcon_storage.md)
32 | - [Phalcon Support](phalcon_support.md)
33 | - [Phalcon Tag](phalcon_tag.md)
34 | - [Phalcon Translate](phalcon_translate.md)
35 |
--------------------------------------------------------------------------------
/docs/api/phalcon_application.md:
--------------------------------------------------------------------------------
1 |
2 | * [Phalcon\Application\AbstractApplication](#application-abstractapplication)
3 | * [Phalcon\Application\Exception](#application-exception)
4 |
5 |