sai

No long description provided.

Installation

dagger install github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31

Entrypoint

Return Type

Sai

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \

func (m *MyModule) Example() *dagger.Sai  {
	return dag.
			Sai()
}

@function
def example() -> dagger.Sai:
	return (
		dag.sai()
	)

@func()
example(): Sai {
	return dag
		.sai()
}

Types

Composer 🔗

install() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
composerJson	File !	-	No description provided
composerLock	File	null	No description provided

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 adopt-phpcontainer --container IMAGE:TAG \
 composer --composer-version string --composer-cache-name string \
 install --composer-json file:path

func (m *MyModule) Example(container *dagger.Container, composerVersion string, composerCacheName string, composerJson *dagger.File) *dagger.Directory  {
	return dag.
			Sai().
			Adoptphpcontainer(container).
			Composer(composerVersion, composerCacheName).
			Install(composerJson)
}

@function
def example(container: dagger.Container, composerversion: str, composercachename: str, composerjson: dagger.File) -> dagger.Directory:
	return (
		dag.sai()
		.adoptphpcontainer(container)
		.composer(composerversion, composercachename)
		.install(composerjson)
	)

@func()
example(container: Container, composerVersion: string, composerCacheName: string, composerJson: File): Directory {
	return dag
		.sai()
		.adoptPhpcontainer(container)
		.composer(composerVersion, composerCacheName)
		.install(composerJson)
}

NginxContainer 🔗

withAppCode() 🔗

Return Type

NginxContainer !

Arguments

Name	Type	Default Value	Description
appCode	Directory !	-	No description provided
path	String !	"\/app"	No description provided

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 nginx --version string --os string \
 with-app-code --app-code DIR_PATH --path string

func (m *MyModule) Example(version string, os string, appCode *dagger.Directory, path string) *dagger.SaiNginxContainer  {
	return dag.
			Sai().
			Nginx(version, os).
			Withappcode(appCode, path)
}

@function
def example(version: str, os: str, appcode: dagger.Directory, path: str) -> dagger.SaiNginxContainer:
	return (
		dag.sai()
		.nginx(version, os)
		.withappcode(appcode, path)
	)

@func()
example(version: string, os: string, appCode: Directory, path: string): SaiNginxContainer {
	return dag
		.sai()
		.nginx(version, os)
		.withAppCode(appCode, path)
}

withConfigTemplate() 🔗

Return Type

NginxContainer !

Arguments

Name	Type	Default Value	Description
configTemplate	File !	-	No description provided

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 nginx --version string --os string \
 with-config-template --config-template file:path

func (m *MyModule) Example(version string, os string, configTemplate *dagger.File) *dagger.SaiNginxContainer  {
	return dag.
			Sai().
			Nginx(version, os).
			Withconfigtemplate(configTemplate)
}

@function
def example(version: str, os: str, configtemplate: dagger.File) -> dagger.SaiNginxContainer:
	return (
		dag.sai()
		.nginx(version, os)
		.withconfigtemplate(configtemplate)
	)

@func()
example(version: string, os: string, configTemplate: File): SaiNginxContainer {
	return dag
		.sai()
		.nginx(version, os)
		.withConfigTemplate(configTemplate)
}

container() 🔗

Return Type

Container !

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 nginx --version string --os string \
 container

func (m *MyModule) Example(version string, os string) *dagger.Container  {
	return dag.
			Sai().
			Nginx(version, os).
			Container()
}

@function
def example(version: str, os: str) -> dagger.Container:
	return (
		dag.sai()
		.nginx(version, os)
		.container()
	)

@func()
example(version: string, os: string): Container {
	return dag
		.sai()
		.nginx(version, os)
		.container()
}

Phpcontainer 🔗

withExtension() 🔗

Return Type

Phpcontainer !

Arguments

Name	Type	Default Value	Description
extension	String !	-	No description provided

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 adopt-phpcontainer --container IMAGE:TAG \
 with-extension --extension string

func (m *MyModule) Example(container *dagger.Container, extension string) *dagger.SaiPhpcontainer  {
	return dag.
			Sai().
			Adoptphpcontainer(container).
			Withextension(extension)
}

@function
def example(container: dagger.Container, extension: str) -> dagger.SaiPhpcontainer:
	return (
		dag.sai()
		.adoptphpcontainer(container)
		.withextension(extension)
	)

@func()
example(container: Container, extension: string): SaiPhpcontainer {
	return dag
		.sai()
		.adoptPhpcontainer(container)
		.withExtension(extension)
}

withExtensions() 🔗

Return Type

Phpcontainer !

Arguments

Name	Type	Default Value	Description
extensions	[String ! ] !	-	No description provided

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 adopt-phpcontainer --container IMAGE:TAG \
 with-extensions --extensions string1 --extensions string2

func (m *MyModule) Example(container *dagger.Container, extensions []string) *dagger.SaiPhpcontainer  {
	return dag.
			Sai().
			Adoptphpcontainer(container).
			Withextensions(extensions)
}

