Sfneal\ViewExport\Pdf\Utils\Metadata

Complexity

Total Complexity

9

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Importance

Changes	5
Bugs	1	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	validateMetadata()	0	3	1
A	__construct()	0	4	2
A	get()	0	3	1
A	set()	0	7	1
A	add()	0	7	2
A	getConfigMetadata()	0	4	2

<?php

namespace Sfneal\ViewExport\Pdf\Utils;

class Metadata
{
    // todo: add tests

    /**
     * Array of valid metadata keys.
     *
     * @var string[]
     */
    private $validMetadataKeys = [
        'Title',
        'Author',
        'Subject',
        'Keywords',
        'Creator',
        'Producer',
        'CreationDate',
        'ModDate',
        'Trapped',
    ];

    /**
     * Metadata info to add to the PDF.
     *
     *  - keys are validated from $validMetadata property
     *
     * @var array
     */
    private $metadata = [];

    /**
     * Metadata constructor.
     *
     * @param array|null $metadata
     */
    public function __construct(array $metadata = null)
    {
        if (! empty($metadata)) {
            $this->set($metadata ?? $this->getConfigMetadata());
        }
    }

    /**
     * Retrieve an array of metadata.
     *
     * @return array
     */
    public function get(): array
    {
        return $this->metadata;
    }

    /**
     * Set the entire $metadata array.
     *
     * @param array $metadata
     * @return $this
     */
    public function set(array $metadata): self
    {
        $this->metadata = array_filter($metadata, function ($key) {
            return $this->validateMetadata($key);
        });

        return $this;
    }

    /**
     * Add a $key, $value pair to the metadata array.
     *
     * @param string $key
     * @param $value
     * @return $this
     */
    public function add(string $key, $value): self
    {
        if ($this->validateMetadata($key)) {
            $this->metadata[$key] = $value;
        }

        return $this;
    }

    /**
     * Confirm a potential metadata key is valid.
     *
     * @param string $key
     * @return bool
     */
    private function validateMetadata(string $key): bool
    {
        return in_array($key, $this->validMetadataKeys);
    }

    /**
     * Retrieve an array of metadata set in the config with null & empty values removed.
     *
     * @return array
     */
    private function getConfigMetadata(): array
    {
        return array_filter(config('view-export.pdf.metadata'), function ($value) {
            return ! is_null($value) && ! empty($value);
        });
    }
}