Pop PHP Framework

• Overview
• New Features
• Install
• Kettle
• Support

Release Information

Pop PHP Framework 5.4.0
Released September 10, 2024

Overview

This repository contains the composer.json file to install the full Pop PHP Framework. The core Pop PHP components and the additional components listed below will be installed:

	Components
pop-acl	pop-debug	pop-mime
pop-audit	pop-dir	pop-nav
pop-auth	pop-dom	pop-paginator
pop-cache	pop-filter	pop-pdf
pop-code	pop-form	popcorn
pop-color	pop-ftp	popphp
pop-config	pop-http	pop-queue
pop-console	pop-i18n	pop-session
pop-cookie	pop-image	pop-storage
pop-css	pop-kettle	pop-utils
pop-csv	pop-log	pop-validator
pop-db	pop-mail	pop-view

New Features

• A large number of improvements, upgrades and refactors across many components.
• Support for PHP 8.1+.
• Support for PHP <=7.4 has been deprecated.
• PHPUnit tests refactored for PHPUnit 10.0+.
• Reference the CHANGELOG.md for further details.

Top

Install

There are multiple ways you can get Pop PHP Framework into your project.

Option 1: Create a New Project

You can create a new project with the composer create-project command, which is recommended. This way, you will have access to the CLI-helper script kettle in the main project folder:

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

Option 2: Clone the Repo

You can clone this repository directly, which will also install the kettle script in the main project folder:

$ git clone https://github.com/popphp/popphp-framework.git popphp
$ cd popphp
$ composer install

Option 3: Use composer require

You can add it to an existing project with the composer require command:

$ composer require popphp/popphp-framework

Option 4: Use composer.json

You can add it your project's composer.json file:

"require": {
    "popphp/popphp-framework": "^5.4.0"
}

Top

Kettle

CLI Helper

pop-kettle

If choose to install the framework in a way that the pop-kettle CLI-helper script is not available in the main project folder (options 3 and 4), you can place a copy of the script from the vendor/popphp/pop-kettle/kettle location in the main project folder (adjacent to the vendor folder):

$ cp vendor/popphp/pop-kettle/kettle .
$ cp vendor/popphp/pop-kettle/kettle.inc.php .

Once you've copied the scripts over, you have to change the reference to the script's config file from:

    $app = new Pop\Application(
        $autoloader, include __DIR__ . '/config/app.console.php'
    );

to

    $app = new Pop\Application(
        $autoloader, include __DIR__ . '/vendor/popphp/pop-kettle/config/app.console.php'
    );

and make sure the newly copied kettle script is set to execute (755)

$ chmod 755 kettle

Top

Support

The best way to directly interact with Pop PHP is here on GitHub. You can:

• Contribute code
• Request a feature
• Report an issue

but please do so under the pertinent repository related to the topic at hand.

Besides interacting with the various repositories here on GitHub, there are a few other ways to participate in the Pop PHP community:

• Slack
• Discord
• X

Top