flipbox\organizations\validators\OrganizationsValidator

Complexity

Total Complexity

10

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	8	2
A	validateAttribute()	0	11	3
A	validateOrganizations()	0	24	5

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://flipboxfactory.com/software/organization/license
 * @link       https://www.flipboxfactory.com/software/organization/
 */

namespace flipbox\organizations\validators;

use craft\helpers\Json;
use flipbox\organizations\behaviors\OrganizationsAssociatedToUserBehavior;
use flipbox\organizations\Organizations as OrganizationPlugin;
use Tightenco\Collect\Support\Collection;
use yii\base\Model;
use yii\validators\Validator;

/**
 * Validates all associated
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
class OrganizationsValidator extends Validator
{
    const DEFAULT_MESSAGE = 'Invalid organizations.';

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();

        if ($this->message === null) {
            $this->message = OrganizationPlugin::t(static::DEFAULT_MESSAGE);
        }
    }

    /**
     * Validates a single attribute.
     * Child classes must implement this method to provide the actual validation logic.
     * @param Model|OrganizationsAssociatedToUserBehavior $model the data model to be validated
     * @param string $attribute the name of the attribute to be validated.
     */
    public function validateAttribute($model, $attribute)
    {
        if (!$model->getOrganizations()->isMutated()) {

The method getOrganizations does only exist in flipbox\organizations\behaviors\OrganizationsAssociatedToUserBehavior, but not in yii\base\Model.

            return;
        }

        $result = $this->validateOrganizations($model->getOrganizations()->getCollection());
        if (!empty($result)) {
            $this->addError($model, $attribute, $result[0], $result[1]);

It seems like $model defined by parameter $model on line 45 can also be of type object<flipbox\organizations\behaviors\OrganizationsAssociatedToUserBehavior>; however, yii\validators\Validator::addError() does only seem to accept object<yii\base\Model>, maybe add an additional type check?

        }
    }

    /**
     * @param Collection $organizations
     * @return array|null
     */
    private function validateOrganizations(Collection $organizations)
    {
        $hasError = false;

        foreach ($organizations as $organization) {
            if (null === $organization->id && !$organization->validate()) {
                $hasError = true;

                OrganizationPlugin::warning(
                    sprintf(
                        "Invalid organization: '%s'",
                        Json::encode($organization->getFirstErrors())
                    ),
                    __METHOD__
                );
            }
        }

        if ($hasError) {
            return [$this->message, []];
        }

        return null;
    }
}