PHPackages                             jeyroik/kb-plan - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. jeyroik/kb-plan

ActiveLibrary

jeyroik/kb-plan
===============

Plan package for Kilobook

0.0.3(6y ago)0122PHP

Since Jul 26Pushed 6y agoCompare

[ Source](https://github.com/jeyroik/kb-plan)[ Packagist](https://packagist.org/packages/jeyroik/kb-plan)[ RSS](/packages/jeyroik-kb-plan/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (5)Versions (2)Used By (2)

kb-plan
=======

[](#kb-plan)

Пакет с сущностью "План".

Установка
=========

[](#установка)

`composer requrie jeyroik/kb-plan`

Использование
=============

[](#использование)

Предполагается следующая модель использования данного пакета:

- Создание собственных сущностей, наследующих сущности текущего пакета (План, План-факт и Прогресс по плану).
- В рамках создания собственных сущностей рекомендуется использовать свои репозитории (но они могут наследовать репозитории по умолчанию из этого пакета).
- В остальном использование абсолютно идентично нижеприведённому.

Пример использования сущностей пакета:
--------------------------------------

[](#пример-использования-сущностей-пакета)

```
/**
 * @var $planRepo extas\interfaces\plans\IPlanRepository
 */
$plan = $planRepo->one([IPlan::FIELD__ID => 'demo.plan']);
$plan->addProgress(['items_count' => 20])
```

Создание своих сущностей
------------------------

[](#создание-своих-сущностей)

### Классы сущностей

[](#классы-сущностей)

```
class MyPlanProgress extends PlanProgress
{
    protected $planRepo = 'my\extas\plans\Repository';
}

class MyPlan extends Plan
{
    protected $planProgressRepo = 'my\extas\plans\progress\Repository';

    /**
     * @return string
     */
    protected function getPlanSubject()
    {
        return 'my.plan';
    }

    /**
     * @param array $data
     *
     * @return IPlanProgress
     */
    protected function getPlanProgress($data)
    {
        return new MyPlanProgress($data);
    }
}

class MyPlanFact extends PlanFact
{
    protected $planRepo = 'my\extas\plans\Repository';
    protected $factRepo = 'my\extas\plans\facts\Repository';
}
```

### Плагины

[](#плагины)

Для наc будет доступна следующая стадия (событие):

- `my.plan.progress.added (IPlan $plan, IPlanProgress $progress)` - добавлен прогресс по плану

Необходимо создать плагин для данного события.

```
class MyPluginFact extends PlanPluginProgressAddToFact
{
    protected $factRepo = 'my\extas\plans\facts\Repository';

    /**
     * @override_it
     *
     * @return string
     */
    protected function getPlanFactSubject()
    {
        return 'my.plan.fact';
    }

    /**
     * @override_it
     *
     * @param $factData
     *
     * @return IPlanFact
     */
    protected function getPlanFact($factData)
    {
        return new MyPlanFact($factData);
    }
}
```

После этого станет доступна стадия (событие):

- `my.plan.fact.progress.add (IPlanFact $fact, IPlanProgress $progress)` - подготовка к добавление прогресса по план-факту.

Необходимо реализовать плагин для этой стадии, чтобы применить параметры из прогресса к план-факту.

Например, будем использовать эти сущности для отслеживания прогресса чтения. Для этого будем использовать параметр прогресса "pages\_count".

```
class CountPagesPlugin extends Plugin
{
    public function __invoke(&$fact, $progress)
    {
        $factPages = $fact->getParameter('pages_count', null);
        $progressPages = $progress->getParameter('page_count', [
            'name' => 'pages_count',
            'value' => 0
        ]);

        if (!$factPages) {
            $factPages = $progressPages;
        } else {
            $factPages->setValue($factPages->getValue() + $progressPages->getValue());
        }

        $fact->setParameter('pages_count', $factPages);
        $fact->setParameter('book', $progress->getParameter('book'));
    }
}
```

### Использование всего ранее созданного вместе

[](#использование-всего-ранее-созданного-вместе)

```
/**
 * @var $planRepo my\extas\plans\Repository
 */

$plan = $planRepo->one([IPlan::FIELD__ID => 'my.plan.some.id']);
if ($plan) {
    $plan->addProgress([
        'pages_count' => 20,
        'book' => 'jeyroik/kb-plan/README.md'
    ]);
}
```

###  Health Score

22

—

LowBetter than 23% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2478d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2aaec5c4bade6ab2b5d1a0f7d97ab4e0ff2ce83937f76499b2888ad16cde5e04?d=identicon)[jeyroik](/maintainers/jeyroik)

---

Top Contributors

[![jeyroik](https://avatars.githubusercontent.com/u/6348124?v=4)](https://github.com/jeyroik "jeyroik (1 commits)")

### Embed Badge

![Health badge](/badges/jeyroik-kb-plan/health.svg)

```
[![Health](https://phpackages.com/badges/jeyroik-kb-plan/health.svg)](https://phpackages.com/packages/jeyroik-kb-plan)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)