PHPWord/Classes/PHPWord/Style/Paragraph.php

<?php
/**
 * PHPWord
 *
 * Copyright (c) 2014 PHPWord
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * @category   PHPWord
 * @package    PHPWord
 * @copyright  Copyright (c) 2014 PHPWord
 * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt    LGPL
 * @version    0.7.0
 */

/**
 * PHPWord_Style_Paragraph
 */
class PHPWord_Style_Paragraph
{

    /**
     * Paragraph alignment
     *
     * @var string
     */
    private $_align;

    /**
     * Space before Paragraph
     *
     * @var int
     */
    private $_spaceBefore;

    /**
     * Space after Paragraph
     *
     * @var int
     */
    private $_spaceAfter;

    /**
     * Spacing between breaks
     *
     * @var int
     */
    private $_spacing;

    /**
     * Set of Custom Tab Stops
     *
     * @var array
     */
    private $_tabs;

    /**
     * Indent by how much
     *
     * @var int
     */
    private $_indent;

    /**
     * Hanging by how much
     *
     * @var int
     */
    private $_hanging;

    /**
     * Parent style
     *
     * @var string
     */
    private $_basedOn;

    /**
     * Style for next paragraph
     *
     * @var string
     */
    private $_next;

    /**
     * Allow first/last line to display on a separate page
     *
     * @var bool
     */
    private $_widowControl;

    /**
     * Keep paragraph with next paragraph
     *
     * @var bool
     */
    private $_keepNext;

    /**
     * Keep all lines on one page
     *
     * @var bool
     */
    private $_keepLines;

    /**
     * Start paragraph on next page
     *
     * @var bool
     */
    private $_pageBreakBefore;

    /**
     * New Paragraph Style
     */
    public function __construct()
    {
        $this->_align = null;
        $this->_spaceBefore = null;
        $this->_spaceAfter = null;
        $this->_spacing = null;
        $this->_tabs = null;
        $this->_indent = null;
        $this->_hanging = null;
        $this->_basedOn = 'Normal';
        $this->_next = null;
        $this->_widowControl = true;
        $this->_keepNext = false;
        $this->_keepLines = false;
        $this->_pageBreakBefore = false;
    }

    /**
     * Set Style value
     *
     * @param string $key
     * @param mixed $value
     */
    public function setStyleValue($key, $value)
    {
        if ($key == '_indent') {
            $value = $value * 720; // 720 twips per indent
        }
        if ($key == '_hanging') {
            $value = $value * 720;
        }
        if ($key == '_spacing') {
            $value += 240; // because line height of 1 matches 240 twips
        }
        if ($key === '_tabs') {
            $value = new PHPWord_Style_Tabs($value);
        }
        $this->$key = $value;
    }

    /**
     * Get Paragraph Alignment
     *
     * @return string
     */
    public function getAlign()
    {
        return $this->_align;
    }

    /**
     * Set Paragraph Alignment
     *
     * @param string $pValue
     * @return PHPWord_Style_Paragraph
     */
    public function setAlign($pValue = null)
    {
        if (strtolower($pValue) == 'justify') {
            // justify becames both
            $pValue = 'both';
        }
        $this->_align = $pValue;
        return $this;
    }

    /**
     * Get Space before Paragraph
     *
     * @return string
     */
    public function getSpaceBefore()
    {
        return $this->_spaceBefore;
    }

    /**
     * Set Space before Paragraph
     *
     * @param int $pValue
     * @return PHPWord_Style_Paragraph
     */
    public function setSpaceBefore($pValue = null)
    {
        $this->_spaceBefore = $pValue;
        return $this;
    }

    /**
     * Get Space after Paragraph
     *
     * @return string
     */
    public function getSpaceAfter()
    {
        return $this->_spaceAfter;
    }

    /**
     * Set Space after Paragraph
     *
     * @param int $pValue
     * @return PHPWord_Style_Paragraph
     */
    public function setSpaceAfter($pValue = null)
    {
        $this->_spaceAfter = $pValue;
        return $this;
    }

