Nikaia\TranslationSheet\Sheet\TranslationsSheet

Complexity

Total Complexity

30

Size/Duplication

Total Lines	237
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

24 Methods

Rating	Name	Duplication	Size	Complexity
A	getId()	0	4	1
A	setId()	0	6	1
A	getTitle()	0	4	1
A	setTitle()	0	6	1
A	setPath()	0	6	1
A	getPath()	0	4	1
A	setTabColor()	0	5	1
A	getTabColor()	0	4	1
A	markAsPrimarySheet()	0	6	1
A	markAsExtraSheet()	0	6	1
A	isPrimarySheet()	0	4	1
A	isExtraSheet()	0	4	1
A	coordinates()	0	4	1
A	emptyCoordinates()	0	4	1
A	setup()	0	13	1
A	writeTranslations()	0	9	1
A	readTranslations()	0	4	1
A	styleDocument()	0	52	3
A	prepareForWrite()	0	6	1
A	lockTranslations()	0	11	1
A	unlockTranslations()	0	14	2
A	isTranslationsLocked()	0	6	2
A	removeAllProtectedRanges()	0	15	3
A	updateHeaderRow()	0	7	1

<?php

namespace Nikaia\TranslationSheet\Sheet;

class TranslationsSheet extends AbstractSheet
{
    protected $title = null;
    protected $id = null;
    protected $path = null;
    protected $tabColor = null;
    protected $primary = true;

    public function getId()
    {
        return $this->id;
    }

    public function setId($id)
    {
        $this->id = $id;

        return $this;
    }

    public function getTitle()
    {
        return $this->title;
    }

    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

    public function setPath($path)
    {
        $this->path = $path;

        return $this;
    }

    public function getPath()
    {
        return $this->path ?? app()->make('path.lang');
    }

    public function setTabColor($tabColor)
    {
        $this->tabColor = $tabColor;
        return $this;
    }

    public function getTabColor()
    {
        return $this->tabColor ?? $this->styles()->translationSheetTabColor();
    }

    public function markAsPrimarySheet()
    {
        $this->primary = true;

        return $this;
    }

    public function markAsExtraSheet()
    {
        $this->primary = false;

        return $this;
    }

    public function isPrimarySheet()
    {
        return $this->primary;
    }

    public function isExtraSheet()
    {
        return !$this->primary;
    }

    public function coordinates()
    {
        return $this->spreadsheet->translationsSheetCoordinates($this->getId(), $this->getTitle());
    }

    public function emptyCoordinates()
    {
        return $this->spreadsheet->translationsSheetCoordinates($this->getId(), $this->getTitle());
    }

    public function setup()
    {
        $this->spreadsheet->api()
            ->addBatchRequests([
                // Set properties
                $this->spreadsheet->api()->setSheetPropertiesRequest(
                    $this->getId(),
                    $this->getTitle(),
                    $this->styles()->translationSheetTabColor()
                ),
            ])
            ->sendBatchRequests();
    }

    public function writeTranslations($translations)
    {
        $translations = array_values($translations);

        $this->spreadsheet->setTranslations($translations);

        $this->spreadsheet->api()
            ->writeCells($this->coordinates()->dataShortRange(), $translations);
    }

    public function readTranslations()
    {
        return $this->spreadsheet->api()->readCells($this->getId(), $this->coordinates()->dataShortRange(2, true));
    }

