Clientbase
/
PHPWord
mirror of https://github.com/basemaster/PHPWord.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[CHANGED] Docblock for pass-by-reference parameters.

This commit is contained in:
Roman Syroeshko 2014-07-03 16:11:15 +04:00
parent d0a609bc95
commit 8056b6926c
19 changed files with 42 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/PhpWord/Media.php
View File

@ -38,7 +38,7 @@ class Media
* @param string $container section|headerx|footerx|footnote|endnote * @param string $container section|headerx|footerx|footnote|endnote
* @param string $mediaType image|object|link * @param string $mediaType image|object|link
* @param string $source * @param string $source
* @param \PhpOffice\PhpWord\Element\Image $image * @param \PhpOffice\PhpWord\Element\Image &$image
* @return integer * @return integer
* @throws \PhpOffice\PhpWord\Exception\Exception * @throws \PhpOffice\PhpWord\Exception\Exception
* @since 0.9.2 * @since 0.9.2

2
src/PhpWord/Reader/ODText.php
View File

@ -53,7 +53,7 @@ class ODText extends AbstractReader implements ReaderInterface
/** /**
* Read document part. * Read document part.
* *
* @param \PhpOffice\PhpWord\PhpWord $phpWord * @param \PhpOffice\PhpWord\PhpWord &$phpWord
* @param array $relationships * @param array $relationships
* @param string $partName * @param string $partName
* @param string $docFile * @param string $docFile

2
src/PhpWord/Reader/ODText/Content.php
View File

@ -30,7 +30,7 @@ class Content extends AbstractPart
/** /**
* Read content.xml. * Read content.xml.
* *
* @param \PhpOffice\PhpWord\PhpWord $phpWord * @param \PhpOffice\PhpWord\PhpWord &$phpWord
* @return void * @return void
*/ */
public function read(PhpWord &$phpWord) public function read(PhpWord &$phpWord)

2
src/PhpWord/Reader/ODText/Meta.php
View File

@ -30,7 +30,7 @@ class Meta extends AbstractPart
/** /**
* Read meta.xml. * Read meta.xml.
* *
* @param \PhpOffice\PhpWord\PhpWord $phpWord * @param \PhpOffice\PhpWord\PhpWord &$phpWord
* @return void * @return void
* @todo Process property type * @todo Process property type
*/ */

2
src/PhpWord/Reader/RTF/Document.php
View File

@ -129,7 +129,7 @@ class Document
* - Builds control words and control symbols * - Builds control words and control symbols
* - Pushes every other character into the text queue * - Pushes every other character into the text queue
* *
* @param \PhpOffice\PhpWord\PhpWord $phpWord * @param \PhpOffice\PhpWord\PhpWord &$phpWord
* @return void * @return void
* @todo Use `fread` stream for scalability * @todo Use `fread` stream for scalability
*/ */

2
src/PhpWord/Reader/Word2007.php
View File

@ -77,7 +77,7 @@ class Word2007 extends AbstractReader implements ReaderInterface
/** /**
* Read document part. * Read document part.
* *
* @param \PhpOffice\PhpWord\PhpWord $phpWord * @param \PhpOffice\PhpWord\PhpWord &$phpWord
* @param array $relationships * @param array $relationships
* @param string $partName * @param string $partName
* @param string $docFile * @param string $docFile

6
src/PhpWord/Reader/Word2007/AbstractPart.php
View File

@ -94,7 +94,7 @@ abstract class AbstractPart
* *
* @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader
* @param \DOMElement $domNode * @param \DOMElement $domNode
* @param mixed $parent * @param mixed &$parent
* @param string $docPart * @param string $docPart
* @return void * @return void
* *
@ -185,7 +185,7 @@ abstract class AbstractPart
* *
* @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader
* @param \DOMElement $domNode * @param \DOMElement $domNode
* @param mixed $parent * @param mixed &$parent
* @param string $docPart * @param string $docPart
* @param mixed $paragraphStyle * @param mixed $paragraphStyle
* @return void * @return void
@ -248,7 +248,7 @@ abstract class AbstractPart
* *
* @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader
* @param \DOMElement $domNode * @param \DOMElement $domNode
* @param mixed $parent * @param mixed &$parent
* @param string $docPart * @param string $docPart
* @return void * @return void
*/ */

2
src/PhpWord/Reader/Word2007/DocPropsCore.php
View File

