lang/php/lib/Schema/AvroFixedSchema.php

<?php

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Apache\Avro\Schema;

use Apache\Avro\AvroException;

/**
 * AvroNamedSchema with fixed-length data values
 */
class AvroFixedSchema extends AvroNamedSchema
{
    /**
     * @var int byte count of this fixed schema data value
     */
    private int $size;

    /**
     * @param int $size byte count of this fixed schema data value
     * @throws AvroSchemaParseException
     */
    public function __construct(AvroName $name, ?string $doc, int $size, AvroNamedSchemata $schemata, ?array $aliases = null)
    {
        parent::__construct(AvroSchema::FIXED_SCHEMA, $name, $doc, $schemata, $aliases);
        $this->size = $size;
    }

    /**
     * @return int byte count of this fixed schema data value
     */
    public function size(): int
    {
        return $this->size;
    }

    public function toAvro(): string|array
    {
        $avro = parent::toAvro();
        $avro[AvroSchema::SIZE_ATTR] = $this->size;

        return $avro;
    }

    /**
     * @param null|array<int, string> $aliases
     * @throws AvroSchemaParseException
     */
    public static function duration(
        AvroName $name,
        ?string $doc,
        AvroNamedSchemata $schemata,
        ?array $aliases = null
    ): self {
        $fixedSchema = new self(
            name: $name,
            doc: $doc,
            size: 12,
            schemata: $schemata,
            aliases: $aliases
        );

        $fixedSchema->logicalType = AvroLogicalType::duration();

        return $fixedSchema;
    }

    /**
     * @param null|array<int, string> $aliases
     * @throws AvroSchemaParseException
     * @throws AvroException
     */
    public static function decimal(
        AvroName $name,
        ?string $doc,
        int $size,
        int $precision,
        int $scale,
        AvroNamedSchemata $schemata,
        ?array $aliases = null
    ): self {
        $self = new self(
            name: $name,
            doc: $doc,
            size: $size,
            schemata: $schemata,
            aliases: $aliases
        );

        $maxPrecision = (int) floor(log10(self::maxDecimalMagnitude($size)));

        if ($precision > $maxPrecision) {
            throw new AvroException(
                "Invalid precision for specified fixed size (size='{$size}', precision='{$precision}')."
            );
        }

        $self->logicalType = AvroLogicalType::decimal($precision, $scale);

        return $self;
    }

    public static function maxDecimalMagnitude(int $size): float
    {
        return (float) (2 ** ((8 * $size) - 1)) - 1;
    }
}