Borders.php

Go to the documentation of this file.

<?php
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;

        private $_left;

        private $_right;

        private $_top;

        private $_bottom;

        private $_diagonal;

        private $_diagonalDirection;

        private $_allBorders;

        private $_outline;

        private $_inside;

        private $_vertical;

        private $_horizontal;

        private $_parentPropertyName;

        private $_isSupervisor;

        private $_parent;

    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');
                }
    }

        public function bindParent($parent)
        {
                $this->_parent = $parent;
                return $this;
        }

        public function getIsSupervisor()
        {
                return $this->_isSupervisor;
        }

        public function getSharedComponent()
        {
                return $this->_parent->getSharedComponent()->getBorders();
        }

        public function getActiveSheet()
        {
                return $this->_parent->getActiveSheet();
        }

        public function getSelectedCells()
        {
                return $this->getActiveSheet()->getSelectedCells();
        }

        public function getActiveCell()
        {
                return $this->getActiveSheet()->getActiveCell();
        }

        public function getStyleArray($array)
        {
                return array('borders' => $array);
        }

        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;
        }

    public function getLeft() {
                return $this->_left;
    }

    public function getRight() {
                return $this->_right;
    }

    public function getTop() {
                return $this->_top;
    }

    public function getBottom() {
                return $this->_bottom;
    }

    public function getDiagonal() {
                return $this->_diagonal;
    }

    public function getAllBorders() {
                if (!$this->_isSupervisor) {
                        throw new Exception('Can only get pseudo-border for supervisor.');
                }
                return $this->_allBorders;
    }

    public function getOutline() {
                if (!$this->_isSupervisor) {
                        throw new Exception('Can only get pseudo-border for supervisor.');
                }
        return $this->_outline;
    }

    public function getInside() {
                if (!$this->_isSupervisor) {
                        throw new Exception('Can only get pseudo-border for supervisor.');
                }
        return $this->_inside;
    }

    public function getVertical() {
                if (!$this->_isSupervisor) {
                        throw new Exception('Can only get pseudo-border for supervisor.');
                }
                return $this->_vertical;
    }

    public function getHorizontal() {
                if (!$this->_isSupervisor) {
                        throw new Exception('Can only get pseudo-border for supervisor.');
                }
                return $this->_horizontal;
    }

    public function getDiagonalDirection() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getDiagonalDirection();
                }
        return $this->_diagonalDirection;
    }

    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;
    }

        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__
        );
    }

        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;
                        }
                }
        }
}