@function
def example(container: dagger.Container, extensions: List[str]) -> dagger.SaiPhpcontainer:
	return (
		dag.sai()
		.adoptphpcontainer(container)
		.withextensions(extensions)
	)

@func()
example(container: Container, extensions: string[]): SaiPhpcontainer {
	return dag
		.sai()
		.adoptPhpcontainer(container)
		.withExtensions(extensions)
}

withComposer() 🔗

Return Type

Phpcontainer !

Arguments

Name	Type	Default Value	Description
composerVersion	String !	"2"	No description provided
composerCacheName	String !	"sai-composer-cache"	Dagger cache name to mount for the composer cache to speed up builds

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 adopt-phpcontainer --container IMAGE:TAG \
 with-composer --composer-version string --composer-cache-name string

func (m *MyModule) Example(container *dagger.Container, composerVersion string, composerCacheName string) *dagger.SaiPhpcontainer  {
	return dag.
			Sai().
			Adoptphpcontainer(container).
			Withcomposer(composerVersion, composerCacheName)
}

@function
def example(container: dagger.Container, composerversion: str, composercachename: str) -> dagger.SaiPhpcontainer:
	return (
		dag.sai()
		.adoptphpcontainer(container)
		.withcomposer(composerversion, composercachename)
	)

@func()
example(container: Container, composerVersion: string, composerCacheName: string): SaiPhpcontainer {
	return dag
		.sai()
		.adoptPhpcontainer(container)
		.withComposer(composerVersion, composerCacheName)
}

composer() 🔗

Return Type

Composer !

Arguments

Name	Type	Default Value	Description
composerVersion	String !	"2"	Composer version to use, suggested values are 1 or 2 however any valid composer docker tag name is accepted.
composerCacheName	String !	"sai-composer-cache"	Dagger cache name to mount for the composer cache to speed up builds.

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 adopt-phpcontainer --container IMAGE:TAG \
 composer --composer-version string --composer-cache-name string

func (m *MyModule) Example(container *dagger.Container, composerVersion string, composerCacheName string) *dagger.SaiComposer  {
	return dag.
			Sai().
			Adoptphpcontainer(container).
			Composer(composerVersion, composerCacheName)
}

@function
def example(container: dagger.Container, composerversion: str, composercachename: str) -> dagger.SaiComposer:
	return (
		dag.sai()
		.adoptphpcontainer(container)
		.composer(composerversion, composercachename)
	)

@func()
example(container: Container, composerVersion: string, composerCacheName: string): SaiComposer {
	return dag
		.sai()
		.adoptPhpcontainer(container)
		.composer(composerVersion, composerCacheName)
}

withAppCode() 🔗

Return Type

Phpcontainer !

Arguments

Name	Type	Default Value	Description
appCode	Directory !	-	No description provided
path	String !	"\/app"	No description provided

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 adopt-phpcontainer --container IMAGE:TAG \
 with-app-code --app-code DIR_PATH --path string

func (m *MyModule) Example(container *dagger.Container, appCode *dagger.Directory, path string) *dagger.SaiPhpcontainer  {
	return dag.
			Sai().
			Adoptphpcontainer(container).
			Withappcode(appCode, path)
}

@function
def example(container: dagger.Container, appcode: dagger.Directory, path: str) -> dagger.SaiPhpcontainer:
	return (
		dag.sai()
		.adoptphpcontainer(container)
		.withappcode(appcode, path)
	)

@func()
example(container: Container, appCode: Directory, path: string): SaiPhpcontainer {
	return dag
		.sai()
		.adoptPhpcontainer(container)
		.withAppCode(appCode, path)
}

withComposerApp() 🔗

Return Type

Phpcontainer !

Arguments

Name	Type	Default Value	Description
appCode	Directory !	-	No description provided
path	String !	"\/app"	No description provided
composerVersion	String !	"2"	No description provided
composerCacheName	String !	"sai-composer-cache"	No description provided

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 adopt-phpcontainer --container IMAGE:TAG \
 with-composer-app --app-code DIR_PATH --path string --composer-version string --composer-cache-name string

func (m *MyModule) Example(container *dagger.Container, appCode *dagger.Directory, path string, composerVersion string, composerCacheName string) *dagger.SaiPhpcontainer  {
	return dag.
			Sai().
			Adoptphpcontainer(container).
			Withcomposerapp(appCode, path, composerVersion, composerCacheName)
}

@function
def example(container: dagger.Container, appcode: dagger.Directory, path: str, composerversion: str, composercachename: str) -> dagger.SaiPhpcontainer:
	return (
		dag.sai()
		.adoptphpcontainer(container)
		.withcomposerapp(appcode, path, composerversion, composercachename)
	)

@func()
example(container: Container, appCode: Directory, path: string, composerVersion: string, composerCacheName: string): SaiPhpcontainer {
	return dag
		.sai()
		.adoptPhpcontainer(container)
		.withComposerApp(appCode, path, composerVersion, composerCacheName)
}

