cleanup relaxed type checking by phpdoc

Author: lode

examples/bootstrap_examples.php

@@ -151,14 +151,11 @@ public function getOfficialLink(): string {
 	 * optionally helpers for the specific profile
 	 */
 
-	/**
-	 * @param ResourceInterface&HasAttributesInterface $resource
-	 */
-	public function setTimestamps(ResourceInterface $resource, ?\DateTimeInterface $created=null, ?\DateTimeInterface $updated=null) {
-		if ($resource instanceof HasAttributesInterface === false) {
-			throw new \Exception('cannot add attributes to identifier objects');
-		}
-		
+	public function setTimestamps(
+		ResourceInterface & HasAttributesInterface $resource,
+		?\DateTimeInterface $created=null,
+		?\DateTimeInterface $updated=null,
+	) {
 		$timestamps = [];
 		if ($created !== null) {
 			$timestamps['created'] = $created->format(\DateTime::ISO8601);

phpstan.bonus.neon

@@ -5,8 +5,6 @@ includes:
 parameters:
 	level: 10
 
-	treatPhpDocTypesAsCertain: true
-	
 	# @see https://github.com/phpstan/phpstan-strict-rules
 	strictRules:
 		allRules: true

phpstan.neon

@@ -5,11 +5,11 @@ parameters:
 		- src/
 		- tests/
 		- examples/
-
+	
 	typeAliases:
 		PHPStanTypeAlias_InternalOptions: 'array<string, bool|int|null|\alsvanzelf\jsonapi\enums\ContentTypeEnum>'
 
-	treatPhpDocTypesAsCertain: false
+	treatPhpDocTypesAsCertain: true
 
 	strictRules:
 		allRules: false

src/helpers/RequestParser.php

@@ -112,7 +112,7 @@ public function hasIncludePaths(): bool {
 	 * the raw format allows for custom processing
 	 * 
 	 * @param  PHPStanTypeAlias_InternalOptions $options {@see RequestParser::$defaults}
-	 * @return string[]|array
+	 * @return array<string>|array<array-key, mixed>
 	 */
 	public function getIncludePaths(array $options=[]): array {
 		if ($this->queryParameters['include'] === '') {

src/objects/RelationshipObject.php

@@ -316,6 +316,7 @@ public function getNestedContainedResourceObjects(): array {
 		$resourceObjects = [];
 
 		foreach ($resources as $resource) {
+			// @phpstan-ignore instanceof.alwaysTrue, identical.alwaysFalse (we _can_ have both ResourceObject and ResourceIdentifierObject here)
 			if ($resource->getResource() instanceof ResourceObject === false) {
 				continue;
 			}

tests/example_output/ExampleTimestampsProfile.php

@@ -14,14 +14,11 @@ public function getOfficialLink(): string {
 		return 'https://jsonapi.org/recommendations/#authoring-profiles';
 	}
 
-	/**
-	 * @param ResourceInterface&HasAttributesInterface $resource
-	 */
-	public function setTimestamps(ResourceInterface $resource, ?\DateTimeInterface $created=null, ?\DateTimeInterface $updated=null) {
-		if ($resource instanceof HasAttributesInterface === false) {
-			throw new InputException('cannot add attributes to identifier objects');
-		}
-		
+	public function setTimestamps(
+		ResourceInterface & HasAttributesInterface $resource,
+		?\DateTimeInterface $created=null,
+		?\DateTimeInterface $updated=null,
+	) {
 		$timestamps = [];
 		if ($created !== null) {
 			$timestamps['created'] = $created->format(\DateTime::ISO8601);