frankenphp

Dec 18, 2025

Changes in this version

+ func CallPHPCallable(cb unsafe.Pointer, params []interface{}) interface

+ func IsPacked(arr unsafe.Pointer) bool

type Option

+ func WithHotReload(topic string, hub *mercure.Hub, patterns []string) Option

type WorkerOption

+ func WithWorkerMercureHub(hub *mercure.Hub) WorkerOption

Nov 25, 2025

Changes in this version

type WorkerOption

+ func WithWorkerRequestOptions(options ...RequestOption) WorkerOption

Nov 21, 2025

Changes in this version

+ var ErrInvalidContentLengthHeader = ErrRejected

+ var ErrInvalidRequestPath = ErrRejected

+ var ErrMaxWaitTimeExceeded = ErrRejected

+ func GoValue[T any](zval unsafe.Pointer) (T, error)

+ func PHPValue(value any) unsafe.Pointer

+ func WithExtensionWorkers(name, fileName string, numThreads int, options ...WorkerOption) (Workers, Option)

+ type ErrRejected struct

+ func (e ErrRejected) Error() string

type Option

+ func WithContext(ctx context.Context) Option

type RequestOption

+ func WithMercureHub(hub *mercure.Hub) RequestOption

type WorkerOption

+ func WithWorkerMaxThreads(num int) WorkerOption

+ func WithWorkerOnReady(f func(int)) WorkerOption

+ func WithWorkerOnServerShutdown(f func()) WorkerOption

+ func WithWorkerOnServerStartup(f func()) WorkerOption

+ func WithWorkerOnShutdown(f func(int)) WorkerOption

+ type Workers interface

+ NumThreads func() int

+ SendMessage func(ctx context.Context, message any, rw http.ResponseWriter) (any, error)

+ SendRequest func(rw http.ResponseWriter, r *http.Request) error

Aug 28, 2025

Changes in this version

+ func GoMap(arr unsafe.Pointer) map[string]any

+ func GoPackedArray(arr unsafe.Pointer) []any

+ func PHPAssociativeArray(arr AssociativeArray) unsafe.Pointer

+ func PHPMap(arr map[string]any) unsafe.Pointer

+ func PHPPackedArray(slice []any) unsafe.Pointer

+ type AssociativeArray struct

+ Map map[string]any

+ Order []string

+ func GoAssociativeArray(arr unsafe.Pointer) AssociativeArray

Jul 18, 2025

Changes in this version

+ func PHPArray(arr *Array) unsafe.Pointer

+ type Array struct

+ func GoArray(arr unsafe.Pointer) *Array

+ func (arr *Array) Append(value interface{})

+ func (arr *Array) At(index uint32) (PHPKey, interface{})

+ func (arr *Array) Len() uint32

+ func (arr *Array) SetInt(key int64, value interface{})

+ func (arr *Array) SetString(key string, value interface{})

+ type PHPKey struct

+ Int int64

+ Str string

+ Type PHPKeyType

+ type PHPKeyType int

+ const PHPIntKey

+ const PHPStringKey

Jul 1, 2025

Changes in this version

+ func GoString(s unsafe.Pointer) string

+ func PHPString(s string, persistent bool) unsafe.Pointer

+ func RegisterExtension(me unsafe.Pointer)

+ type WorkerOption func(*workerOpt) error

+ func WithWorkerEnv(env map[string]string) WorkerOption

+ func WithWorkerMaxFailures(maxFailures int) WorkerOption

+ func WithWorkerWatchMode(watch []string) WorkerOption

May 16, 2025

Changes in this version

+ var ErrAlreadyStarted = errors.New("FrankenPHP is already started")

+ var ErrInvalidPHPVersion = errors.New("FrankenPHP is only compatible with PHP 8.2+")

+ var ErrInvalidRequest = errors.New("not a FrankenPHP request")

+ var ErrMainThreadCreation = errors.New("error creating the main thread")

+ var ErrMaxThreadsReached = errors.New("max amount of overall threads reached")

+ var ErrNotRunning = errors.New(...)

+ var ErrRequestContextCreation = errors.New("error during request context creation")

+ var ErrScriptExecution = errors.New("error during PHP script execution")

+ func ExecutePHPCode(phpCode string) int

type RequestOption

+ func WithWorkerName(name string) RequestOption

Mar 25, 2025

Changes in this version

+ var CannotRemoveLastThreadError = errors.New("cannot remove last thread")

+ var MaxThreadsReachedError = errors.New("max amount of overall threads reached")

+ var WorkerNotFoundError = errors.New("worker not found for given filename")

+ func DrainWorkers()

+ func RestartWorkers()

+ type FrankenPHPDebugState struct

+ ReservedThreadCount int

+ ThreadDebugStates []ThreadDebugState

+ func DebugState() FrankenPHPDebugState

type Metrics

+ DequeuedRequest func()

+ DequeuedWorkerRequest func(name string)

+ QueuedRequest func()

+ QueuedWorkerRequest func(name string)

type Option

+ func WithMaxThreads(maxThreads int) Option

