ClinicalDocument::getReferenceManager() - Code Metrics - Inspection of "added methods to expose hard-coded namespace attri..." - pgee70/cda - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2c36c3...af502a )

by Peter

created 2018-11-21 10:14 UTC

ClinicalDocument::getReferenceManager() A

↳ Parent: ClinicalDocument

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/**
 * The MIT License
 *
 * Copyright 2016 Julien Fastré <[email protected]>.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace i3Soft\CDA;

use i3Soft\CDA\DataType\Identifier\InstanceIdentifier;
use i3Soft\CDA\Elements\TypeId;
use i3Soft\CDA\Helper\ReferenceManager;
use i3Soft\CDA\Interfaces\ClassCodeInterface;
use i3Soft\CDA\Interfaces\MoodCodeInterface;
use i3Soft\CDA\Traits\AuthenticatorTrait;
use i3Soft\CDA\Traits\AuthorizationTrait;
use i3Soft\CDA\Traits\AuthorsTrait;
use i3Soft\CDA\Traits\ClassCodeTrait;
use i3Soft\CDA\Traits\CodeTrait;
use i3Soft\CDA\Traits\CompletionCodeTrait;
use i3Soft\CDA\Traits\ConfidentialityCodeTrait;
use i3Soft\CDA\Traits\CopyTimeTrait;
use i3Soft\CDA\Traits\CustodianTrait;
use i3Soft\CDA\Traits\DataEntererTrait;
use i3Soft\CDA\Traits\DocumentationOfsTrait;
use i3Soft\CDA\Traits\EffectiveTimeTrait;
use i3Soft\CDA\Traits\IdTrait;
use i3Soft\CDA\Traits\InformantsTrait;
use i3Soft\CDA\Traits\InformationRecipientsTrait;
use i3Soft\CDA\Traits\LanguageCodeTrait;
use i3Soft\CDA\Traits\LegalAuthenticatorTrait;
use i3Soft\CDA\Traits\MoodCodeTrait;
use i3Soft\CDA\Traits\ParticipantsTrait;
use i3Soft\CDA\Traits\RealmCodesTrait;
use i3Soft\CDA\Traits\RecordTargetsTrait;
use i3Soft\CDA\Traits\SetIdTrait;
use i3Soft\CDA\Traits\TemplateIdsTrait;
use i3Soft\CDA\Traits\TitleTrait;
use i3Soft\CDA\Traits\TypeIdTrait;
use i3Soft\CDA\Traits\VersionNumberTrait;

/**
 * Root class for clinical document
 *
 * @author Julien Fastré <[email protected]>
 * @author Peter Gee <https://github.com/pgee70>
 */
class ClinicalDocument implements ClassCodeInterface, MoodCodeInterface
{
  const NS_CDA     = '';
  const NS_CDA_URI = 'urn:hl7-org:v3';
  const NS_XSI_URI = 'http://www.w3.org/2001/XMLSchema-instance';
  const VERSION    = '1.0.4';

  use RealmCodesTrait;
  use TypeIdTrait;
  use TemplateIdsTrait;
  use IdTrait;
  use CodeTrait;
  use TitleTrait;
  use EffectiveTimeTrait;
  use ConfidentialityCodeTrait;
  use LanguageCodeTrait;
  use SetIdTrait;
  use VersionNumberTrait;
  use CompletionCodeTrait;
  use CopyTimeTrait;
  use RecordTargetsTrait;
  use AuthorsTrait;
  use DataEntererTrait;
  use InformantsTrait;
  use CustodianTrait;
  use InformationRecipientsTrait;
  use legalAuthenticatorTrait;
  use AuthenticatorTrait;
  use ParticipantsTrait;
  // use InFulfillmentOfsTrait;
  use DocumentationOfsTrait;
  // use RelatedDocumentsTrait;
  use AuthorizationTrait;

  // use ComponentOfTrait;
  // use ComponentTrait;
  use ClassCodeTrait;
  use MoodCodeTrait;

  /**
   * Referer assigned to this document  *
   *
   * @var ReferenceManager
   */
  private $referenceManager;
  /**
   * the root component
   *
   * @var Component\RootBodyComponent
   */
  private $rootComponent;
  private $informationRecipient;

