php

package
v0.27.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 17, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Overview

Package php provides PHP specific functionality for librarian.

Index

Constants

This section is empty.

Variables

View Source
var ErrMissingCommonResources = errors.New("common_resources is required for PHP configurations but was not configured (either set it on the API level or globally under default.php.common_resources)")

ErrMissingCommonResources is returned when common_resources is not configured.

Functions

func Clean

func Clean(library *config.Library) error

Clean removes all generated code from beneath the given library's output directory.

func DefaultOutput added in v0.26.0

func DefaultOutput(name, defaultOutput string) string

DefaultOutput derives an output path from a library name and a default output directory.

func Format

func Format(ctx context.Context, library *config.Library) error

Format formats a generated PHP library.

func Generate

func Generate(ctx context.Context, cfg *config.Config, library *config.Library, src *sources.Sources) (err error)

Generate generates a PHP client library.

func Install added in v0.26.0

func Install(ctx context.Context, tools *config.Tools) error

Install installs the PHP generator tool dependencies.

func InstallDir added in v0.26.0

func InstallDir() (string, error)

InstallDir gets the directory where tools should be installed.

func Tidy added in v0.27.0

func Tidy(lib *config.Library) (*config.Library, error)

Tidy tidies PHP-specific configuration for a library.

func Validate added in v0.27.0

func Validate(cfg *config.Config) error

Validate checks that the PHP-specific configuration is complete and valid.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL