FormalityIndex.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Leximorph\Provider;
 
use Psr\Log\LoggerInterface;
use Wikimedia\Leximorph\Util\JsonLoader;
 
class FormalityIndex {
 
    private const string FORMALITY_INDEXES_PATH = __DIR__ . '/../data/formal-indexes.json';
 
    private static ?array $indexesCache = null;
 
    public function __construct(
        private readonly string $langCode,
        private readonly LoggerInterface $logger,
        private readonly JsonLoader $jsonLoader,
    ) {
    }
 
    public function getFormalityIndex(): int {
        self::$indexesCache ??= $this->loadIndexes();
        $indexesCache = self::$indexesCache;
 
        if ( array_key_exists( $this->langCode, $indexesCache ) ) {
            return $indexesCache[$this->langCode];
        }
 
        if ( str_contains( $this->langCode, '-' ) ) {
            $parts = explode( '-', $this->langCode );
            $suffix = array_pop( $parts );
            if ( $suffix === 'formal' ) {
                return 1;
            } elseif ( $suffix === 'informal' ) {
                return 0;
            }
 
            return $indexesCache[implode( '-', $parts )] ?? 0;
        }
 
        return 0;
    }
 
    private function loadIndexes(): array {
        $rawIndexes = $this->jsonLoader->load( self::FORMALITY_INDEXES_PATH, 'formality indexes' );
        $indexes = [];
 
        foreach ( $rawIndexes as $key => $value ) {
            if ( is_string( $key ) && is_int( $value ) ) {
                $indexes[$key] = $value;
            } else {
                $this->logger->error(
                    'Invalid formality index entry. Expected string key and int value. ' .
                    'Got key type {keyType}, value type {valueType}.',
                    [
                        'keyType' => gettype( $key ),
                        'valueType' => gettype( $value ),
                    ]
                );
            }
        }
 
        return $indexes;
    }
}