MetaDocument::add() - Code Metrics - lode/jsonapi - Measure and Improve Code Quality continuously with Scrutinizer

MetaDocument::add() A
last analyzed 2022-10-02 08:36 UTC

↳ Parent: MetaDocument

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	3
dl	0
loc	2
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php

namespace alsvanzelf\jsonapi;

use alsvanzelf\jsonapi\Document;
use alsvanzelf\jsonapi\helpers\Converter;
use alsvanzelf\jsonapi\objects\MetaObject;

/**
 * this document can be used if neither data nor errors need to be set
 * meta can also be added to ResourceDocument, CollectionDocument and ErrorsDocument via `addMeta()`
 */
class MetaDocument extends Document {
	/**
	 * human api
	 */
	
	/**
	 * @param  array $meta
	 * @return MetaDocument
	 */
	public static function fromArray(array $meta) {
		$metaDocument = new self();
		$metaDocument->setMetaObject(MetaObject::fromArray($meta));
		
		return $metaDocument;
	}
	
	/**
	 * @param  object $meta
	 * @return MetaDocument
	 */
	public static function fromObject($meta) {
		$array = Converter::objectToArray($meta);
		
		return self::fromArray($array);
	}
	
	/**
	 * wrapper for Document::addMeta() to the primary data of this document available via `add()`
	 * 
	 * @param string $key
	 * @param mixed  $value
	 * @param string $level one of the Document::LEVEL_* constants, optional, defaults to Document::LEVEL_ROOT
	 */
	public function add($key, $value, $level=Document::LEVEL_ROOT) {
		parent::addMeta($key, $value, $level);
	}
	
	/**
	 * spec api
	 */
	
	/**
	 * DocumentInterface
	 */
	
	/**
	 * @inheritDoc
	 */
	public function toArray() {
		$array = parent::toArray();
		
		// force meta to be set, and be an object when converting to json
		if (isset($array['meta']) === false) {
			$array['meta'] = new \stdClass();
		}
		
		return $array;
	}
}


1		<?php
2
3		namespace alsvanzelf\jsonapi;
4
5		use alsvanzelf\jsonapi\Document;
6		use alsvanzelf\jsonapi\helpers\Converter;
7		use alsvanzelf\jsonapi\objects\MetaObject;
8
9		/**
10		* this document can be used if neither data nor errors need to be set
11		* meta can also be added to ResourceDocument, CollectionDocument and ErrorsDocument via `addMeta()`
12		*/
13		class MetaDocument extends Document {
14		/**
15		* human api
16		*/
17
18		/**
19		* @param array $meta
20		* @return MetaDocument
21		*/
22	2	public static function fromArray(array $meta) {
23	2	$metaDocument = new self();
24	2	$metaDocument->setMetaObject(MetaObject::fromArray($meta));
25
26	2	return $metaDocument;
27		}
28
29		/**
30		* @param object $meta
31		* @return MetaDocument
32		*/
33	1	public static function fromObject($meta) {
34	1	$array = Converter::objectToArray($meta);
35
36	1	return self::fromArray($array);
37		}
38
39		/**
40		* wrapper for Document::addMeta() to the primary data of this document available via `add()`
41		*
42		* @param string $key
43		* @param mixed $value
44		* @param string $level one of the Document::LEVEL_* constants, optional, defaults to Document::LEVEL_ROOT
45		*/
46	1	public function add($key, $value, $level=Document::LEVEL_ROOT) {
47	1	parent::addMeta($key, $value, $level);
48		}
49
50		/**
51		* spec api
52		*/
53
54		/**
55		* DocumentInterface
56		*/
57
58		/**
59		* @inheritDoc
60		*/
61	7	public function toArray() {
62	7	$array = parent::toArray();
63
64		// force meta to be set, and be an object when converting to json
65	7	if (isset($array['meta']) === false) {
66	2	$array['meta'] = new \stdClass();
67		}
68
69	7	return $array;
70		}
71		}
72

lode / jsonapi

MetaDocument::add() A last analyzed 2022-10-02 08:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

MetaDocument::add() A
last analyzed 2022-10-02 08:36 UTC