bristol-su / control

src/Observers/NotifyObservers/DataRoleNotifier.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Observers\NotifyObservers;

use BristolSU\ControlDB\Contracts\Repositories\DataRole as DataRoleRepository;
use BristolSU\ControlDB\Observers\NotifyObservers\Framework\Notifier;
use BristolSU\ControlDB\Observers\NotifyObservers\Framework\ObserverStore;
use Illuminate\Support\Collection;

class DataRoleNotifier extends Notifier implements DataRoleRepository

Missing doc comment for class DataRoleNotifier

{

    /**

Missing short description in doc comment

     * @var DataRoleRepository
     */
    private $dataRoleRepository;

Private member variable "dataRoleRepository" must be prefixed with an underscore

    public function __construct(DataRoleRepository $dataRoleRepository, ObserverStore $observerStore)

Missing doc comment for function __construct()

    {
        parent::__construct($observerStore, DataRoleRepository::class);
        $this->dataRoleRepository = $dataRoleRepository;
    }

    /**
     * Get a data role by ID
     *
     * @param int $id

Missing parameter comment

     * @return \BristolSU\ControlDB\Contracts\Models\DataRole

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getById(int $id): \BristolSU\ControlDB\Contracts\Models\DataRole
    {
        return $this->dataRoleRepository->getById($id);
    }

    /**
     * Get a data role where the given attributes match, including additional attributes.
     *
     * @param array $attributes

Missing parameter comment

     * @return \BristolSU\ControlDB\Contracts\Models\DataRole

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getWhere($attributes = []): \BristolSU\ControlDB\Contracts\Models\DataRole
    {
        return $this->dataRoleRepository->getWhere($attributes);
    }

    /**
     * Get all data roles where the given attributes match, including additional attributes.
     *
     * @param array $attributes

Missing parameter comment

     * @return Collection|\BristolSU\ControlDB\Contracts\Models\DataRole[]

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getAllWhere($attributes = []): Collection
    {
        return $this->dataRoleRepository->getAllWhere($attributes);
    }

    /**
     * Create a data role with the given attributes
     *
     * @param string|null $roleName Custom name for the role
     * @param string|null $email Email of the role

Expected 4 spaces after parameter name; 1 found

     * @return \BristolSU\ControlDB\Contracts\Models\DataRole

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function create(?string $roleName = null, ?string $email = null): \BristolSU\ControlDB\Contracts\Models\DataRole
    {
        $dataRole = $this->dataRoleRepository->create($roleName, $email);
        $this->notify('create', $dataRole);
        return $dataRole;
    }

    /**
     * Update a role with the given attributes
     *
     * @param int $id

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

     * @param string|null $roleName Name of the role
     * @param string|null $email Email of the role

Expected 4 spaces after parameter name; 1 found

     * @return \BristolSU\ControlDB\Contracts\Models\DataRole

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function update(int $id, ?string $roleName = null, ?string $email = null): \BristolSU\ControlDB\Contracts\Models\DataRole
    {
        $oldDataRole = $this->getById($id);
        $newDataRole = $this->dataRoleRepository->update($id, $roleName, $email);
        $this->notify('update', $oldDataRole, $newDataRole);
        return $newDataRole;
    }
    
    
}