openstamanager/src/Util/Generator.php

<?php
/*
 * OpenSTAManager: il software gestionale open source per l'assistenza tecnica e la fatturazione
 * Copyright (C) DevCode s.r.l.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace Util;

use Carbon\Carbon;
use Illuminate\Database\Capsule\Manager;

/**
 * Classe dedicata alla gestione e all'interpretazione delle stringhe personalizzate.
 *
 * @since 2.3
 */
class Generator
{
    /** @var array Elenco delle varabili da sostituire nel pattern */
    protected static $replaces = [
        'YYYY' => [
            'date' => 'Y',
        ],
        'yy' => [
            'date' => 'y',
        ],
        'm' => [
            'date' => 'm',
        ],
        'd' => [
            'date' => 'd',
        ],
        'H' => [
            'date' => 'H',
        ],
        'i' => [
            'date' => 'i',
        ],
        's' => [
            'date' => 'd',
        ],
    ];

    /**
     * Genera un pattern sulla base del precedente.
     *
     * @param string $pattern
     * @param string $last
     * @param int    $quantity
     * @param array  $values
     *
     * @return string
     */
    public static function generate($pattern, $last = null, $quantity = 1, $values = [], $date = null)
    {
        // Costruzione del pattern
        $result = self::complete($pattern, $values, $date);
        $length = substr_count($result, '#');

        // Individuazione dei valori precedenti
        $previous = self::read($pattern, $last);

        $number = 1;
        if (isset($previous['number'])) {
            $number = intval($previous['number']) + $quantity;
        }

        $result = preg_replace('/#{1,}/', str_pad($number, $length, '0', STR_PAD_LEFT), $result);

        return $result;
    }

    /**
     * Completa un determinato pattern con le informazioni di base.
     *
     * @return string
     */
    public static function complete($pattern, $values = [], $date = null)
    {
        // Costruzione del pattern
        $replaces = array_merge(self::getReplaces($date), $values);

        $keys = array_keys($replaces);
        $values = array_column($replaces, 'value');

        $result = str_replace($keys, $values, $pattern);

        return $result;
    }

    /**
     * Restituisce i valori utilizzati sul pattern.
     *
     * @return array
     */
    public static function read($pattern, $string, $date = null)
    {
        // Costruzione del pattern
        $replaces = self::getReplaces($date);

        $replaces['#'] = [
            'regex' => '(?<number>[0-9]+)',
        ];

        $values = array_column($replaces, 'regex');

        $pattern = preg_replace('/#{1,}/', '#', $pattern);
        $pattern = str_replace('\\#', '#', preg_quote($pattern, '/'));
        $pattern = str_replace(array_keys($replaces), array_values($values), $pattern);

        // Individuazione dei valori
        preg_match('/^'.$pattern.'/', (string) $string, $m);

        return array_filter($m, 'is_string', ARRAY_FILTER_USE_KEY);
    }

    /**
     * Restituisce l'elenco delle variabili da sostituire normalizzato per l'utilizzo.
     *
     * @return array
     */
    public static function getReplaces($date = null)
    {
        $replaces = self::$replaces;

        $date_object = new Carbon($date);

        foreach ($replaces as $key => $value) {
            if (!isset($replaces[$key]['value'])) {
                if (isset($replaces[$key]['date'])) {
                    $replaces[$key]['value'] = $date_object->format($replaces[$key]['date']);
                } else {
                    $replaces[$key]['value'] = $key;
                }
            }

            if (!isset($replaces[$key]['regex'])) {
                $replaces[$key]['regex'] = '(?<'.preg_quote($key).'>.{'.strlen($replaces[$key]['value']).'})';
            }
        }

        return $replaces;
    }

    /**
     * Interpreta una data specifica per la sostituzione nei pattern.
     *
     * @return array
     */
    public static function dateToPattern($date)
    {
        $replaces = self::$replaces;

        $date = strtotime($date);
        $results = [];

        foreach ($replaces as $key => $value) {
            if (isset($replaces[$key]['date'])) {
                $results[$key]['value'] = date($replaces[$key]['date'], $date);
            }
        }

        return $results;
    }

    /**
     * Restituisce la maschera specificata per il segmento indicato.
     *
     * @param int $id_segment
     *
     * @return string
     */
    public static function getMaschera($id_segment)
    {
        $database = database();

        $maschera = $database->fetchOne('SELECT pattern FROM zz_segments WHERE id = :id_segment', [
            ':id_segment' => $id_segment,
        ]);

        return $maschera['pattern'];
    }

    public static function getPreviousFrom($maschera, $table, $field, $where = [], $date = null)
    {
        $order = static::getMascheraOrder($maschera, $field);

        $maschera = Generator::complete($maschera, [], $date);
        $maschera = str_replace('#', '%', $maschera);

        $query = Manager::table($table)->select($field)->where($field, 'like', $maschera)->orderByRaw($order);

        foreach ($where as $and) {
            $query->whereRaw($and);
        }

        $result = $query->first();

        return isset($result->{$field}) ? $result->{$field} : null;
    }

    /**
     * Metodo per l'individuazione del tipo di ordine da impostare per la corretta interpretazione della maschera.
     * Esempi:
     * - maschere con testo iniziale (FT-####-YYYY) necessitano l'ordinamento alfabetico
     * - maschere di soli numeri (####-YYYY) è necessario l'ordinamento numerico forzato.
     *
     * @param string $maschera
     * @param string $field
     *
     * @return string
     */
    protected static function getMascheraOrder($maschera, $field)
    {
        // Query di default
        $query = $field.' DESC';

        // Estraggo blocchi di caratteri standard
        preg_match('/[#]+/', $maschera, $matches);

        if (!empty($matches)) {
            $pos1 = strpos($maschera, (string) $matches[0]);
            if ($pos1 == 0) {
                $query = 'CAST('.$field.' AS UNSIGNED) DESC';
            }
        }

        return $query;
    }
}