UserStatistics::searchStatsByTypeDesc() - Code Metrics - Inspection of "Add Code Tables feature" - scriptotek/php-alma-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#24)

unknown

created 2021-05-25 18:48 UTC

UserStatistics::searchStatsByTypeDesc() A

↳ Parent: UserStatistics

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	10
Ratio	100 %

Importance

Changes

Metric	Value
cc	3
nc	3
nop	1
dl	10
loc	10
rs	9.9332
c	0
b	0
f	0

<?php

namespace Scriptotek\Alma\Users;

use Scriptotek\Alma\Client;
use Scriptotek\Alma\Model\Model;

/**
 * Iterable collection of statistics resources.
 */
class UserStatistics extends Model
{
    /**
     * Get the user's statistics.
     *
     * @return Array of Statistics.
     */
    public function getStatistics()
    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                array_push($stats,$statistic);
        }
        return $stats;
    }

    /**
    * Get a statistic.
    *
    * @param $typeCode code of the category type.
    * @param $categoryCode code of the statistical category.
    *
    * @return Statistic.

    */
    public function getStatistic($typeCode,$categoryCode)
    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (($statistic->category_type->value == $typeCode) && 
                ($statistic->statistic_category->value == $categoryCode)) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Add a user statistic with no regard to existing Types and Categories.
    *
    * @param string $typeCode code of the category type.
    * @param string $typeDesc description of the category type.
    * @param string $categoryCode code of the statistical category.
    * @param string $categoryDesc description of the statistical category.
    * @param string $note free text description of the statistic.
    * @param string $segment_type (Internal|External)
    *
    * @return Statistic
    */
    public function addStatisticRaw($typeCode,$typeDesc,$categoryCode,$categoryDesc,$segment_type,$note)
    {
        # Create the new statistic object
        $stat_obj = (object) [
            'statistic_category' => (object) [
                'value' => $categoryCode,
                'desc'  => $categoryDesc,
            ],
            'category_type' => (object) [
                'value' => $typeCode,
                'desc'  => $typeDesc,
            ],
            'statistic_note' => $note,
            'segment_type'   => $segment_type,
        ];

        # Add the object to the user
        $this->data[] = $stat_obj;

        /*  Not Sure this is quite right or needed. */
        #return Statistic::make($this->client,$stat_obj);
        #return($this->data);
    }

    /**
    * Add a user statistic based upon existing Types and Categories.
    *
    * @param string $typeCode code of the category type.
    * @param string $categoryCode code of the statistical category.
    *
    * @return Statistic
    */
    public function addStatistic($typeCode,$categoryCode,$segmentType,$note)
    {
        //* TODO HERE *//

        /* Logic: */
        /* Lookup both $typeCode and $categoryCode in codetable */
        /* Obtain information (code/description) from both code tables. */
        /* If found and ok, add the statistic to the user */

        /* Code Tables used:
            Code Table; UserStatisticalTypes
            Code Table: UserStatCategories
        */

        /* Seems to be an issue with # of categoryCodes that can be pulled at once (max:10) */
        /* But performing via curl returns all (???). */
        /* May need to open a case to allow resumption on pulling code tables regarding 'limit' and 'offset'? */

        #
        # These functions for CodeTables need defined.
        #
        #$typeDesc = $this->conf->CodeTables->getDesc('UserStatisticalTypes',$typeCode);
        #$categoryDesc = $this->conf->CodeTables->getDesc('UserStatCagegories',$categoryCode);
        #
        # These are temporary for testing.
        $typeDesc = 'Test';
        $categoryDesc = 'Test';
        
        $this->addStatisticRaw($typeCode,$typeDesc,$categoryCode,$categoryDesc,$segmentType,$note);

    }

    /**
    * Delete a user statistic.
    *
    * @param string $typeCode code of the category type.
    * @param string $categoryCode code of the statistical category.
    */
    public function removeStatistic($typeCode,$categoryCode)
    {
        $max = sizeof($this->data);
        $ret = false;
        for($i = 0; $i < $max; $i++) {
            if (($this->data[$i]->category_type->value == $typeCode) && ($this->data[$i]->statistic_category->value == $categoryCode)) {
                unset($this->data[$i]);
                $ret = true;
            }
        }
        return($ret);
    }

    /**
    * Update a user statistic.
    *
    */
    public function updateStatistic($fromTypeCode,$fromCategoryCode,$toTypeCode,$toCategoryCode,$segementType,$note)
    {
        /* Remove "from" statistic, then add "to" statistic */
        $this->removeStatistic($fromTypeCode,$categoryCode);

        $this->addStatistic($toTypeCode,$toCategoryCode,$segmentType,$note);

    }

    /**
    * Get Stats By Type Code.
    *
    * @return Array of Statistics.
    */
    public function getStatsByTypeCode($typeCode)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($statistic->category_type->value == $typeCode) {
                array_push($stats,$statistic);
            }
    
        }
        return $stats;
    } 

    /**
    * Get Stats by Type Desc.
    *
    * @return Array of statistics.
    */
    public function getStatsByTypeDesc($typeDesc)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($statistic->category_type->desc == $typeDesc) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Get Stats by Category Code.
    *
    * @return Array of Statistics.
    */
    public function getStatsByCategoryCode($categoryCode)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($statistic->statistic_category->value == $categoryCode) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Get Stats by Category Desc.
    *
    * @return Array of Statistics.
    */
    public function getStatsByCategoryDesc($categoryDesc)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($statistic->statistic_category->desc == $categoryDesc) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Get Stats by Segment Type.
    *
    * @return Array of Statistics.
    */
    public function getStatsBySegmentType($segmentType)
    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($statistic->segment_type == $segmentType) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }  

    /**
    * Search Stats by Note.
    *
    * @return Array of Statistics.
    */
    public function searchStatsByNote($note)
    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match("/$note/i", $statistic->statistic_note)) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /** 
    * Search Stats by Type Code.
    *
    * @return Array of Statistics.
    */
    public function searchStatsByTypeCode($typeCode)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match("/$typeCode/i", $statistic->category_type->value)) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Search Stats by Type Code.
    *
    * @return Array of Statistics.
    */
    public function searchStatsByTypeDesc($typeDesc)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match("/$typeDesc/i", $statistic->category_type->desc)) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Search Stats by Type Code.
    *
    * @return Array of Statistics.
    */
    public function searchStatsByCategoryCode($categoryCode)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match("/$categoryCode/i", $statistic->statistic_category->value)) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Search Stats by Type Code.
    *
    * @return Array of Statistics.
    */
    public function searchStatsByCategoryDesc($categoryDesc)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match("/$categoryDesc/i", $statistic->statistic_category->desc)) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

}