  private $inFulfillmentOf;

  private $documentationOf;

  private $relatedDocument;


  /** @var string  the xmlns:ext attribute - leave empty string to not render.*/
  private $attributeXmlnsExt;
  /** @var string the xmlns:xs attribute - leave as empty string to not render*/
  private $attributeXmlNsXs;
  /** @var array the three parameters of the attribute Namespace*/
  private $attributeNs;

  /**
   * ClinicalDocument constructor.
   */
  public function __construct ()
  {
    $this->rootComponent    = new Component\RootBodyComponent();
    $this->referenceManager = new ReferenceManager();
    $this->setTypeId(new TypeId(new InstanceIdentifier('2.16.840.1.113883.1.3', 'POCD_HD000040')))
      ->setAttributeNs(self::NS_XSI_URI, 'xsi:schemaLocation', 'CDA-ES-v1_3.xsd')
      ->setAttributeXmlnsExt('http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0')
      ->setAttributeXmlNsXs('http://www.w3.org/2001/XMLSchema')
      ->setAcceptableClassCodes(['', ClassCodeInterface::CLINICAL_DOCUMENT])
      ->setClassCode('')
      ->setAcceptableMoodCodes(['', MoodCodeInterface::EVENT])
      ->setMoodCode('');
  }

  /**
   *
   * @return ReferenceManager
   */
  public function getReferenceManager (): ReferenceManager
  {
    return $this->referenceManager;
  }

  /**
   *
   * @param \DOMDocument|null $doc
   *
   * @return \DOMDocument
   */
  public function toDOMDocument (\DOMDocument $doc = NULL): \DOMDocument
  {
    $doc = $doc ?? new \DOMDocument('1.0', 'UTF-8');
    $el  = $doc->createElementNS(self::NS_CDA_URI, 'ClinicalDocument');
    $doc->appendChild($el);
    // set the NS
    if (implode('',$this->getAttributeNs()))
    {
      $el->setAttributeNS(
        $this->getAttributeNs()[0],
        $this->getAttributeNs()[1],
        $this->getAttributeNs()[2]
      );
    }
    if ($xmlNsExt = $this->getAttributeXmlnsExt())
    {
      $el->setAttribute('xmlns:ext', $xmlNsExt);
    }
    if ($xmlNsXs = $this->getAttributeXmlNsXs())
    {
      $el->setAttribute('xmlns:xs', $xmlNsXs);
    }
    if ($this->hasClassCode())
    {
      $el->setAttribute('classCode', $this->getClassCode());
    }
    if ($this->hasMoodCode())
    {
      $el->setAttribute('moodCode', $this->getMoodCode());
    }
    $this->renderRealmCodes($el, $doc)
      ->renderTypeId($el, $doc)
      ->renderTemplateIds($el, $doc)
      ->renderId($el, $doc)
      ->renderCode($el, $doc)
      ->renderTitle($el, $doc)
      ->renderEffectiveTime($el, $doc)
      ->renderConfidentialityCode($el, $doc)
      ->renderLanguageCode($el, $doc)
      ->renderSetId($el, $doc)
      ->renderVersionNumber($el, $doc)
      ->renderCopyTime($el, $doc)
      ->renderCompletionCode($el, $doc)
      ->renderRecordTargets($el, $doc)
      ->renderAuthors($el, $doc)
      ->renderDataEnter($el, $doc)
      ->renderInformants($el, $doc)
      ->renderCustodian($el, $doc)
      ->renderInformationRecipients($el, $doc)
      ->renderLegalAuthenticator($el, $doc)
      ->renderAuthenticator($el, $doc)
      ->renderParticipants($el, $doc)
      // todo inFulfillmentOf
      ->renderDocumentationOfs($el, $doc)
      // todo relatedDocument
      ->renderAuthorization($el, $doc);
    // todo componentOf
    // add components
    if (FALSE === $this->getRootComponent()->isEmpty())
    {
      $el->appendChild($this->getRootComponent()->toDOMElement($doc));
    }
    return $doc;
  }

  /**
   *
   * @return Component\RootBodyComponent
   */
  public function getRootComponent (): Component\RootBodyComponent
  {
    return $this->rootComponent;
  }

