1: <?php
  2: /**
  3:  * LICENSE (BSD)
  4:  *
  5:  * Copyright (c) 2013, Gerd Christian Kunze
  6:  * All rights reserved.
  7:  *
  8:  * Redistribution and use in source and binary forms, with or without
  9:  * modification, are permitted provided that the following conditions are
 10:  * met:
 11:  *
 12:  *  * Redistributions of source code must retain the above copyright
 13:  *    notice, this list of conditions and the following disclaimer.
 14:  *
 15:  *  * Redistributions in binary form must reproduce the above copyright
 16:  *    notice, this list of conditions and the following disclaimer in the
 17:  *    documentation and/or other materials provided with the distribution.
 18:  *
 19:  *  * Neither the name of Gerd Christian Kunze nor the names of the
 20:  *    contributors may be used to endorse or promote products derived from
 21:  *    this software without specific prior written permission.
 22:  *
 23:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 24:  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 25:  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 26:  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 27:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 28:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 29:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 30:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 31:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 32:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 33:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 34:  *
 35:  * Worksheet
 36:  * 25.02.2013 16:06
 37:  */
 38: namespace MOC\Module\Office\Document\Excel;
 39: use MOC\Api;
 40: use MOC\Generic\Device\Module;
 41: 
 42: /**
 43:  *
 44:  */
 45: class Worksheet implements Module {
 46:     /**
 47:      * Get Changelog
 48:      *
 49:      * @static
 50:      * @return \MOC\Core\Changelog
 51:      */
 52:     public static function InterfaceChangelog() {
 53:         return Api::Core()->Changelog()->Create( __CLASS__ );
 54:     }
 55: 
 56:     /**
 57:      * Get Dependencies
 58:      *
 59:      * @static
 60:      * @return \MOC\Core\Depending
 61:      */
 62:     public static function InterfaceDepending() {
 63:         return Api::Core()->Depending();
 64:     }
 65: 
 66:     /**
 67:      * Get Singleton/Instance
 68:      *
 69:      * @static
 70:      * @return Worksheet
 71:      */
 72:     public static function InterfaceInstance() {
 73:         return new Worksheet();
 74:     }
 75: 
 76:     /**
 77:      * @param string $Name
 78:      *
 79:      * @return \MOC\Module\Office\Document\Excel
 80:      */
 81:     public function Create( $Name ){
 82:         Api::Extension()->Excel()->Current()->createSheet();
 83:         $Max = Api::Extension()->Excel()->Current()->getSheetCount();
 84: 
 85:         Api::Extension()->Excel()->Current()->getSheet( $Max -1 )->setTitle( $Name );
 86:         $this->Select( $Name );
 87: 
 88:         return Api::Module()->Office()->Document()->Excel();
 89:     }
 90: 
 91:     /**
 92:      * @return \PHPExcel_Worksheet
 93:      */
 94:     public function Current() {
 95:         return $this->getActiveSheet();
 96:     }
 97: 
 98:     /**
 99:      * @param string $Name
100:      *
101:      * @return \MOC\Module\Office\Document\Excel
102:      */
103:     public function Rename( $Name ) {
104:         $this->getActiveSheet()->setTitle( $Name );
105:         return Api::Module()->Office()->Document()->Excel();
106:     }
107: 
108:     /**
109:      * @return Worksheet\Select
110:      */
111:     public function Select() {
112:         return Worksheet\Select::InterfaceInstance();
113:     }
114: 
115:     /**
116:      * @return Worksheet\Dimension
117:      */
118:     public function Dimension() {
119:         return Worksheet\Dimension::InterfaceInstance();
120:     }
121: 
122:     /**
123:      * @return \MOC\Module\Office\Document\Excel
124:      */
125:     public function Remove() {
126:         /** @noinspection PhpParamsInspection */
127:         Api::Extension()->Excel()->Current()->removeSheetByIndex(
128:             Api::Extension()->Excel()->Current()->getIndex( $this->getActiveSheet() )
129:         );
130:         return Api::Module()->Office()->Document()->Excel();
131:     }
132: 
133:     /**
134:      * @param int $Row
135:      *
136:      * @return \MOC\Module\Office\Document\Excel
137:      */
138:     public function AutoFilter( $Row = 1 ) {
139:         $this->getActiveSheet()->setAutoFilter( 'A'.$Row.':'.\PHPExcel_Cell::stringFromColumnIndex( $this->Dimension()->GetWidth() -1 ).$Row );
140:         return Api::Module()->Office()->Document()->Excel();
141:     }
142: 
143:     /**
144:      * @return \PHPExcel_Worksheet
145:      */
146:     private function getActiveSheet() {
147:         return Api::Extension()->Excel()->Current()->getActiveSheet();
148:     }
149: }
150: