wowstack / php-dbc-parser

src/MappingField/LocalizedStringField.php

<?php

declare(strict_types=1);

namespace Wowstack\Dbc\MappingField;

/**
 * Implements a field containing localized strings.
 */
class LocalizedStringField extends AbstractField implements MappingFieldInterface
{
    /**
     * Supported locales and their offset in the field.
     */
    const LOCALE_INDEX = [
        'enUS' => 0,
        'enGB' => 0,
        'koKR' => 1,
        'frFR' => 2,
        'deDE' => 3,
        'zhCN' => 4,
        'zhTW' => 5,
        'esES' => 6,
        'esMX' => 7,
    ];

    /**
     * Amount of bytes used by localization checksum.
     */
    const CHECKSUM_SIZE = 4;

    /**
     * Name of type.
     */
    const TYPE = 'localized_string';

    /**
     * {@inheritdoc}
     */
    protected $size = 4;

    /**
     * Amount of fields to follow.
     *
     * @var int
     */
    protected $count = 0;

    /**
     * Default locale to use.
     */
    protected $locale = 'enUS';

    /**
     * Default amount of locale fields to read.
     */
    protected $locale_count = 8;

    /**
     * Defines required parameters.
     */
    const PARAMETERS = ['count'];

    /**
     * Defines optional parameters and their defaults.
     */
    const OPTIONAL_PARAMETERS = ['locale' => 'enUS', 'locale_count' => 8];

    /**
     * Format used to pack/unpack this field type.
     */
    const PACK_FORMAT = 'V';

    /**
     * Constructs the field.
     *
     * @param string $name
     * @param array  $parameters
     *
     * @throws MappingException
     */
    public function __construct(string $name, array $parameters = [])
    {
        $this->name = $name;
        $this->setParameters($parameters);
        $this->setOptionalParameters($parameters);
    }

    /**
     * {@inheritdoc}
     */
    public function getOffset(): int
    {
        return self::LOCALE_INDEX[$this->locale];
    }

    /**
     * {@inheritdoc}
     */
    public function getTotalCount(): int
    {
        return $this->count * ($this->locale_count + 1);

Variable "locale_count" is not in valid camel caps format

    }

    /**
     * {@inheritdoc}
     */
    public function getSize(): int
    {
        return ($this->size * $this->locale_count) + self::CHECKSUM_SIZE;

Variable "locale_count" is not in valid camel caps format

    }

    /**
     * {@inheritdoc}
     */
    public function getTotalSize(): int
    {
        return $this->getSize() * $this->count;
    }

    /**
     * {@inheritdoc}
     */
    public function getParsedFields(): array
    {
        $count = 1;
        $locale_count = $this->getLocaleCount();

Variable "locale_count" is not in valid camel caps format

        $string_offset = 0;

Variable "string_offset" is not in valid camel caps format

        $parsed_fields = [];

Variable "parsed_fields" is not in valid camel caps format

        while ($count <= $this->getCount()) {
            $field_name = ($this->getCount() > 1 ? $this->getName().$count : $this->getName());

Variable "field_name" is not in valid camel caps format

Concat operator must be surrounded by a single space

            $pack_fields = [];

Variable "pack_fields" is not in valid camel caps format

            while ($string_offset < $locale_count) {

Variable "string_offset" is not in valid camel caps format

Variable "locale_count" is not in valid camel caps format

                if ($string_offset === $this->getOffset()) {

Variable "string_offset" is not in valid camel caps format

                    $pack_fields[] = $this::PACK_FORMAT.'1'.$field_name;

Variable "pack_fields" is not in valid camel caps format

Concat operator must be surrounded by a single space

Variable "field_name" is not in valid camel caps format

                } else {
                    $pack_fields[] = $this::PACK_FORMAT.'1'.$field_name.'_unused'.$string_offset;

Variable "pack_fields" is not in valid camel caps format

Concat operator must be surrounded by a single space

Variable "field_name" is not in valid camel caps format

Variable "string_offset" is not in valid camel caps format

                }
                ++$string_offset;

Variable "string_offset" is not in valid camel caps format

            }
            $string_offset = 0;

Variable "string_offset" is not in valid camel caps format

            $pack_fields[] = $this::PACK_FORMAT.'1'.$field_name.'_checksum';

Variable "pack_fields" is not in valid camel caps format

Concat operator must be surrounded by a single space

Variable "field_name" is not in valid camel caps format

            $parsed_field = [

Variable "parsed_field" is not in valid camel caps format

                'type' => $this->getType(),
                'size' => $this->getSize(),
                'format' => implode('/', $pack_fields),

Variable "pack_fields" is not in valid camel caps format

                'offset' => $this->getOffset(),
            ];

            $parsed_fields[$field_name] = $parsed_field;

Variable "parsed_fields" is not in valid camel caps format

Variable "field_name" is not in valid camel caps format

Variable "parsed_field" is not in valid camel caps format

            ++$count;
        }

        return $parsed_fields;

Variable "parsed_fields" is not in valid camel caps format

    }

    /**
     * Returns the selected locale.
     *
     * @return string
     */
    public function getLocale(): string
    {
        return $this->locale;
    }

    /**
     * Returns the selected locale count.
     *
     * @return int
     */
    public function getLocaleCount(): int
    {
        return $this->locale_count;

Variable "locale_count" is not in valid camel caps format

    }
}