plan

Documentation

Index

• func ParseExtensions(raw string) (include, exclude []string, reset bool)
• func ParsePHPVersionFile(path string) (string, error)
• type CoverageDriver
• type IniValue
  • func ParseIniValues(raw string) ([]IniValue, error)
• type Plan
  • func FromEnv() (*Plan, error)
  • func (p *Plan) ApplyCoverage()
  • func (p *Plan) Hash() string

Functions

func ParseExtensions

func ParseExtensions(raw string) (include, exclude []string, reset bool)

ParseExtensions parses shivammathur/setup-php@v2's extensions syntax. Recognized tokens:

• bare name (e.g. "redis") → include
• ":name" → exclude
• "none" → reset both include and exclude to empty; subsequent tokens process normally

Both include and exclude are sorted, deduplicated, and lower-cased.

func ParsePHPVersionFile

func ParsePHPVersionFile(path string) (string, error)

Types

type CoverageDriver

type CoverageDriver string

const (
	CoverageNone   CoverageDriver = "none"
	CoverageXdebug CoverageDriver = "xdebug"
	CoveragePCOV   CoverageDriver = "pcov"
)

type IniValue

type IniValue struct {
	Key   string
	Value string
}

func ParseIniValues

func ParseIniValues(raw string) ([]IniValue, error)

type Plan

type Plan struct {
	PHPVersion        string
	Extensions        []string
	ExtensionsExclude []string
	ExtensionsReset   bool
	IniValues         []IniValue
	Coverage          CoverageDriver
	Tools             []string
	ThreadSafety      string
	OS                string
	Arch              string
	FailFast          bool
	Update            bool
	IniFile           string
	Debug             bool
	Verbose           bool
}

func FromEnv

func FromEnv() (*Plan, error)

func (*Plan) ApplyCoverage

func (p *Plan) ApplyCoverage()

ApplyCoverage adds the requested coverage driver (xdebug or pcov) to the extensions list so it is resolved, fetched, and composed like any other extension. "none" is a no-op.

func (*Plan) Hash

func (p *Plan) Hash() string