CMSFactory\MetaManipulator\MetaManipulator

Complexity

Total Complexity

111

Size/Duplication

Total Lines	803
Duplicated Lines	3.49 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	2
Bugs	0	Features	0

53 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	39	4
A	getGraments()	0	4	1
A	getStorage()	0	4	1
A	setStorage()	0	4	1
A	__call()	0	8	3
A	make()	0	21	4
C	morphing()	0	42	8
C	getGrammensWord()	14	23	8
A	getTypeMany()	0	15	2
B	getTypeSpeechWord()	0	20	6
C	checkGrammat()	0	23	9
A	setPhpMorphy()	0	4	1
A	getPhpMorphy()	0	4	1
A	getMorph()	0	7	3
A	setMorph()	0	4	2
A	transliteration()	0	6	1
A	getBrand()	0	4	1
A	setBrand()	0	4	1
A	getCS()	0	7	2
A	setCS()	0	4	1
A	getCategory()	0	4	1
A	setCategory()	0	4	1
A	getDescLength()	0	10	3
A	setDescLength()	0	6	3
A	getDescription()	0	7	2
A	setDescription()	0	12	2
A	getModel()	0	4	1
A	setModel()	0	4	1
A	getID()	0	7	2
A	setID()	0	4	1
A	getMetaDescription()	0	4	1
A	setMetaDescription()	0	4	1
A	getMetaH1()	0	4	1
A	setMetaH1()	0	4	1
A	getMetaKeywords()	0	4	1
A	setMetaKeywords()	0	4	1
A	getMetaTitle()	0	4	1
A	setMetaTitle()	0	4	1
A	getName()	0	7	2
A	setName()	0	4	1
A	getPageNumber()	0	4	2
A	setPageNumber()	0	4	1
A	getNumber()	0	7	3
A	setNumber()	0	4	1
A	getPrice()	0	4	1
A	setPrice()	0	4	1
B	render()	14	36	6
A	getWrapper()	0	4	1
A	setWrapper()	0	4	1
A	getMatching()	0	4	2
A	setMatching()	0	4	1
A	getMetaArray()	0	4	1
A	setMetaArray()	0	8	2

<?php

namespace CMSFactory\MetaManipulator;

use CI;
use CMSFactory\assetManager;
use Currency\Currency;
use Exception;
use MY_Controller;
use phpMorphy;
use phpMorphy_Exception;
use SBrands;
use SCategory;
use SProducts;

/**
 * Class MetaManipulator
 * @package CMSFactory\MetaManipulator
 */
class MetaManipulator
{

Opening brace of a class must be on the same line as the definition

    const META_TITLE = 1;
    const META_DESCRIPTION = 2;
    const META_KEYWORDS = 3;
    const META_H1 = 4;

    /**
     * Currency
     * @var string
     */
    protected $CS;

    /**
     * ID
     * @var string
     */
    protected $ID;

    /**
     * Brand
     * @var string
     */
    protected $brand;

    /**
     * Category
     * @var string
     */
    protected $category;

    /**
     * @var int
     */
    protected $descLength;

    /**
     * @var string
     */
    protected $description;

    /**
     * @var array
     */
    protected $matching = [];

    /**
     * @var array
     */
    protected $metaArray = [];

    /**
     * @var string
     */
    protected $metaDescription;

    /**
     * @var string
     */
    protected $metaH1;

    /**
     * @var string
     */
    protected $metaKeywords;

    /**
     * @var string
     */
    protected $metaTitle;

    /**
     * @var SCategory|SBrands|SProducts|array|null
     */
    protected $model;

    /**
     * @var array
     */
    protected $morph = [];

    /**
     * @var string
     */
    protected $name;

    /**
     * @var int
     */
    protected $number;

    /**
     * @var string
     */
    protected $pageNumber;

    /**
     * Price
     * @var string
     */
    protected $price;