    /**
     * Get Spacing between breaks
     *
     * @return int
     */
    public function getSpacing()
    {
        return $this->_spacing;
    }

    /**
     * Set Spacing between breaks
     *
     * @param int $pValue
     * @return PHPWord_Style_Paragraph
     */
    public function setSpacing($pValue = null)
    {
        $this->_spacing = $pValue;
        return $this;
    }

    /**
     * Get indentation
     *
     * @return int
     */
    public function getIndent()
    {
        return $this->_indent;
    }

    /**
     * Set indentation
     *
     * @param int $pValue
     * @return PHPWord_Style_Paragraph
     */
    public function setIndent($pValue = null)
    {
        $this->_indent = $pValue;
        return $this;
    }

    /**
     * Get hanging
     *
     * @return int
     */
    public function getHanging()
    {
        return $this->_hanging;
    }

    /**
     * Set hanging
     *
     * @param int $pValue
     * @return PHPWord_Style_Paragraph
     */
    public function setHanging($pValue = null)
    {
        $this->_hanging = $pValue;
        return $this;
    }

    /**
     * Get tabs
     *
     * @return PHPWord_Style_Tabs
     */
    public function getTabs()
    {
        return $this->_tabs;
    }

    /**
     * Get parent style ID
     *
     * @return  string
     */
    public function getBasedOn()
    {
        return $this->_basedOn;
    }

    /**
     * Set parent style ID
     *
     * @param   string  $pValue
     * @return  PHPWord_Style_Paragraph
     */
    public function setBasedOn($pValue = 'Normal')
    {
        $this->_basedOn = $pValue;
        return $this;
    }

    /**
     * Get style for next paragraph
     *
     * @return string
     */
    public function getNext()
    {
        return $this->_next;
    }

    /**
     * Set style for next paragraph
     *
     * @param   string  $pValue
     * @return  PHPWord_Style_Paragraph
     */
    public function setNext($pValue = null)
    {
        $this->_next = $pValue;
        return $this;
    }

    /**
     * Get allow first/last line to display on a separate page setting
     *
     * @return  bool
     */
    public function getWidowControl()
    {
        return $this->_widowControl;
    }

    /**
     * Set keep paragraph with next paragraph setting
     *
     * @param   bool    $pValue
     * @return  PHPWord_Style_Paragraph
     */
    public function setWidowControl($pValue = true)
    {
        if (!is_bool($pValue)) {
            $pValue = false;
        }
        $this->_widowControl = $pValue;
        return $this;
    }

    /**
     * Get keep paragraph with next paragraph setting
     *
     * @return  bool
     */
    public function getKeepNext()
    {
        return $this->_keepNext;
    }

    /**
     * Set keep paragraph with next paragraph setting
     *
     * @param   bool    $pValue
     * @return  PHPWord_Style_Paragraph
     */
    public function setKeepNext($pValue = true)
    {
        if (!is_bool($pValue)) {
            $pValue = false;
        }
        $this->_keepNext = $pValue;
        return $this;
    }

    /**
     * Get keep all lines on one page setting
     *
     * @return  bool
     */
    public function getKeepLines()
    {
        return $this->_keepLines;
    }

    /**
     * Set keep all lines on one page setting
     *
     * @param   bool    $pValue
     * @return  PHPWord_Style_Paragraph
     */
    public function setKeepLines($pValue = true)
    {
        if (!is_bool($pValue)) {
            $pValue = false;
        }
        $this->_keepLines = $pValue;
        return $this;
    }

    /**
     * Get start paragraph on next page setting
     *
     * @return bool
     */
    public function getPageBreakBefore()
    {
        return $this->_pageBreakBefore;
    }

    /**
     * Set start paragraph on next page setting
     *
     * @param   bool    $pValue
     * @return  PHPWord_Style_Paragraph
     */
    public function setPageBreakBefore($pValue = true)
    {
        if (!is_bool($pValue)) {
            $pValue = false;
        }
        $this->_pageBreakBefore = $pValue;
        return $this;
    }

}