Download the PHP package axy/posix without Composer
On this page you can find all versions of the php package axy/posix. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package posix
Short Description Mockable wrapper for POSIX functions
License MIT
Homepage https://github.com/axypro/posix
Informations about the package posix
axy/posix
Mockable wrapper for POSIX functions.
The library provides the interface axy\posix\IPosix
which almost completely reproduces the POSIX functions list.
The standard implementation is also provided.
It is the RealPosix
class that just delegates execution to those functions.
What benefits of using this?
Except of some minor improvements (see below), using an object with a specified interface allows you to change implementation.
Firstly, this is useful for tests.
The RealPosix
itself provides the listener functionality (see below).
IPosix
The interface contains methods similar to standard posix_*()
functions.
- Method names doesn't contain prefix
posix_
. Otherwise, the names as identical. It can be possible change they to more human-readable style, but it is the standard, you know. - An exception is thrown when an error is happened (standard functions usually return
FALSE
). - For same reason there are no methods for get the last error code.
- Structures that are returned by some methods (
getgrgid()
for example) are converted to objects of certain data-classes (standard functions return associative arrays).
Exceptions
Are located in axy\posix\exceptions
:
IPosixException
- the main interfacePosixException
- a standard function error (extendsLogicException
, just because)- The constructor takes an error code as only argument
- An exception object has readonly properties:
$posixErrorCode (int)
- the origin error code, is equal to the exception code$posixErrorConstant (?string)
- the error constant name (EPERM
for example, NULL if not defined)$posixErrorMessage (string)
- the error message asposix_strerror()
returned
PosixNotImplementedException
- the corresponding function is not defined (for example,getpgid
is not defined on all systems, some functions were added in 8.3)
Structures
All the following structures is data classes.
Each of them has the property $data
that contains the original array and other named properties for elements of that array.
PosicUserInfo
- returned bygetpwnam()
,getpwuid()
PosixGroupInfo
- returned bygetgrgid()
,getgrnam()
PosixTimesInfo
- returned bytimes()
PosixUnameInfo
- returned byuname()
PosixResourceLimits
- returned bygetrlimits()
, contains two subobjectshard
andsoft
with a similar structure
Constants
All constants that used as method arguments are collected in the PosixConstants
class.
These are just copies of the standard constants (without the prefix POSIX_
).
The PHP version allows collect these in the IPosix
but this would clutter the interface with rarely used elements.
Error codes
Error codes constants are collected in PosixErrors
.
There is a method PosixErrors::getConstName(int $code): ?string
that returns the constant name for a code.
Listener
Listeners for RealPosix
allow to make a logger or a simple mock.
A listener must implement axy\posix\IPosixListener
or extend PosixListener
.
There are two methods:
before(string $method, array $args, ?int &$code = null): mixed
after(string $method, array $args, mixed $result, ?int &$code = null): mixed
before()
is called before the call of a real function.
It takes the method name (such "getgid", without the prefix) and the arguments list.
If it returns any value except NULL
it is considered as the result and the real function is not called.
after()
is called, respectively, at the end and takes also $result
(as the result of performance, it also can be the result of before()
).
It can change the result and return it.
If you don't want change result here just return the $result
argument.
- Both methods must return values in the standard function format. For
getgrgid()
it is an array, not a data object. - The methods must follow the return value type. If they return
int
whenstring
is required it will lead to the fatal error. - To signal an error they can throw
PosixException
or return the standard value for this case (usually it isFALSE
or -1). - Both method takes
$code
by a link and can change it. It will be used as the error code if an error will be detected.before()
takes it asNULL
,after()
takes it changed bybefore()
or the real error code. If an error is happened and$code
was not changed by listeners will be used the real code fromposix_get_last_error()
.
All versions of posix with dependencies
ext-posix Version *