Class Util_Process


					
	public

__construct()

#


					
	public

setDescriptor(int $fd, string $type, string|array $mode, string $alias = '', array $opts = []): $this|bool

Set file descriptor type

Parameters

`$fd`	descriptor number
`$type`	pipe or file
`$mode`	pipe mode or [file, file mode]
`$alias`	nickname

#


					
	public

getOption($name)

#


					
	public

getPipeNames(): array

Get all defined pipe names, alias preferred

#


					
	public

setDescriptorOption($fd, $opt, $value)

#


					
	public
					static

exec(array|string $cmd, mixed $args = null, array $exits = [0], array $opts = []): array

Execute a program

Optional parameters: run (bool) : execute process automatically fd (array): file descriptors consisting of an array of descriptor-specific options

fd options:

close (bool): close pipe on creation - useful with stdin

Parameters

`$cmd`	command
`$args`	format arguments
`$exits`	permitted exit values
`$opts`	optional process options

#


					
	public
					static

decompose($cmd): array

Break a full command down into its command + arguments in bash/sh dialect

#


					
	public
					static

mkfifo(string $path = '/tmp'): string|null

Allocate a fifo pipe

Parameters

$path

base path

#


					
	public

__destruct()

#


					
	public

run($cmd, ...$args)

#


					
	public

setPriority(int $prio): $this|bool|void

Set process priorrity

#


					
	public

setSuid($user): void

Set user id for task

#


					
	public

setSgid($group): void

Set group id for task

#


					
	public

process(): unknown_type

Util_Process a program

#


					
	public

getDescriptors()

#


					
	public

getDescriptorMode(int|string $fd): string

Get mode assigned to descriptor

Parameters

$fd

fd/alias

Returns

fd mode (r,w,a)

#


					
	public

getDescriptorType(int|string $fd): string

Get type assigned to descriptor

Parameters

$fd

fd/alias

Returns

fd type (file, pipe)

#


					
	public

getDescriptorOptions($fd)

#


					
	public

pipeClose(int|resource &$pipe): bool

Close pipe

#


					
	public
					
					&

getPipePeer()

#


					
	public

getProcessStatus(): array|null

Get process status

#


					
	public

pipe($cmd, ...$args)

#


					
	public

pipeProcess(Util_Process &$peer): object

Attach another program's output to program input

Parameters

$peer

processs created by create()

#


					
	public

setEncoding($mode, $fd = null)

#


					
	public

pipeDescriptor($read, $write)

#


					
	public

forceRun(): bool|Util_Process

Force a delayed start

Used in conjunction with setOption("run", false)

#


					
	public

running()

#


					
	public

format(string $fmt = 'apnscp'): mixed

Transform process data Format options: --------------- esprit: traditional apnscp esprit format stderr, stdout,…

Transform process data Format options:

esprit: traditional apnscp esprit format stderr, stdout, output, error, return, errno fields

Parameters

$fmt

data format

#


					
	public

getExit(): int

Return process exit code

#


					
	public

exitSuccess()

#


					
	public

getOutput($pipe)

#


					
	public

addEnvironment($name, $val): $this

Add environment exported to child process via putenv()

Returns

instance

#


					
	public

setResource(array $limits): void

Set resource limits for process

Parameters

$limits

key => value limits

#


					
	public

setEnvironment(mixed $name, mixed $val = null): $this

Set environment variable overwriting if set

Returns

instance

#


					
	public

unsetEnvironment($var)

#


					
	public

getEnvironment()

#


					
	public

close(): int

Terminate process

Returns

exit value

#


					
	public

pipeRead(int|resource $pipe, int $length = -1, int $offset = 0): string

Read pipe input

#


					
	public

pipeWrite(int|resource $pipe, string $data, int $length = null): int

Write to pipe

Returns

number of bytes written

#


					
	public

getExits()

#


					
	public

setExits($exits = '/./')

#


					
	public

getCommand(bool $raw = false): string

Return process command

Parameters

$raw

command as provided

#


					
	public

setOption(string $name, mixed $val = null): $this

Set process option

Create callback methods using camel case _ is stripped, e.g. tv_usec -> setTvUsec

Parameters

$name

option name

#


					
	public

setUnshare(Unshare $pool)

Add unshare resource to execution context

#


					
	public

setTee($file)

#


					
	public

addCallback(callable $function, string $when = 'read', array ...$args): void

Parameters

`$when`	callback context {@link $this->callbacks}
...`$args`	additional arguments to pass

#


					
	public

getDescriptorOption($fd, $opt)

#


					
	public

deleteCallback(string $when, string $namespace = ''): bool|void

Delete a registered callback

Parameters

`$when`	callback context (read, write, close)
`$namespace`	optional namespace

#

Namespaces

Classes

Interfaces

Parameters

fd options:

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Transform process data Format options:

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Parameters

Parameters

Parameters