samsoncms\api\Material

Complexity

Total Complexity

55

Size/Duplication

Total Lines	448
Duplicated Lines	9.6 %

Coupling/Cohesion

Components	3
Dependencies	8

Importance

Changes	9
Bugs	2	Features	6

11 Methods

Rating	Name	Duplication	Size	Complexity
B	idsByFieldValue()	0	36	5
A	idsByNavigationID()	0	22	3
A	byFieldValue()	6	14	3
A	byNavigationID()	15	15	3
A	byNavigationIdAndFieldValue()	6	21	4
A	byUrl()	0	8	2
B	setFieldByID()	0	37	5
A	selectText()	0	19	4
B	gallery()	0	31	5
C	copy()	16	42	8
D	getTable()	0	89	13

<?php
/**
 * Created by Vitaly Iegorov <egorov@samsonos.com>
 * on 07.08.14 at 17:11
 */
namespace samsoncms\api;

use \samsonframework\orm\Condition;
use \samsonframework\orm\QueryInterface;

/**
 * SamsonCMS Material database record object.
 * This class extends default ActiveRecord material table record functionality.
 * @package samson\cms
 * @author Vitaly Egorov <egorov@samsonos.com>
 */
class Material extends \samson\activerecord\material
{
    /** Override table attributes for late static binding */
    public static $_attributes = array();
    public static $_sql_select = array();
    public static $_sql_from = array();
    public static $_own_group = array();
    public static $_map = array();

    /**
     * Get identifiers collection by field identifier and its value.
     * Method is optimized for performance.
     *
     * @param QueryInterface $query Database query instance
     * @param string $fieldID Additional field identifier
     * @param string $fieldValue Additional field value for searching
     * @param array|null $return Variable where request result would be returned
     * @param array $materialIDs Collection of material identifiers for filtering query
     * @return bool|array True if material entities has been found and $return is passed
     *                      or identifiers collection if only two parameters is passed.
     */
    public static function idsByFieldValue(
        QueryInterface $query,
        $fieldID,
        $fieldValue,
        &$return = array(),
        $materialIDs = null
    ) {
        /** @var array $fields Collection for storing fields data */
        static $fields;

        /** @var Field $fieldRecord Cache field object */
        $fieldRecord = isset($fields[$fieldID]) ? $fields[$fieldID] : Field::byID($query, $fieldID);

        // We need to have field record
        if (isset($fieldRecord)) {
            $materials = array();

            // Get material identifiers by field
            $query->entity('samson\activerecord\materialfield')
                ->where('MaterialID', $materials)

$materials is of type array, but the function expects a string|null.

                ->where('Active', 1)
                ->where('FieldID', $fieldID)
                ->where($fieldRecord->valueFieldName(), $fieldValue);

            // Add material identifier filter if passed
            if (isset($materialIDs)) {
                $query->where('MaterialID', $materialIDs);

$materialIDs is of type array, but the function expects a string|null.

            }

            // Perform database query and get only material identifiers collection
            $return = $query->fields($materials);

$materials is of type array, but the function expects a string.

        }

        // If only one argument is passed - return null, otherwise bool
        return func_num_args() > 3 ? $return == null : $return;
    }

    /**
     * Get current entity identifiers collection by navigation identifier.
     *
     * @param QueryInterface $query Database query
     * @param string $navigationID Navigation identifier
     * @param array $return Variable where request result would be returned
     * @param array $materialIDs Collection of material identifiers for filtering query
     * @return bool|array True if material entities has been found and $return is passed
     *                      or collection of identifiers if only two parameters is passed.
     */
    public static function idsByNavigationID(
        QueryInterface $query,
        $navigationID,
        &$return = array(),
        $materialIDs = null
    ) {
        // Prepare query
         $query->entity('\samson\activerecord\structurematerial')
            ->where('StructureID', $navigationID)
            ->where('Active', 1);

        // Add material identifier filter if passed
        if (isset($materialIDs)) {
            $query->where('MaterialID', $materialIDs);

$materialIDs is of type array, but the function expects a string|null.

        }

        // Perform database query and get only material identifiers collection
        $return = $query->fields('MaterialID');

        // If only one argument is passed - return null, otherwise bool
        return func_num_args() > 2 ? $return == null : $return;
    }