container() 🔗

Return Type

Container !

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 adopt-phpcontainer --container IMAGE:TAG \
 container

func (m *MyModule) Example(container *dagger.Container) *dagger.Container  {
	return dag.
			Sai().
			Adoptphpcontainer(container).
			Container()
}

@function
def example(container: dagger.Container) -> dagger.Container:
	return (
		dag.sai()
		.adoptphpcontainer(container)
		.container()
	)

@func()
example(container: Container): Container {
	return dag
		.sai()
		.adoptPhpcontainer(container)
		.container()
}

QaTools 🔗

phpStan() 🔗

Runs PHPStan against your codebase

Return Type

ReportsPhpstanReport !

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 qa-tools \
 php-stan

func (m *MyModule) Example() *dagger.SaiReportsPhpstanReport  {
	return dag.
			Sai().
			Qatools().
			Phpstan()
}

@function
def example() -> dagger.SaiReportsPhpstanReport:
	return (
		dag.sai()
		.qatools()
		.phpstan()
	)

@func()
example(): SaiReportsPhpstanReport {
	return dag
		.sai()
		.qaTools()
		.phpStan()
}

ReportsPhpstanReport 🔗

report() 🔗

Returns the report from PHPStan

Return Type

String !

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 qa-tools \
 php-stan \
 report

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Sai().
			Qatools().
			Phpstan().
			Report(ctx)
}

@function
async def example() -> str:
	return await (
		dag.sai()
		.qatools()
		.phpstan()
		.report()
	)

@func()
async example(): Promise<string> {
	return dag
		.sai()
		.qaTools()
		.phpStan()
		.report()
}

logFile() 🔗

Returns the report from PHPStan as a File

Return Type

File !

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 qa-tools \
 php-stan \
 log-file

func (m *MyModule) Example() *dagger.File  {
	return dag.
			Sai().
			Qatools().
			Phpstan().
			Logfile()
}

@function
def example() -> dagger.File:
	return (
		dag.sai()
		.qatools()
		.phpstan()
		.logfile()
	)

@func()
example(): File {
	return dag
		.sai()
		.qaTools()
		.phpStan()
		.logFile()
}

Sai 🔗

php() 🔗

Return Type

Phpcontainer !

Arguments

Name	Type	Default Value	Description
version	String !	"8.5"	PHP Version to use
os	String !	"alpine"	OS Version to use, valid options: alpine, debian
variant	String !	"cli"	Image variant, valid options: apache, cli, fpm, zts

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 php --version string --os string --variant string

func (m *MyModule) Example(version string, os string, variant string) *dagger.SaiPhpcontainer  {
	return dag.
			Sai().
			Php(version, os, variant)
}

@function
def example(version: str, os: str, variant: str) -> dagger.SaiPhpcontainer:
	return (
		dag.sai()
		.php(version, os, variant)
	)

@func()
example(version: string, os: string, variant: string): SaiPhpcontainer {
	return dag
		.sai()
		.php(version, os, variant)
}

adoptPhpcontainer() 🔗

Return Type

Phpcontainer !

Arguments

Name	Type	Default Value	Description
container	Container !	-	No description provided

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 adopt-phpcontainer --container IMAGE:TAG

func (m *MyModule) Example(container *dagger.Container) *dagger.SaiPhpcontainer  {
	return dag.
			Sai().
			Adoptphpcontainer(container)
}

@function
def example(container: dagger.Container) -> dagger.SaiPhpcontainer:
	return (
		dag.sai()
		.adoptphpcontainer(container)
	)

@func()
example(container: Container): SaiPhpcontainer {
	return dag
		.sai()
		.adoptPhpcontainer(container)
}

nginx() 🔗

Return Type

NginxContainer !

Arguments

Name	Type	Default Value	Description
version	String !	"1.31"	Nginx Version to use
os	String !	"alpine"	OS Version to use, valid options: alpine, trixie
variant	String	null	Image variant, valid options: slim, perl, otel

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 nginx --version string --os string

func (m *MyModule) Example(version string, os string) *dagger.SaiNginxContainer  {
	return dag.
			Sai().
			Nginx(version, os)
}

@function
def example(version: str, os: str) -> dagger.SaiNginxContainer:
	return (
		dag.sai()
		.nginx(version, os)
	)

@func()
example(version: string, os: string): SaiNginxContainer {
	return dag
		.sai()
		.nginx(version, os)
}

qaTools() 🔗

Return Type

QaTools !

Arguments

Name	Type	Default Value	Description
container	Container	null	No description provided

Example

dagger -m github.com/sai-php/sai@dcc5dd6d2d15b0906defbc5ca492611adf687f31 call \
 qa-tools

func (m *MyModule) Example() *dagger.SaiQaTools  {
	return dag.
			Sai().
			Qatools()
}

@function
def example() -> dagger.SaiQaTools:
	return (
		dag.sai()
		.qatools()
	)

@func()
example(): SaiQaTools {
	return dag
		.sai()
		.qaTools()
}