Documentation

PluginConfig

Table of Contents

$args  : PluginConfigArgs|null
$description  : string|null
$dockerVersion  : string|null
Docker Version used to create the plugin.
$documentation  : string|null
$entrypoint  : array<string|int, string>|null
$env  : array<string|int, PluginEnv>|null
$interface  : PluginConfigInterface|null
The interface between Docker and the plugin.
$ipcHost  : bool|null
$linux  : PluginConfigLinux|null
$mounts  : array<string|int, PluginMount>|null
$network  : PluginConfigNetwork|null
$pidHost  : bool|null
$propagatedMount  : string|null
$rootfs  : PluginConfigRootfs|null
$user  : PluginConfigUser|null
$workDir  : string|null
getArgs()  : PluginConfigArgs|null
getDescription()  : string|null
getDockerVersion()  : string|null
Docker Version used to create the plugin.
getDocumentation()  : string|null
getEntrypoint()  : array<string|int, string>|null
getEnv()  : array<string|int, PluginEnv>|null
getInterface()  : PluginConfigInterface|null
The interface between Docker and the plugin.
getIpcHost()  : bool|null
getLinux()  : PluginConfigLinux|null
getMounts()  : array<string|int, PluginMount>|null
getNetwork()  : PluginConfigNetwork|null
getPidHost()  : bool|null
getPropagatedMount()  : string|null
getRootfs()  : PluginConfigRootfs|null
getUser()  : PluginConfigUser|null
getWorkDir()  : string|null
setArgs()  : self
setDescription()  : self
setDockerVersion()  : self
Docker Version used to create the plugin.
setDocumentation()  : self
setEntrypoint()  : self
setEnv()  : self
setInterface()  : self
The interface between Docker and the plugin.
setIpcHost()  : self
setLinux()  : self
setMounts()  : self
setNetwork()  : self
setPidHost()  : self
setPropagatedMount()  : self
setRootfs()  : self
setUser()  : self
setWorkDir()  : self

Properties

$dockerVersion

Docker Version used to create the plugin.

protected string|null $dockerVersion

$entrypoint

protected array<string|int, string>|null $entrypoint

Methods

getDescription()

public getDescription() : string|null
Return values
string|null

getDockerVersion()

Docker Version used to create the plugin.

public getDockerVersion() : string|null
Return values
string|null

getDocumentation()

public getDocumentation() : string|null
Return values
string|null

getEntrypoint()

public getEntrypoint() : array<string|int, string>|null
Return values
array<string|int, string>|null

getIpcHost()

public getIpcHost() : bool|null
Return values
bool|null

getPidHost()

public getPidHost() : bool|null
Return values
bool|null

getPropagatedMount()

public getPropagatedMount() : string|null
Return values
string|null

getWorkDir()

public getWorkDir() : string|null
Return values
string|null

setDescription()

public setDescription(string|null $description) : self
Parameters
$description : string|null
Return values
self

setDockerVersion()

Docker Version used to create the plugin.

public setDockerVersion(string|null $dockerVersion) : self
Parameters
$dockerVersion : string|null
Return values
self

setDocumentation()

public setDocumentation(string|null $documentation) : self
Parameters
$documentation : string|null
Return values
self

setEntrypoint()

public setEntrypoint(array<string|int, string>|null $entrypoint) : self
Parameters
$entrypoint : array<string|int, string>|null
Return values
self

setEnv()

public setEnv(array<string|int, PluginEnv>|null $env) : self
Parameters
$env : array<string|int, PluginEnv>|null
Return values
self

setIpcHost()

public setIpcHost(bool|null $ipcHost) : self
Parameters
$ipcHost : bool|null
Return values
self

setPidHost()

public setPidHost(bool|null $pidHost) : self
Parameters
$pidHost : bool|null
Return values
self

setPropagatedMount()

public setPropagatedMount(string|null $propagatedMount) : self
Parameters
$propagatedMount : string|null
Return values
self

setWorkDir()

public setWorkDir(string|null $workDir) : self
Parameters
$workDir : string|null
Return values
self

Search results