    /**
     * @var MetaStorage
     */
    protected $storage;

    /**
     * @var string
     */
    protected $wrapper = '%';

    /**
     * @var array
     */
    private $graments = ['ИМ', 'РД', 'ДТ', 'ВН', 'ТВ', 'ПР'];

    /**
     * method processing meta data
     * @var
     */
    private $phpMorphy;

    /**
     * MetaManipulator constructor.
     * @param SBrands|SCategory|SProducts|array $model
     * @param MetaStorage $storage
     * @throws Exception

Comment missing or not on the next line for @throws tag in function comment

     */
    public function __construct($model, MetaStorage $storage) {

        $dir = APPPATH . 'modules/CMSFactory/MetaManipulator/dics';

        // set some options
        $opts = [
            // storage type, follow types supported
            // PHPMORPHY_STORAGE_FILE - use file operations(fread, fseek) for dictionary access, this is very slow...
            // PHPMORPHY_STORAGE_SHM - load dictionary in shared memory(using shmop php extension), this is preferred mode
            // PHPMORPHY_STORAGE_MEM - load dict to memory each time when phpMorphy initialized, this useful when shmop ext. not activated.
            //                          Speed same as for PHPMORPHY_STORAGE_SHM type
            'storage' => extension_loaded('shmop') ? PHPMORPHY_STORAGE_SHM : PHPMORPHY_STORAGE_MEM,
            // Enable prediction by suffix
            'predict_by_suffix' => true,
            // Enable prediction by prefix
            'predict_by_db' => true,
            'graminfo_as_text' => true,
        ];

        $this->setPhpMorphy(new phpMorphy($dir, 'ru_RU', $opts));

        if ($model === null) {
            throw new Exception('Model not set');
        }

        if ($storage === null) {
            throw new Exception('Storage not set');
        }

        $this->setModel($model);
        $this->setStorage($storage);
        $this->setMetaTitle($this->getStorage()->getTitleTemplate());
        $this->setMetaDescription($this->getStorage()->getDescriptionTemplate());
        $this->setMetaKeywords($this->getStorage()->getKeywordsTemplate());
        $this->setMetaH1($this->getStorage()->getH1Template());

        $this->setMatching('desc', 'description');
        $this->setMetaArray(['metaTitle', 'metaH1', 'metaDescription', 'metaKeywords']);
    }

    /**
     * @return array
     */
    public function getGraments() {

        return $this->graments;
    }

    /**
     * @return MetaStorage
     */
    public function getStorage() {

        return $this->storage;
    }

    /**
     * @param MetaStorage $storage
     */
    public function setStorage($storage) {

        $this->storage = $storage;
    }

    /**
     * @param string $name
     * @param string $arguments
     * @return string
     */
    public function __call($name, $arguments) {

        $prev_string = $name;
        $method = substr($name, 0, strpos($name, '['));
        $string = method_exists(__CLASS__, $method) ? $this->$method() : '';

        return $string !== '' ? $this->make($string, $prev_string) : '';
    }

    /**
     * @param string $string
     * @param string $prev_string
     * @return null|string

Consider making the return type a bit more specific; maybe use string.

     */
    public function make($string, $prev_string) {

        $return = $string;

        //morphing
        if (preg_match('/\[\d\]/', $prev_string, $match)) {
            $part = str_replace(['[', ']'], '', $match[0]);
            $words = explode(' ', $string);
            foreach ($words as $word) {
                $array[] = $this->morphing($word, $part);

$array was never initialized. Although not strictly required by PHP, it is generally a good practice to add $array = array(); before regardless.

            }
            $return = implode(' ', $array);
        }

        //transliteration
        if (preg_match('/\[t\]/', $prev_string)) {
            $return = $this->transliteration($return);
        }

        return $return;
    }