    /**
     * Get self[] by field identifier and its value.
     * Method is optimized for performance.
     *
     * @param QueryInterface $query Database query instance
     * @param string $fieldID Additional field identifier
     * @param string $fieldValue Additional field value for searching
     * @param self[]|array|null $return Variable where request result would be returned
     * @return bool|self[] True if material entities has been found and $return is passed
     *                      or self[] if only two parameters is passed.
     */
    public static function byFieldValue(QueryInterface $query, $fieldID, $fieldValue, &$return = array())
    {
        /** @var array $materialIds Collection of entity identifiers filtered by additional field */
        $materialIds = null;
        if (static::idsByFieldValue($query, $fieldID, $fieldValue, $materialIds)) {

This code seems to be duplicated across your project.

            // Get material instances
            $return = $query->entity(get_called_class())
                ->where('MaterialID', $materialIds)

It seems like $materialIds can also be of type array; however, samsonframework\orm\QueryInterface::where() does only seem to accept string|null, maybe add an additional type check?

                ->exec();
        }

        // If only one argument is passed - return null, otherwise bool
        return func_num_args() > 3 ? $return == null : $return;
    }

    /**
     * Get current entity instances collection by navigation identifier.
     *
     * @param QueryInterface $query Database query
     * @param string $navigationID Navigation identifier
     * @param self[]|array|null $return Variable where request result would be returned
     * @return bool|self[] True if material entities has been found and $return is passed
     *                      or self[] if only two parameters is passed.
     */
    public static function byNavigationID(QueryInterface $query, $navigationID, &$return = array())

This method seems to be duplicated in your project.

    {
        /** @var array $materialIds Collection of entity identifiers filtered by additional field */
        $materialIds = null;
        if (static::idsByNavigationID($query, $navigationID, $materialIds)) {
            $return = $query->entity(get_called_class())
                ->where('MaterialID', $materialIds)

$materialIds is of type array, but the function expects a string|null.

                ->where('Active', 1)
                ->where('Published', 1)
                ->exec();
        }

        // If only one argument is passed - return null, otherwise bool
        return func_num_args() > 2 ? $return == null : $return;
    }

    /**
     * Get current entity instances collection by navigation identifier.
     *
     * @param QueryInterface $query Database query
     * @param string $navigationID Navigation identifier
     * @param string $fieldID Additional field identifier
     * @param string $fieldValue Additional field value for searching
     * @param self[]|array|null $return Variable where request result would be returned
     * @return bool|Material[] True if material entities has been found and $return is passed
     *                      or self[] if only two parameters is passed.
     */
    public static function byNavigationIdAndFieldValue(
        QueryInterface $query,
        $navigationID,
        $fieldID,
        $fieldValue,
        &$return = array()
    ) {
        /** @var array $materialIds Collection of entity identifiers filtered by additional field */
        $materialIds = null;
        if (static::idsByNavigationID($query, $navigationID, $materialIds)) {
            if (static::idsByFieldValue($query, $fieldID, $fieldValue, $materialIds, $materialIds)) {

This code seems to be duplicated across your project.

                // Get entities by filtered identifiers
                $return = $query->entity(get_called_class())
                    ->where('MaterialID', $materialIds)

It seems like $materialIds can also be of type array; however, samsonframework\orm\QueryInterface::where() does only seem to accept string|null, maybe add an additional type check?

                    ->exec();
            }
        }

        // If only one argument is passed - return null, otherwise bool
        return func_num_args() > 4 ? $return == null : $return;
    }

    /**
     * Get material entities collection by URL(s).
     * @param QueryInterface $query Object for performing database queries
     * @param array|string $url Material URL or collection of material URLs
     * @param self[]|array|null $return Variable where request result would be returned
     * @return bool|self[] True if material entities has been found
     */
    public static function byUrl(QueryInterface $query, $url, & $return = array())
    {
        // Get field record by identifier column
        $return = static::collectionByColumn($query, 'Url', $url);

It seems like $url defined by parameter $url on line 199 can also be of type array; however, samsonframework\orm\Record::collectionByColumn() does only seem to accept string, maybe add an additional type check?

        // If only one argument is passed - return null, otherwise bool
        return func_num_args() > 1 ? $return == null : $return;
    }