@ -54,7 +54,7 @@ class DocPropsCore extends AbstractPart
/** /**
* Read core/extended document properties. * Read core/extended document properties.
* *
* @param \PhpOffice\PhpWord\PhpWord $phpWord * @param \PhpOffice\PhpWord\PhpWord &$phpWord
* @return void * @return void
*/ */
public function read(PhpWord &$phpWord) public function read(PhpWord &$phpWord)

2
src/PhpWord/Reader/Word2007/DocPropsCustom.php
View File

@ -31,7 +31,7 @@ class DocPropsCustom extends AbstractPart
/** /**
* Read custom document properties. * Read custom document properties.
* *
* @param \PhpOffice\PhpWord\PhpWord $phpWord * @param \PhpOffice\PhpWord\PhpWord &$phpWord
* @return void * @return void
*/ */
public function read(PhpWord &$phpWord) public function read(PhpWord &$phpWord)

8
src/PhpWord/Reader/Word2007/Document.php
View File

@ -39,7 +39,7 @@ class Document extends AbstractPart
/** /**
* Read document.xml. * Read document.xml.
* *
* @param \PhpOffice\PhpWord\PhpWord $phpWord * @param \PhpOffice\PhpWord\PhpWord &$phpWord
* @return void * @return void
*/ */
public function read(PhpWord &$phpWord) public function read(PhpWord &$phpWord)
@ -65,7 +65,7 @@ class Document extends AbstractPart
* Read header footer. * Read header footer.
* *
* @param array $settings * @param array $settings
* @param \PhpOffice\PhpWord\Element\Section $section * @param \PhpOffice\PhpWord\Element\Section &$section
* @return void * @return void
*/ */
private function readHeaderFooter($settings, Section &$section) private function readHeaderFooter($settings, Section &$section)
@ -144,7 +144,7 @@ class Document extends AbstractPart
* *
* @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader
* @param \DOMElement $node * @param \DOMElement $node
* @param \PhpOffice\PhpWord\Element\Section $section * @param \PhpOffice\PhpWord\Element\Section &$section
* @return void * @return void
* *
* @todo <w:lastRenderedPageBreak> * @todo <w:lastRenderedPageBreak>
@ -174,7 +174,7 @@ class Document extends AbstractPart
* *
* @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader
* @param \DOMElement $node * @param \DOMElement $node
* @param \PhpOffice\PhpWord\Element\Section $section * @param \PhpOffice\PhpWord\Element\Section &$section
* @return void * @return void
*/ */
private function readWSectPrNode(XMLReader $xmlReader, \DOMElement $node, Section &$section) private function readWSectPrNode(XMLReader $xmlReader, \DOMElement $node, Section &$section)

2
src/PhpWord/Reader/Word2007/Footnotes.php
View File

@ -44,7 +44,7 @@ class Footnotes extends AbstractPart
/** /**
* Read (footnotes|endnotes).xml. * Read (footnotes|endnotes).xml.
* *
* @param \PhpOffice\PhpWord\PhpWord $phpWord * @param \PhpOffice\PhpWord\PhpWord &$phpWord
* @return void * @return void
*/ */
public function read(PhpWord &$phpWord) public function read(PhpWord &$phpWord)

2
src/PhpWord/Reader/Word2007/Numbering.php
View File

@ -30,7 +30,7 @@ class Numbering extends AbstractPart
/** /**
* Read numbering.xml. * Read numbering.xml.
* *
* @param \PhpOffice\PhpWord\PhpWord $phpWord * @param \PhpOffice\PhpWord\PhpWord &$phpWord
* @return void * @return void
*/ */
public function read(PhpWord &$phpWord) public function read(PhpWord &$phpWord)

2
src/PhpWord/Reader/Word2007/Styles.php
View File

@ -30,7 +30,7 @@ class Styles extends AbstractPart
/** /**
* Read styles.xml. * Read styles.xml.
* *
* @param \PhpOffice\PhpWord\PhpWord $phpWord * @param \PhpOffice\PhpWord\PhpWord &$phpWord
* @return void * @return void
*/ */
public function read(PhpWord &$phpWord) public function read(PhpWord &$phpWord)

16
src/PhpWord/Shared/Html.php
View File

