Alignment.php

Go to the documentation of this file.

<?php
class PHPExcel_Style_Alignment implements PHPExcel_IComparable
{
        /* Horizontal alignment styles */
        const HORIZONTAL_GENERAL                                = 'general';
        const HORIZONTAL_LEFT                                   = 'left';
        const HORIZONTAL_RIGHT                                  = 'right';
        const HORIZONTAL_CENTER                                 = 'center';
        const HORIZONTAL_CENTER_CONTINUOUS              = 'centerContinuous';
        const HORIZONTAL_JUSTIFY                                = 'justify';

        /* Vertical alignment styles */
        const VERTICAL_BOTTOM                                   = 'bottom';
        const VERTICAL_TOP                                              = 'top';
        const VERTICAL_CENTER                                   = 'center';
        const VERTICAL_JUSTIFY                                  = 'justify';

        private $_horizontal    = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL;

        private $_vertical              = PHPExcel_Style_Alignment::VERTICAL_BOTTOM;

        private $_textRotation  = 0;

        private $_wrapText              = false;

        private $_shrinkToFit   = false;

        private $_indent                = 0;

        private $_parentPropertyName;

        private $_isSupervisor;

        private $_parent;

        public function __construct($isSupervisor = false)
        {
                // Supervisor?
                $this->_isSupervisor = $isSupervisor;
        }

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

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

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

        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('alignment' => $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('horizontal', $pStyles)) {
                                        $this->setHorizontal($pStyles['horizontal']);
                                }
                                if (array_key_exists('vertical', $pStyles)) {
                                        $this->setVertical($pStyles['vertical']);
                                }
                                if (array_key_exists('rotation', $pStyles)) {
                                        $this->setTextRotation($pStyles['rotation']);
                                }
                                if (array_key_exists('wrap', $pStyles)) {
                                        $this->setWrapText($pStyles['wrap']);
                                }
                                if (array_key_exists('shrinkToFit', $pStyles)) {
                                        $this->setShrinkToFit($pStyles['shrinkToFit']);
                                }
                                if (array_key_exists('indent', $pStyles)) {
                                        $this->setIndent($pStyles['indent']);
                                }
                        }
                } else {
                        throw new Exception("Invalid style array passed.");
                }
                return $this;
        }

        public function getHorizontal() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getHorizontal();
                }
                return $this->_horizontal;
        }

        public function setHorizontal($pValue = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL) {
                if ($pValue == '') {
                        $pValue = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL;
                }

                if ($this->_isSupervisor) {
                        $styleArray = $this->getStyleArray(array('horizontal' => $pValue));
                        $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                }
                else {
                        $this->_horizontal = $pValue;
                }
                return $this;
        }

        public function getVertical() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getVertical();
                }
                return $this->_vertical;
        }

        public function setVertical($pValue = PHPExcel_Style_Alignment::VERTICAL_BOTTOM) {
                if ($pValue == '') {
                        $pValue = PHPExcel_Style_Alignment::VERTICAL_BOTTOM;
                }

                if ($this->_isSupervisor) {
                        $styleArray = $this->getStyleArray(array('vertical' => $pValue));
                        $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                } else {
                        $this->_vertical = $pValue;
                }
                return $this;
        }

        public function getTextRotation() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getTextRotation();
                }
                return $this->_textRotation;
        }

        public function setTextRotation($pValue = 0) {
                // Excel2007 value 255 => PHPExcel value -165
                if ($pValue == 255) {
                        $pValue = -165;
                }

                // Set rotation
                if ( ($pValue >= -90 && $pValue <= 90) || $pValue == -165 ) {
                        if ($this->_isSupervisor) {
                                $styleArray = $this->getStyleArray(array('rotation' => $pValue));
                                $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                        } else {
                                $this->_textRotation = $pValue;
                        }
                } else {
                        throw new Exception("Text rotation should be a value between -90 and 90.");
                }

                return $this;
        }

        public function getWrapText() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getWrapText();
                }
                return $this->_wrapText;
        }

        public function setWrapText($pValue = false) {
                if ($pValue == '') {
                        $pValue = false;
                }
                if ($this->_isSupervisor) {
                        $styleArray = $this->getStyleArray(array('wrap' => $pValue));
                        $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                } else {
                        $this->_wrapText = $pValue;
                }
                return $this;
        }

        public function getShrinkToFit() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getShrinkToFit();
                }
                return $this->_shrinkToFit;
        }

        public function setShrinkToFit($pValue = false) {
                if ($pValue == '') {
                        $pValue = false;
                }
                if ($this->_isSupervisor) {
                        $styleArray = $this->getStyleArray(array('shrinkToFit' => $pValue));
                        $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                } else {
                        $this->_shrinkToFit = $pValue;
                }
                return $this;
        }

        public function getIndent() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getIndent();
                }
                return $this->_indent;
        }

        public function setIndent($pValue = 0) {
                if ($pValue > 0) {
                        if ($this->getHorizontal() != self::HORIZONTAL_GENERAL && $this->getHorizontal() != self::HORIZONTAL_LEFT && $this->getHorizontal() != self::HORIZONTAL_RIGHT) {
                                $pValue = 0; // indent not supported
                        }
                }
                if ($this->_isSupervisor) {
                        $styleArray = $this->getStyleArray(array('indent' => $pValue));
                        $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                } else {
                        $this->_indent = $pValue;
                }
                return $this;
        }

        public function getHashCode() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getHashCode();
                }
                return md5(
                          $this->_horizontal
                        . $this->_vertical
                        . $this->_textRotation
                        . ($this->_wrapText ? 't' : 'f')
                        . ($this->_shrinkToFit ? 't' : 'f')
                        . $this->_indent
                        . __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;
                        }
                }
        }
}