    /**
     * Set additional material field value by field identifier
     * @param string $fieldID Field identifier
     * @param string $value Value to be stored
     * @param string $locale Locale identifier
     */
    public function setFieldByID($fieldID, $value, $locale = DEFAULT_LOCALE)
    {
        // TODO: This should be removed
        /** @var QueryInterface $query This should be removed to use $this->database*/
        $query = dbQuery();

The call to dbQuery() misses a required argument $class_name.

        /** @var Field $fieldRecord Try to find this additional field */
        $fieldRecord = null;
        if (Field::byID($query, $fieldID, $fieldRecord)) {

$fieldRecord is of type object<samsoncms\api\Field>, but the function expects a null|object<self>.

            /** @var MaterialField $materialFieldRecord Try to find additional field value */
            $materialFieldRecord = null;
            if (!MaterialField::byFieldIDAndMaterialID($query, $this->id, $fieldRecord->id, $materialFieldRecord)) {

$materialFieldRecord is of type object<samsoncms\api\MaterialField>, but the function expects a null|object<self>.

                // Create new additional field value record if it does not exists
                $materialFieldRecord = new MaterialField();
                $materialFieldRecord->FieldID = $fieldRecord->id;

The property FieldID does not seem to exist in samsoncms\api\MaterialField.

                $materialFieldRecord->MaterialID = $this->id;

The property MaterialID does not seem to exist in samsoncms\api\MaterialField.

                $materialFieldRecord->Active = 1;

The property Active does not seem to exist in samsoncms\api\MaterialField.

                $materialFieldRecord->locale = $locale;

The property locale does not seem to exist in samsoncms\api\MaterialField.

            }

            // Define which field should be filled
            switch ($fieldRecord->Type) {
                case 1:
                    $valueFieldName = 'numeric_value';
                    break;
                case 2:
                    $valueFieldName = 'key_value';
                    break;
                default:
                    $valueFieldName = 'Value';
            }

            // At this point we already have database record instance
            $fieldRecord->$valueFieldName = $value;
            $fieldRecord->save();
        }
    }

    /**
     * Get select additional field text value
     * TODO: Find where do we use it
     * @return string Select field text
     */
    public function selectText($fieldID)
    {
        /** @var \samson\activerecord\field $field */
        $field = null;
        if (dbQuery('field')->id($fieldID)->first($field)) {

The method samson\activerecord\dbQuery::id() has been deprecated with message: Use direct query with where('PRIMARY_FIELD',...)

            // If this entity has this field set
            if (isset($this[$field->Name]{0})) {
                $types = array();
                foreach (explode(',', $field->Value) as $typeValue) {
                    $typeValue = explode(':', $typeValue);
                    $types[$typeValue[0]] = $typeValue[1];
                }
                return $types[$this[$field->Name]];
            }
        }

        // Value not set
        return '';
    }

    /**
     * Get collection of images for material by gallery additional field selector. If none is passed
     * all images from gallery table would be returned for this material entity.
     *
     * @param string|null $fieldSelector Additional field selector value
     * @param string $selector Additional field field name to search for
     * @return \samson\activerecord\gallery[] Collection of images in this gallery additional field for material
     */
    public function &gallery($fieldSelector = null, $selector = 'FieldID')
    {
        /** @var \samson\activerecord\gallery[] $images Get material images for this gallery */
        $images = array();

        /* @var \samson\activerecord\field Get field object if we need to search it by other fields */
        $field = null;

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

        if ($selector != 'FieldID') {
            $field = dbQuery('field')->cond($selector, $fieldSelector)->first();

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

            $fieldSelector = $field->id;
        }

        // Create query
        $query = dbQuery('materialfield');

        // Add field filter if present
        if (isset($fieldSelector)) {
            $query->cond("FieldID", $fieldSelector);

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

        }

        /** @var \samson\activerecord\materialfield $dbMaterialField Find material field gallery record */
        $dbMaterialField = null;
        if ($query->cond('MaterialID', $this->id)->first($dbMaterialField)) {

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

            // Get material images for this materialfield
            if (dbQuery('gallery')->cond('materialFieldId', $dbMaterialField->id)->exec($images)) {

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

            }
        }

        return $images;
    }

    /**
     * Create copy of current object
     * @param mixed $clone Material for cloning
     * @param array $excludedFields excluded from materialfield fields identifiers
     * @returns void
     */
    public function &copy(& $clone = null, $excludedFields = array())
    {
        // Create new instance by copying
        $clone = parent::copy($clone);

        /** @var \samson\activerecord\structurematerial[] $objects Create structure material relations */
        $objects = array();
        if (dbQuery('structurematerial')->cond('MaterialID', $this->MaterialID)->exec($objects)) {

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

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

This code seems to be duplicated across your project.

            foreach ($objects as $cmsNavigation) {
                /** @var \samson\activerecord\Record $copy */
                $copy = $cmsNavigation->copy();
                $copy->MaterialID = $clone->id;
                $copy->save();
            }
        }
        /** @var \samson\activerecord\materialfield[] $objects Create material field relations */
        $objects = array();
        if (dbQuery('materialfield')->cond('MaterialID', $this->MaterialID)->exec($objects)) {

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

            foreach ($objects as $pMaterialField) {
                // Check if field is NOT excluded from copying
                if (!in_array($pMaterialField->FieldID, $excludedFields)) {
                    /** @var \samson\activerecord\dbRecord $copy Copy instance */
                    $copy = $pMaterialField->copy();
                    $copy->MaterialID = $clone->id;

The property MaterialID does not seem to exist in samson\activerecord\dbRecord.

                    $copy->save();
                }
            }
        }

        /** @var \samson\activerecord\gallery[] $objects Create gallery field relations */
        $objects = array();
        if (dbQuery('gallery')->cond('MaterialID', $this->MaterialID)->exec($objects)) {

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

This code seems to be duplicated across your project.

            foreach ($objects as $cmsGallery) {
                /** @var \samson\activerecord\Record $copy */
                $copy = $cmsGallery->copy();
                $copy->MaterialID = $clone->id;
                $copy->save();
            }
        }

        return $clone;
    }

