majiameng / spreadsheet-php

config/TSpreadSheet.php

Spacing +12 added lines, -12 removed lines

@@ -1,22 +1,22 @@
 <?php
 use \tinymeng\spreadsheet\Util\ConstCode;
 return [
-    'creator'=>'tinymeng',                  //文件创建者
-    'pathName'=>null,                       //文件存储位置
-    'fileName'=>null,                       //文件名称
-    'horizontalCenter'=>true,               //是否居中
-    'titleHeight'=>null,                    //定义表头行高,常用22
-    'titleWidth'=>null,                     //定义表头列宽(未设置则自动计算宽度),常用20
-    'height'=>null,                         //定义数据行高,常用22
-    'autoFilter'=>false,                    //自动筛选(是否开启)
-    'autoDataType'=>true,                   //自动适应文本类型
-    'freezePane'=>false,                    //冻结窗格（要冻结的首行首列"B2"，false不开启）
+    'creator'=>'tinymeng', //文件创建者
+    'pathName'=>null, //文件存储位置
+    'fileName'=>null, //文件名称
+    'horizontalCenter'=>true, //是否居中
+    'titleHeight'=>null, //定义表头行高,常用22
+    'titleWidth'=>null, //定义表头列宽(未设置则自动计算宽度),常用20
+    'height'=>null, //定义数据行高,常用22
+    'autoFilter'=>false, //自动筛选(是否开启)
+    'autoDataType'=>true, //自动适应文本类型
+    'freezePane'=>false, //冻结窗格（要冻结的首行首列"B2"，false不开启）
     /**
      * 字段映射方式
      * ConstCode::FIELD_MAPPING_METHOD_FIELD_CORRESPONDING_NAME = 1;//字段对应名称
      * ConstCode::FIELD_MAPPING_METHOD_NAME_CORRESPONDING_FIELD = 2;//名称对应字段
      */
     'fieldMappingMethod'=>ConstCode::FIELD_MAPPING_METHOD_NAME_CORRESPONDING_FIELD,
-    'mainTitleLine'=>false,                 //主标题行是否显示
-    'mainTitle'=>'',                        //主标题名称，默认为sheet的名称
+    'mainTitleLine'=>false, //主标题行是否显示
+    'mainTitle'=>'', //主标题名称，默认为sheet的名称
 ];

src/Gateways/Export.php

Spacing +24 added lines, -24 removed lines

@@ -33,7 +33,7 @@ 
     /**
      * __construct
      */
-    public function __construct($config=[]){
+    public function __construct($config = []) {
         $this->setConfig($config);
 
         $this->spreadSheet = new Spreadsheet();
@@ -46,7 +46,7 @@ 
      * @param $config
      * @return $this
      */
-    public function setConfig($config){
+    public function setConfig($config) {
         foreach ($config as $key => $value) {
             if (property_exists($this, $key)) {
                 $this->$key = $value;
@@ -64,7 +64,7 @@ 
     {
         /** 实例化定义默认excel **/
         $this->spreadSheet->getProperties()->setCreator($this->creator)->setLastModifiedBy($this->creator);
-        if($this->horizontalCenter){
+        if ($this->horizontalCenter) {
             $this->spreadSheet->getDefaultStyle()->getAlignment()->setHorizontal(Alignment::HORIZONTAL_CENTER); //默认水平居中
             $this->spreadSheet->getDefaultStyle()->getAlignment()->setVertical(Alignment::VERTICAL_CENTER); //默认垂直居中
             $this->spreadSheet->getDefaultStyle()->getAlignment()->setHorizontal(Alignment::VERTICAL_CENTER); //默认垂直居中
@@ -77,21 +77,21 @@ 
      * @return $this
      * @throws \PhpOffice\PhpSpreadsheet\Exception
      */
-    public function createWorkSheet($sheetName="Worksheet")
+    public function createWorkSheet($sheetName = "Worksheet")
     {
         $this->sheetName = $sheetName;
         /** @var workSheet */
         $this->workSheet = $this->greateWorkSheet($sheetName);
-        if($this->workSheet == null){
-            if($this->sheetCount==1){
+        if ($this->workSheet == null) {
+            if ($this->sheetCount == 1) {
                 $this->workSheet = $this->spreadSheet->getActiveSheet();
-            }else{
+            } else {
                 $this->workSheet = $this->spreadSheet->createSheet();
             }
-            $this->sheetCount += 1;//总sheet数量
-            $this->workSheet->setTitle($sheetName);//设置sheet名称
+            $this->sheetCount += 1; //总sheet数量
+            $this->workSheet->setTitle($sheetName); //设置sheet名称
         }
-        if(empty($this->mainTitle)){
+        if (empty($this->mainTitle)) {
             $this->mainTitle = $sheetName;
         }
 
@@ -118,13 +118,13 @@ 
     public function generate()
     {
         /** 开启自动筛选 **/
-        if($this->autoFilter){
+        if ($this->autoFilter) {
             $this->spreadSheet->getActiveSheet()->setAutoFilter(
                 $this->spreadSheet->getActiveSheet()->calculateWorksheetDimension()
             );
         }
         //文件存储
-        if(empty($this->fileName)){
+        if (empty($this->fileName)) {
             $this->getFileName($this->sheetName);
         }
         return $this;
@@ -135,8 +135,8 @@ 
      * @param $file_name
      * @return string
      */
-    private function getFileName($sheetName){
-        $this->fileName = $sheetName.'_'.date('Y-m-d').'_'.rand(111,999).'.xlsx';
+    private function getFileName($sheetName) {
+        $this->fileName = $sheetName.'_'.date('Y-m-d').'_'.rand(111, 999).'.xlsx';
         return $this->fileName;
     }
 
@@ -146,18 +146,18 @@ 
      * @return void
      * @throws ExceptionAlias
      */
-    public function download($filename=''){
-        if(empty($filename)){
+    public function download($filename = '') {
+        if (empty($filename)) {
             $filename = $this->fileName;
-        }else{
+        } else {
             $filename = $this->getFileName($filename);
         }
 
         /** 输出下载 **/
-        ob_end_clean();//清除缓冲区,避免乱码
-        header( 'Access-Control-Allow-Headers:responsetype,content-type,usertoken');
-        header( 'Access-Control-Allow-Methods:GET,HEAD,PUT,POST,DELETE,PATCH');
-        header( 'Access-Control-Allow-Origin:*');
+        ob_end_clean(); //清除缓冲区,避免乱码
+        header('Access-Control-Allow-Headers:responsetype,content-type,usertoken');
+        header('Access-Control-Allow-Methods:GET,HEAD,PUT,POST,DELETE,PATCH');
+        header('Access-Control-Allow-Origin:*');
         header('Content-Type: application/vnd.ms-excel');
         header('Content-Disposition: attachment;filename="'.$filename);
         header('Cache-Control: max-age=0');
@@ -174,12 +174,12 @@ 
      * @return string
      * @throws ExceptionAlias
      */
-    public function save($filename='',$pathName=''): string
+    public function save($filename = '', $pathName = ''): string
     {
         $pathName = $this->getPathName($pathName);
-        if(empty($filename)){
+        if (empty($filename)) {
             $filename = $this->fileName;
-        }else{
+        } else {
             $filename = $this->getFileName($filename);
         }
         FileTool::mkdir($pathName);

src/Excel/TWorkSheet.php

Spacing +92 added lines, -92 removed lines

@@ -12,7 +12,7 @@ 
 use tinymeng\tools\exception\StatusCode;
 use tinymeng\tools\exception\TinymengException;
 
-trait TWorkSheet{
+trait TWorkSheet {
 
     /**
      * sheet名称
@@ -45,7 +45,7 @@ 
      * 文件信息
      * @var array
      */
-    private $fileTitle=[];
+    private $fileTitle = [];
 
 
     /**
@@ -71,7 +71,7 @@ 
      * @param $data
      * @return $this
      */
-    public function setData($data){
+    public function setData($data) {
         $this->data = $data;
         return $this;
     }
@@ -80,7 +80,7 @@ 
      * @param $data
      * @return $this
      */
-    public function getData(){
+    public function getData() {
         return $this->data;
     }
 
@@ -96,7 +96,7 @@ 
         $this->fileTitle = [];
         $this->data = [];
         $this->field = [];
-        if($this->freezePane) $this->workSheet->freezePane($this->freezePane); //冻结窗格
+        if ($this->freezePane) $this->workSheet->freezePane($this->freezePane); //冻结窗格
     }
 
     /**
@@ -106,9 +106,9 @@ 
      * @throws TinymengException
      * @throws \PhpOffice\PhpSpreadsheet\Exception
      */
-    public function setWorkSheetData($fileTitle,$data)
+    public function setWorkSheetData($fileTitle, $data)
     {
-        if(isset($fileTitle['title_row']) || isset($fileTitle['group_left'])){
+        if (isset($fileTitle['title_row']) || isset($fileTitle['group_left'])) {
             /**
              * $fileTitle = [
              *       'title_row'=>1,
@@ -118,10 +118,10 @@ 
              *       ],
              *  ];
              */
-            $this->title_row = $fileTitle['title_row']??1;
-            $this->group_left = $fileTitle['group_left']??[];
-            $titleData = $fileTitle['title']??[];
-        }else{
+            $this->title_row = $fileTitle['title_row'] ?? 1;
+            $this->group_left = $fileTitle['group_left'] ?? [];
+            $titleData = $fileTitle['title'] ?? [];
+        } else {
             /**
              *  $fileTitle = [
              *       '姓名'=>'name',
@@ -131,14 +131,14 @@ 
         }
         // 根据字段映射方式处理 title
         if ($this->fieldMappingMethod === ConstCode::FIELD_MAPPING_METHOD_FIELD_CORRESPONDING_NAME) {
-            $this->fileTitle = array_flip($titleData);// 字段对应名称方式 - 需要将键值对调
-        }else{
-            $this->fileTitle = $titleData;// 名称对应字段方式 - 保持原样
+            $this->fileTitle = array_flip($titleData); // 字段对应名称方式 - 需要将键值对调
+        } else {
+            $this->fileTitle = $titleData; // 名称对应字段方式 - 保持原样
         }
         $this->data = $data;
 
         /** 设置第一行格式 */
-        if($this->mainTitleLine === true){
+        if ($this->mainTitleLine === true) {
             $this->excelHeader();
         }
 
@@ -146,17 +146,17 @@ 
         $this->excelTitle();
 
         /** 获取列表里所有字段 **/
-        foreach ($this->fileTitle as $key => $val){
-            if(is_array($val)){
-                foreach ($val as $k => $v){
+        foreach ($this->fileTitle as $key => $val) {
+            if (is_array($val)) {
+                foreach ($val as $k => $v) {
                     $this->field[] = $v;
                 }
-            }else{
+            } else {
                 $this->field[] = $val;
             }
         }
         /** 查询结果赋值 **/
-        if(!empty($this->data)){
+        if (!empty($this->data)) {
             $this->excelSetValue();
         }
         return $this;
@@ -167,33 +167,33 @@ 
      * @author: Tinymeng <666@majiameng.com>
      * @time: 2022/2/22 11:43
      */
-    public function excelSetValue(){
-        if(empty($this->group_left)){ //判断左侧是否分组
-            foreach ($this->data as $key => $val){
+    public function excelSetValue() {
+        if (empty($this->group_left)) { //判断左侧是否分组
+            foreach ($this->data as $key => $val) {
                 $this->excelSetCellValue($val);
             }
-        }else{   //根据设置分组字段进行分组
+        } else {   //根据设置分组字段进行分组
             /** 数据分组 **/
             $data = [];
             $group_left_count = count($this->group_left);
-            if($group_left_count == 1){
-                foreach ($this->data as $k => $v){
+            if ($group_left_count == 1) {
+                foreach ($this->data as $k => $v) {
                     $data[$v[$this->group_left[0]]][] = $v;
                 }
-                foreach ($data as $k =>$v){
+                foreach ($data as $k =>$v) {
                     $data[$k] = [
                         'data' => $v,
                         'count' => count($v)
                     ];
                 }
                 $this->excelGroupLeft($data, $group_left_count);
-            }elseif($group_left_count == 2){
+            }elseif ($group_left_count == 2) {
                 foreach ($this->data as $v) {
                     $data[$v[$this->group_left[0]]][$v[$this->group_left[1]]][] = $v;
                 }
                 $this->data = $this->arrayCount($data);
                 $this->excelGroupLeft($this->data, $group_left_count);
-            }else{
+            } else {
                 throw new TinymengException(StatusCode::COMMON_PARAM_INVALID,
                     '左侧分组过多，导出失败！'
                 );
@@ -205,7 +205,7 @@ 
      * @return void
      * @throws \PhpOffice\PhpSpreadsheet\Exception
      */
-    public function excelHeader(){
+    public function excelHeader() {
         $row = 1;
         $this->workSheet->setCellValue('A'.$row, $this->mainTitle);
         
@@ -220,33 +220,33 @@ 
         }
         
         // 使用实际的标题列数来合并单元格
-        $this->workSheet->mergeCells('A'.$row.':'.$this->cellName($titleCount-1).$row);
+        $this->workSheet->mergeCells('A'.$row.':'.$this->cellName($titleCount - 1).$row);
     }
 
     /**
      * @return void
      * @throws \PhpOffice\PhpSpreadsheet\Exception
      */
-    private function excelTitle(){
-        if($this->mainTitleLine === true){
-            $this->_row ++;//当前行数
+    private function excelTitle() {
+        if ($this->mainTitleLine === true) {
+            $this->_row++; //当前行数
         }
 
         $_merge = $this->cellName($this->_col);
         foreach ($this->fileTitle as $key => $val) {
-            if(!empty($this->titleHeight)) {
-                $this->workSheet->getRowDimension($this->_col)->setRowHeight($this->titleHeight);//行高度
+            if (!empty($this->titleHeight)) {
+                $this->workSheet->getRowDimension($this->_col)->setRowHeight($this->titleHeight); //行高度
             }
             $rowName = $this->cellName($this->_col);
-            $this->workSheet->getStyle($rowName . $this->_row)->getAlignment()->setWrapText(true);//自动换行
+            $this->workSheet->getStyle($rowName.$this->_row)->getAlignment()->setWrapText(true); //自动换行
             if (is_array($val)) {
                 $num = 1;
                 $_cols = $this->_col;
                 foreach ($val as $k => $v) {
-                    $this->workSheet->setCellValue($this->cellName($_cols) . ($this->_row+1), $k);
-                    if(!empty($this->titleWidth)) {
+                    $this->workSheet->setCellValue($this->cellName($_cols).($this->_row + 1), $k);
+                    if (!empty($this->titleWidth)) {
                         $this->workSheet->getColumnDimension($this->cellName($_cols))->setWidth($this->titleWidth); //列宽度
-                    }else{
+                    } else {
                         $this->workSheet->getColumnDimension($this->cellName($_cols))->setAutoSize(true); //自动计算宽度
                     }
                     if ($num < count($val)) {
@@ -255,23 +255,23 @@ 
                     }
                     $_cols++;
                 }
-                $this->workSheet->mergeCells($_merge . $this->_row.':' . $this->cellName($this->_col) .$this->_row);
-                $this->workSheet->setCellValue($_merge . $this->_row, $key);//设置值
+                $this->workSheet->mergeCells($_merge.$this->_row.':'.$this->cellName($this->_col).$this->_row);
+                $this->workSheet->setCellValue($_merge.$this->_row, $key); //设置值
             } else {
                 if ($this->title_row != 1) {
-                    $this->workSheet->mergeCells($rowName . $this->_row.':' . $rowName . ($this->_row + $this->title_row - 1));
+                    $this->workSheet->mergeCells($rowName.$this->_row.':'.$rowName.($this->_row + $this->title_row - 1));
                 }
-                $this->workSheet->setCellValue($rowName . $this->_row, $key);//设置值
-                if(!empty($this->titleWidth)){
+                $this->workSheet->setCellValue($rowName.$this->_row, $key); //设置值
+                if (!empty($this->titleWidth)) {
                     $this->workSheet->getColumnDimension($rowName)->setWidth($this->titleWidth); //列宽度
-                }else{
+                } else {
                     $this->workSheet->getColumnDimension($rowName)->setAutoSize(true); //自动计算宽度
                 }
             }
             $this->_col++;
             $_merge = $this->cellName($this->_col);
         }
-        $this->_row += $this->title_row;//当前行数
+        $this->_row += $this->title_row; //当前行数
     }
 
     /**
@@ -282,60 +282,60 @@ 
     private function excelSetCellValue($val)
     {
         //设置单元格行高
-        if(!empty($this->height)){
+        if (!empty($this->height)) {
             $this->workSheet->getRowDimension($this->_row)->setRowHeight($this->height);
         }
         $_lie = 0;
-        foreach ($this->field as $v){
+        foreach ($this->field as $v) {
             $rowName = $this->cellName($_lie);
 
-            if(strpos($v,'.') !== false){
-                $v = explode('.',$v);
+            if (strpos($v, '.') !== false) {
+                $v = explode('.', $v);
                 $content = $val;
-                for ($i=0;$i<count($v);$i++){
-                    $content = $content[$v[$i]]??'';
+                for ($i = 0; $i < count($v); $i++) {
+                    $content = $content[$v[$i]] ?? '';
                 }
-            }elseif($v == '_id'){
-                $content = $this->_row-$this->title_row;//自增序号列
-            }else{
-                $content = ($val[$v]??'');
+            }elseif ($v == '_id') {
+                $content = $this->_row - $this->title_row; //自增序号列
+            } else {
+                $content = ($val[$v] ?? '');
             }
-            if(is_array($content) && isset($content['type']) && isset($content['content'])){
-                if($content['type'] == 'image'){
+            if (is_array($content) && isset($content['type']) && isset($content['content'])) {
+                if ($content['type'] == 'image') {
                     $path = $this->verifyFile($content['content']);
                     $drawing = new \PhpOffice\PhpSpreadsheet\Worksheet\Drawing();
                     $drawing->setPath($path);
-                    if(!empty($content['height'])) {
+                    if (!empty($content['height'])) {
                         $drawing->setHeight($content['height']);
                     }
-                    if(!empty($content['width'])) {
-                        $drawing->setWidth($content['width']);//只设置高，宽会自适应，如果设置宽后，高则失效
+                    if (!empty($content['width'])) {
+                        $drawing->setWidth($content['width']); //只设置高，宽会自适应，如果设置宽后，高则失效
                     }
-                    if(!empty($content['offsetX'])) {
-                        $drawing->setOffsetX($content['offsetX']);//设置X方向偏移量
+                    if (!empty($content['offsetX'])) {
+                        $drawing->setOffsetX($content['offsetX']); //设置X方向偏移量
                     }
-                    if(!empty($content['offsetY'])) {
-                        $drawing->setOffsetY($content['offsetY']);//设置Y方向偏移量
+                    if (!empty($content['offsetY'])) {
+                        $drawing->setOffsetY($content['offsetY']); //设置Y方向偏移量
                     }
 
                     $drawing->setCoordinates($rowName.$this->_row);
                     $drawing->setWorksheet($this->workSheet);
                 }
-            }else {
-                $content = $this->formatValue($content);//格式化数据
-                if (is_numeric($content)){
-                    if($this->autoDataType && strlen($content)<11){
-                        $this->workSheet->setCellValueExplicit($rowName.$this->_row, $content,DataType::TYPE_NUMERIC);
-                    }else{
-                        $this->workSheet->setCellValueExplicit($rowName.$this->_row, $content,DataType::TYPE_STRING2);
+            } else {
+                $content = $this->formatValue($content); //格式化数据
+                if (is_numeric($content)) {
+                    if ($this->autoDataType && strlen($content) < 11) {
+                        $this->workSheet->setCellValueExplicit($rowName.$this->_row, $content, DataType::TYPE_NUMERIC);
+                    } else {
+                        $this->workSheet->setCellValueExplicit($rowName.$this->_row, $content, DataType::TYPE_STRING2);
                     }
-                }else{
-                    $this->workSheet->setCellValueExplicit($rowName.$this->_row, $content,DataType::TYPE_STRING2);
+                } else {
+                    $this->workSheet->setCellValueExplicit($rowName.$this->_row, $content, DataType::TYPE_STRING2);
                 }
             }
-            $_lie ++;
+            $_lie++;
         }
-        $this->_row ++;
+        $this->_row++;
     }
 
     /**
@@ -348,39 +348,39 @@ 
     {
         // 获取分组字段在field中的实际位置
         $group_field_positions = [];
-        foreach($this->group_left as $group_field){
+        foreach ($this->group_left as $group_field) {
             $position = array_search($group_field, $this->field);
-            if($position !== false){
+            if ($position !== false) {
                 $group_field_positions[] = $position;
             }
         }
 
-        if(empty($group_field_positions)){
+        if (empty($group_field_positions)) {
             throw new TinymengException(StatusCode::COMMON_PARAM_INVALID, '分组字段未在标题中定义');
         }
 
         $group_start = $this->_row;
-        foreach ($data as $key => $val){
+        foreach ($data as $key => $val) {
             // 第一级分组的合并单元格
             $rowName = $this->cellName($group_field_positions[0]); // 使用第一个分组字段的实际位置
-            $coordinate = $rowName.$this->_row.':'.$rowName.($this->_row+$val['count']-1);
+            $coordinate = $rowName.$this->_row.':'.$rowName.($this->_row + $val['count'] - 1);
             $this->workSheet->mergeCells($coordinate);
             $this->workSheet->setCellValue($rowName.$this->_row, $key);
             
-            if($group_left_count == 1){
-                foreach ($val['data'] as $data){
+            if ($group_left_count == 1) {
+                foreach ($val['data'] as $data) {
                     $this->excelSetCellValue($data);
                 }
-            }else{
+            } else {
                 $sub_group_start = $this->_row;
                 $rowName = $this->cellName($group_field_positions[1]); // 使用第二个分组字段的实际位置
                 
-                foreach ($val['data'] as $k => $v){
-                    $coordinate = $rowName.$sub_group_start.':'.$rowName.($sub_group_start+$v['count']-1);
+                foreach ($val['data'] as $k => $v) {
+                    $coordinate = $rowName.$sub_group_start.':'.$rowName.($sub_group_start + $v['count'] - 1);
                     $this->workSheet->mergeCells($coordinate);
                     $this->workSheet->setCellValue($rowName.$sub_group_start, $k);
                     
-                    foreach ($v['data'] as $data){
+                    foreach ($v['data'] as $data) {
                         $this->excelSetCellValue($data);
                     }
                     
@@ -399,13 +399,13 @@ 
      * @param array $data 二维数组原始数据
      * @return array
      */
-    private function arrayCount($data=[])
+    private function arrayCount($data = [])
     {
-        foreach ($data as $key => $val){
+        foreach ($data as $key => $val) {
             $num = 0;
-            foreach ($val as $k => $v){
+            foreach ($val as $k => $v) {
                 $sub_num = count($v);
-                $num = $num+$sub_num;
+                $num = $num + $sub_num;
                 $val[$k] = [
                     'count' => $sub_num,
                     'data' => $v