    /**
     * @param string $string
     * @param int $part 1-6
     * @return string|null
     */
    protected function morphing($string, $part) {

        $ucFirst = false;
        //check if first letter is uppercase
        if (mb_strtolower($string) !== $string) {
            $ucFirst = true;
        }

        $word = mb_strtoupper($string);

        if (!array_key_exists($string, $this->morph)) {
            try {

                if (function_exists('iconv')) {
                    $word = iconv('utf-8', $this->getPhpMorphy()->getEncoding(), $word);
                }
                $collection = $this->getPhpMorphy()->findWord($word);

                if (false !== $collection) {
                    $param = $this->getTypeMany($word);

                    foreach ($collection->getByPartOfSpeech($param['TypeSpeech']) as $paradigm) {

                        $checkGrammat = $this->checkGrammat($paradigm, $param, $word);

                        $result = $this->getGrammensWord($paradigm, $param, $checkGrammat);

$param is of type array<string,string|array,{"param":"string","TypeSpeech":"array"}>, but the function expects a string.

                        if ($result[0] == $word) {
                            break;
                        }
                    }

                    $this->setMorph($string, $result);
                }
                return $this->getMorph($string, $part, $ucFirst);
            } catch (phpMorphy_Exception $e) {
                die('Error occurred while creating phpMorphy instance: ' . PHP_EOL . $e->getMessage());
            }
        }

        return $this->getMorph($string, $part, $ucFirst);
    }

    /**
     * @param object $paradigm
     * @param  string $param
     * @param null|string $gramat
     * @return array
     */
    private function getGrammensWord($paradigm, $param, $gramat = null) {

        $result = [];
        if ($gramat != null) {

            foreach ($this->getGraments() as $key => $val) {
                foreach ($paradigm->getWordFormsByGrammems([$param['param'], $val , $gramat]) as $form) {

Expected 0 spaces between "$val" and comma; 1 found

                    if (!$result[$key]) {
                        $result[$key] = $form->getWord();
                    }
                }
            }
        } else {
            foreach ($this->getGraments() as $key => $val) {
                foreach ($paradigm->getWordFormsByGrammems([$param['param'], $val]) as $form) {
                    if (!$result[$key]) {
                        $result[$key] = $form->getWord();
                    }
                }
            }
        }
        return $result;
    }

    /**
     * @param string $word
     * @return array

Consider making the return type a bit more specific; maybe use array<string,string|array>.

     */
    private function getTypeMany($word) {

        $checkString = $this->getPhpMorphy()->castFormByGramInfo($word, null, ['МН', 'ИМ'], true)[0];

        $param = ($word != $checkString) ? 'ЕД' : 'МН';

        $typeSpeech = $this->getTypeSpeechWord($word, $param);

        $result = [
            'param' => $param,
            'TypeSpeech' => $typeSpeech
        ];

        return $result;
    }

    /**
     * @param string $word
     * @param string $param
     * @return array
     */
    private function getTypeSpeechWord($word, $param) {

        $typeSpeech = $this->getPhpMorphy()->getPartOfSpeech($word);
        foreach ($typeSpeech as $type) {
            $checkGrammar[$type] = $this->getPhpMorphy()->castFormByGramInfo($word, $type, [$param, 'ИМ'], true);

$checkGrammar was never initialized. Although not strictly required by PHP, it is generally a good practice to add $checkGrammar = array(); before regardless.

            foreach ($checkGrammar[$type] as $value) {

                if (empty($resultType)) {
                    $resultType = $word == $value ? $type : null;
                }
                if ($resultType) {
                    break 2;
                }
            }
        }

        return $resultType;

    }

    /**
     * @param object $paradigm
     * @param array $param
     * @param string $word
     * @return string|null
     */
    private function checkGrammat($paradigm, $param, $word) {

        foreach ($paradigm as $form) {
            foreach ($form->getGrammems() as $grammatical) {
                switch ($grammatical) {
                    case 'МР':
                    case 'ЖР':
                    case 'СР':
                        if (empty($checkGrammar)) {

                            $checkGrammar = ($word == $this->getPhpMorphy()->castFormByGramInfo($word, $param['TypeSpeech'], [$param['param'], 'ИМ', $grammatical], true)[0]) ? $grammatical : null;
                        }
                        if ($checkGrammar) {
                            continue;
                        }

                }
            }
        }

        return $checkGrammar;

    }

