jeyroik/extas-players-groups

There is no license information available for the latest version (0.1.0) of this package.

Groups for extas players

0.1.0 2020-08-19 09:29 UTC

Requires

• jeyroik/extas-players: 2.*

Requires (Dev)

• jeyroik/extas-repositories-mongo: 1.*
• jeyroik/extas-snuffbox: 0.*
• jeyroik/extas-snuffbox-repositories: 0.*
• phpstan/phpstan: 0.*
• phpunit/phpunit: ^9
• vlucas/phpdotenv: ^3.4

Unknown License

README

Описание

Пакет предоставляет функционал групп пользователей.

Установка

# vendor/bin/extas i

Пакет предоставляет несколько базовых групп: public, authorized, admin.

Чтобы их использовать, необходимо в родительском пакете прописать импорт:

{
  "import": {
    "from": {
      "extas/players-groups": {
        "players_groups": "*"
      }
    },
    "parameters": {
      "on_miss_package": {
        "name": "on_miss_package",
        "value": "throw"
      },
      "on_miss_section": {
        "name": "on_miss_section",
        "value": "throw"
      }
    }
  }
}

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

Группа представляет собой простого пользователя с определёнными параметрами.

/**
 * @var \extas\interfaces\repositories\IRepository $players
 */
$player = $players->one(['name' => 'test']);
if ($player->isGroup()) {
    $group = $player->__toGroup();
}

Группа совместима с пользователями, поэтому может использоваться стандартный репозиторий пользователей для сохранения и получения групп.

use extas\components\players\PlayerGroup;

/**
 * @var \extas\interfaces\repositories\IRepository $players
 */

$group = new PlayerGroup();
$group->setCreatorName('test')->setCreatedAt(time())->setPrivate(true);
$players->create($group);