# php-go

**Repository Path**: shirdonl/php-go

## Basic Information

- **Project Name**: php-go
- **Description**: PHP绑定golang库,让您快速在go语言里调用php,欢迎star,fork~
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://gitee.com/shirdonl/php-go.git
- **GVP Project**: No

## Statistics

- **Stars**: 91
- **Forks**: 8
- **Created**: 2019-11-29
- **Last Updated**: 2025-07-19

## Categories & Tags

**Categories**: utils

**Tags**: None

## README

# tips:作者新书《零基础Go语言算法实战》出版了，欢迎京东当当购买！
#### 免费开源代码库：https://gitee.com/shirdonl/goAlgorithms
#### （当当（🔥🔥🔥🔥🔥🔥 活动抢购中）：https://product.dangdang.com/11726270217.html
#### （京东（🔥🔥🔥🔥🔥🔥 活动抢购中）：https://item.jd.com/14101229.html
# PHP bindings for Go

这个包实现了对执行PHP脚本、导出Go变量以便在PHP上下文中使用、将Go方法接收器附加为PHP类以及返回PHP变量以便在Go上下文中使用的支持。


支持PHP 5.x and PHP 7.x 

## 编译

构建这个包需要将PHP作为库安装。对于大多数Linux系统，这通常可以在“php-embed”包或其变体中找到。
确保PHP库可用，就可以使用“go build”编译绑定，并且可以使用“go get”。

**Note**: Building against PHP 5.x requires that the `php5` tag is provided, i.e.:

```bash
go get -tags php5 gitee.com/shirdonl/php-go
```

This is due to the fact that PHP 7.x is the default build target.

## Status

Executing PHP [script files] as well as [inline strings]is supported and stable.

[Binding Go values] as PHP variables is allowed for most base types, and PHP values returned from eval'd strings can be converted and used in Go contexts as `interface{}` values.

It is possible to [attach Go method receivers] as PHP classes, with full support for calling expored methods, as well as getting and setting embedded fields (for `struct`-type method receivers).

### Caveats

Be aware that, by default, PHP is **not** designed to be used in multithreaded environments (which severely restricts the use of these bindings with Goroutines) if not built with [ZTS support](https://secure.php.net/manual/en/pthreads.requirements.php). However, ZTS support has seen major refactoring between PHP 5 and PHP 7, and as such is currently unsupported by this package.

Currently, it is recommended to either sync use of seperate Contexts between Goroutines, or share a single Context among all running Goroutines.

## Roadmap

Currently, the package lacks in several respects:

  * ZTS/multi-threading support. This basically means using Go-PHP in Goroutines is severely limited.
  * Documentation and examples, both package-level and external.
  * Performance. There's no reason to believe Go-PHP suffers from any serious performance issues in particular, but adding benchmarks, especially compared against vanilla PHP, might help.
  * Your feature request here?

These items will be tackled in order of significance (which may not be the order shown above).

## Usage

### Basic

Executing a script is simple:

```go
package main

import (
    php "gitee.com/shirdonl/php-go"
    "os"
)

func main() {
    engine, _ := php.New()

    context, _ := engine.NewContext()
    context.Output = os.Stdout

    context.Exec("index.php")
    engine.Destroy()
}
```

The above will execute script file `index.php` located in the current folder and will write any output to the `io.Writer` assigned to `Context.Output` (in this case, the standard output).

### Binding and returning variables

The following example demonstrates binding a Go variable to the running PHP context, and returning a PHP variable for use in Go:

```go
package main

import (
    "fmt"
    php "gitee.com/shirdonl/php-go"
)

func main() {
    engine, _ := php.New()
    context, _ := engine.NewContext()

    var str string = "Hello"
    context.Bind("var", str)

    val, _ := context.Eval("return $var.' World';")
    fmt.Printf("%s", val.Interface())
    // Prints 'Hello World' back to the user.

    engine.Destroy()
}
```

A string value "Hello" is attached using `Context.Bind` under a name `var` (available in PHP as `$var`). A script is executed inline using `Context.Eval`, combinding the attached value with a PHP string and returning it to the user.

Finally, the value is returned as an `interface{}` using `Value.Interface()` (one could also use `Value.String()`, though the both are equivalent in this case).

## License

All code in this repository is covered by the terms of the MIT License, the full text of which can be found in the LICENSE file.

[godoc-url]: https://godoc.org/gitee.com/shirdonl/php-go
[godoc-svg]: https://godoc.org/gitee.com/shirdonl/php-go?status.svg

[license-url]: https://gitee.com/shirdonl/php-go/blob/master/LICENSE
[license-svg]: https://img.shields.io/badge/license-MIT-blue.svg

[Context.Exec]: https://godoc.org/gitee.com/shirdonl/php-go/engine#Context.Exec
[Context.Eval]: https://godoc.org/gitee.com/shirdonl/php-go/engine#Context.Eval
[NewValue]:     https://godoc.org/gitee.com/shirdonl/php-go/engine#NewValue
[NewReceiver]:  https://godoc.org/gitee.com/shirdonl/php-go/engine#NewReceiver