AlgoWeb\ODataMetadata\MetadataV3\Edmx\Edmx

Complexity

Total Complexity

9

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setDataServices()	0	4	1
A	__construct()	0	3	1
A	issetDataServices()	0	3	1
A	getDataServices()	0	3	1
A	unsetDataServices()	0	3	1
A	addToDataServices()	0	4	1
A	getAttributes()	0	4	1
A	getDomName()	0	3	1
A	getChildElements()	0	3	1

<?php

declare(strict_types=1);


namespace AlgoWeb\ODataMetadata\MetadataV3\Edmx;

use AlgoWeb\ODataMetadata\MetadataV3\DomBase;
use AlgoWeb\ODataMetadata\MetadataV3\Edm\EdmBase;
use AlgoWeb\ODataMetadata\MetadataV3\Edm\Schema;
use AlgoWeb\ODataMetadata\OdataVersions;
use AlgoWeb\ODataMetadata\Writer\AttributeContainer;
use AlgoWeb\ODataMetadata\Writer\WriterContext;

/**
 * Class TEdmxType.
 *
 * 3.1 The edmx:Edmx Element
 *
 * An OData service exposes a single entity model. A CSDL description of the entity model can be requested from
 * $metadata.
 *
 * The document returned by $metadata MUST contain a single root edmx:Edmx element. This element MUST contain a single
 * direct child edmx:DataServices element. The data services element contains a description of the entity model(s)
 * exposed by the OData service.
 *
 * In addition to the data services element, Edmx may have zero or more edmx:Reference elements and zero or more
 * edmx:AnnotationsReference elements. Reference elements specify the location of schemas referenced by the OData
 * service. Annotations reference elements specify the location of annotations to be applied to the OData service.
 *
 * The following example demonstrates the basic structure of the Edmx element and the edmx:DataServices element:
 *
 *     <edmx:Edmx xmlns:edmx="http://schemas.microsoft.com/ado/2007/06/edmx" Version="1.0">
 *         <edmx:DataServices xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" m:DataServiceVersion="2.0">
 *             <Schema ... />
 *         </edmx:DataServices>
 *     </edmx:Edmx>
 *
 * The edmx:Edmx element defines the XML namespace for the EDMX document and contains the edmx:DataServices sub-element.
 * The following rules apply to the edmx:Edmx element:
 * An EDMX document MUST have exactly one edmx:Edmx element as its root element.
 * The Version attribute MUST be defined on the edmx:Edmx element. Version is of type xs:string, as specified in the
 * XML schema [XMLSCHEMA1].
 * The edmx:Edmx element can contain a choice of zero or more of each of the following sub-elements:
 * edmx:Reference
 * edmx:AnnotationsReference
 *
 * Sub-elements in a given choice set can appear in any given order.
 * The edmx:Edmx element specifies exactly one edmx:DataServices sub-element. This sub-element MUST appear after the
 * edmx:Reference and edmx:AnnotationReference sub-elements, if present.
 *
 * @package AlgoWeb\ODataMetadata\MetadataV3
 */
class Edmx extends DomBase
{
    /**
     * @var string $version 3.1.1 The Version Attribute
     *             The Version attribute MUST be present on the edmx:Edmx element.
     *
     * The Version attribute is a string value that specifies the version of the EDMX wrapper, and must be of the
     * form .. This version of the specification defines version 1.0 of the EDMX Wrapper.
     */
    private $version = '1.0';

    /**
     * @var DataServices|Schema[] $dataServices  3.2 The edmx:DataServices Element
     *                            The edmx:DataServices element contains zero or more Edm:Schema elements which define the schema(s) exposed by
     *                            the OData service.
     */
    private $dataServices;

    public function __construct()
    {
        $this->dataServices = new DataServices();
    }

    /**
     * Adds as schema.
     *
     * @param  Schema $schema
     * @return self
     */
    public function addToDataServices(Schema $schema)
    {
        $this->dataServices[] = $schema;
        return $this;
    }

    /**
     * isset dataServices.
     *
     * @param  int|string $index
     * @return bool
     */
    public function issetDataServices($index)
    {
        return isset($this->dataServices[$index]);
    }

    /**
     * unset dataServices.
     *
     * @param  int|string $index
     * @return void
     */
    public function unsetDataServices($index)
    {
        unset($this->dataServices[$index]);
    }

    /**
     * Gets as dataServices.
     *
     * @return Schema[]
     */
    public function getDataServices()
    {
        return $this->dataServices;
    }

    /**
     * Sets a new dataServices.
     *
     * @param  Schema[] $dataServices
     * @return self
     */
    public function setDataServices(array $dataServices)
    {
        $this->dataServices = $dataServices;
        return $this;
    }

    /**
     * @return array|AttributeContainer[]
     */
    public function getAttributes(): array
    {
        return [
            new AttributeContainer('Version', $this->version)
        ];
    }

    /**
     * @return array|DomBase[]
     */
    public function getChildElements(): array
    {
        return [$this->getDataServices()];

The expression return array($this->getDataServices()) returns the type array<integer,AlgoWeb\ODataMetadata\MetadataV3\Edm\Schema[]> which is incompatible with the return type mandated by AlgoWeb\ODataMetadata\MetadataV3\DomBase::getChildElements() of AlgoWeb\ODataMetadata\MetadataV3\DomBase[].

    }

    /**
     * @return string
     */
    public function getDomName(): string
    {
        return 'edmx:Edmx';
    }
}