popphp/popphp-tutorial

Tutorial Application for Pop PHP Framework

4.0.1 2024-03-05 15:30 UTC

Requires

• php: >=8.1.0
• popphp/pop-console: ^4.2.1
• popphp/pop-db: ^6.5.3
• popphp/pop-form: ^4.1.0
• popphp/pop-http: ^5.0.8
• popphp/pop-kettle: ^2.3.2
• popphp/pop-session: ^4.0.0
• popphp/pop-view: ^4.0.0
• popphp/popphp: ^4.2.8

BSD-3-Clause

• Nick Sagona

• framework
• application
• php framework
• tutorial
• pop
• pop php

README

• Overview
• Install
• Basic Usage
• Notes

Overview

This is a basic tutorial application for the Pop PHP Framework to demonstrate how to wire up some simple routes for a web-facing application and a CLI-based application.

Top

Install

Create a new project with it:

$ composer create-project popphp/popphp-tutorial project-folder

Or clone the repository and install it:

$ composer install

Once installed, the web access point is at public/index.php and the main CLI access point is at script/pop

Permissions

You must change the permissions of the database folder and script/pop file to writable in order for the application to fully work.

Top

Basic Usage

Web

Start the web server by running:

$ ./kettle serve

And then access the web application at these address:

http://localhost:8000/

You should see the main home page with comment form at the bottom. You can submit a comment and see it added to the list of comments on the page.

Console

Setting the script/pop script to be executable, you can test the CLI application like this:

$ ./script/pop help
$ ./script/pop show
$ ./script/pop delete

The first command shows the help screen; the second command shows any comments that have been posted; the third command allows you to select a post to delete.

Top

Notes

• The tutorial application uses the pop-db component to store the comments in a small SQLite database.
• The tutorial application uses the pop-form component to create, render and validate the comment form.
• The web application has a view folder, app/view, that holds the view scripts for web page display.
• The web application is utilizing the pop-http component to leverage the HTTP request and response objects within the controller object.
• The CLI application is utilizing the pop-console component to leverage it for parsing the CLI requests and returning the appropriate responses to the CLI.

Top