PubPeerFoundation\PublicationDataExtractor\Schema

Complexity

Total Complexity

2

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	validate()	0	6	1
A	getDataTypes()	0	3	1

<?php

namespace PubPeerFoundation\PublicationDataExtractor;

use Volan\Volan;
use Volan\ValidatorResult;

class Schema
{
    /**
     * Array validation schema.
     */
    const SCHEMA = [
        'root' => [
            '_source' => [
                '_type' => 'string',
            ],
            'authors' => [
                '_type' => 'nested_array',
                'first_name' => [
                    '_type' => 'string',
                ],
                'last_name' => [
                    '_type' => 'required_string',
                ],
                'orcid' => [
                    '_type' => 'string',
                ],
                'email' => [
                    '_type' => 'string',
                ],
                'affiliation' => [
                    '_type' => 'array',
                    'name' => [
                        '_type' => 'string',
                    ],
                ],
            ],
            'identifiers' => [
                '_type' => 'nested_array',
                'value' => [
                    '_type' => 'required_string',
                ],
                'type' => [
                    '_type' => 'required_string',
                ],
            ],
            'journal' => [
                '_type' => 'required_array',
                'title' => [
                    '_type' => 'string',
                ],
                'issn' => [
                    '_type' => 'array',
                ],
                'publisher' => [
                    '_type' => 'string',
                ],
            ],
            'publication' => [
                '_type' => 'required_array',
                'title' => [
                    '_type' => 'required_string',
                ],
                'abstract' => [
                    '_type' => 'string',
                ],
                'url' => [
                    '_type' => 'required_string',
                ],
                'published_at' => [
                    '_type' => 'string',
                ],
            ],
            'types' =>  [
                '_type' => 'nested_array',
                'name' => [
                    '_type' => 'string',
                ],
            ],
            'tags' => [
                '_type' => 'nested_array',
                'name' => [
                    '_type' => 'string',
                ],
            ],
            'affiliations' => [
                '_type' => 'nested_array',
                'name' => [
                    '_type' => 'string',
                ],
            ],
            'updates' => [
                '_type' => 'array',
                'timestamp' => [
                    '_type' => 'string',
                ],
                'identifier' => [
                    '_type' => 'array',
                    'doi' => [
                        '_type' => 'string',
                    ],
                ],
                'type' => [
                    '_type' => 'string',
                ],
            ],
        ],
    ];

    /**
     * Validate the data against Schema.
     *
     * @param $data
     * @return \Volan\ValidatorResult
     */
    public static function validate($data): ValidatorResult
    {
        $validator = new Volan(static::SCHEMA);
        $result = $validator->validate($data);

        return $result;
    }

    /**
     * Get the main data types from Schema.
     *
     * @return array
     */
    public static function getDataTypes(): array
    {
        return array_slice(array_keys(self::SCHEMA['root']), 1);
    }
}