seboettg / citeproc-php

src/Seboettg/CiteProc/Util/Variables.php

Spacing +65 added lines, -65 removed lines

@@ -14,103 +14,103 @@
 {
 
     const NAME_VARIABLES = [
-        'author',               //author
-        'collection-editor',    //editor of the collection holding the item (e.g. the series editor for a book)
-        'composer',             //composer (e.g. of a musical score)
-        'container-author',     //author of the container holding the item (e.g. the book author for a book chapter)
-        'director',             //director (e.g. of a film)
-        'editor',               //editor
-        'editorial-director',   //managing editor (“Directeur de la Publication” in French)
-        'illustrator',          //illustrator (e.g. of a children’s book)
-        'interviewer',          //interviewer (e.g. of an interview)
-        'original-author',      //
-        'recipient',            //recipient (e.g. of a letter)
+        'author', //author
+        'collection-editor', //editor of the collection holding the item (e.g. the series editor for a book)
+        'composer', //composer (e.g. of a musical score)
+        'container-author', //author of the container holding the item (e.g. the book author for a book chapter)
+        'director', //director (e.g. of a film)
+        'editor', //editor
+        'editorial-director', //managing editor (“Directeur de la Publication” in French)
+        'illustrator', //illustrator (e.g. of a children’s book)
+        'interviewer', //interviewer (e.g. of an interview)
+        'original-author', //
+        'recipient', //recipient (e.g. of a letter)
         'reviewed-author'       //author of the item reviewed by the current item
     ];
 
     const NUMBER_VARIABLES = [
-        'chapter-number',       //chapter number
-        'collection-number',    //number identifying the collection holding the item (e.g. the series number for a book)
-        'edition',              //(container) edition holding the item (e.g. “3” when citing a chapter in the third
+        'chapter-number', //chapter number
+        'collection-number', //number identifying the collection holding the item (e.g. the series number for a book)
+        'edition', //(container) edition holding the item (e.g. “3” when citing a chapter in the third
                                 //edition of a book)
-        'issue',                //(container) issue holding the item (e.g. “5” when citing a journal article from
+        'issue', //(container) issue holding the item (e.g. “5” when citing a journal article from
                                 //journal volume 2, issue 5)
-        'number',               //number identifying the item (e.g. a report number)
-        'number-of-pages',      //total number of pages of the cited item
-        'number-of-volumes',    //total number of volumes, usable for citing multi-volume books and such
+        'number', //number identifying the item (e.g. a report number)
+        'number-of-pages', //total number of pages of the cited item
+        'number-of-volumes', //total number of volumes, usable for citing multi-volume books and such
         'volume'                //(container) volume holding the item (e.g. “2” when citing a chapter from book volume 2)
     ];
 
     const DATE_VARIABLES = [
-        'accessed',             //date the item has been accessed
+        'accessed', //date the item has been accessed
         'container',
-        'event-date',           //date the related event took place
-        'issued',               //date the item was issued/published
-        'original-date',        //(issue) date of the original version
+        'event-date', //date the related event took place
+        'issued', //date the item was issued/published
+        'original-date', //(issue) date of the original version
         'submitted'             //date the item (e.g. a manuscript) has been submitted for publication
     ];
 
     const STANDARD_VARIABLE = [
-        'abstract',             //abstract of the item (e.g. the abstract of a journal article)
-        'annote',               //reader’s notes about the item content
-        'archive',              //archive storing the item
-        'archive-location',     //storage location within an archive (e.g. a box and folder number)
-        'archive-place',        //geographic location of the archive
-        'authority',            //issuing or judicial authority (e.g. “USPTO” for a patent, “Fairfax Circuit Court” for
+        'abstract', //abstract of the item (e.g. the abstract of a journal article)
+        'annote', //reader’s notes about the item content
+        'archive', //archive storing the item
+        'archive-location', //storage location within an archive (e.g. a box and folder number)
+        'archive-place', //geographic location of the archive
+        'authority', //issuing or judicial authority (e.g. “USPTO” for a patent, “Fairfax Circuit Court” for
                                 //a legal case)
-        'call-number',          //call number (to locate the item in a library)
-        'citation-label',       //label identifying the item in in-text citations of label styles (e.g. “Ferr78”). May
+        'call-number', //call number (to locate the item in a library)
+        'citation-label', //label identifying the item in in-text citations of label styles (e.g. “Ferr78”). May
                                 //be assigned by the CSL processor based on item metadata.
-        'citation-number',      //index (starting at 1) of the cited reference in the bibliography (generated by the CSL
+        'citation-number', //index (starting at 1) of the cited reference in the bibliography (generated by the CSL
                                 //processor)
-        'collection-title',     //title of the collection holding the item (e.g. the series title for a book)
-        'container-title',      //title of the container holding the item (e.g. the book title for a book chapter, the
+        'collection-title', //title of the collection holding the item (e.g. the series title for a book)
+        'container-title', //title of the container holding the item (e.g. the book title for a book chapter, the
                                 //journal title for a journal article)
-        'container-title-short',//short/abbreviated form of “container-title” (also accessible through the “short” form
+        'container-title-short', //short/abbreviated form of “container-title” (also accessible through the “short” form
                                 //of the “container-title” variable)
-        'dimensions',           //physical (e.g. size) or temporal (e.g. running time) dimensions of the item
-        'DOI',                  //Digital Object Identifier (e.g. “10.1128/AEM.02591-07”)
-        'event',                //name of the related event (e.g. the conference name when citing a conference paper)
-        'event-place',          //geographic location of the related event (e.g. “Amsterdam, the Netherlands”)
+        'dimensions', //physical (e.g. size) or temporal (e.g. running time) dimensions of the item
+        'DOI', //Digital Object Identifier (e.g. “10.1128/AEM.02591-07”)
+        'event', //name of the related event (e.g. the conference name when citing a conference paper)
+        'event-place', //geographic location of the related event (e.g. “Amsterdam, the Netherlands”)
         'first-reference-note-number', //number of a preceding note containing the first reference to the item. Assigned
                                 // by the CSL processor. The variable holds no value for non-note-based styles, or when
                                 // the item hasn’t been cited in any preceding notes.
-        'genre',                //class, type or genre of the item (e.g. “adventure” for an adventure movie,
+        'genre', //class, type or genre of the item (e.g. “adventure” for an adventure movie,
                                 //“PhD dissertation” for a PhD thesis),
-        'ISBN',                 //International Standard Book Number
-        'ISSN',                 //International Standard Serial Number
-        'jurisdiction',         //geographic scope of relevance (e.g. “US” for a US patent)
-        'keyword',              //keyword(s) or tag(s) attached to the item
-        'locator',              //a cite-specific pinpointer within the item (e.g. a page number within a book, or a
+        'ISBN', //International Standard Book Number
+        'ISSN', //International Standard Serial Number
+        'jurisdiction', //geographic scope of relevance (e.g. “US” for a US patent)
+        'keyword', //keyword(s) or tag(s) attached to the item
+        'locator', //a cite-specific pinpointer within the item (e.g. a page number within a book, or a
                                 //volume in a multi-volume work). Must be accompanied in the input data by a label
                                 //indicating the locator type (see the Locators term list), which determines which term
                                 //is rendered by cs:label when the “locator” variable is selected.
-        'medium',               //medium description (e.g. “CD”, “DVD”, etc.)
-        'note',                 //(short) inline note giving additional item details (e.g. a concise summary or commentary)
-        'original-publisher',   //original publisher, for items that have been republished by a different publisher
+        'medium', //medium description (e.g. “CD”, “DVD”, etc.)
+        'note', //(short) inline note giving additional item details (e.g. a concise summary or commentary)
+        'original-publisher', //original publisher, for items that have been republished by a different publisher
         'original-publisher-place', //geographic location of the original publisher (e.g. “London, UK”)
-        'original-title',       //title of the original version (e.g. “Война и мир”, the untranslated Russian title of
+        'original-title', //title of the original version (e.g. “Война и мир”, the untranslated Russian title of
                                 // “War and Peace”)
-        'page',                 //range of pages the item (e.g. a journal article) covers in a container (e.g. a journal
+        'page', //range of pages the item (e.g. a journal article) covers in a container (e.g. a journal
                                 // issue)
-        'page-first',           //first page of the range of pages the item (e.g. a journal article) covers in a
+        'page-first', //first page of the range of pages the item (e.g. a journal article) covers in a
                                 //container (e.g. a journal issue)
-        'PMCID',                //PubMed Central reference number
-        'PMID',                 //PubMed reference number
-        'publisher',            //publisher
-        'publisher-place',      //geographic location of the publisher
-        'references',           //resources related to the procedural history of a legal case
-        'reviewed-title',       //title of the item reviewed by the current item
-        'scale',                //scale of e.g. a map
-        'section',              //container section holding the item (e.g. “politics” for a newspaper article)
-        'source',               //from whence the item originates (e.g. a library catalog or database)
-        'status',               //(publication) status of the item (e.g. “forthcoming”)
-        'title',                //primary title of the item
-        'title-short',          //short/abbreviated form of “title” (also accessible through the “short” form of the
+        'PMCID', //PubMed Central reference number
+        'PMID', //PubMed reference number
+        'publisher', //publisher
+        'publisher-place', //geographic location of the publisher
+        'references', //resources related to the procedural history of a legal case
+        'reviewed-title', //title of the item reviewed by the current item
+        'scale', //scale of e.g. a map
+        'section', //container section holding the item (e.g. “politics” for a newspaper article)
+        'source', //from whence the item originates (e.g. a library catalog or database)
+        'status', //(publication) status of the item (e.g. “forthcoming”)
+        'title', //primary title of the item
+        'title-short', //short/abbreviated form of “title” (also accessible through the “short” form of the
                                 //“title” variable)
-        'URL',                  //Uniform Resource Locator (e.g. “http://aem.asm.org/cgi/content/full/74/9/2766”)
-        'version',              //version of the item (e.g. “2.0.9” for a software program)
-        'year-suffix',          //disambiguating year suffix in author-date styles (e.g. “a” in “Doe, 1999a”)
+        'URL', //Uniform Resource Locator (e.g. “http://aem.asm.org/cgi/content/full/74/9/2766”)
+        'version', //version of the item (e.g. “2.0.9” for a software program)
+        'year-suffix', //disambiguating year suffix in author-date styles (e.g. “a” in “Doe, 1999a”)
 
 
     ];

src/Seboettg/CiteProc/Rendering/Date/Date.php

Doc Comments +4 added lines, -1 removed lines

@@ -229,7 +229,7 @@ 
     }
 
     /**
-     * @param $differentParts
+     * @param integer $differentParts
      * @param DateTime $from
      * @param DateTime $to
      * @param $delim
@@ -469,6 +469,9 @@ 
         }
     }
 
+    /**
+     * @param string $form
+     */
     private function prepareDatePartsChildren($dateParts, $form)
     {
         /* Localized date formats are selected with the optional form attribute, which must set to either “numeric”

src/Seboettg/CiteProc/Rendering/Layout.php

Spacing +2 added lines, -3 removed lines

@@ -84,8 +84,7 @@ 
 
         if (CiteProc::getContext()->isModeBibliography()) {
             if ($data instanceof DataList) {
-                foreach ($data as $citationNumber => $item) {
-                    ++self::$numberOfCitedItems;
+                foreach ($data as $citationNumber => $item) {++self::$numberOfCitedItems;
                     CiteProc::getContext()->getResults()->append($this->wrapBibEntry($this->renderSingle($item, $citationNumber)));
                 }
                 $ret .= implode($this->delimiter, CiteProc::getContext()->getResults()->toArray());
@@ -93,7 +92,7 @@ 
                 $ret .= $this->wrapBibEntry($this->renderSingle($data, $citationNumber));
             }
             $ret = StringHelper::clearApostrophes($ret);
-            return "<div class=\"csl-bib-body\">".$ret."\n</div>";
+            return "<div class=\"csl-bib-body\">" . $ret . "\n</div>";
 
         } else if (CiteProc::getContext()->isModeCitation()) {
             if (is_array($data) || $data instanceof DataList) {

src/Seboettg/CiteProc/Styles/QuotesTrait.php

Spacing +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
             } else {
                 $lastChar = substr($text, -1);
                 if (preg_match("/[,\.;]/", $text)) {
-                    $subStr = substr($text, 0,strlen($text)-1);
+                    $subStr = substr($text, 0, strlen($text) - 1);
                     return $openQuote . $subStr . $closeQuote . $lastChar;
                 }
             }

src/Seboettg/CiteProc/Styles/DisplayTrait.php

Spacing +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
         if (!in_array($this->display, self::$allowedValues)) {
             return $text;
         }
-        $divStyle = "class=\"csl-".$this->display."\"";
+        $divStyle = "class=\"csl-" . $this->display . "\"";
         return "<div $divStyle>$text</div>";
     }
 }
\ No newline at end of file

src/Seboettg/CiteProc/Rendering/Name/Name.php

Doc Comments +9 added lines, -3 removed lines

@@ -204,7 +204,7 @@ 
     }
 
     /**
-     * @param $name
+     * @param \stdClass $name
      * @return \stdClass
      */
     private function cloneNamePOSC($name)
@@ -497,6 +497,12 @@ 
     }
 
 
