Update upcoming version number to 0.10.0 as per #178

This commit is contained in:
Ivan Lanin 2014-04-11 19:04:53 +07:00
parent a7567f721b
commit ae652a6379
25 changed files with 66 additions and 66 deletions

View File

@ -2,7 +2,7 @@
This is the changelog between releases of PHPWord. Releases are listed in reverse chronological order with the latest version listed on top, while additions/changes in each release are listed in chronological order. Changes in each release are divided into three parts: added or change features, bugfixes, and miscellaneous improvements. Each line contains short information about the change made, the person who made it, and the related issue number(s) in GitHub. This is the changelog between releases of PHPWord. Releases are listed in reverse chronological order with the latest version listed on top, while additions/changes in each release are listed in chronological order. Changes in each release are divided into three parts: added or change features, bugfixes, and miscellaneous improvements. Each line contains short information about the change made, the person who made it, and the related issue number(s) in GitHub.
## 0.9.2 - Not yet released ## 0.10.0 - Not yet released
This release marked heavy refactorings on internal code structure with the creation of some abstract classes to reduce code duplication. `Element` subnamespace is introduced in this release to replace `Section`. Word2007 reader capability is greatly enhanced. Endnote is introduced. List numbering is now customizable. This release marked heavy refactorings on internal code structure with the creation of some abstract classes to reduce code duplication. `Element` subnamespace is introduced in this release to replace `Section`. Word2007 reader capability is greatly enhanced. Endnote is introduced. List numbering is now customizable.
@ -29,7 +29,7 @@ This release marked heavy refactorings on internal code structure with the creat
- General: Add `Style::resetStyles()`, `Footnote::resetElements()`, and `TOC::resetTitles()` - @ivanlanin GH-187 - General: Add `Style::resetStyles()`, `Footnote::resetElements()`, and `TOC::resetTitles()` - @ivanlanin GH-187
- Reader: Ability to read header, footer, footnotes, link, preservetext, textbreak, pagebreak, table, and list - @ivanlanin - Reader: Ability to read header, footer, footnotes, link, preservetext, textbreak, pagebreak, table, and list - @ivanlanin
- Endnote: Ability to add endnotes - @ivanlanin - Endnote: Ability to add endnotes - @ivanlanin
- ListItem: Ability to create custom list and reset list number - @ivanlanin GH-10 - ListItem: Ability to create custom list and reset list number - @ivanlanin GH-10 GH-198
### Bugfixes ### Bugfixes

View File

