From 8056b6926c850d7d85db90ecee2ad9dea69d0292 Mon Sep 17 00:00:00 2001 From: Roman Syroeshko Date: Thu, 3 Jul 2014 16:11:15 +0400 Subject: [PATCH] [CHANGED] Docblock for pass-by-reference parameters. --- src/PhpWord/Media.php | 2 +- src/PhpWord/Reader/ODText.php | 2 +- src/PhpWord/Reader/ODText/Content.php | 2 +- src/PhpWord/Reader/ODText/Meta.php | 2 +- src/PhpWord/Reader/RTF/Document.php | 2 +- src/PhpWord/Reader/Word2007.php | 2 +- src/PhpWord/Reader/Word2007/AbstractPart.php | 6 +++--- src/PhpWord/Reader/Word2007/DocPropsCore.php | 2 +- src/PhpWord/Reader/Word2007/DocPropsCustom.php | 2 +- src/PhpWord/Reader/Word2007/Document.php | 8 ++++---- src/PhpWord/Reader/Word2007/Footnotes.php | 2 +- src/PhpWord/Reader/Word2007/Numbering.php | 2 +- src/PhpWord/Reader/Word2007/Styles.php | 2 +- src/PhpWord/Shared/Html.php | 16 ++++++++-------- src/PhpWord/Style/AbstractStyle.php | 6 +++--- src/PhpWord/Template.php | 2 +- src/PhpWord/Writer/ODText/Part/Content.php | 12 ++++++------ src/PhpWord/Writer/RTF/Part/Header.php | 4 ++-- src/PhpWord/Writer/Word2007.php | 8 ++++---- 19 files changed, 42 insertions(+), 42 deletions(-) diff --git a/src/PhpWord/Media.php b/src/PhpWord/Media.php index 7f35841c..aa289edc 100644 --- a/src/PhpWord/Media.php +++ b/src/PhpWord/Media.php @@ -38,7 +38,7 @@ class Media * @param string $container section|headerx|footerx|footnote|endnote * @param string $mediaType image|object|link * @param string $source - * @param \PhpOffice\PhpWord\Element\Image $image + * @param \PhpOffice\PhpWord\Element\Image &$image * @return integer * @throws \PhpOffice\PhpWord\Exception\Exception * @since 0.9.2 diff --git a/src/PhpWord/Reader/ODText.php b/src/PhpWord/Reader/ODText.php index d7d23c80..0c24185d 100644 --- a/src/PhpWord/Reader/ODText.php +++ b/src/PhpWord/Reader/ODText.php @@ -53,7 +53,7 @@ class ODText extends AbstractReader implements ReaderInterface /** * Read document part. * - * @param \PhpOffice\PhpWord\PhpWord $phpWord + * @param \PhpOffice\PhpWord\PhpWord &$phpWord * @param array $relationships * @param string $partName * @param string $docFile diff --git a/src/PhpWord/Reader/ODText/Content.php b/src/PhpWord/Reader/ODText/Content.php index 9feb669a..aecb7419 100644 --- a/src/PhpWord/Reader/ODText/Content.php +++ b/src/PhpWord/Reader/ODText/Content.php @@ -30,7 +30,7 @@ class Content extends AbstractPart /** * Read content.xml. * - * @param \PhpOffice\PhpWord\PhpWord $phpWord + * @param \PhpOffice\PhpWord\PhpWord &$phpWord * @return void */ public function read(PhpWord &$phpWord) diff --git a/src/PhpWord/Reader/ODText/Meta.php b/src/PhpWord/Reader/ODText/Meta.php index 827446f0..fc061ba1 100644 --- a/src/PhpWord/Reader/ODText/Meta.php +++ b/src/PhpWord/Reader/ODText/Meta.php @@ -30,7 +30,7 @@ class Meta extends AbstractPart /** * Read meta.xml. * - * @param \PhpOffice\PhpWord\PhpWord $phpWord + * @param \PhpOffice\PhpWord\PhpWord &$phpWord * @return void * @todo Process property type */ diff --git a/src/PhpWord/Reader/RTF/Document.php b/src/PhpWord/Reader/RTF/Document.php index 26763576..1f3dbb34 100644 --- a/src/PhpWord/Reader/RTF/Document.php +++ b/src/PhpWord/Reader/RTF/Document.php @@ -129,7 +129,7 @@ class Document * - Builds control words and control symbols * - Pushes every other character into the text queue * - * @param \PhpOffice\PhpWord\PhpWord $phpWord + * @param \PhpOffice\PhpWord\PhpWord &$phpWord * @return void * @todo Use `fread` stream for scalability */ diff --git a/src/PhpWord/Reader/Word2007.php b/src/PhpWord/Reader/Word2007.php index acf40483..556b0bb0 100644 --- a/src/PhpWord/Reader/Word2007.php +++ b/src/PhpWord/Reader/Word2007.php @@ -77,7 +77,7 @@ class Word2007 extends AbstractReader implements ReaderInterface /** * Read document part. * - * @param \PhpOffice\PhpWord\PhpWord $phpWord + * @param \PhpOffice\PhpWord\PhpWord &$phpWord * @param array $relationships * @param string $partName * @param string $docFile diff --git a/src/PhpWord/Reader/Word2007/AbstractPart.php b/src/PhpWord/Reader/Word2007/AbstractPart.php index 0309f193..eead400f 100644 --- a/src/PhpWord/Reader/Word2007/AbstractPart.php +++ b/src/PhpWord/Reader/Word2007/AbstractPart.php @@ -94,7 +94,7 @@ abstract class AbstractPart * * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader * @param \DOMElement $domNode - * @param mixed $parent + * @param mixed &$parent * @param string $docPart * @return void * @@ -185,7 +185,7 @@ abstract class AbstractPart * * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader * @param \DOMElement $domNode - * @param mixed $parent + * @param mixed &$parent * @param string $docPart * @param mixed $paragraphStyle * @return void @@ -248,7 +248,7 @@ abstract class AbstractPart * * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader * @param \DOMElement $domNode - * @param mixed $parent + * @param mixed &$parent * @param string $docPart * @return void */ diff --git a/src/PhpWord/Reader/Word2007/DocPropsCore.php b/src/PhpWord/Reader/Word2007/DocPropsCore.php index d8a8768d..3889db0c 100644 --- a/src/PhpWord/Reader/Word2007/DocPropsCore.php +++ b/src/PhpWord/Reader/Word2007/DocPropsCore.php @@ -54,7 +54,7 @@ class DocPropsCore extends AbstractPart /** * Read core/extended document properties. * - * @param \PhpOffice\PhpWord\PhpWord $phpWord + * @param \PhpOffice\PhpWord\PhpWord &$phpWord * @return void */ public function read(PhpWord &$phpWord) diff --git a/src/PhpWord/Reader/Word2007/DocPropsCustom.php b/src/PhpWord/Reader/Word2007/DocPropsCustom.php index 5f99495e..0d81333e 100644 --- a/src/PhpWord/Reader/Word2007/DocPropsCustom.php +++ b/src/PhpWord/Reader/Word2007/DocPropsCustom.php @@ -31,7 +31,7 @@ class DocPropsCustom extends AbstractPart /** * Read custom document properties. * - * @param \PhpOffice\PhpWord\PhpWord $phpWord + * @param \PhpOffice\PhpWord\PhpWord &$phpWord * @return void */ public function read(PhpWord &$phpWord) diff --git a/src/PhpWord/Reader/Word2007/Document.php b/src/PhpWord/Reader/Word2007/Document.php index 1d51819f..afe0e0a5 100644 --- a/src/PhpWord/Reader/Word2007/Document.php +++ b/src/PhpWord/Reader/Word2007/Document.php @@ -39,7 +39,7 @@ class Document extends AbstractPart /** * Read document.xml. * - * @param \PhpOffice\PhpWord\PhpWord $phpWord + * @param \PhpOffice\PhpWord\PhpWord &$phpWord * @return void */ public function read(PhpWord &$phpWord) @@ -65,7 +65,7 @@ class Document extends AbstractPart * Read header footer. * * @param array $settings - * @param \PhpOffice\PhpWord\Element\Section $section + * @param \PhpOffice\PhpWord\Element\Section &$section * @return void */ private function readHeaderFooter($settings, Section &$section) @@ -144,7 +144,7 @@ class Document extends AbstractPart * * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader * @param \DOMElement $node - * @param \PhpOffice\PhpWord\Element\Section $section + * @param \PhpOffice\PhpWord\Element\Section &$section * @return void * * @todo @@ -174,7 +174,7 @@ class Document extends AbstractPart * * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader * @param \DOMElement $node - * @param \PhpOffice\PhpWord\Element\Section $section + * @param \PhpOffice\PhpWord\Element\Section &$section * @return void */ private function readWSectPrNode(XMLReader $xmlReader, \DOMElement $node, Section &$section) diff --git a/src/PhpWord/Reader/Word2007/Footnotes.php b/src/PhpWord/Reader/Word2007/Footnotes.php index fd351014..30e6c58b 100644 --- a/src/PhpWord/Reader/Word2007/Footnotes.php +++ b/src/PhpWord/Reader/Word2007/Footnotes.php @@ -44,7 +44,7 @@ class Footnotes extends AbstractPart /** * Read (footnotes|endnotes).xml. * - * @param \PhpOffice\PhpWord\PhpWord $phpWord + * @param \PhpOffice\PhpWord\PhpWord &$phpWord * @return void */ public function read(PhpWord &$phpWord) diff --git a/src/PhpWord/Reader/Word2007/Numbering.php b/src/PhpWord/Reader/Word2007/Numbering.php index bc34bd68..7b33bc4c 100644 --- a/src/PhpWord/Reader/Word2007/Numbering.php +++ b/src/PhpWord/Reader/Word2007/Numbering.php @@ -30,7 +30,7 @@ class Numbering extends AbstractPart /** * Read numbering.xml. * - * @param \PhpOffice\PhpWord\PhpWord $phpWord + * @param \PhpOffice\PhpWord\PhpWord &$phpWord * @return void */ public function read(PhpWord &$phpWord) diff --git a/src/PhpWord/Reader/Word2007/Styles.php b/src/PhpWord/Reader/Word2007/Styles.php index 00010af6..964147ad 100644 --- a/src/PhpWord/Reader/Word2007/Styles.php +++ b/src/PhpWord/Reader/Word2007/Styles.php @@ -30,7 +30,7 @@ class Styles extends AbstractPart /** * Read styles.xml. * - * @param \PhpOffice\PhpWord\PhpWord $phpWord + * @param \PhpOffice\PhpWord\PhpWord &$phpWord * @return void */ public function read(PhpWord &$phpWord) diff --git a/src/PhpWord/Shared/Html.php b/src/PhpWord/Shared/Html.php index 86d466db..13824f33 100644 --- a/src/PhpWord/Shared/Html.php +++ b/src/PhpWord/Shared/Html.php @@ -191,7 +191,7 @@ class Html * * @param \DOMNode $node * @param \PhpOffice\PhpWord\Element\AbstractContainer $element - * @param array $styles + * @param array &$styles * @return \PhpOffice\PhpWord\Element\TextRun */ private static function parseParagraph($node, $element, &$styles) @@ -206,7 +206,7 @@ class Html * Parse heading node * * @param \PhpOffice\PhpWord\Element\AbstractContainer $element - * @param array $styles + * @param array &$styles * @param string $argument1 Name of heading style * @return \PhpOffice\PhpWord\Element\TextRun * @@ -226,7 +226,7 @@ class Html * * @param \DOMNode $node * @param \PhpOffice\PhpWord\Element\AbstractContainer $element - * @param array $styles + * @param array &$styles * @return null */ private static function parseText($node, $element, &$styles) @@ -245,7 +245,7 @@ class Html /** * Parse property node * - * @param array $styles + * @param array &$styles * @param string $argument1 Style name * @param string $argument2 Style value * @return null @@ -262,7 +262,7 @@ class Html * * @param \DOMNode $node * @param \PhpOffice\PhpWord\Element\AbstractContainer $element - * @param array $styles + * @param array &$styles * @param string $argument1 Method name * @return \PhpOffice\PhpWord\Element\AbstractContainer $element * @@ -292,8 +292,8 @@ class Html /** * Parse list node * - * @param array $styles - * @param array $data + * @param array &$styles + * @param array &$data * @param string $argument1 List type * @return null */ @@ -314,7 +314,7 @@ class Html * * @param \DOMNode $node * @param \PhpOffice\PhpWord\Element\AbstractContainer $element - * @param array $styles + * @param array &$styles * @param array $data * @return null * diff --git a/src/PhpWord/Style/AbstractStyle.php b/src/PhpWord/Style/AbstractStyle.php index 6f527210..aec490b5 100644 --- a/src/PhpWord/Style/AbstractStyle.php +++ b/src/PhpWord/Style/AbstractStyle.php @@ -297,7 +297,7 @@ abstract class AbstractStyle * * @param mixed $value * @param string $styleName - * @param mixed $style + * @param mixed &$style * @return mixed */ protected function setObjectVal($value, $styleName, &$style) @@ -319,8 +319,8 @@ abstract class AbstractStyle /** * Set $property value and set $pairProperty = false when $value = true * - * @param bool $property - * @param bool $pairProperty + * @param bool &$property + * @param bool &$pairProperty * @param bool $value * @return self */ diff --git a/src/PhpWord/Template.php b/src/PhpWord/Template.php index 2d994574..f91e99a2 100644 --- a/src/PhpWord/Template.php +++ b/src/PhpWord/Template.php @@ -106,7 +106,7 @@ class Template /** * Applies XSL style sheet to template's parts. * - * @param \DOMDocument $xslDOMDocument + * @param \DOMDocument &$xslDOMDocument * @param array $xslOptions * @param string $xslOptionsURI * @return void diff --git a/src/PhpWord/Writer/ODText/Part/Content.php b/src/PhpWord/Writer/ODText/Part/Content.php index b2159d7d..4bde66ee 100644 --- a/src/PhpWord/Writer/ODText/Part/Content.php +++ b/src/PhpWord/Writer/ODText/Part/Content.php @@ -23,10 +23,10 @@ use PhpOffice\PhpWord\Element\Text; use PhpOffice\PhpWord\Element\TextRun; use PhpOffice\PhpWord\PhpWord; use PhpOffice\PhpWord\Shared\XMLWriter; +use PhpOffice\PhpWord\Style; use PhpOffice\PhpWord\Style\Font; use PhpOffice\PhpWord\Style\Paragraph; use PhpOffice\PhpWord\Style\Table as TableStyle; -use PhpOffice\PhpWord\Style; use PhpOffice\PhpWord\Writer\ODText\Element\Container; use PhpOffice\PhpWord\Writer\ODText\Style\Paragraph as ParagraphStyleWriter; @@ -190,8 +190,8 @@ class Content extends AbstractPart * Table style can be null or string of the style name * * @param \PhpOffice\PhpWord\Element\AbstractContainer $container - * @param int $paragraphStyleCount - * @param int $fontStyleCount + * @param int &$paragraphStyleCount + * @param int &$fontStyleCount * @return void * @todo Simplify the logic */ @@ -223,9 +223,9 @@ class Content extends AbstractPart /** * Get style of individual element * - * @param \PhpOffice\PhpWord\Element\Text $element - * @param int $paragraphStyleCount - * @param int $fontStyleCount + * @param \PhpOffice\PhpWord\Element\Text &$element + * @param int &$paragraphStyleCount + * @param int &$fontStyleCount * @return void */ private function getElementStyle(&$element, &$paragraphStyleCount, &$fontStyleCount) diff --git a/src/PhpWord/Writer/RTF/Part/Header.php b/src/PhpWord/Writer/RTF/Part/Header.php index 574bff76..31fbb7f4 100644 --- a/src/PhpWord/Writer/RTF/Part/Header.php +++ b/src/PhpWord/Writer/RTF/Part/Header.php @@ -19,8 +19,8 @@ namespace PhpOffice\PhpWord\Writer\RTF\Part; use PhpOffice\PhpWord\Settings; use PhpOffice\PhpWord\Shared\Converter; -use PhpOffice\PhpWord\Style\Font; use PhpOffice\PhpWord\Style; +use PhpOffice\PhpWord\Style\Font; /** * RTF header part writer @@ -246,7 +246,7 @@ class Header extends AbstractPart /** * Register individual font and color. * - * @param array $table + * @param array &$table * @param string $value * @param string $default * @return void diff --git a/src/PhpWord/Writer/Word2007.php b/src/PhpWord/Writer/Word2007.php index 21471505..baac8222 100644 --- a/src/PhpWord/Writer/Word2007.php +++ b/src/PhpWord/Writer/Word2007.php @@ -192,10 +192,10 @@ class Word2007 extends AbstractWriter implements WriterInterface /** * Add header/footer content. * - * @param \PhpOffice\PhpWord\Element\Section $section + * @param \PhpOffice\PhpWord\Element\Section &$section * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip * @param string $elmType header|footer - * @param integer $rId + * @param integer &$rId * @return void */ private function addHeaderFooterContent(Section &$section, ZipArchive $zip, $elmType, &$rId) @@ -221,7 +221,7 @@ class Word2007 extends AbstractWriter implements WriterInterface * Add footnotes/endnotes * * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip - * @param integer $rId + * @param integer &$rId * @param string $noteType * @return void */ @@ -259,7 +259,7 @@ class Word2007 extends AbstractWriter implements WriterInterface * Add chart. * * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip - * @param integer $rId + * @param integer &$rId * @return void */ private function addChart(ZipArchive $zip, &$rId)