cphalcon README

The project's README from github.com/phalcon/cphalcon. As one markdown file: README.md.

Phalcon Framework

Latest Version PHP Version Total Downloads License

Phalcon 5.x CI Quality Gate (phalcon) Coverage (phalcon)

Discord Contributors Phalcon Backers OpenCollective Backers OpenCollective Sponsors

5.0 Pull Requests 5.0 Issues

Phalcon is an open-source web framework delivered as a C extension for PHP, providing high performance and lower resource consumption.

A big thank you to our Backers; you rock!

Getting Started

Phalcon is written in Zephir/C with platform independence in mind. As a result, Phalcon is available on Microsoft Windows, GNU/Linux, FreeBSD and macOS. You can either download a binary package for the system of your choice or build it from source.

Installation

PIE is the modern PHP extension installer:

pie install phalcon/cphalcon

Using PECL

[!IMPORTANT] PECL has been deprecated, so users should switch to installing Phalcon with PIE. We will keep releasing on PECL until PECL is retired or v5.x reaches its end of life.

pecl install phalcon

From source

For detailed installation instructions you can check our installation page in the docs.

Generating API Documentation

Generating new documentation files for docs repository can be done using the script in bin/generate-api-docs.php. Steps:

General

Support

Social Media

Sponsors

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

OpenCollective Sponsors

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

OpenCollective Backers

License

Phalcon is open-source software licensed under the BSD 3-Clause License.

Copyright © 2011-present, Phalcon Team.

See the LICENSE.txt file for details. Additional licenses of packages that Phalcon uses, is inspired by, or has adapted are located in the 3rdparty/licenses directory.

cphalcon (phalcon/cphalcon)

Searching Database…

10.8K ·GitHub
What is this?Phalcon is an open-source web framework for PHP that is delivered as a C extension instead of plain PHP files, giving it high performance and low resource consumption.
Is it a regular PHP library or something more unusual?It is a C extension that you compile and load into the PHP interpreter (written in Zephir/C), not a Composer-only PHP package, which is what gives it its speed advantage.
What do I need on my system before installing it?You need a compatible PHP install (and a C build toolchain if compiling from source) on Windows, GNU/Linux, FreeBSD, or macOS.
Any install pitfalls I should know about?PECL installation is deprecated, so new users should switch to installing via PIE instead, since PECL support will only continue until its end of life.
Which operating systems does it actually run on?Phalcon ships binaries and builds for Windows, Linux, FreeBSD, and macOS.
Can I extend Phalcon with plugins written in plain PHP?Yes, there is a community-driven Incubator repository with plugins and classes written in PHP that extend the C-extension framework.
How is API documentation generated for the docs site?Running the bin/generate-api-docs.php script against a checked-out tag produces Markdown files that are then published to the Phalcon website repo.
What are similar projects?phpredis, fastify, webserver, yii2, Tars, fiber, homebrew-cask, go-zero
Creator
phalcon
Size
277.9 MB
Stars
10.8K
Age
14y
Commits · 90 Days