/common/libraries/plugin/phpexcel/PHPExcel/Style/Borders.php

<?php

/**
 * PHPExcel
 *
 * Copyright (c) 2006 - 2011 PHPExcel
 *
 * 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   PHPExcel
 * @package    PHPExcel_Style
 * @copyright  Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)
 * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt	LGPL
 * @version    1.7.6, 2011-02-27
 */



/**
 * PHPExcel_Style_Borders
 *
 * @category   PHPExcel
 * @package    PHPExcel_Style
 * @copyright  Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)
 */

class PHPExcel_Style_Borders implements PHPExcel_IComparable

{

    /* Diagonal directions */

    const DIAGONAL_NONE = 0;

    const DIAGONAL_UP = 1;

    const DIAGONAL_DOWN = 2;

    const DIAGONAL_BOTH = 3;

    

    /**
     * Left
     *
     * @var PHPExcel_Style_Border
     */

    private $_left;

    

    /**
     * Right
     *
     * @var PHPExcel_Style_Border
     */

    private $_right;

    

    /**
     * Top
     *
     * @var PHPExcel_Style_Border
     */

    private $_top;

    

    /**
     * Bottom
     *
     * @var PHPExcel_Style_Border
     */

    private $_bottom;

    

    /**
     * Diagonal
     *
     * @var PHPExcel_Style_Border
     */

    private $_diagonal;

    

    /**
     * DiagonalDirection
     *
     * @var int
     */

    private $_diagonalDirection;

    

    /**
     * All borders psedo-border. Only applies to supervisor.
     *
     * @var PHPExcel_Style_Border
     */

    private $_allBorders;

    

    /**
     * Outline psedo-border. Only applies to supervisor.
     *
     * @var PHPExcel_Style_Border
     */

    private $_outline;

    

    /**
     * Inside psedo-border. Only applies to supervisor.
     *
     * @var PHPExcel_Style_Border
     */

    private $_inside;

    

    /**
     * Vertical pseudo-border. Only applies to supervisor.
     *
     * @var PHPExcel_Style_Border
     */

    private $_vertical;

    

    /**
     * Horizontal pseudo-border. Only applies to supervisor.
     *
     * @var PHPExcel_Style_Border
     */

    private $_horizontal;

    

    /**
     * Parent Borders
     *
     * @var _parentPropertyName string
     */

    private $_parentPropertyName;

    

    /**
     * Supervisor?
     *
     * @var boolean
     */

    private $_isSupervisor;

    

    /**
     * Parent. Only used for supervisor
     *
     * @var PHPExcel_Style
     */

    private $_parent;



    /**
     * Create a new PHPExcel_Style_Borders
     */

    public function __construct($isSupervisor = false)

    {

        // Supervisor?
        $this->_isSupervisor = $isSupervisor;

        

        // Initialise values
        $this->_left = new PHPExcel_Style_Border($isSupervisor);

        $this->_right = new PHPExcel_Style_Border($isSupervisor);

        $this->_top = new PHPExcel_Style_Border($isSupervisor);

        $this->_bottom = new PHPExcel_Style_Border($isSupervisor);

        $this->_diagonal = new PHPExcel_Style_Border($isSupervisor);

        $this->_diagonalDirection = PHPExcel_Style_Borders :: DIAGONAL_NONE;

        

        // Specially for supervisor
        if ($isSupervisor)

        {

            // Initialize pseudo-borders
            $this->_allBorders = new PHPExcel_Style_Border(true);

            $this->_outline = new PHPExcel_Style_Border(true);

            $this->_inside = new PHPExcel_Style_Border(true);

            $this->_vertical = new PHPExcel_Style_Border(true);

            $this->_horizontal = new PHPExcel_Style_Border(true);

            

            // bind parent if we are a supervisor
            $this->_left->bindParent($this, '_left');

            $this->_right->bindParent($this, '_right');

            $this->_top->bindParent($this, '_top');

            $this->_bottom->bindParent($this, '_bottom');

            $this->_diagonal->bindParent($this, '_diagonal');

            $this->_allBorders->bindParent($this, '_allBorders');

            $this->_outline->bindParent($this, '_outline');

            $this->_inside->bindParent($this, '_inside');

            $this->_vertical->bindParent($this, '_vertical');

            $this->_horizontal->bindParent($this, '_horizontal');

        }

    }



