Skip to content

Commit

Permalink
Translated comments into English. Fixed minor bugs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@alhimik1986
alhimik1986 committed Jun 12, 2020
1 parent c6b828b commit ef813f4
Show file tree
Hide file tree
Showing 14 changed files with 282 additions and 287 deletions.
6 changes: 5 additions & 1 deletion composer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@
}
},
"require": {
"php": ">=5.6.0",
"php": ">=7.2",

This comment has been minimized.

Sign in to view

Copy link
@alexey-m-ukolov

alexey-m-ukolov Jun 18, 2020

Well, it's a mighty breaking change for people who are stuck on PHP 5, so it should be in a major release.
"phpoffice/phpspreadsheet": ">=1.4"
}
,
"require-dev": {
"roave/security-advisories": "dev-master"
}
}
136 changes: 65 additions & 71 deletions src/InsertedCells.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@
class InsertedCells
{
/**
* @var integer[][] Вставленные строки, где
* ключ 1 - номер столбца,
* ключ 2 - номер строки,
* значение - количество вставленных строк относительно этой строки
* @var integer[][] Inserted rows, where
* key 1 - index of column,
* key 2 - index of row,
* value - count of inserted rows in the row of template variable
*/
public $inserted_rows;

/**
* @var integer[][] Вставленные столбцы, где
* ключ 1 - номер строки,
* ключ 2 - номер столбца,
* значение - количество вставленных столбцов относительно этого столбца
* @var integer[][] Inserted columns, where
* ключ 1 - index of row,
* ключ 2 - index of column,
* value - count of inserted columns in the column of template variable
*/
public $inserted_cols;

Expand All @@ -33,12 +33,11 @@ public function __construct($inserted_cols=[], $inserted_rows=[])
}

/**
* @param $row_key integer Текущая строка таблицы
* @param $col_key integer Текущая колонка таблицы
* @return integer Общее число вставленных строк,
* которые были вставлены от начала таблицы до текущей строки
* @param $row_key integer Current index of row
* @param $col_key integer Current index of column
* @return integer Total count of inserted rows, that were inserted from 0 row to current row
*/
public function getInsertedRowsCount($row_key, $col_key)
public function getInsertedRowsCount($row_key, $col_key): int
{
$this->_addKeysTo2DArrayIfNotExists($this->inserted_rows, $col_key, $row_key);

Expand All @@ -50,12 +49,11 @@ public function getInsertedRowsCount($row_key, $col_key)
}

/**
* @param $row_key integer Текущая строка таблицы
* @param $col_key integer Текущая колонка таблицы
* @return integer Общее число столбцов,
* которые были вставлены от начала таблицы до текущего столбца
* @param $row_key integer Current index of row
* @param $col_key integer Current index of column
* @return integer Total count of inserted columns, that were inserted from 0 column to current column
*/
public function getInsertedColsCount($row_key, $col_key)
public function getInsertedColsCount($row_key, $col_key): int
{
$this->_addKeysTo2DArrayIfNotExists($this->inserted_cols, $row_key, $col_key);

Expand All @@ -67,81 +65,77 @@ public function getInsertedColsCount($row_key, $col_key)
}

/**
* Подменяет добавленные столбцы относительно указанной строки и столбца
* @param $row_key integer Строка таблицы, в которой была шаблонная переменная
* @param $col_key integer Столбец таблицы, в котором была шаблонная переменная
* @param $inserted_cols_count integer Количество добавленных столбцов
* @param $row_key integer The row index, where was template variable
* @param $col_key integer The column index, where was template variable
* @param $inserted_cols_count integer
*/
public function setInsertedCols($row_key, $col_key, $inserted_cols_count)
public function setInsertedCols($row_key, $col_key, $inserted_cols_count): void
{
$this->_addKeysTo2DArrayIfNotExists($this->inserted_cols, $row_key, $col_key);
$this->inserted_cols[$row_key][$col_key] = $inserted_cols_count;
}

