samsoncms\api\query\Generic

Complexity

Total Complexity

10

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	where()	0	10	2
A	findByNavigationIDs()	0	4	1
A	findByAdditionalFields()	0	15	3
A	findByAdditionalField()	0	6	1
A	find()	0	16	3

<?php
/**
 * Created by PhpStorm.
 * User: VITALYIEGOROV
 * Date: 08.12.15
 * Time: 23:11
 */
namespace samsoncms\api\query;

use samson\activerecord\dbQuery;
use samsonframework\orm\Query;

/**
 * Material with additional fields query.
 * @package samsoncms\api
 */
class Generic
{
    /** @var string Entity identifier */
    protected static $identifier;

    /** @var string Entity navigation identifiers */
    protected static $navigationIDs;

    /** @var array Collection of entity field filter */
    protected $fieldFilter;

    /** @var array Collection of matching entity identifiers */
    protected $entityIDs;

    /**
     * Add condition to current query.
     *
     * @param string $fieldName Entity field name
     * @param string $fieldValue Value
     * @param string $relation Relation between field name and its value
     * @return self Chaining
     */
    public function where($fieldName, $fieldValue = null, $relation = '=')

The parameter $relation is not used and could be removed.

    {
        // Try to find entity additional field
        if (property_exists(static::$identifier, $fieldName)) {
            // Store additional field filter value
            $this->fieldFilter[$fieldName] = $fieldValue;
        }

        return $this;
    }

    /**
     * Get collection of entity identifiers filtered by navigation identifiers.
     *
     * @param array $entityIDs Additional collection of entity identifiers for filtering
     * @return array Collection of material identifiers by navigation identifiers
     */
    protected function findByNavigationIDs($entityIDs)
    {
        return (new MaterialNavigation($entityIDs))->idsByRelationID(static::$navigationIDs);
    }

    /**
     * Get collection of entity identifiers filtered by additional field and its value.
     *
     * @param array $additionalFields Collection of additional field identifiers => values
     * @param array $entityIDs Additional collection of entity identifiers for filtering
     * @return array Collection of material identifiers by navigation identifiers
     */
    protected function findByAdditionalFields($additionalFields, $entityIDs = array())
    {
        // Iterate all additional fields needed for filter entity
        foreach ($additionalFields as $fieldID => $fieldValue) {
            // Get collection of entity identifiers passing already found identifiers
            $entityIDs = (new MaterialField($entityIDs))->idsByRelationID($fieldID, $fieldValue);

            // Stop execution if we have no entities found at this step
            if (!sizeof($entityIDs)) {
                break;
            }
        }

        return $entityIDs;
    }

    /** @return array Collection of material identifiers by navigation identifiers */
    protected function findByAdditionalField()
    {
        $return = (new MaterialField($idsByNavigation))

The variable $idsByNavigation does not exist. Did you forget to declare it?

$return is not used, you could remove the assignment.

            ->byRelationID($this->fieldFilter[]);
        return (new MaterialNavigation())->idsByRelationID(static::$navigationIDs);
    }

    /**
     * Perform SamsonCMS query and get entities collection.
     *
     * @return mixed[] Collection of found entities
     */
    public function find()
    {
        $return = array();
        /** @var array $idsByNavigation First step - filter by navigation */
        if (sizeof($idsByNavigation = $this->findByNavigationIDs())) {

The call to findByNavigationIDs() misses a required argument $entityIDs.

            // Second step filter by additional field value
            if (sizeof($this->fieldFilter)) {
                $return = (new MaterialField($idsByNavigation))

$idsByNavigation is of type boolean|object<samsonframework\orm\RecordInterface>, but the function expects a array.

                    ->byRelationID($this->fieldFilter[]);
            } else { // Just return entities filtered by navigation
                return (new Material($idsByNavigation, static::$identifier))->byIDs($idsByNavigation, 'exec');

$idsByNavigation is of type boolean|object<samsonframework\orm\RecordInterface>, but the function expects a array.

$idsByNavigation is of type boolean|object<samsonframework\orm\RecordInterface>, but the function expects a string|array.

            }
        }

        return $return;
    }
}