Skip to content

Latest commit

 

History

History
233 lines (157 loc) · 3.4 KB

DockerClient.md

File metadata and controls

233 lines (157 loc) · 3.4 KB

DockerClient

  • Full name: \IterativeCode\Component\DockerClient\DockerClient

Methods

__construct

DockerClient constructor.

public __construct(array $options = []): mixed

Parameters:

Parameter Type Description
$options array

info

public info(): array

version

public version(): array

listContainers

public listContainers(array $options = []): array

Parameters:

Parameter Type Description
$options array

stopContainer

public stopContainer( $id): bool

Parameters:

Parameter Type Description
$id ****

startContainer

public startContainer( $id): array

Parameters:

Parameter Type Description
$id ****

runContainer

public runContainer( $name,  $payload): false|string

Parameters:

Parameter Type Description
$name ****
$payload ****

inspectContainer

public inspectContainer( $id): array

Parameters:

Parameter Type Description
$id ****

getContainerStats

public getContainerStats( $id, false $oneShot = false): array

Parameters:

Parameter Type Description
$id ****
$oneShot false

getContainerLogs

public getContainerLogs( $id, string $level = 'all'): string

Parameters:

Parameter Type Description
$id ****
$level string

deleteContainer

public deleteContainer( $id, bool $force = false): bool

Parameters:

Parameter Type Description
$id ****
$force bool

pruneContainers

Deletes stopped containers

public pruneContainers(mixed $label = null): array

Parameters:

Parameter Type Description
$label mixed

imageExists

public imageExists( $name): bool

Parameters:

Parameter Type Description
$name ****

listImages

public listImages(null $label = null): array

Parameters:

Parameter Type Description
$label null

inspectImage

public inspectImage( $nameOrId): array

Parameters:

Parameter Type Description
$nameOrId ****

pullImage

public pullImage( $image): void

Parameters:

Parameter Type Description
$image ****

removeImage

public removeImage( $image,  $force = false): void

Parameters:

Parameter Type Description
$image ****
$force ****

Automatically generated from source code comments on 2022-09-27 using phpDocumentor and saggre/phpdocumentor-markdown