    /**
     * Bind parent. Only used for supervisor
     *
     * @param PHPExcel_Style $parent
     * @return PHPExcel_Style_Borders
     */

    public function bindParent($parent)

    {

        $this->_parent = $parent;

        return $this;

    }



    /**
     * Is this a supervisor or a real style component?
     *
     * @return boolean
     */

    public function getIsSupervisor()

    {

        return $this->_isSupervisor;

    }



    /**
     * Get the shared style component for the currently active cell in currently active sheet.
     * Only used for style supervisor
     *
     * @return PHPExcel_Style_Borders
     */

    public function getSharedComponent()

    {

        return $this->_parent->getSharedComponent()->getBorders();

    }



    /**
     * Get the currently active sheet. Only used for supervisor
     *
     * @return PHPExcel_Worksheet
     */

    public function getActiveSheet()

    {

        return $this->_parent->getActiveSheet();

    }



    /**
     * Get the currently active cell coordinate in currently active sheet.
     * Only used for supervisor
     *
     * @return string E.g. 'A1'
     */

    public function getSelectedCells()

    {

        return $this->getActiveSheet()->getSelectedCells();

    }



    /**
     * Get the currently active cell coordinate in currently active sheet.
     * Only used for supervisor
     *
     * @return string E.g. 'A1'
     */

    public function getActiveCell()

    {

        return $this->getActiveSheet()->getActiveCell();

    }



    /**
     * Build style array from subcomponents
     *
     * @param array $array
     * @return array
     */

    public function getStyleArray($array)

    {

        return array('borders' => $array);

    }



    /**
     * Apply styles from array
     *
     * <code>
     * $objPHPExcel->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray(
     * array(
     * 'bottom'     => array(
     * 'style' => PHPExcel_Style_Border::BORDER_DASHDOT,
     * 'color' => array(
     * 'rgb' => '808080'
     * )
     * ),
     * 'top'     => array(
     * 'style' => PHPExcel_Style_Border::BORDER_DASHDOT,
     * 'color' => array(
     * 'rgb' => '808080'
     * )
     * )
     * )
     * );
     * </code>
     * <code>
     * $objPHPExcel->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray(
     * array(
     * 'allborders' => array(
     * 'style' => PHPExcel_Style_Border::BORDER_DASHDOT,
     * 'color' => array(
     * 'rgb' => '808080'
     * )
     * )
     * )
     * );
     * </code>
     *
     * @param	array	$pStyles	Array containing style information
     * @throws	Exception
     * @return PHPExcel_Style_Borders
     */

    public function applyFromArray($pStyles = null)

    {

        if (is_array($pStyles))

        {

            if ($this->_isSupervisor)

            {

                $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));

            }

            else

