README

Wrapper for retrieving information about an operating system user with native PHP functions

Installation

composer require operating-system/user

Usage

Instantiate user with uid 0:

use OperatingSystem\User\User;
use OperatingSystem\User\Exception\PosixNotAvailableException;

try {
    $user = new User(0);
} catch (PosixNotAvailableException $e) {
    $e->getMessage;         // 'Could not retrieve information about the operating system user because POSIX functions are not available to your PHP executable.'
}

Get user information for user with uid 0:

$user->getName();           // 'root'
$user->getPassword();       // 'x'
$user->getUid();            // 0
$user->getGid();            // 0
$user->getGecos();          // 'root'
$user->getHomeDirectory();  // 'root'
$user->getShell();          // '/bin/bash'

Factory methods:

use OperatingSystem\User\Factory\UserFactory;
use OperatingSystem\User\Exception\PosixNotAvailableException;

try {
    $user = UserFactory::createFromExecutedFileOwner();
} catch (PosixNotAvailableException $e) {
    $e->getMessage;         // 'Could not retrieve information about the operating system user because POSIX functions are not available to your PHP executable.'
} catch (\Exception $e) {
    $e->getMessage;         // 'Could not get the owner of the current script.'
}

try {
    $user = UserFactory::createFromEffectiveProcessUser();
} catch (PosixNotAvailableException $e) {
    $e->getMessage;         // 'Could not retrieve information about the operating system user because POSIX functions are not available to your PHP executable.'
} catch (\Exception $e) {
    $e->getMessage;         // 'Could not get the effective user of the current process.'
}

try {
    $user = UserFactory::createFromRealProcessUser();
} catch (PosixNotAvailableException $e) {
    $e->getMessage;         // 'Could not retrieve information about the operating system user because POSIX functions are not available to your PHP executable.'
} catch (\Exception $e) {
    $e->getMessage;         // 'Could not get the real user of the current process.'
}

try {
    $user = UserFactory::createFromFileOwner(__FILE__);
} catch (\InvalidArgumentException $e) {
    $e->getMessage;         // 'Invalid file name provided.'
} catch (PosixNotAvailableException $e) {
    $e->getMessage;         // 'Could not retrieve information about the operating system user because POSIX functions are not available to your PHP executable.'
} catch (\Exception $e) {
    $e->getMessage;         // 'Could not get the real user of the current process.'
}

Testing

$ ./vendor/bin/phpunit

License

The MIT License (MIT). Please see License File for more information.