1			<?php
2
3			namespace Scriptotek\Alma\Users;
4
5			use Scriptotek\Alma\Client;
6			use Scriptotek\Alma\Model\Model;
7
8			/**
9			* Iterable collection of statistics resources.
10			*/
11			class UserStatistics extends Model
12			{
13			/**
14			* Get the user's statistics.
15			*
16			* @return Array of Statistics.
17			*/
18			public function getStatistics()
19			{
20			$stats = array();
21			foreach ($this->data as $statistic) {
			0 ignored issues – show Bug introduced 2021-05-25 18:53 UTC by Report Bug Copy Issue Report The expression `$this->data` of type `object<stdClass>\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
22			array_push($stats,$statistic);
23			}
24			return $stats;
25			}
26
27			/**
28			* Get a statistic.
29			*
30			* @param $typeCode code of the category type.
31			* @param $categoryCode code of the statistical category.
32			*
33			* @return Statistic.
			0 ignored issues – show Documentation introduced 2021-05-25 18:53 UTC by Report Bug Copy Issue Report The doc-type `Statistic.` could not be parsed: Unknown type name "Statistic." at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
34			*/
35			public function getStatistic($typeCode,$categoryCode)
36			{
37			$stats = array();
38			foreach ($this->data as $statistic) {

scriptotek / php-alma-client

Pull Request — master (#24)

UserStatistics::searchStatsByTypeDesc() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like