Inotify\InotifyEventCodeEnum

Complexity

Total Complexity

4

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Test Coverage

Coverage

62.5%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getCodeDescription()	0	7	2
A	createFromMask()	0	6	2

<?php

declare(strict_types=1);

namespace Inotify;

use InvalidArgumentException;
use MyCLabs\Enum\Enum;
use UnexpectedValueException;

/**
 * @method static InotifyEventCodeEnum ON_ACCESS()
 * @method static InotifyEventCodeEnum ON_MODIFY()
 * @method static InotifyEventCodeEnum ON_ATTRIB();
 * @method static InotifyEventCodeEnum ON_CLOSE_WRITE()
 * @method static InotifyEventCodeEnum ON_CLOSE_NOWRITE()
 * @method static InotifyEventCodeEnum ON_OPEN()
 * @method static InotifyEventCodeEnum ON_MOVED_FROM()
 * @method static InotifyEventCodeEnum ON_MOVED_TO()
 * @method static InotifyEventCodeEnum ON_CREATE()
 * @method static InotifyEventCodeEnum ON_DELETE()
 * @method static InotifyEventCodeEnum ON_DELETE_SELF()
 * @method static InotifyEventCodeEnum ON_MOVE_SELF()
 * @method static InotifyEventCodeEnum ON_UNMOUNT()
 * @method static InotifyEventCodeEnum ON_Q_OVERFLOW()
 * @method static InotifyEventCodeEnum ON_IGNORED()
 * @method static InotifyEventCodeEnum ON_CLOSE()
 * @method static InotifyEventCodeEnum ON_MOVE()
 * @method static InotifyEventCodeEnum ON_ALL_EVENTS()
 * @method static InotifyEventCodeEnum ON_ONLYDIR()
 * @method static InotifyEventCodeEnum ON_DONT_FOLLOW()
 * @method static InotifyEventCodeEnum ON_MASK_ADD()
 * @method static InotifyEventCodeEnum ON_ISDIR()
 * @method static InotifyEventCodeEnum ON_ONESHOT()
 * @method static InotifyEventCodeEnum ON_CLOSE_NOWRITE_HIGH()
 * @method static InotifyEventCodeEnum ON_OPEN_HIGH()
 * @method static InotifyEventCodeEnum ON_CREATE_HIGH()
 * @method static InotifyEventCodeEnum ON_DELETE_HIGH()
 * @method static InotifyEventCodeEnum UNKNOWN()
 */
class InotifyEventCodeEnum extends Enum
{
    private const ON_ACCESS = 1;
    private const ON_MODIFY = 2;
    private const ON_ATTRIB = 4;
    private const ON_CLOSE_WRITE = 8;
    private const ON_CLOSE_NOWRITE = 16;
    private const ON_OPEN = 32;
    private const ON_MOVED_FROM = 64;
    private const ON_MOVED_TO = 128;
    private const ON_CREATE = 256;
    private const ON_DELETE = 512;
    private const ON_DELETE_SELF = 1024;
    private const ON_MOVE_SELF = 2048;
    private const ON_UNMOUNT = 8192;
    private const ON_Q_OVERFLOW = 16384;
    private const ON_IGNORED = 32768;
    private const ON_CLOSE = 24;
    private const ON_MOVE = 192;
    private const ON_ALL_EVENTS = 4095;
    private const ON_ONLYDIR = 16777216;
    private const ON_DONT_FOLLOW = 33554432;
    private const ON_MASK_ADD = 536870912;
    private const ON_ISDIR = 1073741824;
    private const ON_ONESHOT = 2147483648;

    private const ON_CLOSE_NOWRITE_HIGH = 1073741840;
    private const ON_OPEN_HIGH = 1073741856;
    private const ON_CREATE_HIGH = 1073742080;
    private const ON_DELETE_HIGH = 1073742336;

    private const UNKNOWN = 0;

    public static $constants = [
        0 => ['UNKNOWN', 'Unknown code.'],
        1 => ['ON_ACCESS', 'File was accessed (read)'],
        2 => ['ON_MODIFY', 'File was modified'],
        4 => ['ON_ATTRIB', 'Metadata changed (e.g. permissions, mtime, etc.)'],
        8 => ['ON_CLOSE_WRITE', 'File opened for writing was closed'],
        16 => ['ON_CLOSE_NOWRITE', 'File not opened for writing was closed'],
        32 => ['ON_OPEN', 'File was opened'],
        128 => ['ON_MOVED_TO', 'File moved into watched directory'],
        64 => ['ON_MOVED_FROM', 'File moved out of watched directory'],
        256 => ['ON_CREATE', 'File or directory created in watched directory'],
        512 => ['ON_DELETE', 'File or directory deleted in watched directory'],
        1024 => ['ON_DELETE_SELF', 'Watched file or directory was deleted'],
        2048 => ['ON_MOVE_SELF', 'Watch file or directory was moved'],
        24 => ['ON_CLOSE', 'Equals to ON_CLOSE_WRITE | ON_CLOSE_NOWRITE'],
        192 => ['ON_MOVE', 'Equals to ON_MOVED_FROM | ON_MOVED_TO'],
        4095 => ['ON_ALL_EVENTS', 'Bitmask of all the above constants'],
        8192 => ['ON_UNMOUNT', 'File system containing watched object was unmounted'],
        16384 => ['ON_Q_OVERFLOW', 'Event queue overflowed (wd is -1 for this event)'],
        32768 => ['ON_IGNORED', 'Watch was removed (explicitly by inotify_rm_watch() or because file was removed or filesystem unmounted'],
        1073741824 => ['ON_ISDIR', 'Subject of this event is a directory'],
        1073741840 => ['ON_CLOSE_NOWRITE', 'High-bit: File not opened for writing was closed'],
        1073741856 => ['ON_OPEN', 'High-bit: File was opened'],
        1073742080 => ['ON_CREATE', 'High-bit: File or directory created in watched directory'],
        1073742336 => ['ON_DELETE', 'High-bit: File or directory deleted in watched directory'],
        16777216 => ['ON_ONLYDIR', 'Only watch pathname if it is a directory (Since Linux 2.6.15)'],
        33554432 => ['ON_DONT_FOLLOW', 'Do not dereference pathname if it is a symlink (Since Linux 2.6.15)'],
        536870912 => ['ON_MASK_ADD', 'Add events to watch mask for this pathname if it already exists (instead of replacing mask).'],
        2147483648 => ['ON_ONESHOT', 'Monitor pathname for one event, then remove from watch list.'],
    ];

    public static function getCodeDescription(int $code): string
    {
        if (!isset(self::$constants[$code])) {
            throw new InvalidArgumentException('Unknown code');
        }

        return implode(' - ', self::$constants[$code]);
    }

    public static function createFromMask(int $code): self
    {
        try {
            return new self($code);
        } catch (UnexpectedValueException $exception) {
            return self::UNKNOWN();
        }
    }
}