StrTokenGenerator::variablesTokens() - Code Metrics - Inspection of "support many entities" - fomvasss/laravel-str-tokens - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 005cd7...e6687a )

by Vasyl
created 2019-02-11 22:42 UTC
StrTokenGenerator::variablesTokens() A

↳ Parent: StrTokenGenerator
Complexity

Conditions	2
Paths	2
Size

Total Lines	9
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	4
nc	2
nop	1
dl	0
loc	9
rs	10
c	0
b	0
f	0
<?php
/**
 * Created by PhpStorm.
 * User: fomvasss
 * Date: 26.10.18
 * Time: 03:21
 */

namespace Fomvasss\LaravelStrTokens;

use Carbon\Carbon;
use Illuminate\Database\Eloquent\Collection;
filter:
    dependency_paths: ["lib/*"]
use Illuminate\Database\Eloquent\Model;
filter:
    dependency_paths: ["lib/*"]
 
class StrTokenGenerator
{
    /** @var \Illuminate\Foundation\Application The Laravel application instance. */
filter:
    dependency_paths: ["lib/*"]
    protected $app;
    
    /** @var mixed The Laravel application configs. */
    protected $config;
    
    /** @var string */
    protected $text = '';

    /** @var null */
    protected $date = null;

    /** @var null */
    protected $entity = null;
    
    /** @var array */
    protected $entities = [];

    /** @var bool */
    protected $clearEmptyTokens = true;

    /**
     * StrTokenGenerator constructor.
     */
    public function __construct($app = null)
    {
        if (!$app) {
            $app = app();   //Fallback when $app is not given
            $app = /** @scrutinizer ignore-call */ app();   //Fallback when $app is not given
        }
        $this->app = $app;

        $this->config = $this->app['config'];
    }
    
    /**
     * @param string $text
     * @return StrTokenGenerator
     */
    public function setText(string $text = ''): self
    {
        $this->text = $text;

        return $this;
    }

    /**
     * @param Carbon $date
     * @return StrTokenGenerator
     */
    public function setDate(Carbon $date): self
    {
        $this->date = $date;


        return $this;
    }

    /**
     * @param Model $entity
     * @return StrTokenGenerator
     */
    public function setEntity(Model $entity): self
    {
        $this->entity = $entity;


        return $this;
    }

    /**
     * @param array $entities [string key => Illuminate\Database\Eloquent\Model value]
     * @return \Fomvasss\LaravelStrTokens\StrTokenGenerator
     * @throws \Exception
     */
    public function setEntities(array $entities): self
    {
        foreach ($entities as $key => $entity) {
            $this->ensureValidEntity($entity);
        }
        
        $this->entities = $entities;
        
        return $this;
    }
    
    /**
     * @return StrTokenGenerator
     */
    public function doNotClearEmptyTokens(): self
    {
        $this->clearEmptyTokens = false;

        return $this;
    }

    /**
     * @return StrTokenGenerator
     */
    public function clearEmptyTokens(): self
    {
        $this->clearEmptyTokens = true;

        return $this;
    }

    /**
     * @return string
     */
    public function replace(): string
    {
        $groupTokens = $this->tokenScan($this->text);
        $replacements = [];

        foreach ($groupTokens as $key => $attributes) {

            if ($key === 'date') {
                $replacements += $this->dateTokens($attributes);

            } elseif ($key === 'config') {
                $replacements += $this->configTokens($attributes);

            } elseif ($this->entity && strtolower($key) === snake_case(class_basename($this->entity))) {
                $replacements += $this->eloquentModelTokens($this->entity, $attributes, $key);

            // For related taxonomy: https://github.com/fomvasss/laravel-taxonomy
            // and you set preffix in your relation methods - "tx"
            } elseif ($this->entity && substr($key, 0, 2) === 'tx') {
                $replacements += $this->eloquentModelTokens($this->entity, $attributes, $key);
                
            } elseif (in_array($key, array_keys($this->entities))) {
                $eloquentModel = $this->entities[$key];
                $replacements += $this->eloquentModelTokens($eloquentModel, $attributes, $key);
            }

            if ($this->clearEmptyTokens) {
                $replacements += array_fill_keys($attributes, '');
            }
        }

        $attributes = array_keys($replacements);
        $values = array_values($replacements);

        return str_replace($attributes, $values, $this->text);
    }

