CuyZ / NotiZ

Classes/Service/StringService.php

<?php
declare(strict_types=1);

/*
 * Copyright (C)
 * Nathan Boiron <nathan.boiron@gmail.com>
 * Romain Canon <romain.hydrocanon@gmail.com>
 *
 * This file is part of the TYPO3 NotiZ project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace CuyZ\Notiz\Service;

use CuyZ\Notiz\Service\Traits\SelfInstantiateTrait;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class StringService implements SingletonInterface
{
    use SelfInstantiateTrait;

    /**
     * Static alias method for:
     *
     * @see \CuyZ\Notiz\Service\StringService::doMark
     *
     * @param mixed $content
     * @param string $replacement
     * @return string
     */
    public static function mark($content, string $replacement = '<samp class="bg-info">$1</samp>'): string
    {
        return self::get()->doMark($content, $replacement);

It seems like doMark() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Modifies the contents using the grave accent wrapper, by replacing it with the
     * HTML tag `samp`.
     *
     * Example:
     *
     * > Look at `foo` lorem ipsum...
     *
     * will become:
     *
     * > Look at <samp class="bg-info">foo</samp> lorem ipsum...
     *
     * @param mixed $content
     * @param string $replacement
     * @return string
     */
    public function doMark($content, string $replacement): string
    {
        return preg_replace(
            '/`([^`]+)`/',
            $replacement,
            (string)$content
        );
    }

    /**
     * Takes an email address that can have the following format:
     *
     * - `John Smith <john.smith@example.com>`
     * - `jane.smith@example.com`
     *
     * It will return an array:
     *
     * ```
     * // `John Smith <john.smith@example.com>` becomes :
     * [
     *     'email' => 'john.smith@example.com',
     *     'name' => 'John Smith'
     * ]
     *
     * // `jane.smith@example.com` becomes:
     * [
     *     'email' => 'jane.smith@example.com',
     *     'name' => null
     * ]
     * ```
     *
     * @param string $email
     * @return array
     */
    public function formatEmailAddress(string $email): array
    {
        if (preg_match('#([^<]+) <([^>]+)>#', $email, $matches)) {
            return [
                'name' => $matches[1],
                'email' => $matches[2],
            ];
        } else {
            return [
                'name' => null,
                'email' => $email,
            ];
        }
    }

    /**
     * @param string $string
     * @return string
     */
    public function upperCamelCase(string $string): string
    {
        return GeneralUtility::underscoredToUpperCamelCase(GeneralUtility::camelCaseToLowerCaseUnderscored($string));
    }

    /**
     * This will wrap each line of `$text` inside `<p></p>` tags.
     *
     * @param $text
     * @return string
     */

    public function wrapLines($text): string
    {
        $pad = function ($line) {
            return "<p>$line</p>";
        };

        $text = preg_replace('/ ?#LF# ?/', "\n", $text);
        $lines = explode("\n", $text);
        $lines = array_map('trim', $lines);
        $lines = array_filter($lines);
        $lines = array_map($pad, $lines);

        return implode('', $lines);
    }
}