  /**
   * @return string
   */
  public function getAttributeXmlnsExt (): string
  {
    return $this->attributeXmlnsExt;
  }

  /**
   * @param string $attributeXmlnsExt
   *
   * @return self
   */
  public function setAttributeXmlnsExt (string $attributeXmlnsExt): self
  {
    $this->attributeXmlnsExt = $attributeXmlnsExt;
    return $this;
  }

  /**
   * @return string
   */
  public function getAttributeXmlNsXs (): string
  {
    return $this->attributeXmlNsXs;
  }

  /**
   * @param string $attributeXmlNsXs
   *
   * @return self
   */
  public function setAttributeXmlNsXs (string $attributeXmlNsXs): self
  {
    $this->attributeXmlNsXs = $attributeXmlNsXs;
    return $this;
  }

  /**
   * @param string $namespaceUri
   * @param string $qualifiedName
   * @param string $value
   *
   * @return ClinicalDocument
   */
  public function setAttributeNs (string $namespaceUri, string $qualifiedName, string $value): self
  {
    $this->attributeNs = [$namespaceUri, $qualifiedName, $value];
    return $this;
  }

  /**
   * @return array
   */
  public function getAttributeNs (): array
  {
    return $this->attributeNs;
  }
}


1			<?php
2
3			/**
4			* The MIT License
5			*
6			* Copyright 2016 Julien Fastré <[email protected]>.
7			*
8			* Permission is hereby granted, free of charge, to any person obtaining a copy
9			* of this software and associated documentation files (the "Software"), to deal
10			* in the Software without restriction, including without limitation the rights
11			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12			* copies of the Software, and to permit persons to whom the Software is
13			* furnished to do so, subject to the following conditions:
14			*
15			* The above copyright notice and this permission notice shall be included in
16			* all copies or substantial portions of the Software.
17			*
18			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20			* FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
21			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24			* THE SOFTWARE.
25			*/
26
27			namespace i3Soft\CDA;
28
29			use i3Soft\CDA\DataType\Identifier\InstanceIdentifier;
30			use i3Soft\CDA\Elements\TypeId;
31			use i3Soft\CDA\Helper\ReferenceManager;
32			use i3Soft\CDA\Interfaces\ClassCodeInterface;
33			use i3Soft\CDA\Interfaces\MoodCodeInterface;
34			use i3Soft\CDA\Traits\AuthenticatorTrait;
35			use i3Soft\CDA\Traits\AuthorizationTrait;
36			use i3Soft\CDA\Traits\AuthorsTrait;
37			use i3Soft\CDA\Traits\ClassCodeTrait;
38			use i3Soft\CDA\Traits\CodeTrait;
39			use i3Soft\CDA\Traits\CompletionCodeTrait;
40			use i3Soft\CDA\Traits\ConfidentialityCodeTrait;
41			use i3Soft\CDA\Traits\CopyTimeTrait;
42			use i3Soft\CDA\Traits\CustodianTrait;
43			use i3Soft\CDA\Traits\DataEntererTrait;
44			use i3Soft\CDA\Traits\DocumentationOfsTrait;
45			use i3Soft\CDA\Traits\EffectiveTimeTrait;
46			use i3Soft\CDA\Traits\IdTrait;
47			use i3Soft\CDA\Traits\InformantsTrait;
48			use i3Soft\CDA\Traits\InformationRecipientsTrait;
49			use i3Soft\CDA\Traits\LanguageCodeTrait;
50			use i3Soft\CDA\Traits\LegalAuthenticatorTrait;
51			use i3Soft\CDA\Traits\MoodCodeTrait;
52			use i3Soft\CDA\Traits\ParticipantsTrait;
53			use i3Soft\CDA\Traits\RealmCodesTrait;
54			use i3Soft\CDA\Traits\RecordTargetsTrait;
55			use i3Soft\CDA\Traits\SetIdTrait;
56			use i3Soft\CDA\Traits\TemplateIdsTrait;
57			use i3Soft\CDA\Traits\TitleTrait;
58			use i3Soft\CDA\Traits\TypeIdTrait;
59			use i3Soft\CDA\Traits\VersionNumberTrait;
60
61			/**
62			* Root class for clinical document
63			*
64			* @author Julien Fastré <[email protected]>
65			* @author Peter Gee <https://github.com/pgee70>
66			*/
67			class ClinicalDocument implements ClassCodeInterface, MoodCodeInterface
68			{
69			const NS_CDA = '';
70			const NS_CDA_URI = 'urn:hl7-org:v3';
71			const NS_XSI_URI = 'http://www.w3.org/2001/XMLSchema-instance';
72			const VERSION = '1.0.4';
73
74			use RealmCodesTrait;
75			use TypeIdTrait;
76			use TemplateIdsTrait;
77			use IdTrait;
78			use CodeTrait;
79			use TitleTrait;
80			use EffectiveTimeTrait;
81			use ConfidentialityCodeTrait;
82			use LanguageCodeTrait;
83			use SetIdTrait;
84			use VersionNumberTrait;
85			use CompletionCodeTrait;
86			use CopyTimeTrait;
87			use RecordTargetsTrait;
88			use AuthorsTrait;
89			use DataEntererTrait;
90			use InformantsTrait;
91			use CustodianTrait;
92			use InformationRecipientsTrait;
93			use legalAuthenticatorTrait;
94			use AuthenticatorTrait;
95			use ParticipantsTrait;
96			// use InFulfillmentOfsTrait;
97			use DocumentationOfsTrait;
98			// use RelatedDocumentsTrait;
99			use AuthorizationTrait;
100
101			// use ComponentOfTrait;
102			// use ComponentTrait;
103			use ClassCodeTrait;
104			use MoodCodeTrait;
105
106			/**
107			* Referer assigned to this document *
108			*
109			* @var ReferenceManager
110			*/
111			private $referenceManager;
112			/**
113			* the root component
114			*
115			* @var Component\RootBodyComponent
116			*/
117			private $rootComponent;
118			private $informationRecipient;
			0 ignored issues – show introduced 2018-08-28 13:17 UTC by Report Bug Copy Issue Report The private property `$informationRecipient` is not used, and could be removed. Loading history...
119			private $inFulfillmentOf;
			0 ignored issues – show introduced 2018-08-28 13:17 UTC by Report Bug Copy Issue Report The private property `$inFulfillmentOf` is not used, and could be removed. Loading history...
120			private $documentationOf;
			0 ignored issues – show introduced 2018-08-28 13:17 UTC by Report Bug Copy Issue Report The private property `$documentationOf` is not used, and could be removed. Loading history...
121			private $relatedDocument;
			0 ignored issues – show introduced 2018-11-21 10:28 UTC by Report Bug Copy Issue Report The private property `$relatedDocument` is not used, and could be removed. Loading history...
122
123			/** @var string the xmlns:ext attribute - leave empty string to not render.*/
124			private $attributeXmlnsExt;
125			/** @var string the xmlns:xs attribute - leave as empty string to not render*/
126			private $attributeXmlNsXs;
127			/** @var array the three parameters of the attribute Namespace*/
128			private $attributeNs;
129
130			/**
131			* ClinicalDocument constructor.
132			*/
133			public function __construct ()
134			{
135			$this->rootComponent = new Component\RootBodyComponent();
136			$this->referenceManager = new ReferenceManager();
137			$this->setTypeId(new TypeId(new InstanceIdentifier('2.16.840.1.113883.1.3', 'POCD_HD000040')))
138			->setAttributeNs(self::NS_XSI_URI, 'xsi:schemaLocation', 'CDA-ES-v1_3.xsd')
139			->setAttributeXmlnsExt('http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0')
140			->setAttributeXmlNsXs('http://www.w3.org/2001/XMLSchema')
141			->setAcceptableClassCodes(['', ClassCodeInterface::CLINICAL_DOCUMENT])
142			->setClassCode('')
143			->setAcceptableMoodCodes(['', MoodCodeInterface::EVENT])
144			->setMoodCode('');
145			}
146
147			/**
148			*
149			* @return ReferenceManager
150			*/
151			public function getReferenceManager (): ReferenceManager
152			{
153			return $this->referenceManager;
154			}
155
156			/**
157			*
158			* @param \DOMDocument\|null $doc
159			*
160			* @return \DOMDocument
161			*/
162			public function toDOMDocument (\DOMDocument $doc = NULL): \DOMDocument
163			{
164			$doc = $doc ?? new \DOMDocument('1.0', 'UTF-8');
165			$el = $doc->createElementNS(self::NS_CDA_URI, 'ClinicalDocument');
166			$doc->appendChild($el);
167			// set the NS
168			if (implode('',$this->getAttributeNs()))
169			{
170			$el->setAttributeNS(
171			$this->getAttributeNs()[0],
172			$this->getAttributeNs()[1],
173			$this->getAttributeNs()[2]
174			);
175			}
176			if ($xmlNsExt = $this->getAttributeXmlnsExt())
177			{
178			$el->setAttribute('xmlns:ext', $xmlNsExt);
179			}
180			if ($xmlNsXs = $this->getAttributeXmlNsXs())
181			{
182			$el->setAttribute('xmlns:xs', $xmlNsXs);
183			}
184			if ($this->hasClassCode())
185			{
186			$el->setAttribute('classCode', $this->getClassCode());
187			}
188			if ($this->hasMoodCode())
189			{
190			$el->setAttribute('moodCode', $this->getMoodCode());
191			}
192			$this->renderRealmCodes($el, $doc)
193			->renderTypeId($el, $doc)
194			->renderTemplateIds($el, $doc)
195			->renderId($el, $doc)
196			->renderCode($el, $doc)
197			->renderTitle($el, $doc)
198			->renderEffectiveTime($el, $doc)
199			->renderConfidentialityCode($el, $doc)
200			->renderLanguageCode($el, $doc)
201			->renderSetId($el, $doc)
202			->renderVersionNumber($el, $doc)
203			->renderCopyTime($el, $doc)
204			->renderCompletionCode($el, $doc)
205			->renderRecordTargets($el, $doc)
206			->renderAuthors($el, $doc)
207			->renderDataEnter($el, $doc)
208			->renderInformants($el, $doc)
209			->renderCustodian($el, $doc)
210			->renderInformationRecipients($el, $doc)
211			->renderLegalAuthenticator($el, $doc)
212			->renderAuthenticator($el, $doc)
213			->renderParticipants($el, $doc)
214			// todo inFulfillmentOf
215			->renderDocumentationOfs($el, $doc)
216			// todo relatedDocument
217			->renderAuthorization($el, $doc);
218			// todo componentOf
219			// add components
220			if (FALSE === $this->getRootComponent()->isEmpty())
221			{
222			$el->appendChild($this->getRootComponent()->toDOMElement($doc));
223			}
224			return $doc;
225			}
226
227			/**
228			*
229			* @return Component\RootBodyComponent
230			*/
231			public function getRootComponent (): Component\RootBodyComponent
232			{
233			return $this->rootComponent;
234			}
235
236			/**
237			* @return string
238			*/
239			public function getAttributeXmlnsExt (): string
240			{
241			return $this->attributeXmlnsExt;
242			}
243
244			/**
245			* @param string $attributeXmlnsExt
246			*
247			* @return self
248			*/
249			public function setAttributeXmlnsExt (string $attributeXmlnsExt): self
250			{
251			$this->attributeXmlnsExt = $attributeXmlnsExt;
252			return $this;
253			}
254
255			/**
256			* @return string
257			*/
258			public function getAttributeXmlNsXs (): string
259			{
260			return $this->attributeXmlNsXs;
261			}
262
263			/**
264			* @param string $attributeXmlNsXs
265			*
266			* @return self
267			*/
268			public function setAttributeXmlNsXs (string $attributeXmlNsXs): self
269			{
270			$this->attributeXmlNsXs = $attributeXmlNsXs;
271			return $this;
272			}
273
274			/**
275			* @param string $namespaceUri
276			* @param string $qualifiedName
277			* @param string $value
278			*
279			* @return ClinicalDocument
280			*/
281			public function setAttributeNs (string $namespaceUri, string $qualifiedName, string $value): self
282			{
283			$this->attributeNs = [$namespaceUri, $qualifiedName, $value];
284			return $this;
285			}
286
287			/**
288			* @return array
289			*/
290			public function getAttributeNs (): array
291			{
292			return $this->attributeNs;
293			}
294			}
295

pgee70 / cda

Push — master ( 2c36c3...af502a )

ClinicalDocument::getReferenceManager() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like