PeachPie - the PHP compiler and runtime for .NET and .NET Core
Clone or download
jakubmisek referencing script library improvements
- user types are mostly ignored if it is an unreachable declaration
- internal assertions and cleanup
- correct declaration of types depending on a user type
Latest commit 781b387 Nov 16, 2018

README.md


PeachPie
PeachPie Compiler

The open-source PHP compiler to .NET

We recommend using the project with caution and testing it thoroughly before utilizing PeachPie in a production environment. There may still be inconsistencies and incompatibilities with the PHP language; if you run into any issues, kindly let us know and we'll do our best to address them. Take a look at our Roadmap to see which features and extensions we still have to implement.

We are now a member of the .NET Foundation!

Continuous Integration

Service Platform Build Status
Travis CI Ubuntu Build status
MyGet Build Services Windows peachpie MyGet Build Status
Azure DevOps Windows VSTS Build Status

What is PeachPie?

PeachPie is a modern PHP compiler based on the Microsoft Roslyn compiler platform and drawing from our popular Phalanger project. It allows PHP to be executed within the .NET framework, thereby opening the door for PHP developers into the world of .NET – and vice versa.

Status and Compatibility

You can find an up-to-date status of the project in our Roadmap section. Please note that the status is dynamic; PeachPie is a work in progress, which means that the list of finished and planned features frequently changes and will be updated on a regular basis. To see the current status of compatibility with the PHP language, please refer to our Compatibility overview.

Project goals

  • Increased performance: PeachPie's extensive type analysis and the influence of Microsoft Roslyn should provide an improved performance of PHP applications and components.

  • Security: since programs run within the standardized and manageable .NET or .NET Core environment, the code is fully verifiable without any unsafe constructs. In addition, PHP applications can be distributed source-lessly for added security benefits.

  • Cross-platform development: the project compiles legacy PHP code into portable class libraries, enabling developers to build cross-platform apps and libraries for Microsoft platforms.

  • Full .NET compatibility: compiled programs run on the reimplemented PeachPie runtime, fully compatibly with the PHP runtime.

  • Both-way interoperability: the project allows for hybrid applications, where parts are written in C# and others in PHP. The parts will be entirely compatible and can communicate seamlessly, all within the .NET framework.

How to use PeachPie

There are currently two ways of using PeachPie through msbuild: in your favorite shell or in Visual Studio Code/Visual Studio 2017. Keep in mind that PeachPie is still a work in progress and we therefore recommend thorough testing before running PeachPie-powered apps in a production environment.

Visual Studio Code

We have a custom VSCode extension to make working with PeachPie compiler as comfortable as possible. The extension automatically installs all required dependencies, enables the PeachPie: Create project command, syntax error underlining and PeachPie analytics:

Peachpie Extension

To install the PeachPie extension, simply launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter: ext install peachpie-vscode. Watch the intro video to see how to work with the extension.

Command line building

Alternatively, you can also work with PeachPie on the command line. Please refer to our short introduction video to see how to run the compiler on the command line and to the Getting Started section in our documentation.

How to contribute?

We can use all the help we can get. You can contribute to our repository, spread the word about this project, or give us a small donation to help fund the development. If you believe you have valuable knowledge and experience to add to this project, please do not hesitate to contribute to our repo – your help is much appreciated.

However, please read the Contribution Guidelines first and ensure you are following them. Also, we kindly ask you to respect our Code of Conduct when posting or interacting with other users.

You can also contribute by donating a dollar or two to the development of PeachPie:

Providing feedback

If you found a bug, have a question or if you have an improvement suggestion, the easiest way of providing feedback is to post it on Gitter or submit an issue here on GitHub. We try to respond as quickly as possible.

.NET Foundation

.NET Foundation
This project is supported by the .NET Foundation.

How to get in touch?

If you have a problem or question, the easiest way is to submit an issue here. You can also follow us on Twitter or Facebook and contact us there regarding your questions or ask the community for support on Gitter, but please understand that we do not provide email support.

For partnership inquiries, commercial support or other questions, please contact us via email at info@iolevel.com.