/**
* Подменяет добавленные строки относительно указанной строки
* @param $row_key integer Строка таблицы, в которой была шаблонная переменная
* @param $col_key integer Столбец таблицы, в котором была шаблонная переменная
* @param $inserted_rows_count integer Количество добавленных строк
* @param $row_key integer The row index, where was template variable
* @param $col_key integer The column index, where was template variable
* @param $inserted_rows_count integer
*/
public function setInsertedRows($row_key, $col_key, $inserted_rows_count)
public function setInsertedRows($row_key, $col_key, $inserted_rows_count): void
{
$this->_addKeysTo2DArrayIfNotExists($this->inserted_rows, $col_key, $row_key);
$this->inserted_rows[$col_key][$row_key] = $inserted_rows_count;
}

/**
* Регистрирует добавленные столбцы относительно указанной строки и столбца
* @param $row_key integer Строка таблицы, в которой была шаблонная переменная
* @param $col_key integer Столбец таблицы, в котором была шаблонная переменная
* @param $inserted_cols_count integer Количество добавленных столбцов
* @param $row_key integer The row index, where was template variable
* @param $col_key integer The column index, where was template variable
* @param $inserted_cols_count integer
*/
public function addInsertedCols($row_key, $col_key, $inserted_cols_count)
public function addInsertedCols($row_key, $col_key, $inserted_cols_count): void
{
$this->_addKeysTo2DArrayIfNotExists($this->inserted_cols, $row_key, $col_key);
$this->inserted_cols[$row_key][$col_key] += $inserted_cols_count;
}

/**
* Регистрирует добавленные строки относительно указанной строки
* @param $row_key integer Строка таблицы, в которой была шаблонная переменная
* @param $col_key integer Столбец таблицы, в котором была шаблонная переменная
* @param $inserted_rows_count integer Количество добавленных строк
* @param $row_key integer
* @param $col_key integer
* @param $inserted_rows_count integer
*/
public function addInsertedRows($row_key, $col_key, $inserted_rows_count)
public function addInsertedRows($row_key, $col_key, $inserted_rows_count): void
{
$this->_addKeysTo2DArrayIfNotExists($this->inserted_rows, $col_key, $row_key);
$this->inserted_rows[$col_key][$row_key] += $inserted_rows_count;
}

/**
* @param $row_key integer Строка таблицы, в которой была шаблонная переменная
* @param $col_key integer Столбец таблицы, в котором была шаблонная переменная
* @return integer Число вставленных строк относительно указанной строки
* @param $row_key integer
* @param $col_key integer
* @return integer
*/
public function getInsertedRows($row_key, $col_key)
public function getInsertedRows($row_key, $col_key): int
{
$this->_addKeysTo2DArrayIfNotExists($this->inserted_rows, $col_key, $row_key);
return $this->inserted_rows[$col_key][$row_key];
}

/**
* @param $row_key integer Строка таблицы, в которой была шаблонная переменная
* @param $col_key integer Столбец таблицы, в котором была шаблонная переменная
* @return integer Число вставленных столбцов относительно указанной строки и столбца
* @param $row_key integer
* @param $col_key integer
* @return integer
*/
public function getInsertedCols($row_key, $col_key)
public function getInsertedCols($row_key, $col_key): int
{
$this->_addKeysTo2DArrayIfNotExists($this->inserted_cols, $row_key, $col_key);
return $this->inserted_cols[$row_key][$col_key];
}