            {

                if (array_key_exists('left', $pStyles))

                {

                    $this->getLeft()->applyFromArray($pStyles['left']);

                }

                if (array_key_exists('right', $pStyles))

                {

                    $this->getRight()->applyFromArray($pStyles['right']);

                }

                if (array_key_exists('top', $pStyles))

                {

                    $this->getTop()->applyFromArray($pStyles['top']);

                }

                if (array_key_exists('bottom', $pStyles))

                {

                    $this->getBottom()->applyFromArray($pStyles['bottom']);

                }

                if (array_key_exists('diagonal', $pStyles))

                {

                    $this->getDiagonal()->applyFromArray($pStyles['diagonal']);

                }

                if (array_key_exists('diagonaldirection', $pStyles))

                {

                    $this->setDiagonalDirection($pStyles['diagonaldirection']);

                }

                if (array_key_exists('allborders', $pStyles))

                {

                    $this->getLeft()->applyFromArray($pStyles['allborders']);

                    $this->getRight()->applyFromArray($pStyles['allborders']);

                    $this->getTop()->applyFromArray($pStyles['allborders']);

                    $this->getBottom()->applyFromArray($pStyles['allborders']);

                }

            }

        }

        else

        {

            throw new Exception("Invalid style array passed.");

        }

        return $this;

    }



    /**
     * Get Left
     *
     * @return PHPExcel_Style_Border
     */

    public function getLeft()

    {

        return $this->_left;

    }



    /**
     * Get Right
     *
     * @return PHPExcel_Style_Border
     */

    public function getRight()

    {

        return $this->_right;

    }



    /**
     * Get Top
     *
     * @return PHPExcel_Style_Border
     */

    public function getTop()

    {

        return $this->_top;

    }



    /**
     * Get Bottom
     *
     * @return PHPExcel_Style_Border
     */

    public function getBottom()

    {

        return $this->_bottom;

    }



    /**
     * Get Diagonal
     *
     * @return PHPExcel_Style_Border
     */

    public function getDiagonal()

    {

        return $this->_diagonal;

    }



    /**
     * Get AllBorders (pseudo-border). Only applies to supervisor.
     *
     * @return PHPExcel_Style_Border
     * @throws Exception
     */

    public function getAllBorders()

    {

        if (! $this->_isSupervisor)

        {

            throw new Exception('Can only get pseudo-border for supervisor.');

        }

        return $this->_allBorders;

    }



    /**
     * Get Outline (pseudo-border). Only applies to supervisor.
     *
     * @return boolean
     * @throws Exception
     */

    public function getOutline()

    {

        if (! $this->_isSupervisor)

        {

            throw new Exception('Can only get pseudo-border for supervisor.');

        }

        return $this->_outline;

    }



    /**
     * Get Inside (pseudo-border). Only applies to supervisor.
     *
     * @return boolean
     * @throws Exception
     */

    public function getInside()

    {

        if (! $this->_isSupervisor)

        {

            throw new Exception('Can only get pseudo-border for supervisor.');

        }

        return $this->_inside;

    }



    /**
     * Get Vertical (pseudo-border). Only applies to supervisor.
     *
     * @return PHPExcel_Style_Border
     * @throws Exception
     */

    public function getVertical()

    {

        if (! $this->_isSupervisor)

        {

            throw new Exception('Can only get pseudo-border for supervisor.');

        }

        return $this->_vertical;

    }



    /**
     * Get Horizontal (pseudo-border). Only applies to supervisor.
     *
     * @return PHPExcel_Style_Border
     * @throws Exception
     */

    public function getHorizontal()

    {

        if (! $this->_isSupervisor)

        {

            throw new Exception('Can only get pseudo-border for supervisor.');

        }

        return $this->_horizontal;

    }



    /**
     * Get DiagonalDirection
     *
     * @return int
     */

    public function getDiagonalDirection()

    {

        if ($this->_isSupervisor)

        {

            return $this->getSharedComponent()->getDiagonalDirection();

        }

        return $this->_diagonalDirection;

    }



    /**
     * Set DiagonalDirection
     *
     * @param int $pValue
     * @return PHPExcel_Style_Borders
     */

    public function setDiagonalDirection($pValue = PHPExcel_Style_Borders::DIAGONAL_NONE)

    {

        if ($pValue == '')

        {

            $pValue = PHPExcel_Style_Borders :: DIAGONAL_NONE;

        }

        if ($this->_isSupervisor)

        {

            $styleArray = $this->getStyleArray(array('diagonaldirection' => $pValue));

            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);

        }

        else

        {

            $this->_diagonalDirection = $pValue;

        }

        return $this;

    }



    /**
     * Get hash code
     *
     * @return string	Hash code
     */

    public function getHashCode()

    {

        if ($this->_isSupervisor)

        {

            return $this->getSharedComponent()->getHashcode();

        }

        return md5($this->getLeft()->getHashCode() . $this->getRight()->getHashCode() . $this->getTop()->getHashCode() . $this->getBottom()->getHashCode() . $this->getDiagonal()->getHashCode() . $this->getDiagonalDirection() . __CLASS__);

    }



    /**
     * Implement PHP __clone to create a deep clone, not just a shallow copy.
     */

    public function __clone()

    {

        $vars = get_object_vars($this);

        foreach ($vars as $key => $value)

        {

            if ((is_object($value)) && ($key != '_parent'))

            {

                $this->$key = clone $value;

            }

            else

            {

                $this->$key = $value;

            }

        }

    }

}