ComboWordCount.php

<?php

/**
 * JBZoo Toolbox - Csv-Blueprint.
 *
 * This file is part of the JBZoo Toolbox project.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT
 * @copyright  Copyright (C) JBZoo.com, All rights reserved.
 * @see        https://github.com/JBZoo/Csv-Blueprint
 */

declare(strict_types=1);

namespace JBZoo\CsvBlueprint\Rules\Cell;

final class ComboWordCount extends AbstractCellRuleCombo
{
    protected const NAME = 'word count';

    public function getHelpMeta(): array
    {
        return [
            [
                'Count number of words used in a string',
                'Note that multibyte locales are not supported.',
                'Example: "Hello World, 123" - 2 words only (123 is not a word).',
            ],
            [],
        ];
    }

    public static function analyzeColumnValues(array $columnValues): array|bool|float|int|string
    {
        $min = null;
        $max = null;

        foreach ($columnValues as $cellValue) {
            $numWords = \str_word_count($cellValue, 0);

            if ($min === null || $numWords < $min) {
                $min = $numWords;
            }

            if ($max === null || $numWords > $max) {
                $max = $numWords;
            }
        }

        if ($min === 0 || $max === 0) {
            return false;
        }

        return $max === $min ? ['' => $max] : ['min' => $min, 'max' => $max];
    }

    protected function getExpected(): float
    {
        return $this->getOptionAsInt();
    }

    protected function getActualCell(string $cellValue): float
    {
        // @phan-suppress-next-line PhanPartialTypeMismatchReturn
        return \str_word_count($cellValue, 0);
    }
}