phpweb

Documentation

Index

• Constants
• func LoadAvailablePHPExtensions() ([]string, error)
• func PickWebDir(buildpackYAML config.BuildpackYAML) string
• func SearchForWebApp(appRoot string, webdir string) (bool, error)
• func Version(buildpack buildpack.Buildpack) string
• type Contributor
  • func NewContributor(context build.Build) (Contributor, bool, error)
  • func (c Contributor) Contribute() error
• type Metadata
  • func (m Metadata) Identity() (name string, version string)

Constants

const (
	// Dependency in the buildplan indicates that this is a web app
	Dependency = "php-web"
)

Functions

func LoadAvailablePHPExtensions

func LoadAvailablePHPExtensions() ([]string, error)

LoadAvailablePHPExtensions locates available extensions and returns the list

func PickWebDir

func PickWebDir(buildpackYAML config.BuildpackYAML) string

PickWebDir will select the correct web directory to use

func SearchForWebApp

func SearchForWebApp(appRoot string, webdir string) (bool, error)

SearchForWebApp looks to see if this application is a PHP web app

func Version

func Version(buildpack buildpack.Buildpack) string

Version returns the selected version of PHP using the following precedence:

1. `php.version` from `buildpack.yml` 2. Build Plan Version, if set by composer 3. Buildpack Metadata "default_version" 4. `*` which should pick latest version

Types

type Contributor

type Contributor struct {
	// contains filtered or unexported fields
}

Contributor represents a PHP contribution by the buildpack

func NewContributor

func NewContributor(context build.Build) (Contributor, bool, error)

NewContributor creates a new Contributor instance. willContribute is true if build plan contains "php-script" or "php-web" dependency, otherwise false.

func (Contributor) Contribute

func (c Contributor) Contribute() error

Contribute contributes an expanded PHP to a cache layer.

type Metadata

type Metadata struct {
	Name string
	Hash string
}

Metadata is used solely for providing `Identity()`

func (Metadata) Identity

func (m Metadata) Identity() (name string, version string)

Identity provides libcfbuildpack with information to decide if it should contribute