Phalcon is an open-source, full-stack web framework for PHP, focused on high performance, low overhead and a clean, expressive API.
Important
This repository is the pure PHP implementation of Phalcon (v6). Unlike cphalcon, it is not a C extension: there is nothing to compile and no PECL/PIE installation required - just add it to your project with Composer. Phalcon v6 is currently in alpha; APIs may change before the stable release.
A big thank you to our Backers; you rock!
Phalcon is written in plain PHP with portability in mind, so it runs anywhere a supported PHP runtime is available - GNU/Linux, FreeBSD, macOS and Microsoft Windows.
- PHP
>= 8.1 < 9.0 ext-fileinfo,ext-json,ext-mbstring,ext-pdo,ext-xml
Optional extensions enable additional adapters and features:
| Extension | Used by |
|---|---|
ext-apcu |
Cache\Adapter\Apcu, Storage\Adapter\Apcu |
ext-gd |
Image\Adapter\Gd |
ext-igbinary |
Storage\Serializer\Igbinary |
ext-imagick |
Image\Adapter\Imagick |
ext-memcached |
Cache\Adapter\Libmemcached, Session\Adapter\Libmemcached, Storage\Adapter\Libmemcached |
ext-openssl |
Encryption\Crypt |
ext-pcntl |
Queue\Consumer\Worker |
ext-redis |
Cache\Adapter\Redis, Session\Adapter\Redis, Storage\Adapter\Redis |
ext-yaml |
Config\Adapter\Yaml |
Install the framework with Composer:
composer require phalcon/phalconWhile v6 is in alpha you may need to allow pre-release versions:
composer require phalcon/phalcon:^6.0@alphaFor detailed instructions see the installation page in the docs.
API documentation for the docs repository can be generated with the script in
bin/generate-api-docs.php:
- Clone the phalcon repository.
- Check out the tag you would like to generate docs for.
- Run
php bin/generate-api-docs.php. - The generated
*.mdfiles contain the documentation, ready for publishing to the Phalcon docs repository.
Tests run with PHPUnit:
composer test-unit # unit tests
composer test-db-mysql # MySQL database tests
composer test-db-pgsql # PostgreSQL database tests
composer test-db-sqlite # SQLite database tests
composer test-all # everythingStatic analysis and coding standards:
composer analyze # PHPStan
composer cs # PHP_CodeSniffer (PSR-12)- Contributing to Phalcon
- Official Documentation
- Incubator - community-driven plugins and classes that extend the framework
Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]
Support us with a monthly donation and help us continue our activities. [Become a backer]
Phalcon is open-source software licensed under the MIT License.
Copyright © 2020–present, The Phalcon PHP Framework.
See the LICENSE file for details.
