We are moving our forum in GitHub Discussions. For questions about Phalcon v3/v4 you can visit here and for Phalcon v5 here.

Documentation - Not as high quality as the framework


I am one of those guys moving on from CodeIgniter to Phalcon and am trying to be 100% behind it. After stumbling through the "basics", I realized it took forever just to get passed the initial learning curve due to the documentation.

You do provide some nice "pre packaged" apps, but they all seem to have different configurations, setups, etc. What is included in the index file, what is an include file, and each one seems to have variations. I realize this is a benefit for being flexible to however the developer wants, but is there a defined "right way"? Is there a consistent version? Is there a pre packaged app that should be modeled after over another? (Honestly, if the answer is something like "do what you want" , the is going to pose a problem for creating a community and guidelines to follow)

Anyway, example of something tangible: On this page there is a filter available for "email", how many other filters are there?? http://docs.phalcon.io/en/latest/api/Phalcon_Http_Request.html //Returns value from $_REQUEST["user_email"] with sanitizing $userEmail = $request->get("user_email", "email");

Codeigniter has filters as well for a form validation, and if you scroll down you see all the variations in the tables http://ellislab.com/codeigniter/user-guide/libraries/form_validation.html required, matches, is_unique, alpha_numeric, alpha, etc etc all in a nice table.

I am just suggesting this is one of the hangups for people converting "easily" to Phalcon. Not everyone will have 3 weeks of determination to go through this process. For all the flaws people like to point out of CodeIgniter, their documentation and ease of use was a key ingredient of convincing people to use their code.


The second parameter of getRequest/getPost/getQuery is a filter provided by Phalcon\Filter: http://docs.phalcon.io/en/latest/reference/filter.html#types-of-built-in-filters

Thank You for the response! That is where it gets a bit taxing on my time. Trying to get to where that might be.

That was just an example of items I am stumbling on, in one section of the docs and trying to piece together what the parts are and what are my options. Just trying to help point out some of the user roadblocks from someone walking into Phalcon.

I also see this post to add comments as a todo item. Something that would help out too. http://forum.phalcon.io/discussion/809/comments-on-phalcon-docs

Personally I have always liked PHP.net's site and the comments seem as helpful as the examples