cphalcon

# Phalcon Framework

[![Latest Version][packagist-version-badge]][packagist-version-link]
[![PHP Version][php-version-badge]][packagist-version-link]
[![Total Downloads][packagist-downloads-badge]][packagist-downloads-link]
[![License][license-badge]][license-link]

[![Phalcon 5.x CI][phalcon-5x-badge]][action-5x-link]
[![Quality Gate (phalcon)][sonar-quality-badge]][sonar-link]
[![Coverage (phalcon)][sonar-coverage-badge]][sonar-link]

[![Discord][discord-badge]][discord-link]
[![Contributors][contributors-badge]][contributors-link]
[![OpenCollective Backers][oc-backers-badge]][backers-link]
[![OpenCollective Sponsors][oc-sponsors-badge]][sponsors-link]

[![5.0 Pull Requests][phalcon-5x-pr-badge]][phalcon-5x-pr-link]
[![5.0 Issues][phalcon-5x-issue-badge]][phalcon-5x-issue-link]


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](https://zephir-lang.com/) 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

### Using PIE (recommended)

[PIE](https://github.com/php/pie) is the modern PHP extension installer:

```bash
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.

```bash
pecl install phalcon
```

### From source

For detailed installation instructions you can check our [installation](https://docs.phalcon.io/latest/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:
- Clone the phalcon repo
- Checkout the tag you would like to generate docs for.
- Run `php bin/generate-api-docs.php`
- The generated `*.md` files will contain the documentation
- For publishing to the Phalcon website this [repo](https://github.com/phalcon/docs/tree/5.0/api) is used.

## Sponsors and backers

These sponsors and backers support Phalcon and Zephir. To join them, become a sponsor or a backer on [Open Collective](https://opencollective.com/phalcon) or [GitHub Sponsors](https://phalcon.io/fund).

<!-- The roster below is generated every day by the "Update backers" workflow from the phalcon/assets roster. Do not edit it by hand. -->
<!-- backers:start -->

### Sponsors

<a href="https://opencollective.com/commercesuite"><img src="https://images.opencollective.com/commercesuite/5c683c0/logo.png" alt="Commercesuite" title="Commercesuite" height="40"></a>
<a href="https://github.com/markofo"><img src="https://avatars.githubusercontent.com/u/59839390?v=4" alt="markofo" title="markofo" height="40"></a>