Derafu\Lib\Core\Helper\Str

Complexity

Total Complexity

11

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Test Coverage

Coverage

66.67%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	utf8decode()	0	13	4
A	utf8encode()	0	13	4
A	wordWrap()	0	7	1
A	replacePlaceholders()	0	9	2

<?php

declare(strict_types=1);

/**
 * Derafu: Biblioteca PHP (Núcleo).
 * Copyright (C) Derafu <https://www.derafu.org>
 *
 * Este programa es software libre: usted puede redistribuirlo y/o modificarlo
 * bajo los términos de la Licencia Pública General Affero de GNU publicada por
 * la Fundación para el Software Libre, ya sea la versión 3 de la Licencia, o
 * (a su elección) cualquier versión posterior de la misma.
 *
 * Este programa se distribuye con la esperanza de que sea útil, pero SIN
 * GARANTÍA ALGUNA; ni siquiera la garantía implícita MERCANTIL o de APTITUD
 * PARA UN PROPÓSITO DETERMINADO. Consulte los detalles de la Licencia Pública
 * General Affero de GNU para obtener una información más detallada.
 *
 * Debería haber recibido una copia de la Licencia Pública General Affero de GNU
 * junto a este programa.
 *
 * En caso contrario, consulte <http://www.gnu.org/licenses/agpl.html>.
 */

namespace Derafu\Lib\Core\Helper;

use Illuminate\Support\Str as IlluminateStr;

/**
 * Clase para trabajar con strings.
 */
class Str extends IlluminateStr
{
    /**
     * Ancho por defecto al aplicar la función wordWrap().
     */
    public const WORDWRAP = 64;

    /**
     * Corta el string a un largo fijo por línea.
     *
     * @param string $string String a recortar.
     * @param integer $characters Ancho, o largo, máximo de cada línea.
     * @param string $break Caracter para el "corte" o salto de línea.
     * @param boolean $cutLongWords Si se deben cortar igual palabras largas.
     * @return string String en varias líneas ajustado al largo solicitado.
     */
    public static function wordWrap(
        $string,
        $characters = self::WORDWRAP,
        $break = "\n",
        $cutLongWords = true
    ) {
        return parent::wordWrap($string, $characters, $break, $cutLongWords);
    }

    /**
     * Convierte un string desde UTF-8 a ISO-8859-1.
     *
     * Si el string pasado no está codificado en UTF-8 se retornará el
     * string origial.
     *
     * @param string $string String a convertir en UTF-8.
     * @return string String en ISO-8859-1 si se logró convertir.
     */
    public static function utf8decode(string $string): string
    {
        if (empty($string)) {
            return $string;
        }

        if (!mb_detect_encoding($string, 'UTF-8', true)) {
            return $string;
        }

        $result = mb_convert_encoding($string, 'ISO-8859-1', 'UTF-8');

        return $result ?: $string;

The expression return $result ?: $string could return the type array which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Convierte un string desde ISO-8859-1 a UTF-8.
     *
     * Si el string pasado no está codificado en ISO-8859-1 se retornará el
     * string origial.
     *
     * @param string $string String a convertir en ISO-8859-1.
     * @return string String en UTF-8 si se logró convertir.
     */
    public static function utf8encode(string $string): string
    {
        if (empty($string)) {
            return $string;
        }

        if (!mb_detect_encoding($string, 'ISO-8859-1', true)) {
            return $string;
        }

        $result = mb_convert_encoding($string, 'UTF-8', 'ISO-8859-1');

        return $result ?: $string;

The expression return $result ?: $string could return the type array which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Reemplaza un listado de placeholders que tiene $template con los valores
     * que están en $data.
     *
     * Si $data es un arreglo con otros arreglos el método aplanará el arreglo y
     * se reemplazarán los placeholders con la sintaxis de punto ".".
     *
     * @param string $template
     * @param array $data
     * @return string
     */
    function replacePlaceholders(string $template, array $data): string

It is generally recommended to explicitly declare the visibility for methods.

    {
        $flatData = Arr::dot($data);

        foreach ($flatData as $key => $value) {
            $template = str_replace("{{{$key}}}", $value, $template);
        }

        return $template;
    }
}