@ -191,7 +191,7 @@ class Html
* *
* @param \DOMNode $node * @param \DOMNode $node
* @param \PhpOffice\PhpWord\Element\AbstractContainer $element * @param \PhpOffice\PhpWord\Element\AbstractContainer $element
* @param array $styles * @param array &$styles
* @return \PhpOffice\PhpWord\Element\TextRun * @return \PhpOffice\PhpWord\Element\TextRun
*/ */
private static function parseParagraph($node, $element, &$styles) private static function parseParagraph($node, $element, &$styles)
@ -206,7 +206,7 @@ class Html
* Parse heading node * Parse heading node
* *
* @param \PhpOffice\PhpWord\Element\AbstractContainer $element * @param \PhpOffice\PhpWord\Element\AbstractContainer $element
* @param array $styles * @param array &$styles
* @param string $argument1 Name of heading style * @param string $argument1 Name of heading style
* @return \PhpOffice\PhpWord\Element\TextRun * @return \PhpOffice\PhpWord\Element\TextRun
* *
@ -226,7 +226,7 @@ class Html
* *
* @param \DOMNode $node * @param \DOMNode $node
* @param \PhpOffice\PhpWord\Element\AbstractContainer $element * @param \PhpOffice\PhpWord\Element\AbstractContainer $element
* @param array $styles * @param array &$styles
* @return null * @return null
*/ */
private static function parseText($node, $element, &$styles) private static function parseText($node, $element, &$styles)
@ -245,7 +245,7 @@ class Html
/** /**
* Parse property node * Parse property node
* *
* @param array $styles * @param array &$styles
* @param string $argument1 Style name * @param string $argument1 Style name
* @param string $argument2 Style value * @param string $argument2 Style value
* @return null * @return null
@ -262,7 +262,7 @@ class Html
* *
* @param \DOMNode $node * @param \DOMNode $node
* @param \PhpOffice\PhpWord\Element\AbstractContainer $element * @param \PhpOffice\PhpWord\Element\AbstractContainer $element
* @param array $styles * @param array &$styles
* @param string $argument1 Method name * @param string $argument1 Method name
* @return \PhpOffice\PhpWord\Element\AbstractContainer $element * @return \PhpOffice\PhpWord\Element\AbstractContainer $element
* *
@ -292,8 +292,8 @@ class Html
/** /**
* Parse list node * Parse list node
* *
* @param array $styles * @param array &$styles
* @param array $data * @param array &$data
* @param string $argument1 List type * @param string $argument1 List type
* @return null * @return null
*/ */
@ -314,7 +314,7 @@ class Html
* *
* @param \DOMNode $node * @param \DOMNode $node
* @param \PhpOffice\PhpWord\Element\AbstractContainer $element * @param \PhpOffice\PhpWord\Element\AbstractContainer $element
* @param array $styles * @param array &$styles
* @param array $data * @param array $data
* @return null * @return null
* *

6
src/PhpWord/Style/AbstractStyle.php
View File

@ -297,7 +297,7 @@ abstract class AbstractStyle
* *
* @param mixed $value * @param mixed $value
* @param string $styleName * @param string $styleName
* @param mixed $style * @param mixed &$style
* @return mixed * @return mixed
*/ */
protected function setObjectVal($value, $styleName, &$style) protected function setObjectVal($value, $styleName, &$style)
@ -319,8 +319,8 @@ abstract class AbstractStyle
/** /**
* Set $property value and set $pairProperty = false when $value = true * Set $property value and set $pairProperty = false when $value = true
* *
* @param bool $property * @param bool &$property
* @param bool $pairProperty * @param bool &$pairProperty
* @param bool $value * @param bool $value
* @return self * @return self
*/ */

2
src/PhpWord/Template.php
View File

