rhosocial\user\models\invitation\registration\UserInvitationRegistrationTrait

Complexity

Total Complexity

16

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

73.52%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	createInvitationRegistration()	0	4	1
A	hasEnabledInvitationRegistration()	0	7	4
A	getInvitationRegistrations()	0	10	2
A	getInvitationRegistrationInvitees()	0	4	1
B	registerAccordingToInvitation()	0	29	8

<?php

/**
 *  _   __ __ _____ _____ ___  ____  _____
 * | | / // // ___//_  _//   ||  __||_   _|
 * | |/ // /(__  )  / / / /| || |     | |
 * |___//_//____/  /_/ /_/ |_||_|     |_|
 * @link https://vistart.me/
 * @copyright Copyright (c) 2016 - 2017 vistart
 * @license https://vistart.me/license/
 */

namespace rhosocial\user\models\invitation\registration;

use rhosocial\base\models\queries\BaseBlameableQuery;
use rhosocial\user\models\invitation\Invitation;
use rhosocial\user\User;
use Yii;
use yii\base\InvalidParamException;
use yii\db\IntegrityException;

/**
 * Trait UserInvitationRegistrationTrait
 * @property-read Invitation[] invitationRegistrations
 * @property-read User[] invitationRegistrationInvitees
 *
 * @package rhosocial\user\models\invitation\registration
 * @version 1.0
 * @author vistart <i@vistart.me>
 */
trait UserInvitationRegistrationTrait
{
    public $invitationRegistrationClass = Registration::class;
    /**
     * @param array $associatedModels
     * @param array $authRoles
     * @param User $inviter
     * @return boolean
     * @throws \Exception
     * @throws InvalidParamException
     */
    public function registerAccordingToInvitation($associatedModels = [], $authRoles = [], $inviter)
    {
        if (!$inviter) {
            return false;
        }
        if ($inviter instanceof User && $inviter->getIsNewRecord()) {
            throw new InvalidParamException("Inviter cannot be a new user.");
        }
        $transaction = Yii::$app->db->beginTransaction();
        try {
            $result = $this->register($associatedModels, $authRoles);

The method register() does not exist on rhosocial\user\models\invitation\registration\UserInvitationRegistrationTrait. Did you maybe mean registerAccordingToInvitation()?

            if ($result instanceof \Exception) {
                throw $result;
            }
            if ($result !== true) {
                throw new IntegrityException("Registration Failed.");
            }
            $invitation = $inviter->createInvitationRegistration($this);
            $result = $invitation->save();
            if (!$result) {
                throw new IntegrityException("Record Invitation Failed.");
            }
            $transaction->commit();
        } catch (\Exception $ex) {
            $transaction->rollBack();
            throw $ex;
        }
        return true;
    }

    /**
     * Create a registration invitation instance.
     * @param string|User $invitee The invited person.
     * @return Registration
     */
    public function createInvitationRegistration($invitee)
    {
        return $this->create($this->invitationRegistrationClass, ['invitee' => $invitee]);

The method create() does not exist on rhosocial\user\models\invitation\registration\UserInvitationRegistrationTrait. Did you maybe mean createInvitationRegistration()?

    }

    /**
     * Check whether this user enables the invitation from registration feature or not.
     * @return boolean
     */
    public function hasEnabledInvitationRegistration()
    {
        if ($this->invitationRegistrationClass === false || !is_string($this->invitationRegistrationClass) || !class_exists($this->invitationRegistrationClass)) {
            return false;
        }
        return true;
    }

    /**
     * @return BaseBlameableQuery
     */
    public function getInvitationRegistrations()
    {
        if (!$this->hasEnabledInvitationRegistration()) {
            return null;
        }
        $irClass = $this->invitationRegistrationClass;
        $noInit = $irClass::buildNoInitModel();
        /* @var $noInit Registration */
        return $this->hasMany($irClass, [$noInit->createdByAttribute => $this->guidAttribute]);

The property guidAttribute does not exist. Did you maybe forget to declare it?

It seems like hasMany() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @return User[]
     */
    public function getInvitationRegistrationInvitees()
    {
        return $this->hasMany(static::class, [$this->guidAttribute => 'invitee_guid'])->via('invitationRegistrations');

It seems like hasMany() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
}