Git Product home page Git Product logo

small's Introduction

Small

Some Small Helpers

Installation

composer require avnovoselov/small

API

  • Arguments - класс для работы с аргументами скрипта
  • Daemon - абстрактный класс демона
  • DaemonInterface - интерфейс демона
  • Path - работа с путями
  • Script - абстрактный класс скрипта
  • Terminal - класс для работы с выводом в терминал

Устаревшее ↓

Daemon

InterfaceDaemon и AbstractDaemon

Для создания нового демона следует расширить абстрактный класс AbstractDaemon и реализовать интерфейс InterfaceDaemon.

InterfaceDaemon::process() - метод, выполняемый в каждой итерации (тело демона)

Counter.php

class Counter extends \Small\AbstractDaemon
{
    private $count = 0;

    public function process()
    {
        ++$this->count;
        echo PHP_EOL . " iteration run at: {$this->lastRunDate}";
        echo PHP_EOL . " iteration number: {$this->count}";
    }
}

если необходимо добавить условия выполнения итерации, следует реализовать метод InterfaceDaemon::skip

InterfaceDaemon::skip(): bool - метод, проверяющий удовлетворены ли условия для выполнения итерации. Например подключение к БД.

class Counter extends \Small\AbstractDaemon
{
    ...

    public function skip(): bool
    {
        return time() % 2;
    }
}

В примере выше метод Counter::skip пропускает итерации, запущенные в нечетные секунды

InterfaceDaemon::environment(): InterfaceDaemon - метод, определяющий настройки окружения (Настройки подключения в БД, отображение ошибок и т.д.).

class Counter extends \Small\AbstractDaemon
{
    ...

    public function environment(): \Small\InterfaceDaemon
    {
        ini_set('display_errors', 0);
        ini_set('display_startup_errors', 0);
        error_reporting(0);

        return $this;
    }
}

AbstractDaemon::arguments(array $defaultArguments = []): \Small\InterfaceDaemon - метод, определяющий аргументы вызова демона и устанавливающий значения по умолчанию.

daemon/counter.php

$counterDaemon = new Counter('Counter');

$counterDaemon
    ->arguments(['count' => 0])
    ->run();
/> php daemon/counter.php --count=3

Для демона $counterDaemon доступен аргумент --count, со значения которого начнется счет в примере выше, аргумент --count имеет значение по умолчанию 0.

AbstractDaemon::$arguments - экземпляр класса \Small\Arguments, обеспечивающий доступ к аргументам запуска демона.

class Counter extends \Small\AbstractDaemon
{
    public function environment(): \Small\InterfaceDaemon
        {
            $this->count = $this->arguments->get('count');

            ini_set('display_errors', 0);
            ini_set('display_startup_errors', 0);
            error_reporting(0);

            return $this;
        }
}

AbstractDaemon::run(): void - запуск демона

AbstractDaemon::__construct(string $name, int $sleep = 1): AbstractDaemon - конструктор демона

  • $name - имя демона
  • $sleep - задержка между итерациями (в секундах)

Arguments

small's People

Contributors

avnovoselov avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.