refs #18664 [fid] get it box comments

module/fid/src/View/Helper/Root/GetIt.php

@@ -77,20 +77,77 @@ class GetIt extends AbstractHelper
      * @var \fid\Service\Client
      */
     protected $fidClient;
+    /**
+     * Solr field source_id
+     * @var
+     */
     protected $sid;
+    /**
+     * Solr field format
+     * or instance specific configuration
+     * @var
+     */
     protected $format;
+    /**
+     * Solr field facet_avail
+     * @var
+     */
     protected $facetAvail;
+    /**
+     * Solr field multipart_set
+     * @var
+     */
     protected $multipart;
+    /**
+     * Has a hierarchy parent title
+     * @var
+     */
     protected $isCollection;
+    /**
+     * Solr field institution
+     * @var
+     */
     protected $institution;
+    /**
+     * Solr field mega_collection
+     * @var
+     */
     protected $megacollection;
+    /**
+     * Solr field collection
+     * @var
+     */
     protected $collection;
+    /**
+     * Solr field isbn
+     * @var
+     */
     protected $isbn;
+    /**
+     * Solr field issn
+     * @var
+     */
     protected $issn;
 
+    /**
+     * Default color of a accordeon
+     * @var
+     */
     protected $accordeonColorDefault;
+    /**
+     * second color of the accordeon
+     * @var
+     */
     protected $accordeonColorAlternative;
+    /**
+     * Default headline text of the get it box
+     * @var
+     */
     protected $accordeonHeadlineDefault;
+    /**
+     * second headline text of the get it box
+     * @var
+     */
     protected $accordeonHeadlineAlternative;
 
     /**
@@ -105,6 +162,8 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     * Get Solr field data
+     *
      * @param $driver
      */
     public function __invoke($driver)
@@ -222,8 +281,12 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     *
+     * Open Access
+     *
      * Configuration of SIDs 13,22,26,28,30,34,53,80,84,87,88,99,101,150,153,170
      *
+     *
      * @param $accordeonColor       string  accordeon color
      * @param $accordeonHeadline    string  accordeon headline
      * @param $boxHeadline          string  headline text get it box
@@ -259,6 +322,9 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     *
+     * Magazine Articles
+     *
      * Configuration of SID 49,55,68,105
      *
      * @param $accordeonColor       string  accordeon color
@@ -300,6 +366,9 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     *
+     * PDA
+     *
      * Configuration of SID 51
      *
      * @param $accordeonColor       string  accordeon color
@@ -343,6 +412,9 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     *
+     * EBL
+     *
      * Configuration of SID 76
      *
      * @param $accordeonColor       string  accordeon color
@@ -397,6 +469,9 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     *
+     * IZI Database
+     *
      * Configuration of SID 78
      *
      * @param $accordeonColor       string  accordeon color
@@ -432,6 +507,9 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     *
+     * Margaret Herrick Library
+     *
      * Configuration of SID 103
      *
      * @param $accordeonColor       string  accordeon color
@@ -469,6 +547,9 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     *
+     * VK Film collection
+     *
      * Configuration of SID 0,109,117,119,127,142,148,151,155
      *
      * @param $accordeonColor       string  accordeon color
@@ -653,6 +734,9 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     *
+     * VK Film collection
+     *
      * Configuration of SID 0 (special cases)
      *
      * @param $accordeonColor       string  accordeon color
@@ -721,6 +805,9 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     *
+     * MediathekViewWeb
+     *
      * Configuration of SID 169
      *
      * @param $accordeonColor       string  accordeon color
@@ -758,6 +845,9 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     *
+     * Bielefeld Academic Search Engine (BASE)
+     *
      * Configuration of SID 126
      *
      * @param $accordeonColor       string  accordeon color
@@ -793,6 +883,9 @@ class GetIt extends AbstractHelper
     }
 
     /**
+     *
+     * Has User ordered certain Record (SID 51)
+     *
      * @return bool
      */
     public function isRecordOrdered()