    /**
     * @param phpMorphy $phpMorphy
     */
    private function setPhpMorphy($phpMorphy) {

        $this->phpMorphy = $phpMorphy;
    }

    /**
     * @return phpMorphy
     */
    private function getPhpMorphy() {

        return $this->phpMorphy;
    }

    /**
     * @param string $string
     * @param integer $part
     * @param bool $ucFirst
     * @return array

Should the return type not be string?

     */
    public function getMorph($string, $part, $ucFirst = false) {

        if (array_key_exists(--$part, $this->morph[$string])) {
            $string = mb_strtolower($this->morph[$string][$part]);
        }
        return $ucFirst ? mb_strtoupper(mb_substr($string, 0, 1)) . mb_substr($string, 1) : $string;
    }

    /**
     * @param string $string
     * @param array $morph
     */
    public function setMorph($string, $morph) {

        $this->morph[$string] = $morph ?: $string;
    }

    /**
     * @param string $string
     * @return string
     */
    protected function transliteration($string = '') {

        CI::$APP->load->helper('translit');

        return translit($string);
    }

    /**
     * @return string
     */
    public function getBrand() {

        return $this->brand;
    }

    /**
     * @param string $brand
     */
    public function setBrand($brand) {

        $this->brand = $brand;
    }

    /**
     * @return string
     */
    public function getCS() {

        if (!$this->CS) {
            $this->setCS(Currency::create()->getSymbol());
        }
        return $this->CS;
    }

    /**
     * @param string $CS
     */
    public function setCS($CS) {

        $this->CS = $CS;
    }

    /**
     * @return string
     */
    public function getCategory() {

        return $this->category;
    }

    /**
     * @param string $category
     */
    public function setCategory($category) {

        $this->category = $category;
    }

    /**
     * @return int
     */
    public function getDescLength() {

        if ($this->descLength === 0) {
            return 0;
        } elseif ($this->descLength > 0) {
            return $this->descLength;
        } else {
            return 100;
        }
    }

    /**
     * @param int $descLength
     */
    public function setDescLength($descLength) {

        if ($descLength != null and (int) $descLength >= 0) {
            $this->descLength = (int) $descLength;
        }
    }

    /**
     * @return string
     */
    public function getDescription() {

        if (!$this->description) {
            $this->setDescription($this->getModel()->getDescription());
        }
        return $this->description;
    }

    /**
     * @param string $description
     */
    public function setDescription($description) {

        $description = strip_tags($description);
        $description = str_replace([PHP_EOL, '  '], ' ', $description);
        $description = rtrim($description, '!,.-:; ');
        if (mb_strlen($description) > $this->getDescLength()) {
            $description = mb_substr($description, 0, $this->getDescLength());
            $description = mb_substr($description, 0, mb_strrpos($description, ' '));
        }

        $this->description = $description;
    }

    /**
     * @return array|null|SBrands|SCategory|SProducts
     */
    public function getModel() {

        return $this->model;
    }

    /**
     * @param array|null|SBrands|SCategory|SProducts $model
     */
    public function setModel($model) {

        $this->model = $model;
    }

    /**
     * @return string
     */
    public function getID() {

        if (!$this->ID) {
            $this->setID($this->getModel()->getId());
        }
        return $this->ID;
    }

    /**
     * @param string $ID
     */
    public function setID($ID) {

        $this->ID = $ID;
    }

    /**
     * @return string
     */
    public function getMetaDescription() {

        return $this->metaDescription;
    }

