Jump to content

[resource] PrestaShop 1.3 API documentation


Recommended Posts

Hi everyone!
I've tried summing up my findings about PrestaShop basic classes before, but describing even one class was taking very long time, so I tried a different approach.
Using PHP's Reflection API, we can get a lot of information about any given class. So I used this API to generate documentation. The comments in code were also parsed so that documentation would be more complete (return values, parameters).
Now, because it was generated automatically, it would sometimes guess parameter type (integer, array, boolean, etc.) wrong, and I will of course be fixing these manually.
But it's kind of helpful even now as it is.
Anyway, visit my blog to see it. I'll appreciate all comments and requests you may have.
Cheers!

P.S.: I anticipate some questions so I'll answer them right away:
1) No, the documentation is not generated on the fly, it was pre-generated and later added as news entries.
2) Using filter you can filter out the methods or properties you don't need (eg. show "public" methods only). To reset the filter, click the active button again.
3) Click "show" button at the end of each method description to show its source code.
4) The documentation is for the latest RC 7 version of PrestaShop.

Link to comment
Share on other sites

  • 1 month later...
×
×
  • Create New...