@ -106,7 +106,7 @@ class Template
/** /**
* Applies XSL style sheet to template's parts. * Applies XSL style sheet to template's parts.
* *
* @param \DOMDocument $xslDOMDocument * @param \DOMDocument &$xslDOMDocument
* @param array $xslOptions * @param array $xslOptions
* @param string $xslOptionsURI * @param string $xslOptionsURI
* @return void * @return void

12
src/PhpWord/Writer/ODText/Part/Content.php
View File

@ -23,10 +23,10 @@ use PhpOffice\PhpWord\Element\Text;
use PhpOffice\PhpWord\Element\TextRun; use PhpOffice\PhpWord\Element\TextRun;
use PhpOffice\PhpWord\PhpWord; use PhpOffice\PhpWord\PhpWord;
use PhpOffice\PhpWord\Shared\XMLWriter; use PhpOffice\PhpWord\Shared\XMLWriter;
use PhpOffice\PhpWord\Style;
use PhpOffice\PhpWord\Style\Font; use PhpOffice\PhpWord\Style\Font;
use PhpOffice\PhpWord\Style\Paragraph; use PhpOffice\PhpWord\Style\Paragraph;
use PhpOffice\PhpWord\Style\Table as TableStyle; use PhpOffice\PhpWord\Style\Table as TableStyle;
use PhpOffice\PhpWord\Style;
use PhpOffice\PhpWord\Writer\ODText\Element\Container; use PhpOffice\PhpWord\Writer\ODText\Element\Container;
use PhpOffice\PhpWord\Writer\ODText\Style\Paragraph as ParagraphStyleWriter; 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 * Table style can be null or string of the style name
* *
* @param \PhpOffice\PhpWord\Element\AbstractContainer $container * @param \PhpOffice\PhpWord\Element\AbstractContainer $container
* @param int $paragraphStyleCount * @param int &$paragraphStyleCount
* @param int $fontStyleCount * @param int &$fontStyleCount
* @return void * @return void
* @todo Simplify the logic * @todo Simplify the logic
*/ */
@ -223,9 +223,9 @@ class Content extends AbstractPart
/** /**
* Get style of individual element * Get style of individual element
* *
* @param \PhpOffice\PhpWord\Element\Text $element * @param \PhpOffice\PhpWord\Element\Text &$element
* @param int $paragraphStyleCount * @param int &$paragraphStyleCount
* @param int $fontStyleCount * @param int &$fontStyleCount
* @return void * @return void
*/ */
private function getElementStyle(&$element, &$paragraphStyleCount, &$fontStyleCount) private function getElementStyle(&$element, &$paragraphStyleCount, &$fontStyleCount)

4
src/PhpWord/Writer/RTF/Part/Header.php
View File

@ -19,8 +19,8 @@ namespace PhpOffice\PhpWord\Writer\RTF\Part;
use PhpOffice\PhpWord\Settings; use PhpOffice\PhpWord\Settings;
use PhpOffice\PhpWord\Shared\Converter; use PhpOffice\PhpWord\Shared\Converter;
use PhpOffice\PhpWord\Style\Font;
use PhpOffice\PhpWord\Style; use PhpOffice\PhpWord\Style;
use PhpOffice\PhpWord\Style\Font;
/** /**
* RTF header part writer * RTF header part writer
@ -246,7 +246,7 @@ class Header extends AbstractPart
/** /**
* Register individual font and color. * Register individual font and color.
* *
* @param array $table * @param array &$table
* @param string $value * @param string $value
* @param string $default * @param string $default
* @return void * @return void

8
src/PhpWord/Writer/Word2007.php
View File

@ -192,10 +192,10 @@ class Word2007 extends AbstractWriter implements WriterInterface
/** /**
* Add header/footer content. * Add header/footer content.
* *
* @param \PhpOffice\PhpWord\Element\Section $section * @param \PhpOffice\PhpWord\Element\Section &$section
* @param \PhpOffice\PhpWord\Shared\ZipArchive $zip * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip
* @param string $elmType header|footer * @param string $elmType header|footer
* @param integer $rId * @param integer &$rId
* @return void * @return void
*/ */
private function addHeaderFooterContent(Section &$section, ZipArchive $zip, $elmType, &$rId) private function addHeaderFooterContent(Section &$section, ZipArchive $zip, $elmType, &$rId)
@ -221,7 +221,7 @@ class Word2007 extends AbstractWriter implements WriterInterface
* Add footnotes/endnotes * Add footnotes/endnotes
* *
* @param \PhpOffice\PhpWord\Shared\ZipArchive $zip * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip
* @param integer $rId * @param integer &$rId
* @param string $noteType * @param string $noteType
* @return void * @return void
*/ */
@ -259,7 +259,7 @@ class Word2007 extends AbstractWriter implements WriterInterface
* Add chart. * Add chart.
* *
* @param \PhpOffice\PhpWord\Shared\ZipArchive $zip * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip
* @param integer $rId * @param integer &$rId
* @return void * @return void
*/ */
private function addChart(ZipArchive $zip, &$rId) private function addChart(ZipArchive $zip, &$rId)