@ -34,7 +34,7 @@ use PhpOffice\PhpWord\Element\CheckBox;
/** /**
* Container abstract class * Container abstract class
* *
* @since 0.9.2 * @since 0.10.0
*/ */
abstract class AbstractElement abstract class AbstractElement
{ {
@ -563,7 +563,7 @@ abstract class AbstractElement
* Create textrun element * Create textrun element
* *
* @param mixed $paragraphStyle * @param mixed $paragraphStyle
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function createTextRun($paragraphStyle = null) public function createTextRun($paragraphStyle = null)
@ -575,7 +575,7 @@ abstract class AbstractElement
* Create footnote element * Create footnote element
* *
* @param mixed $paragraphStyle * @param mixed $paragraphStyle
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function createFootnote($paragraphStyle = null) public function createFootnote($paragraphStyle = null)

View File

@ -14,7 +14,7 @@ use PhpOffice\PhpWord\Style\Paragraph;
/** /**
* Endnote element * Endnote element
* *
* @since 0.9.2 * @since 0.10.0
*/ */
class Endnote extends Footnote class Endnote extends Footnote
{ {

View File

@ -44,7 +44,7 @@ class Footer extends AbstractElement
* Set type * Set type
* *
* @param string $value * @param string $value
* @since 0.9.2 * @since 0.10.0
*/ */
public function setType($value = self::AUTO) public function setType($value = self::AUTO)
{ {
@ -55,7 +55,7 @@ class Footer extends AbstractElement
* Get type * Get type
* *
* @return string * @return string
* @since 0.9.2 * @since 0.10.0
*/ */
public function getType() public function getType()
{ {

View File

@ -48,7 +48,7 @@ class Footnote extends AbstractElement
* Get Footnote Reference ID * Get Footnote Reference ID
* *
* @return int * @return int
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function getReferenceId() public function getReferenceId()
@ -60,7 +60,7 @@ class Footnote extends AbstractElement
* Set Footnote Reference ID * Set Footnote Reference ID
* *
* @param int $rId * @param int $rId
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function setReferenceId($rId) public function setReferenceId($rId)

View File

@ -64,7 +64,7 @@ class Header extends AbstractElement
* Set header type * Set header type
* *
* @param string $value * @param string $value
* @since 0.9.2 * @since 0.10.0
*/ */
public function setType($value = self::AUTO) public function setType($value = self::AUTO)
{ {

View File

@ -53,7 +53,7 @@ class ListItem extends AbstractElement
$this->textObject = new Text($text, $fontStyle, $paragraphStyle); $this->textObject = new Text($text, $fontStyle, $paragraphStyle);
$this->depth = $depth; $this->depth = $depth;
// Version >= 0.9.2 will pass numbering style name. Older version will use old method // Version >= 0.10.0 will pass numbering style name. Older version will use old method
if (!is_null($listStyle) && is_string($listStyle)) { if (!is_null($listStyle) && is_string($listStyle)) {
$this->style = new ListItemStyle($listStyle); $this->style = new ListItemStyle($listStyle);
} else { } else {

View File

@ -101,7 +101,7 @@ class Object extends AbstractElement
* Get Object ID * Get Object ID
* *
* @return int * @return int
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function getObjectId() public function getObjectId()
@ -113,7 +113,7 @@ class Object extends AbstractElement
* Set Object ID * Set Object ID
* *
* @param int $objId * @param int $objId
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function setObjectId($objId) public function setObjectId($objId)

View File

@ -113,7 +113,7 @@ class Section extends AbstractElement
* *
* @param string $type * @param string $type
* @return Header * @return Header
* @since 0.9.2 * @since 0.10.0
*/ */
public function addHeader($type = Header::AUTO) public function addHeader($type = Header::AUTO)
{ {
@ -125,7 +125,7 @@ class Section extends AbstractElement
* *
* @param string $type * @param string $type
* @return Footer * @return Footer
* @since 0.9.2 * @since 0.10.0
*/ */
public function addFooter($type = Header::AUTO) public function addFooter($type = Header::AUTO)
{ {
@ -177,7 +177,7 @@ class Section extends AbstractElement
* @param boolean $header * @param boolean $header
* @return Header|Footer * @return Header|Footer
* @throws Exception * @throws Exception
* @since 0.9.2 * @since 0.10.0
*/ */
private function addHeaderFooter($type = Header::AUTO, $header = true) private function addHeaderFooter($type = Header::AUTO, $header = true)
{ {
@ -201,7 +201,7 @@ class Section extends AbstractElement
* Create header * Create header
* *
* @return Header * @return Header
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function createHeader() public function createHeader()
@ -213,7 +213,7 @@ class Section extends AbstractElement
* Create footer * Create footer
* *
* @return Footer * @return Footer
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function createFooter() public function createFooter()
@ -225,7 +225,7 @@ class Section extends AbstractElement
* Get footer * Get footer
* *
* @return Footer * @return Footer
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function getFooter() public function getFooter()

View File

@ -14,7 +14,7 @@ use PhpOffice\PhpWord\Element\Endnote;
/** /**
* Endnote collection * Endnote collection
* *
* @since 0.9.2 * @since 0.10.0
*/ */
class Endnotes class Endnotes
{ {

View File

@ -29,7 +29,7 @@ class Footnotes
* *
* @param Footnote $element * @param Footnote $element
* @return integer Reference ID * @return integer Reference ID
* @since 0.9.2 * @since 0.10.0
*/ */
public static function addElement($element) public static function addElement($element)
{ {
@ -44,7 +44,7 @@ class Footnotes
* *
* @param integer $index * @param integer $index
* @param Footnote $element * @param Footnote $element
* @since 0.9.2 * @since 0.10.0
*/ */
public static function setElement($index, $element) public static function setElement($index, $element)
{ {
@ -58,7 +58,7 @@ class Footnotes
* *
* @param integer $index * @param integer $index
* @return Footnote * @return Footnote
* @since 0.9.2 * @since 0.10.0
*/ */
public static function getElement($index) public static function getElement($index)
{ {
@ -73,7 +73,7 @@ class Footnotes
* Get elements * Get elements
* *
* @return array * @return array
* @since 0.9.2 * @since 0.10.0
*/ */
public static function getElements() public static function getElements()
{ {
@ -84,7 +84,7 @@ class Footnotes
* Get element count * Get element count
* *
* @return integer * @return integer
* @since 0.9.2 * @since 0.10.0
*/ */
public static function countElements() public static function countElements()
{ {
@ -94,7 +94,7 @@ class Footnotes
/** /**
* Reset elements * Reset elements
* *
* @since 0.9.2 * @since 0.10.0
*/ */
public static function resetElements() public static function resetElements()
{ {
@ -106,7 +106,7 @@ class Footnotes
* *
* @param Footnote $element * @param Footnote $element
* @return integer Reference ID * @return integer Reference ID
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function addFootnoteElement($element) public static function addFootnoteElement($element)
@ -118,7 +118,7 @@ class Footnotes
* Get Footnote Elements * Get Footnote Elements
* *
* @return array * @return array
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function getFootnoteElements() public static function getFootnoteElements()
@ -130,7 +130,7 @@ class Footnotes
* Get Footnote Elements Count * Get Footnote Elements Count
* *
* @return integer * @return integer
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function countFootnoteElements() public static function countFootnoteElements()
@ -143,7 +143,7 @@ class Footnotes
* *
* @param string $linkSrc * @param string $linkSrc
* @return integer Reference ID * @return integer Reference ID
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function addFootnoteLinkElement($linkSrc) public static function addFootnoteLinkElement($linkSrc)
@ -155,7 +155,7 @@ class Footnotes
* Get Footnote Link Elements * Get Footnote Link Elements
* *
* @return array * @return array
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function getFootnoteLinkElements() public static function getFootnoteLinkElements()

View File

@ -32,7 +32,7 @@ class Media
* @param string $source * @param string $source
* @param Image $image * @param Image $image
* @return integer * @return integer
* @since 0.9.2 * @since 0.10.0
*/ */
public static function addElement($container, $mediaType, $source, Image $image = null) public static function addElement($container, $mediaType, $source, Image $image = null)
{ {
@ -97,7 +97,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
* @return integer * @return integer
* @since 0.9.2 * @since 0.10.0
*/ */
public static function countElements($container, $mediaType = null) public static function countElements($container, $mediaType = null)
{ {
@ -124,7 +124,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
* @return array * @return array
* @since 0.9.2 * @since 0.10.0
*/ */
public static function getElements($container, $mediaType = null) public static function getElements($container, $mediaType = null)
{ {
@ -170,7 +170,7 @@ class Media
* @param string $type * @param string $type
* @param Image $image * @param Image $image
* @return integer * @return integer
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function addSectionMediaElement($src, $type, Image $image = null) public static function addSectionMediaElement($src, $type, Image $image = null)
@ -183,7 +183,7 @@ class Media
* *
* @param string $linkSrc * @param string $linkSrc
* @return integer * @return integer
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function addSectionLinkElement($linkSrc) public static function addSectionLinkElement($linkSrc)
@ -196,7 +196,7 @@ class Media
* *
* @param string $key * @param string $key
* @return array * @return array
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function getSectionMediaElements($key = null) public static function getSectionMediaElements($key = null)
@ -209,7 +209,7 @@ class Media
* *
* @param string $key * @param string $key
* @return integer * @return integer
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function countSectionMediaElements($key = null) public static function countSectionMediaElements($key = null)
@ -224,7 +224,7 @@ class Media
* @param string $src * @param string $src
* @param Image $image * @param Image $image
* @return integer * @return integer
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function addHeaderMediaElement($headerCount, $src, Image $image = null) public static function addHeaderMediaElement($headerCount, $src, Image $image = null)
@ -237,7 +237,7 @@ class Media
* *
* @param string $key * @param string $key
* @return integer * @return integer
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function countHeaderMediaElements($key) public static function countHeaderMediaElements($key)
@ -249,7 +249,7 @@ class Media
* Get Header Media Elements * Get Header Media Elements
* *
* @return array * @return array
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function getHeaderMediaElements() public static function getHeaderMediaElements()
@ -264,7 +264,7 @@ class Media
* @param string $src * @param string $src
* @param Image $image * @param Image $image
* @return integer * @return integer
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function addFooterMediaElement($footerCount, $src, Image $image = null) public static function addFooterMediaElement($footerCount, $src, Image $image = null)
@ -277,7 +277,7 @@ class Media
* *
* @param string $key * @param string $key
* @return integer * @return integer
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function countFooterMediaElements($key) public static function countFooterMediaElements($key)
@ -289,7 +289,7 @@ class Media
* Get Footer Media Elements * Get Footer Media Elements
* *
* @return array * @return array
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public static function getFooterMediaElements() public static function getFooterMediaElements()

View File

@ -256,7 +256,7 @@ class PhpWord
* *
* @param array $settings * @param array $settings
* @return Section * @return Section
* @deprecated 0.9.2 * @deprecated 0.10.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function createSection($settings = null) public function createSection($settings = null)

View File

@ -18,7 +18,7 @@ use PhpOffice\PhpWord\Element\Section;
/** /**
* Reader for Word2007 * Reader for Word2007
* *
* @since 0.9.2 * @since 0.10.0
* @todo title, list, watermark, checkbox, toc * @todo title, list, watermark, checkbox, toc
* @todo Partly done: image, object * @todo Partly done: image, object
*/ */

View File

@ -15,7 +15,7 @@ use PhpOffice\PhpWord\Settings;
/** /**
* XML Reader wrapper * XML Reader wrapper
* *
* @since 0.9.2 * @since 0.10.0
*/ */
class XMLReader class XMLReader
{ {

View File

@ -22,7 +22,7 @@ require_once 'PCLZip/pclzip.lib.php';
/** /**
* PCLZip wrapper * PCLZip wrapper
* *
* @since 0.9.2 * @since 0.10.0
*/ */
class ZipArchive class ZipArchive
{ {

View File

@ -90,7 +90,7 @@ class Style
* @param string $styleName * @param string $styleName
* @param array $styleValues * @param array $styleValues
* @return Numbering * @return Numbering
* @since 0.9.2 * @since 0.10.0
*/ */
public static function addNumberingStyle($styleName, $styleValues) public static function addNumberingStyle($styleName, $styleValues)
{ {
@ -101,7 +101,7 @@ class Style
* Count styles * Count styles
* *
* @return integer * @return integer
* @since 0.9.2 * @since 0.10.0
*/ */
public static function countStyles() public static function countStyles()
{ {
@ -110,7 +110,7 @@ class Style
/** /**
* Reset styles * Reset styles
* @since 0.9.2 * @since 0.10.0
*/ */
public static function resetStyles() public static function resetStyles()
{ {

View File

@ -12,7 +12,7 @@ namespace PhpOffice\PhpWord\Style;
/** /**
* Abstract style class * Abstract style class
* *
* @since 0.9.2 * @since 0.10.0
*/ */
abstract class AbstractStyle abstract class AbstractStyle
{ {
@ -58,7 +58,7 @@ abstract class AbstractStyle
*/ */
public function setStyleValue($key, $value) public function setStyleValue($key, $value)
{ {
// Backward compability check for versions < 0.9.2 which use underscore // Backward compability check for versions < 0.10.0 which use underscore
// prefix for their private properties // prefix for their private properties
if (substr($key, 0, 1) == '_') { if (substr($key, 0, 1) == '_') {
$key = substr($key, 1); $key = substr($key, 1);

View File

@ -14,8 +14,8 @@ use PhpOffice\PhpWord\Style;
/** /**
* List item style * List item style
* *
* Before version 0.9.2, numbering style is defined statically with $listType. * Before version 0.10.0, numbering style is defined statically with $listType.
* After version 0.9.2, numbering style is defined by using Numbering and * After version 0.10.0, numbering style is defined by using Numbering and
* recorded by $numStyle. $listStyle is maintained for backward compatility * recorded by $numStyle. $listStyle is maintained for backward compatility
*/ */
class ListItem extends AbstractStyle class ListItem extends AbstractStyle
@ -38,7 +38,7 @@ class ListItem extends AbstractStyle
* Numbering style name * Numbering style name
* *
* @var string * @var string
* @since 0.9.2 * @since 0.10.0
*/ */
private $numStyle; private $numStyle;
@ -46,7 +46,7 @@ class ListItem extends AbstractStyle
* Numbering definition instance ID * Numbering definition instance ID
* *
* @var integer * @var integer
* @since 0.9.2 * @since 0.10.0
*/ */
private $numId; private $numId;
@ -75,7 +75,7 @@ class ListItem extends AbstractStyle
} }
/** /**
* Set legacy list type for version < 0.9.2 * Set legacy list type for version < 0.10.0
* *
* @param integer $value * @param integer $value
*/ */
@ -125,7 +125,7 @@ class ListItem extends AbstractStyle
* Get legacy numbering definition * Get legacy numbering definition
* *
* @return array * @return array
* @since 0.9.2 * @since 0.10.0
*/ */
private function getListTypeStyle() private function getListTypeStyle()
{ {

View File

@ -17,7 +17,7 @@ use PhpOffice\PhpWord\Style\NumberingLevel;
* @link http://www.schemacentral.com/sc/ooxml/e-w_numbering.html * @link http://www.schemacentral.com/sc/ooxml/e-w_numbering.html
* @link http://www.schemacentral.com/sc/ooxml/e-w_abstractNum-1.html * @link http://www.schemacentral.com/sc/ooxml/e-w_abstractNum-1.html
* @link http://www.schemacentral.com/sc/ooxml/e-w_num-1.html * @link http://www.schemacentral.com/sc/ooxml/e-w_num-1.html
* @since 0.9.2 * @since 0.10.0
*/ */
class Numbering extends AbstractStyle class Numbering extends AbstractStyle
{ {

View File

@ -13,7 +13,7 @@ namespace PhpOffice\PhpWord\Style;
* Numbering level definition * Numbering level definition
* *
* @link http://www.schemacentral.com/sc/ooxml/e-w_lvl-1.html * @link http://www.schemacentral.com/sc/ooxml/e-w_lvl-1.html
* @since 0.9.2 * @since 0.10.0
*/ */
class NumberingLevel extends AbstractStyle class NumberingLevel extends AbstractStyle
{ {

View File

@ -16,7 +16,7 @@ use PhpOffice\PhpWord\Settings;
/** /**
* Abstract writer class * Abstract writer class
* *
* @since 0.9.2 * @since 0.10.0
*/ */
abstract class AbstractWriter implements WriterInterface abstract class AbstractWriter implements WriterInterface
{ {

View File

@ -17,7 +17,7 @@ use PhpOffice\PhpWord\Shared\XMLWriter;
/** /**
* ODT base part writer * ODT base part writer
* *
* @since 0.9.2 * @since 0.10.0
*/ */
class Base extends AbstractWriterPart class Base extends AbstractWriterPart
{ {

View File

@ -15,7 +15,7 @@ use PhpOffice\PhpWord\Shared\XMLWriter;
/** /**
* Word2007 relationship writer * Word2007 relationship writer
* *
* @since 0.9.2 * @since 0.10.0
*/ */
class Rels extends AbstractWriterPart class Rels extends AbstractWriterPart
{ {

View File

@ -19,7 +19,7 @@ use PhpOffice\PhpWord\Style\Table;
/** /**
* Word2007 styles part writer * Word2007 styles part writer
* *
* @todo Do something with the numbering style introduced in 0.9.2 * @todo Do something with the numbering style introduced in 0.10.0
*/ */
class Styles extends Base class Styles extends Base
{ {