Official Phalcon Documentation
Home Page: https://docs.phalcon.io
License: Other
Phalcon Framework
| Standard | Description |
|---|---|
 |
Phalcon\Logger\Logger |
 |
Phalcon\Autoloader |
 |
Phalcon\Http\Message |
 |
Phalcon\Container\Container |
 |
Coding Standard |
 |
Phalcon\Html\Tag\Link |
 |
Phalcon\Cache\Cache |
| Standard | Description |
|---|---|
 |
Caching Interface |
 |
Event Dispatcher |
 |
HTTP Handlers |
 |
Phalcon\Http\Message |
 |
HTTP Client |
cphalcon
The documentation of the Phalcon\Mvc\Model\Query\Builder class's columns() method is minimal:
Sets the columns to be queried
As suggested by https://docs.phalcon.io/4.0/fr-fr/db-phql, more precisely:
columns - array | string - columns to select
There are examples which hint about valid arguments. Here is another example I found:
->columns("CQLC\Models\Notifications.*")
$validation = new Validation();
$validation->add(
['obj_name', 'obj_type'],
new Uniqueness(
[
'except' => [
'obj_name' => 'Phalcon 2',
'obj_type' => 3,
],
]
)
);
We allow excepts like above but currently it's not documented.
A google result that points to: https://docs.phalcon.io/4.0/en/request
Redirects to:
https://docs.phalcon.io/4.0/en/latest
Then:
https://docs.phalcon.io/4.0/en/latest/latest
And so on...
This is the HTML code of the response
</html>
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Redirecting...</title>
<link rel="canonical" href="[introduction/](https://docs.phalcon.io/4.0/en/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/latest/introduction/)">
<meta name="robots" content="noindex">
<script type="40f3ffd8f1a388e8749b5a2e-text/javascript">var anchor=window.location.hash.substr(1);location.href="latest/"+(anchor?"#"+anchor:"")</script>
<meta http-equiv="refresh" content="0; url=latest/">
</head>
<body>
Redirecting...
<script src="[/cdn-cgi/scripts/7d0fa10a/cloudflare-static/rocket-loader.min.js](https://docs.phalcon.io/cdn-cgi/scripts/7d0fa10a/cloudflare-static/rocket-loader.min.js)" data-cf-settings="40f3ffd8f1a388e8749b5a2e-|49" defer></script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v84a3a4012de94ce1a686ba8c167c359c1696973893317" integrity="sha512-euoFGowhlaLqXsPWQ48qSkBSCFs3DPRyiwVu3FjR96cMPx+Fr+gpWRhIafcHwqwCqWS42RZhIudOvEI+Ckf6MA==" data-cf-beacon='{"rayId":"83b620dd3a1cba74","version":"2023.10.0","token":"359d3a5d34364ab7a64449d1a12ed6f4"}' crossorigin="anonymous"></script>
</body>
</html>Most of the documents bring code snippets. Considering that full file examples would take a lot of space in the documents and make them complex, a new repository with running examples per main classes would be a useful complement to them. The documentation could make direct reference to them. The users can clone the repository and run the examples in his/her local environment to have fully running demos of the code cited in the docs.
Describe the bug
Removed method Phalcon\Model\Manager::registerNamespaceAlias() is used in PHQL documentation.
Expected behavior
Documentation should be updated.
According to doc https://docs.phalcon.io/4.0/en/devtools:
config.php for phalcon devtools usage should be:
return new \Phalcon\Config([
'database' => [
'adapter' => 'Mysql',
'host' => 'localhost',
'username' => 'root',
'password' => '',
'dbname' => 'test',
'charset' => 'utf8',
],
It seems that the right doc is:
return new \Phalcon\Config([
'database' => [
'adapter' => 'Mysql',
'options' => [
'host' => 'localhost',
'username' => 'root',
'password' => '',
'dbname' => 'test',
'charset' => 'utf8',
],
],
My organization is re-evaluating its usage of Phalcon. One concern which came up is security support for the version which some of our components are currently using, version 3. According to Phalcon 3.0's release announcement, version 3.0 was supported for a "long term" of 3 years (which was possibly until 2019-07-29).
However, there is no such information in the announcements of versions 3.1, 3.2, 3.3 or 4.0 (and there was apparently no announcement of 3.4). I cannot see any indication, in the documentation or elsewhere, that Phalcon has security support, even for version 4. I cannot find any security support policy or explanation of a version lifecycle.
The page documenting Phalcon\Http for Phalcon 4.0 contains one table at the start of each class/interface. The vast majority of these, such as the first one, are broken (whether in Google Chrome or Firefox 90), as can be seen in the following screenshot:
Start to update after this ones will be merged:
I spent at least 20 minutes trying to understand the methods described in the Models page before finally finding a "Creating Models" section, 30 screens down. The frustration from that realization got me to carefully look at the page and notice discreet but strange horizontal grey lines at the left. When I explored them with the mouse, I fortunately realized that Phalcon's documentation already had the page-specific tables of contents (TOC-s) I had been missing since I started reading Phalcon's documentation, about 1 man-hour earlier.
When the mouse cursor slowly goes over the viewport's leftmost centimeter, a TOC showing all sections of the currently displaying page appears, for as long as the cursor stays in the area it occupies. When the cursor leaves the area, the TOC retracts back as if it would hide in the page's left edge. It seems impossible to display this TOC without using the cursor (although deficient keyboard accessibility seems to be a general issue).
This TOC has by far the lowest discoverability to usefulness ratio I have ever seen. One would never expect to find a SECTIONS TOC with such a behavior considering that:
click the "Documentation" and you will always be redirected Looks like it's the same as #5
I have this still in my history and went to it
https://docs.phalcon.io/5.0/en/volt
Causing it to redirect back onto itself
https://docs.phalcon.io/5.0/en/latest/latest/latest/latest/latest/
Validation option cancelOnFail is not presented in the docs.
Related: phalcon/cphalcon#1540
Methods in phalcon 3 look different and are less readable than methods in phalcon 4.
In phalcon 3 methods are a plain 'p' tag:
While this is how methods looks in phalcon 4:
maybe it would be nice to tell on the Devilbox Environment Page that Phalcon and PSR are not enabled by default and has to be enabled in .env file at PHP_MODULES_ENABLE=psr, phalcon
With
Phalcon\Mvc\View
echo will produce this error:
Object of class Phalcon\Mvc\View could not be converted to string
Only php use Phalcon\Mvc\View\Simple can be used combined with echo.
The following examples also produce an error:
// 'views-dir/index.phtml'
echo $this->view->render('index'); //returns error: Wrong number of parameters
// 'views-dir/posts/show.phtml'
echo $this->view->render('posts/show'); //returns error: Wrong number of parameters.
//Apparently only works with the format:
$this->view->render("posts", "show")
[...] Haven't checked the ones with the models
// Phalcon\Mvc\View
$view = new View();
echo $view->render('invoices', 'view', $params); //This one works but without `echo`
I've tested with PHP 7.4, Phalcon 4.1, both in Windows 10 and Ubuntu 20.04.
If the errors are validated by dev team, I can make the changes in the docs.
The messages should be appended to the validator using messageFactory method:
$validator->appendMessage(
$this->messageFactory($message, $attribute)
);
Location of the bug: https://docs.phalcon.io/4.0/en/validation#custom-validators
The Methods section of Phalcon\Config's documentation describes path():
public function path( string $path, mixed $defaultValue = null, mixed $delimiter = null ): mixed | null;Returns a value from current config using a dot separated path.
It would greatly help to properly specify that method, indicating what value is returned.
By the way, if that is how values are obtained, renaming to something like "get" would surely clarify.
Not always and not to obvious that primary key is required to find and row and make UPDATE of it, instead of INSERT.
Related: phalcon/cphalcon#15046
Can you guys write a better Release documentation for Phalcon? Most importantly, The Release Cycle and Development Phase. Like how long it takes for example between beta's for a new release? Monthly, Every-3-Months or Yearly etc... This will help everyone involved to at least have some idea on how slow or fast Phlacon development process are going. And please don't say, "When its ready..." this is not helpful. See [1] as a very good example. I don't expect you to strickly stick to this schedule, but at least it will give a better idea of what to expect. Thank you!
[1] Example: https://www.xfce.org/about/releasemodel
Currently there are many options documented which just doesn't work - https://docs.phalcon.io/4.0/pl-pl/db-models#disablingenabling-features
https://github.com/phalcon/cphalcon/blob/master/phalcon/Mvc/Model.zep#L2825
Some of them like enableImplicitJoins, escapeSqlIdentifiers are used somewhere else like Phalcon\Db\ AbstractDb::setup()
Some of them like astCache, cacheLevel are not set, astCache is not even used in a whole project.
Docs needs to be updated for this, and code in phalcon changed as well.
Hello,
in docs for the version 3.4, the pages
Environments - Phalcon Compose (Docker) and
Environments - Phalcon Box (Vagrant)
both redirect to the page
Environments - Nanobox
In docs for the version 4.0, the redirecting pages are not even there, so I presume it is connected to their removal from 3.4.
I suggest either reinstating the pages (preferrable for me as I wanted to install Phalcon via Docker) or removing them from the navigation.
Thank you.
Please review the getting started guide:
Due to the fact that current benchmarks is outdated and it was removed from the docs we need new benchmarks. I believe that the URL of benchmark page should be the same as before.
I took a crack at it here in my Webird caddy branch. I'm sure that its not optimized, tight and sexy yet.
https://github.com/perchlayer/webird/blob/caddy/app/phalcon/common/views/simple/caddy/dev.volt
Here is a response that I received from the forum a while ago. I think that this could help.
https://caddy.community/t/i-have-no-idea-how-to-convert-this-nginx-fastcgi-setup-to-caddy/2156/2
I should be able to get to this in the next 3-6 weeks.
We need better phalcon release cycle documentation. [1] I know every developer always says "When its ready!" but we need a general understanding of when Alpha is released, or when is Stable version is released. Like 1-3 months or 1-3 years, you get the idea. For example you can explain what Alpha or Stable version process is in Phalcon develpment and how often it is released. No one is expecting to see exact dates. But even saying alpha releases every month will be enought ^_^ Maybe even including some sort of release cycle map that phalcon uses similar to [1] Also a better explanation of "End-of-Life" phalcon versions [2] is apreceated.
Example Releases;
[1] https://en.wikipedia.org/wiki/Software_release_life_cycle
[2] https://en.wikipedia.org/wiki/End-of-life_(product)
https://docs.phalcon.io/4.0/en/db-odm
We are providing support of Mongo, since v4, via composer package - https://github.com/phalcon/incubator-mongodb
In documentation on Tutorial ->Basic Page is videotutorial for Phalcon 3.x. Need to record and update videotutorial for Phalcon 4. Since some things was changed
The BASE_PATH in Phalcon tutorial https://docs.phalconphp.com/en/3.4/tutorial-base is inaccurate.
define('BASE_PATH', dirname(__DIR__));
Based on directory structure used with index.php in public dir BASE_PATH should be
define('BASE_PATH', dirname(__DIR__ . '/..'));
I recently upgraded to 4.0.4 and have noticed a number of errors in the documentation here: https://docs.phalcon.io/4.0/en/db-layer#create-1
Most importantly, the second parameter schema for all db operations is null in the documentation, but that causes a fatal error.
For example:
PHP Fatal error: Uncaught TypeError: Argument 2 passed to Phalcon\\Db\\Adapter\\AbstractAdapter::modifyColumn() must be of the type string, null given
I was able to fix this by simply passing "" an empty string as the second param.
Forms page do not contain any information about useful option of validators 'allowEmpty'.
The top line in the header at the top of all pages on the Phalcon Documentation website contains a link to the documentation's source repository with a Git icon:
This link's target is https://github.com/phalcon/docs, which redirects to https://github.com/phalcon-orphanage/docs, an archived repository which does not cover Phalcon versions beyond 5.0.
This link target may be appropriate for old versions, but the repository for the documentation of current versions is this one (https://github.com/phalcon/documentation).
On this page: https://docs.phalconphp.com/3.4/en/views#simple-rendering, in the 3rd code block that demonstrates how to use render(), it references $this->view from a controller. By default that will be \Phalcon\Mvc\View - whose render() function accepts different arguments.
This is misleading as, when one reads this one assumes that $this->view->render() can accept a string argument, when in fact it can only accept controller & action arguments.
I recommend the code be updated from (for example)
echo $this->view->render('posts/show');to
$SimpleView = new SimpleView();
echo $SimpleView->render('posts/show');to be clearer that this code block is referring to the SimpleView functionality.
The documentation of Phalcon\Mvc\Model\Resultset pretty much says that serialize() returns "a big array":
Serializing a resultset will dump all related rows into a big array
As one may guess, this is in fact incorrect, as behavior shows it returns a string, as its synopsis indicates:
public function serialize(): string;
It would help to make the documentation more formal.
Very easy to get buried in the installation docs: https://phalcon.io/en-us/download/linux
Amazon Linux does not appear to be covered...
I had to follow: https://stackoverflow.com/questions/56623885/how-to-install-phalcon-php-on-amazon-linux
I'm thinking there should be an official "installer" repo so issues can be opened related to installation, and to smooth out the bumps in the installation process to make it much easier to follow, and less prone to issues during installation.
I'll work on trying to implement this...
From @dafa168 on August 10, 2014 6:30
Many of the examples listed in the manual, but specifically where to put the code to run it?
Only able to specify where you want the code to run through, and then the specific needs which depend on the ease of reading a written
So please indicate the manual sample code can be run under the location.
Thank you!
Copied from original issue: phalcon/cphalcon#2692
We need a better table of release history in wikipedia [1], there dates and possibly changes or simply links to changelogs. Here is an example of PHP release history [2]
[1] https://en.wikipedia.org/wiki/Phalcon_(framework)
[2] https://en.wikipedia.org/wiki/PHP#Release_history
For now I'm parking this NFR here. Not sure if it really need to be a docs as well but that's something we can discuss.
The idea is to create a video tutorial that will show how to create a basic api with a good looking datatable frontend builded with Vuetify. It should be easy to follow for non experienced users. The basic flow can look something like this.
Video 1
Step 1
Initialise new basic micro application with a MySql database. The needed services should be easy to setup. Thinking about using docker containers in combination with docker-compose.
Step 2
Create a table + model with some basic columns. Table can be created with phpmyadmin. Devtools can be used to generate the model.
Step 3
Create a controller + route that uses the model to retrieve all the records and return a json string on specified route. It should be a GET request so users can easily test this in the browser.
Step 4
Setup a new Nuxt project and run show basic project in browser.
Step 5
Add datatable to nuxt project and connect it to the api endpoint to retrieve all the records.
End Video 1. Sum what we did tell about are next steps.
Video 2
Step 6
Discuss problem with large dataset and use database seeder to insert a large dataset into the database and show loading / memory issues.
Step 7
Introduce paginator in controller. Add get params like page, number of items etc. Test in browser manually.
Step 8
Implement pagination in datatable and show issue with sorting (client side will only sort the items loaded).
Step 9
Implement sorting in controller and test sorting in browser.
Step 10
Implement server side sorting in datatable.
End video 2.
Video 3
Not part of this scope but will introduce content editing and testing your application.
Video 4
Not part of this scope but will introduce full crud and searching.
Video 5
Not part of this scope but will introduce authentication.
Hi Guys,
There is a mistake in a code example on the docs page https://docs.phalcon.io/5.6/datamapper/
use Phalcon\DataMapper\Connection;instead
use Phalcon\DataMapper\Pdo\Connection;Damn it! But I can't find the place to fix it :)
"[phalcon]" section is wrong. According to that description, you will get:
Error: Builder doesn't know where is the models directory.
We can change "[phalcon]" to "[application]", that will solve the problem.
The Models page defines an Invoices class:
<?php
namespace MyApp\Models;
use Phalcon\Mvc\Model;
class Invoices extends Model
{
}
<?php
use MyApp\Models\Invoices;
$invoice = new Invoices();
$invoice->inv_cst_id = 1;
$invoice->inv_status_flag = 1;
$invoice->inv_title = 'Invoice for ACME Inc.';
$invoice->inv_total = 100;
$invoice->inv_created_at = '2019-12-25 01:02:03';
$result = $invoice->save();
if (false === $result) {
echo 'Error saving Invoice: ';
$messages = $invoice->getMessages();
foreach ($messages as $message) {
echo $message . PHP_EOL;
}
} else {
echo 'Record Saved';
}
The class name is plural (Invoices), but the second code fragment shows an instance of the Invoices class represents a single invoice.
I imagine the class was named "Invoices" because it corresponds to a database table named Invoices, but this could confuse readers and does not provide a good example, since class names which represent a single object are singular in object-oriented languages.
I recommend to either:
Hi,
I want to fix style of tags, but cant find assets/stylesheets for documentation. Is there a way to do that?
It is a --md-primary-fg-color css variable and its used for header too. Maybe to set a new one only for links and make them more visible.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.