/**
* Вставляет индексы в указанный массив от нуля до указанного максимального индекса
* @param $array array Массив, в который нужно добавить индексы, если они не существуют
* @param $key_index integer Максимальный индекс
* Inserts indexes to specified array. The array filled with indexes from 0 to $key_index, if the index does not exist.
* @param $array array
* @param $key_index integer
*/
private function _addKeysToArrayIfNotExists(&$array, $key_index)
private function _addKeysToArrayIfNotExists(&$array, $key_index): void
{
for($i=0; $i <= $key_index; $i++) {
if ( ! array_key_exists($i, $array)) {
Expand All @@ -151,12 +145,12 @@ private function _addKeysToArrayIfNotExists(&$array, $key_index)
}

/**
* Вставляет индексы в указанный массив от нуля до указанного максимального индекса массива и подмассива
* @param $array array Массив, в который нужно добавить индексы, если они не существуют
* @param $i_max integer Максимальный индекс массива
* @param $j_max integer Максимальный индекс подмассива
* Inserts indexes to specified 2D array. The array filled with indexes from 0 to $key_index, if the indexes does not exist.
* @param $array array
* @param $i_max integer
* @param $j_max integer
*/
private function _addKeysTo2DArrayIfNotExists(&$array, $i_max, $j_max)
private function _addKeysTo2DArrayIfNotExists(&$array, $i_max, $j_max): void
{
for($i=0; $i <= $i_max; $i++) {
for($j=0; $j <= $j_max; $j++) {
Expand All @@ -171,44 +165,44 @@ private function _addKeysTo2DArrayIfNotExists(&$array, $i_max, $j_max)
}

/**
* @param $row_key integer Строка таблицы, в которой была шаблонная переменная
* @param $col_key integer Столбец таблицы, в котором была шаблонная переменная
* @return integer Строка ячейки с учётом вставленных столбцов и строк (отсчёт с нуля)
* @param $row_key integer The row index, where was template variable
* @param $col_key integer The column index, where was template variable
* @return integer Index of row, considering the count of inserted columns and rows
*/
public function getCurrentRowIndex($row_key, $col_key)
public function getCurrentRowIndex($row_key, $col_key): int
{
$inserted_rows = $this->getInsertedRowsCount($row_key, $col_key);
return $row_key + 1 + $inserted_rows;
}

/**
* @param $row_key integer Строка таблицы, в которой была шаблонная переменная
* @param $col_key integer Столбец таблицы, в котором была шаблонная переменная
* @return integer Столбец ячейки с учётом вставленных столбцов и строк (отсчёт с нуля)
* @param $row_key integer
* @param $col_key integer
* @return integer Index of column, considering the count of inserted columns and rows
*/
public function getCurrentColIndex($row_key, $col_key)
public function getCurrentColIndex($row_key, $col_key): int
{
$inserted_cols = $this->getInsertedColsCount($row_key, $col_key);
return $col_key + 1 + $inserted_cols;
}

/**
* @param $row_key integer Строка таблицы, в которой была шаблонная переменная
* @param $col_key integer Столбец таблицы, в котором была шаблонная переменная
* @return string Столбец ячейки с учётом вставленных столбцов и строк (буквой)
* @param $row_key integer
* @param $col_key integer
* @return string Index of column (as a letter), considering the count of inserted columns and rows
*/
public function getCurrentCol($row_key, $col_key)
public function getCurrentCol($row_key, $col_key): string
{
$col_index = $this->getCurrentColIndex($row_key, $col_key);
return Coordinate::stringFromColumnIndex($col_index);
}

/**
* @param $row_key integer Строка таблицы, в которой была шаблонная переменная
* @param $col_key integer Столбец таблицы, в котором была шаблонная переменная
* @return string Координата ячейки с учётом вставленных столбцов и строк
* @param $row_key integer
* @param $col_key integer
* @return string Cell coordinate, considering the count of inserted columns and rows
*/
public function getCurrentCellCoordinate($row_key, $col_key)
public function getCurrentCellCoordinate($row_key, $col_key): string
{
$col = $this->getCurrentCol($row_key, $col_key);
$row_index = $this->getCurrentRowIndex($row_key, $col_key);
Expand Down
Loading

0 comments on commit ef813f4

Please sign in to comment.