    /**
     * Taken from the best CMS - Drupal :)
     * https://api.drupal.org/api/drupal/includes%21token.inc/function/token_scan/7.x
     * preg_match_all('/\[([^\]:]*):([^\]]*)\]/', $tokenStr, $matches);
     *
     * @param $text
     * @return array
     */
    private function tokenScan(string $text): array
    {

        // Matches tokens with the following pattern: [$type:$name]
        // $type and $name may not contain  [ ] characters.
        // $type may not contain : or whitespace characters, but $name may.
        preg_match_all('/
            \\[             # [ - pattern start
            ([^\\s\\[\\]:]*)  # match $type not containing whitespace : [ or ]
            :              # : - separator
            ([^\\[\\]]*)     # match $name not containing [ or ]
            \\]             # ] - pattern end
            /x', $text, $matches);
        $types = $matches[1];
        $tokens = $matches[2];

        // Iterate through the matches, building an associative array containing
        // $tokens grouped by $types, pointing to the version of the token found in
        // the source text. For example, $results['node']['title'] = '[node:title]';
        $results = [];
        for ($i = 0; $i < count($tokens); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            $results[$types[$i]][$tokens[$i]] = $matches[0][$i];
        }

        return $results;
    }

    /**
     * @param array $tokens
     * @param string $type
     * @return array
     */
    protected function eloquentModelTokens(Model $eloquentModel, array $tokens, string $type): array
    {
        $replacements = [];

        foreach ($tokens as $key => $original) {
            $function = explode(':', $key)[0];
            $strTokenMethod = camel_case('str_token_'.$function);

            // Exists token generate method (defined user)
            if (method_exists($eloquentModel, $strTokenMethod)) {

                $replacements[$original] = $eloquentModel->{$strTokenMethod}($eloquentModel, ...explode(':', $key));

            // Exists relation function (defined user)
            } elseif (method_exists($eloquentModel, $function)) {

                $newOriginal = str_replace("$type:", '', $original);

                if ($eloquentModel->{$function} instanceof Model) {
                    $tm = new static();

                    $replacements[$original] = $tm->setText($newOriginal)->setEntity($eloquentModel->{$function})->replace();
                } elseif ($eloquentModel->{$function} instanceof Collection && ($firstRelatedEntity = $eloquentModel->{$function}->first())) {
                    $tm = new static();

                    $replacements[$original] = $tm->setText($newOriginal)->setEntity($firstRelatedEntity)->replace();
                }
            // Is field model
            } else {
                // TODO: make and check available model fields
                $replacements[$original] = $eloquentModel->{$key};
            }
        }

        return $replacements;
    }

    /**
     * @param array $tokens
     * @return array
     */
    protected function configTokens(array $tokens): array
    {
        $replacements = [];

        $disable = $this->config->get('str-tokens.disable_configs', []);

        foreach ($tokens as $name => $original) {
            if (! Helpers::strIs($disable, $name)) {
                $res = $this->config->get($name, '');
                $replacements[$original] = is_string($res) ? $res : '';
            }
        }

        return $replacements;
    }

    /**
     * @param $tokens
     * @return array
     */
    protected function dateTokens(array $tokens):array
    {
        $this->date = $this->date ?: Carbon::now();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $replacements = [];

        foreach ($tokens as $name => $original) {
            if ($name === 'raw') {
                $replacements[$original] = $this->date;
            } else {
                $format = $this->config->get('str-tokens.date.formats.'.$name, 'D, m/d/Y - H:i');
                $replacements[$original] = $this->date->format($format);
            }
        }

        return $replacements;
    }

    /**
     * @param $entity
     * @throws \Exception
     */
    protected function ensureValidEntity($entity)
    {
        if (! $entity instanceof Model) {
            throw new \Exception("StrToken Entity must by instance of '" . Model::class . "'. Current instance of '" . gettype($entity) . "'");
        }
    }
}
fomvasss / laravel-str-tokens

Push — master ( 005cd7...e6687a )

StrTokenGenerator::variablesTokens() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