+    /**
+     * @param \stdClass $data
+     * @param integer $rank
+     *
+     * @return string
+     */
     private function nameOrder($data, $rank)
     {
         $nameAsSortOrder = (($this->nameAsSortOrder === "first" && $rank === 0) || $this->nameAsSortOrder === "all");
@@ -549,7 +555,7 @@ 
     }
 
     /**
-     * @param $data
+     * @param \stdClass $data
      * @return array
      */
     private function renderNameParts($data)
@@ -580,7 +586,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getDelimiter()
     {

Spacing +5 added lines, -5 removed lines

@@ -91,7 +91,7 @@ 
         foreach ($node->attributes() as $attribute) {
             switch ($attribute->getName()) {
                 case 'form':
-                    $this->form = (string)$attribute;
+                    $this->form = (string) $attribute;
                     break;
             }
 
@@ -151,7 +151,7 @@ 
         cs:names element (taking into account the effects of et-al abbreviation and editor/translator collapsing),
         which allows for advanced sorting. */
         if ($this->form == 'count') {
-            return (int)count($resultNames);
+            return (int) count($resultNames);
         }
 
         return $text;
@@ -503,8 +503,8 @@ 
         $demoteNonDroppingParticle = CiteProc::getContext()->getGlobalOptions()->getDemoteNonDroppingParticles();
 
         if ($this->form === "long" && $nameAsSortOrder &&
-            ((string)$demoteNonDroppingParticle === DemoteNonDroppingParticle::NEVER ||
-                (string)$demoteNonDroppingParticle === DemoteNonDroppingParticle::SORT_ONLY)
+            ((string) $demoteNonDroppingParticle === DemoteNonDroppingParticle::NEVER ||
+                (string) $demoteNonDroppingParticle === DemoteNonDroppingParticle::SORT_ONLY)
         ) {
 
             // [La] [Fontaine], [Jean] [de], [III]
@@ -517,7 +517,7 @@ 
             $text .= !empty($data->suffix) ? $this->sortSeparator . $data->suffix : "";
         } else if ($this->form === "long" && $nameAsSortOrder &&
             (is_null($demoteNonDroppingParticle) ||
-                (string)$demoteNonDroppingParticle === DemoteNonDroppingParticle::DISPLAY_AND_SORT)
+                (string) $demoteNonDroppingParticle === DemoteNonDroppingParticle::DISPLAY_AND_SORT)
         ) {
             // [Fontaine], [Jean] [de] [La], [III]
 

src/Seboettg/CiteProc/Util/NameHelper.php

Spacing +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
     {
         if (isset($data->{$particle}) && isset($data->{$namePart})) {
             $data->{$namePart} = $data->{$particle} . " " . $data->{$namePart}; //prepend $particle to $namePart
-            unset($data->{$particle});//remove particle from $data
+            unset($data->{$particle}); //remove particle from $data
         }
     }
 }
\ No newline at end of file