Book Image

Learning Phalcon PHP

Book Image

Learning Phalcon PHP

Overview of this book

Related Content you might be interested in

Current Title:

Small book image
Learning Phalcon PHP
Aug, 2015 | 328 pages
No titles found
Table of Contents (17 chapters)
Learning Phalcon PHP
Learning Phalcon PHP
Credits
Credits
About the Author
About the Author
About the Reviewers
About the Reviewers
www.PacktPub.com
www.PacktPub.com
Preface
Preface
Free Chapter
1
Getting Started with Phalcon
Getting Started with Phalcon
Installing the required software
Installing Phalcon
The Apache and Nginx configuration files
Understanding the framework's internals
Summary
2
Setting Up the MVC Structure and the Environment for Our Project
Setting Up the MVC Structure and the Environment for Our Project
What is MVC?
The MVC structure
Creating the structure for our project
Creating the configuration file and the Bootstrap
Preparing the initial DI interface and the router
Using the router component in a module
Create the base layout
Summary
3
Learning Phalcon's ORM and ODM
Learning Phalcon's ORM and ODM
The main differences between SQL and NoSQL databases
Connecting to the database
ORM/ODM operations (create, update, delete, transactions, and validations)
CRUD operations using ORM
Using PHQL
Using raw SQL
Database transactions
ODM/MongoDB
ORM – drawbacks and caching
Summary
4
Database Architecture, Models, and CLI Applications
Database Architecture, Models, and CLI Applications
The database architecture
Models
Summary
5
The API Module
The API Module
Using APIs – recommended practices
Enabling SSL on our local machine
Creating the module structure
Writing a fully functional REST module with Phalcon PHP
Securing an API
Documenting the API
Summary
6
Assets, Authentication, and ACL
Assets, Authentication, and ACL
Assets management
Developing an authentication system
Securing the application using the ACL component
Summary
7
The Backoffice Module (Part 1)
The Backoffice Module (Part 1)
Editing the main layout
Cleaning the Core module
Hashtag CRUD
Category CRUD
Summary
8
The Backoffice Module (Part 2)
The Backoffice Module (Part 2)
User CRUD
User templates
Article CRUD
Summary
9
The Frontend Module
The Frontend Module
The Frontend layout and basic functionality
Modifying BaseController.php
Implementing ElasticSearch
Implementing MongoDB
Summary
10
Going Further
Going Further
Uploading files with Phalcon
Using the Annotation router
Summary
Index
Index

Documenting the API

Documentation is probably one of the most important things you should spend time on. When I discovered Phalcon, the first thing that I did was to develop a simple API. When I needed to create documentation for my API, I found myself in a strange situation; there were just a few solutions out there, and most of them had dependencies. This was back in the summer of 2013 or so.

So, I decided to create my own API documentation generator, without any dependencies—just pure PHP. I am going to use this tool (it is publicly available on GitHub at https://github.com/calinrada/php-apidoc) to create and generate the API documentation for our project.

Installation

You should already have it, because I was using the extractor from it to generate comments for the CLI tasks. If you missed it, you can do it in two easy steps:

$ php composer.phar require crada/php-apidoc
$ php composer.phar update

Usage

We'll perform a couple of steps to properly understand the usage:

  1. Let's create a new CLI...

Previous Section
End of Section 7
Next Section