Phalcon API reference

Question

Phalcon API reference

Eugene Jul '13

Created Jul '13	Last Reply Jun '14	Replies 8	Views 1464	Votes 4

Eugene 29.4k

Jul '13

Let me introduce you the application of Phalcon API reference https://phalcon.agent-j.ru/

This is not a release yet, consider it as a preview, so I will gladly accept your comments.

This application was developed using the Phalcon. Backend part is console app which parse the Phalcon C-sources to generate API docs.

Restrictions:

generator uses PHP ReflectionClass, so its possible to generate API only for currently installed Phalcon version
there are no default values for methods arguments
there are no properties descriptions 'cause they are absent in the sources

Roadmap:

host the sources on GitHub
improve the parser to get rid of ReflectionClass
some more improve parser to get default values for methods arguments
multilingual support
UPD: search for methods and properties

4

jeffreycahyono · Answer 1 · 2013-07-31T05:52:42-07:00

Whoaaa nice work Agent-J! It would be nice if the quick search also search the public methods& property classes. Or using the @ style like sublime Ctrl+P.For example if I typed "[email protected]" the quick search result should also display the getControllerName and setControllerName method, so that i can click and goes to the explanation of the getControllerName method directly. The method summary should have complete return type and also parameters description. is the =? in method parameter means it is optional?

Nikolaos Dimopoulos · Answer 2 · 2013-07-31T06:19:14-07:00

Nikolaos Dimopoulos
39.3k

Jul '13

Beautiful work!!!

Eugene · Answer 3 · 2013-07-31T08:05:37-07:00

Thanks!

"= ?" in method parameter means they are optional, but their default value not available for now in the docs. But the next version of ApiReference app will include this info

Eugene · Answer 4 · 2013-07-31T08:24:38-07:00

Give me please your opinion: Is there a need to display the data type for the properties and methods in the summary table? https://i.imm.io/1ef0W.png

You can see it here https://phalcon.agent-j.ru/en/1.2.1/Phalcon/Acl/Adapter/Memory#properties-summary

Nikolaos Dimopoulos · Answer 5 · 2013-07-31T09:01:02-07:00

Nikolaos Dimopoulos
39.3k

Jul '13

My vote is to display it - makes the documentation more thorough.

Roman O · Answer 6 · 2013-07-31T09:54:40-07:00

Roman O
13.8k

Jul '13

multilingual support Where the Russian language? :)

Vladimir Gerasimov · Answer 7 · 2013-07-31T11:44:39-07:00

romanlex, do you really need russian? Keeping an API in English is a good practice, especially because it changes from time to time (usually when new version of phalcon released and new features added)