+ func WithMaxWaitTime(maxWaitTime time.Duration) Option

+ func WithPhpIni(overrides map[string]string) Option

type PrometheusMetrics

+ func (m *PrometheusMetrics) DequeuedRequest()

+ func (m *PrometheusMetrics) DequeuedWorkerRequest(name string)

+ func (m *PrometheusMetrics) QueuedRequest()

+ func (m *PrometheusMetrics) QueuedWorkerRequest(name string)

+ type ThreadDebugState struct

+ Index int

+ IsBusy bool

+ IsWaiting bool

+ Name string

+ State string

+ WaitingSinceMilliseconds int64

Jan 9, 2025

Changes in this version

+ var NotRunningError = errors.New(...)

type RequestOption

+ func WithOriginalRequest(r *http.Request) RequestOption

Nov 11, 2024

Changes in this version

+ const StopReasonCrash

+ const StopReasonRestart

+ const StopReasonShutdown

+ var AlreadyStartedError = errors.New("FrankenPHP is already started")

+ var MaxThreads int

+ type Metrics interface

+ ReadyWorker func(name string)

+ Shutdown func()

+ StartRequest func()

+ StartWorker func(name string)

+ StartWorkerRequest func(name string)

+ StopRequest func()

+ StopWorker func(name string, reason StopReason)

+ StopWorkerRequest func(name string, duration time.Duration)

+ TotalThreads func(num int)

+ TotalWorkers func(name string, num int)

type Option

+ func WithMetrics(m Metrics) Option

+ type PrometheusMetrics struct

+ func NewPrometheusMetrics(registry prometheus.Registerer) *PrometheusMetrics

+ func (m *PrometheusMetrics) ReadyWorker(name string)

+ func (m *PrometheusMetrics) Shutdown()

+ func (m *PrometheusMetrics) StartRequest()

+ func (m *PrometheusMetrics) StartWorker(name string)

+ func (m *PrometheusMetrics) StartWorkerRequest(name string)

+ func (m *PrometheusMetrics) StopRequest()

+ func (m *PrometheusMetrics) StopWorker(name string, reason StopReason)

+ func (m *PrometheusMetrics) StopWorkerRequest(name string, duration time.Duration)

+ func (m *PrometheusMetrics) TotalThreads(num int)

+ func (m *PrometheusMetrics) TotalWorkers(name string, _ int)

+ type StopReason int

Aug 27, 2024

Changes in this version

type RequestOption

+ func WithRequestResolvedDocumentRoot(documentRoot string) RequestOption

Mar 18, 2024

Changes in this version

+ type PreparedEnv = map[string]string

+ func PrepareEnv(env map[string]string) PreparedEnv

type RequestOption

+ func WithRequestPreparedEnv(env PreparedEnv) RequestOption

Dec 29, 2023

Changes in this version

+ func Handles() *handleList

+ func Pointers() *pointerList

Dec 7, 2023

Changes in this version

+ var AlreaydStartedError = errors.New("FrankenPHP is already started")

+ var EmbeddedAppPath string

+ var InvalidPHPVersionError = errors.New("FrankenPHP is only compatible with PHP 8.2+")

+ var InvalidRequestError = errors.New("not a FrankenPHP request")

+ var MainThreadCreationError = errors.New("error creating the main thread")

+ var NotEnoughThreads = errors.New("the number of threads must be superior to the number of workers")

+ var RequestContextCreationError = errors.New("error during request context creation")

+ var RequestStartupError = errors.New("error during PHP request startup")

+ var ScriptExecutionError = errors.New("error during PHP script execution")

+ var ZendSignalsError = errors.New("Zend Signals are enabled, recompile PHP with --disable-zend-signals")

+ func ExecuteScriptCLI(script string, args []string) int

+ func Init(options ...Option) error

+ func NewRequestWithContext(r *http.Request, opts ...RequestOption) (*http.Request, error)

+ func ServeHTTP(responseWriter http.ResponseWriter, request *http.Request) error

+ func Shutdown()

+ type FrankenPHPContext struct

+ func FromContext(ctx context.Context) (fctx *FrankenPHPContext, ok bool)

+ type Option func(h *opt) error

+ func WithLogger(l *zap.Logger) Option

+ func WithNumThreads(numThreads int) Option

+ func WithWorkers(fileName string, num int, env map[string]string) Option

+ type PHPConfig struct

+ Version PHPVersion

+ ZTS bool

+ ZendMaxExecutionTimers bool

+ ZendSignals bool

+ func Config() PHPConfig

+ type PHPVersion struct

+ ExtraVersion string

+ MajorVersion int

+ MinorVersion int

+ ReleaseVersion int

+ Version string

+ VersionID int

+ func Version() PHPVersion

+ type RequestOption func(h *FrankenPHPContext) error

+ func WithRequestDocumentRoot(documentRoot string, resolveSymlink bool) RequestOption

+ func WithRequestEnv(env map[string]string) RequestOption

+ func WithRequestLogger(logger *zap.Logger) RequestOption

+ func WithRequestSplitPath(splitPath []string) RequestOption