    /**
     * @param string $metaDescription
     */
    public function setMetaDescription($metaDescription) {

        $this->metaDescription = $metaDescription;
    }

    /**
     * @return string
     */
    public function getMetaH1() {

        return $this->metaH1;
    }

    /**
     * @param string $metaH1
     */
    public function setMetaH1($metaH1) {

        $this->metaH1 = $metaH1;
    }

    /**
     * @return string
     */
    public function getMetaKeywords() {

        return $this->metaKeywords;
    }

    /**
     * @param string $metaKeywords
     */
    public function setMetaKeywords($metaKeywords) {

        $this->metaKeywords = $metaKeywords;
    }

    /**
     * @return string
     */
    public function getMetaTitle() {

        return $this->metaTitle;
    }

    /**
     * @param string $metaTitle
     */
    public function setMetaTitle($metaTitle) {

        $this->metaTitle = $metaTitle;
    }

    /**
     * @return string
     */
    public function getName() {

        if (!$this->name) {
            $this->setName($this->getModel()->getName());
        }
        return $this->name;
    }

    /**
     * @param string $name
     */
    public function setName($name) {

        $this->name = $name;
    }

    /**
     * @return string
     */
    public function getPageNumber() {

        return $this->getNumber() ? str_replace('%number%', $this->getNumber(), $this->pageNumber) : '';
    }

    /**
     * @param string $pageNumber
     */
    public function setPageNumber($pageNumber) {

        $this->pageNumber = $pageNumber;
    }

    /**
     * @return string

Should the return type not be integer|string?

     */
    public function getNumber() {

        if (!$this->number) {
            $this->setNumber(assetManager::create()->getData('page_number'));
        }
        return (int) $this->number > 1 ? (int) $this->number : '';
    }

    /**
     * @param string $number
     */
    public function setNumber($number) {

        $this->number = $number;

The property $number was declared of type integer, but $number is of type string. Maybe add a type cast?

    }

    /**
     * @return string
     */
    public function getPrice() {

        return $this->price;
    }

    /**
     * @param string $price
     */
    public function setPrice($price) {

        $this->price = $price;
    }

    /**
     * @return array<String>
     */
    public function render() {

        $return = [];
        /** @var string $w wrapper */
        $w = $this->getWrapper();
        $vars = $this->getStorage()->getVars();
        if ($vars !== []) {
            foreach ($vars as $var) {
                $method = $this->getMatching($var) ?: $var;
                $method = "get$method";

                $replace = $this->$method();
                $search = $w . $var . $w;

                foreach ($this->getMetaArray() as $metaName) {
                    $get = "get$metaName";
                    $set = "set$metaName";

                    $return[$metaName] = str_replace($search, $replace, trim($this->$get()));
                    $this->$set($return[$metaName]);
                }
            }
        } else {
            foreach ($this->getMetaArray() as $metaName) {
                $get = "get$metaName";
                $set = "set$metaName";

                $return[$metaName] = trim($this->$get());
                $this->$set($return[$metaName]);
            }

        }

        return $return;

    }

    /**
     * @return string
     */
    public function getWrapper() {

        return $this->wrapper;
    }

    /**
     * @param string $wrapper
     */
    public function setWrapper($wrapper) {

        $this->wrapper = $wrapper;
    }

    /**
     * @param string $key
     * @return bool|array
     */
    public function getMatching($key) {

        return array_key_exists($key, $this->matching) ? $this->matching[$key] : false;
    }

    /**
     * @param string $key
     * @param string $value
     */
    public function setMatching($key, $value) {

        $this->matching[$key] = $value;
    }

    /**
     * @return array
     */
    public function getMetaArray() {

        return $this->metaArray;
    }

    /**
     * @param array $metaArray
     */
    public function setMetaArray($metaArray) {

        foreach ($metaArray as $item) {
            $this->metaArray[] = $item;
        }

        $this->metaArray = array_unique($this->metaArray);
    }
}