    /**
     * Function to retrieve this material table by specified field
     * @param string $tableSelector Selector to identify table structure
     * @param string $selector Database field by which search is performed
     * @param array $tableColumns Columns names list
     * @param string $externalHandler External handler to perform some extra code
     * @param array $params External handler params
     * @return array Collection of collections of table cells, represented as materialfield objects
     */
    public function getTable($tableSelector, $selector = 'StructureID', &$tableColumns = null, $externalHandler = null, $params = array())
    {
        /** @var array $resultTable Collection of collections of field cells */
        $resultTable = array();
        /** @var array $dbTableFieldsIds Array of table structure column identifiers */
        $dbTableFieldsIds = array();

        // Get structure object if we need to search it by other fields
        if ($selector != 'StructureID') {
            $structure = dbQuery('structure')->cond($selector, $tableSelector)->first();

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

            $tableSelector = $structure->id;
        }

        /** If this table has columns */
        if (dbQuery('structurefield')

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

            ->cond("StructureID", $tableSelector)
            ->fields('FieldID', $dbTableFieldsIds)

$dbTableFieldsIds is of type array, but the function expects a string|null.

        ) {
            // Get localized and not localized fields
            $localizedFields = array();
            $unlocalizedFields = array();
            /** @var \samson\cms\CMSField $dbTableField Table column */
            foreach (dbQuery('field')->order_by('priority')->cond('FieldID', $dbTableFieldsIds)->exec() as $field) {

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

                /** Add table columns names */
                $tableColumns[] = $field->Name;
                if ($field->local == 1) {
                    $localizedFields[] = $field->id;
                } else {
                    $unlocalizedFields[] = $field->id;
                }
            }

            // Query to get table rows(table materials)
            $tableQuery = dbQuery('material')

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

                ->cond('parent_id', $this->MaterialID)
                ->cond('Active', '1')
                ->join('structurematerial')
                ->cond('structurematerial_StructureID', $tableSelector)
                ->order_by('priority');

            // Call user function if exists
            if (is_callable($externalHandler)) {
                // Give it query as parameter
                call_user_func_array($externalHandler, array_merge(array(&$tableQuery), $params));
            }

            // Get table row materials
            $tableMaterialIds = array();
            if ($tableQuery->fields('MaterialID', $tableMaterialIds)) {
                // Create field condition
                $localizationFieldCond = new Condition('or');

                // Create localized condition
                if (sizeof($localizedFields)) {
                    $localizedFieldCond = new Condition('and');
                    $localizedFieldCond->add('materialfield_FieldID', $localizedFields)
                        ->add('materialfield_locale', locale());
                    // Add this condition to condition group
                    $localizationFieldCond->add($localizedFieldCond);

The call to add() misses a required argument $value.

$localizedFieldCond is of type object<samsonframework\orm\Condition>, but the function expects a string.

                }

                // Create not localized condition
                if (sizeof($unlocalizedFields)) {
                    $localizationFieldCond->add('materialfield_FieldID', $unlocalizedFields);
                }

                // Create db query
                $materialFieldQuery = dbQuery('materialfield')

The method samson\activerecord\dbQuery::cond() has been deprecated with message: @see self::where()

                    ->cond('MaterialID', $tableMaterialIds)

$tableMaterialIds is of type array, but the function expects a string|null.

                    ->cond($localizationFieldCond);

$localizationFieldCond is of type object<samsonframework\orm\Condition>, but the function expects a string|object<samson\activerecord\ConditionInterface>|object<samson\activerecord\ArgumentInterface>.

                // Flip field identifiers as keys
                $tableColumnIds = array_flip($dbTableFieldsIds);
                $resultTable = array_flip($tableMaterialIds);

                /** @var \samson\activerecord\material $dbTableRow Material object (table row) */
                foreach ($materialFieldQuery->exec() as $mf) {
                    if (!is_array($resultTable[$mf['MaterialID']])) {
                        $resultTable[$mf['MaterialID']] = array();
                    }

                    $resultTable[$mf['MaterialID']][$tableColumnIds[$mf->FieldID]] =
                        !empty($mf->Value) ? $mf->Value : (!empty($mf->numeric_value) ? $mf->numeric_value : $mf->key_value);
                }
            }
        }

        return array_values($resultTable);
    }
}