    public function styleDocument()
    {
        $fullkeyRange = $this->coordinates()->fullKeyColumnRange();
        $translationsRange = $this->coordinates()->translationsRange();
        $metaRange = $this->coordinates()->metaColumnsRange();

        $requests = [
            // Header row
            $this->spreadsheet->api()->frozenRowRequest($this->getId()),
            $this->spreadsheet->api()->styleArea($this->emptyCoordinates()->headerRange(), $this->styles()->translationsHeader()),
            $this->spreadsheet->api()->protectRangeRequest($this->emptyCoordinates()->headerRange(), 'HEADER.'),

            // Full key column
            $this->spreadsheet->api()->frozenColumnRequest($this->getId()),
            $this->spreadsheet->api()->protectRangeRequest($fullkeyRange, 'FULL_KEY'),
            $this->spreadsheet->api()->fixedColumnWidthRequest($this->getId(), 0, 1, 450),
            $this->spreadsheet->api()->styleArea($fullkeyRange, $this->styles()->fullKeyColumn()),

            // Translations columns
            $this->spreadsheet->api()->styleArea($translationsRange, $this->styles()->translationsColumns()),

            // Meta columns
            $this->spreadsheet->api()->protectRangeRequest($metaRange, 'META'),
            $this->spreadsheet->api()->styleArea($metaRange, $this->styles()->metaColumns()),
            $this->spreadsheet->api()->fixedColumnWidthRequest($this->getId(), $this->coordinates()->namespaceColumnIndex(), $this->coordinates()->namespaceColumnIndex() + 1, 145),
            $this->spreadsheet->api()->fixedColumnWidthRequest($this->getId(), $this->coordinates()->groupColumnIndex(), $this->coordinates()->groupColumnIndex() + 1, 80),
            $this->spreadsheet->api()->fixedColumnWidthRequest($this->getId(), $this->coordinates()->keyColumnIndex(), $this->coordinates()->keyColumnIndex() + 1, 240),
            $this->spreadsheet->api()->fixedColumnWidthRequest($this->getId(), $this->coordinates()->sourceFileColumnIndex(), $this->coordinates()->sourceFileColumnIndex() + 1, 360),
        ];

        // Fixed locales translations column width
        $beginAt = 1;
        foreach ($this->spreadsheet->getLocales() as $locale) {
            $requests[] = $this->spreadsheet->api()->fixedColumnWidthRequest($this->getId(), $beginAt, $beginAt + 1, 350);
            $beginAt++;
        }

        // Send requests
        $this->spreadsheet->api()->addBatchRequests($requests)->sendBatchRequests();

        // Delete extra columns and rows if any
        try {
            $this->spreadsheet->api()->addBatchRequests([
                $this->spreadsheet->api()->deleteRowsFrom($this->getId(), $this->coordinates()->getRowsCount()),
                $this->spreadsheet->api()->deleteColumnsFrom($this->getId(), $this->coordinates()->getColumnsCount()),
            ])->sendBatchRequests();
        } catch (\Google_Service_Exception $e) {
            // Avoid exception failing the command
            // ... If there is no extra columns or rows Google api will raise an exception :
            // ... Invalid requests[xxx].deleteDimension: Cannot delete a column that doesn't exist ...
        }
    }

    public function prepareForWrite()
    {
        // We need to remove all protected ranges, to avoid any duplicates that may lead to
        // some weird behaviours
        $this->removeAllProtectedRanges();
    }

    public function lockTranslations()
    {
        $range = $this->coordinates()->translationsRange(1, $this->spreadsheet->api()->getSheetRowCount($this->getId()));

        $this->api()
            ->addBatchRequests([
                $this->spreadsheet->api()->protectRangeRequest($range, 'TRANSLATIONS'),
                $this->spreadsheet->api()->styleArea($range, $this->styles()->lockedTranslationsColumns()),
            ])
            ->sendBatchRequests();
    }

    public function unlockTranslations()
    {
        $requests = [];
        $range = $this->coordinates()->translationsRange(1, $this->spreadsheet->api()->getSheetRowCount($this->getId()));

        $protectedRanges = $this->spreadsheet->api()->getSheetProtectedRanges($this->getId(), 'TRANSLATIONS');
        foreach ($protectedRanges as $protectedRange) {
            $requests[] = $this->spreadsheet->api()->deleteProtectedRange($protectedRange->protectedRangeId);
        }

        $requests[] = $this->spreadsheet->api()->styleArea($range, $this->styles()->translationsColumns());

        $this->spreadsheet->api()->addBatchRequests($requests)->sendBatchRequests();
    }

    public function isTranslationsLocked()
    {
        $protectedRanges = $this->spreadsheet->api()->getSheetProtectedRanges($this->getId(), 'TRANSLATIONS');

        return !empty($protectedRanges) && count($protectedRanges) > 0;
    }

    public function removeAllProtectedRanges()
    {
        $protectedRanges = $this->spreadsheet->api()->getSheetProtectedRanges($this->getId());

        $requests = [];
        foreach ($protectedRanges as $protectedRange) {
            $requests[] = $this->spreadsheet->api()->deleteProtectedRange($protectedRange->protectedRangeId);
        }

        if (empty($requests)) {
            return;
        }

        $this->spreadsheet->api()->addBatchRequests($requests)->sendBatchRequests();
    }

    public function updateHeaderRow()
    {
        $this->api()->writeCells(
            $this->emptyCoordinates()->headerShortRange(),
            [$this->spreadsheet->getHeader()]
        );
    }

}