Fix various code stinks

Author: lutzhelm

src/Iiif/Context/JsonLdProcessor.php

@@ -262,7 +262,7 @@ public function processContext($localContext, JsonLdContext $activeContext, $rem
                 } elseif (IRI::isAbsoluteIri($value)) {
                     // 5.7.3)
                     $result->setBaseIri($value);
-                } elseif (IRI::isRelativeIri($uri) && $result->getBaseIri() != null) {
+                } elseif (IRI::isRelativeIri($value) && $result->getBaseIri() != null) {
                     // 5.7.4)
                     $result->setBaseIri(IRI::resolveAbsoluteIri($result->getBaseIri(), $value));
                 } else {

src/Iiif/Presentation/Common/Model/AbstractIiifEntity.php

@@ -34,6 +34,8 @@
 
 abstract class AbstractIiifEntity {
 
+    protected ?string $id = null;
+
     /**
      *
      * @var array

src/Iiif/Presentation/Common/Model/LazyLoadingIterator.php

@@ -36,18 +36,21 @@ public function __construct(&$entity, $field, &$items) {
         $this->items = &$items;
     }
 
-    public function next() {
+    public function next(): void
+    {
         $this->position++;
     }
 
-    public function valid() {
+    public function valid(): bool
+    {
         return $this->items != null && $this->position < sizeof($this->items); 
     }
 
     /**
-     * @return AbstractIiifEntity
+     * @return ?AbstractIiifEntity
      */
-    public function current() {
+    public function current(): ?AbstractIiifEntity
+    {
         if (!$this->valid()) {
             return null;
         }
@@ -62,11 +65,12 @@ public function current() {
         return $this->items[$this->position];
     }
 
-    public function rewind() {
+    public function rewind(): void
+    {
         $this->position = 0;
     }
 
-    public function key() {
+    public function key(): ?int {
         return $this->valid() ? $this->position : null;
     }
 

src/Iiif/Presentation/Common/Model/Resources/AbstractIiifResource.php

@@ -24,7 +24,9 @@
 use Ubl\Iiif\Context\JsonLdHelper;
 
 abstract class AbstractIiifResource extends AbstractIiifEntity implements IiifResourceInterface {
-    
+
+    protected abstract function getValueForDisplay($value, $language = null, $joinChars = "; ", $options = IiifResourceInterface::SANITIZE_XML_ENCODE_NONHTML): string|array|null;
+
     protected function getWeblinksForDisplayCommon($value, $language, $joinChars, $idOrAlias) {
         if (empty($value)) {
             return null;

src/Iiif/Presentation/Common/Model/Resources/AnnotationContainerInterface.php

@@ -34,7 +34,7 @@ interface AnnotationContainerInterface extends IiifResourceInterface {
      * @link https://www.w3.org/TR/annotation-vocab/#motivation
      * 
      */
-    public function getTextAnnotations($motivation = null);
+    public function getTextAnnotations($motivation = null): ?array;
 
 }
 

src/Iiif/Presentation/Common/Model/Resources/AnnotationInterface.php

@@ -35,10 +35,10 @@ public function getBody();
     public function getMotivation();
 
     /**
-     * @return string The id of the resource (usually a Canvas) that is referenced by
+     * @return ?string The id of the resource (usually a Canvas) that is referenced by
      *                the annotation, without any fragments and not enclosed in specific resources
      */
-    public function getTargetResourceId();
+    public function getTargetResourceId(): ?string;
 
 
     public function getOnSelector();

src/Iiif/Presentation/Common/Model/Resources/CanvasInterface.php

@@ -39,7 +39,7 @@ public function getPossibleTextAnnotationContainers($motivation = null);
      * @param boolean $painting 
      * @return LazyLoadingIterator
      */
-    public function getPotentialTextAnnotationContainerIterator($painting = null);
+    public function getPotentialTextAnnotationContainerIterator($painting = null): ?LazyLoadingIterator;
 
     /**
      * @return int

src/Iiif/Presentation/Common/Model/Resources/IiifResourceInterface.php

@@ -173,7 +173,7 @@ public function getRenderingUrlsForFormat($format, $useChildResources = true);
      * @return string A thumbnail URL for the resource, either provided by a "thumbnail" property or
      * generated with default dimensions in @link \Ubl\Iiif\Tools\Options.
      */
-    public function getThumbnailUrl();
+    public function getThumbnailUrl(): ?string;
 
     /**
      * Extract data from json node by JsonPath expression

src/Iiif/Presentation/Common/Model/Resources/ManifestInterface.php

@@ -20,14 +20,16 @@
 
 namespace Ubl\Iiif\Presentation\Common\Model\Resources;
 
+use Ubl\Iiif\Presentation\Common\Model\AbstractIiifEntity;
+
 interface ManifestInterface extends IiifResourceInterface {
 
     /**
      * versions 1, 2: canvases of default sequence
      * version 3: items of the first range with "sequence" behaviour; otherwise items of manifest 
-     * @return CanvasInterface[]
+     * @return ?CanvasInterface[]
      */
-    public function getDefaultCanvases();
+    public function getDefaultCanvases(): ?array;
 
     /**
      * version 2: first range marked as top or any ranges that are no children of other ranges
@@ -58,7 +60,7 @@ public function getStructures();
      * @return IiifResourceInterface The PHP object representation of the IIIF resource the ID $id.
      * If the manifest does not contain such a resource, return null.  
      */
-    public function getContainedResourceById($id);
+    public function getContainedResourceById($id): ?AbstractIiifEntity;
 
 }
 

src/Iiif/Presentation/V1/Model/Resources/AbstractIiifResource1.php

@@ -31,11 +31,6 @@
 
 abstract class AbstractIiifResource1 extends AbstractIiifResource implements IiifResourceInterface {
 
-    /**
-     * 
-     * @var string
-     */
-    protected $id;
     /**
      *
      * @var string
@@ -319,11 +314,13 @@ public function getSummaryForDisplay($language = null, $joinChars = "; ", $optio
      * {@inheritDoc}
      * @see \Ubl\Iiif\Presentation\Common\Model\Resources\IiifResourceInterface::getThumbnailUrl()
      */
-    public function getThumbnailUrl() {
+    public function getThumbnailUrl(): ?string
+    {
         return null;
     }
 
-    protected function getValueForDisplay($value, $language = null, $joinChars = "; ", $options = IiifResourceInterface::SANITIZE_XML_ENCODE_NONHTML) {
+    protected function getValueForDisplay($value, $language = null, $joinChars = "; ", $options = IiifResourceInterface::SANITIZE_XML_ENCODE_NONHTML): string|array|null
+    {
         if (is_null($value)){
             return null;
         }