[MAINTENANCE] Fix documentation (mainly an -> a) (kitodo#1522)

Signed-off-by: Stefan Weil <sw@weilnetz.de>

Author: stweil

Classes/Common/AbstractDocument.php

@@ -417,7 +417,7 @@ abstract protected function establishRecordId(int $pid): void;
      *
      * @abstract
      *
-     * @return \SimpleXMLElement|IiifResourceInterface An PHP object representation of
+     * @return \SimpleXMLElement|IiifResourceInterface A PHP object representation of
      * the current document. SimpleXMLElement for METS, IiifResourceInterface for IIIF
      */
     abstract protected function getDocument();

Classes/Common/Helper.php

@@ -364,7 +364,7 @@ public static function encrypt(string $string)
     }
 
     /**
-     * Clean up a string to use in an URL.
+     * Clean up a string to use in a URL.
      *
      * @access public
      *
@@ -409,7 +409,7 @@ public static function getHookObjects(string $scriptRelPath): array
     }
 
     /**
-     * Get the "index_name" for an UID
+     * Get the "index_name" for a UID
      *
      * @access public
      *
@@ -671,7 +671,7 @@ public static function translate(string $indexName, string $table, string $pid):
         $languageAspect = GeneralUtility::makeInstance(Context::class)->getAspect('language');
         $languageContentId = $languageAspect->getContentId();
 
-        // Check if "index_name" is an UID.
+        // Check if "index_name" is a UID.
         if (MathUtility::canBeInterpretedAsInteger($indexName)) {
             $indexName = self::getIndexNameFromUid((int) $indexName, $table, $pid);
         }
@@ -716,7 +716,7 @@ public static function translate(string $indexName, string $table, string $pid):
             $row = $result->fetchAssociative();
 
             if ($row) {
-                // If there is an translated content element, overwrite the received $indexName.
+                // If there is a translated content element, overwrite the received $indexName.
                 $indexName = $row['index_name'];
             }
         }

Classes/Common/Solr/Solr.php

@@ -592,7 +592,7 @@ protected function __construct(?string $core)
             $eventDispatcher = null;
         } else {
             // When updating to TYPO3 >=10.x and Solarium >=6.x
-            // we have to provide an PSR-14 Event Dispatcher instead of
+            // we have to provide a PSR-14 Event Dispatcher instead of
             // "null".
             $eventDispatcher = GeneralUtility::makeInstance(EventDispatcher::class);
         }

Classes/Eid/PageViewProxy.php

@@ -132,7 +132,7 @@ protected function handleOptions(ServerRequestInterface $request): ResponseInter
     }
 
     /**
-     * Handle an HEAD request.
+     * Handle a HEAD request.
      *
      * @access protected
      *

Documentation/Plugins/Index.rst

@@ -1036,7 +1036,7 @@ The model URL is extracted from the METS file or taken from the provided model p
 
 Search in Document Tool
 ^^^^^^^^^^^^^^^^^^^^^^^
-This plugin adds an possibility to search all appearances of the phrase in currently displayed document
+This plugin adds a possibility to search all appearances of the phrase in currently displayed document.
 
 :typoscript:`plugin.tx_dlf_searchindocumenttool.`
 

Resources/Private/Templates/ListView/Main.html

@@ -18,7 +18,7 @@ <h2 class="tx-dlf-listview-label">
             <f:translate key="search.search"  />
             <f:translate key="search.for" arguments="{0: '{lastSearch.query}'}" />
             <f:comment>
-                We need an ViewHelper to get the Extbase document object here. Usable e.g. on search in a newspaper title.
+                We need a ViewHelper to get the Extbase document object here. Usable e.g. on search in a newspaper title.
                 <f:translate key="search.in" arguments="{0: '{lastSearch.documentId}'}" />
             </f:comment>
         </h2>