Box\Spout\Writer\Common\Manager\Style\StyleManager

Complexity

Total Complexity

8

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getDefaultStyle()	0	5	1
A	registerStyle()	0	4	1
A	applyExtraStylesIfNeeded()	0	6	1
A	applyWrapTextIfCellContainsNewLine()	0	12	4

<?php

namespace Box\Spout\Writer\Common\Manager\Style;

use Box\Spout\Writer\Common\Entity\Cell;
use Box\Spout\Writer\Common\Entity\Style\Style;

/**
 * Class StyleManager
 * Manages styles to be applied to a cell
 */
class StyleManager implements StyleManagerInterface
{
    /** @var StyleRegistry Registry for all used styles */
    protected $styleRegistry;

    /**
     * @param StyleRegistry $styleRegistry
     */
    public function __construct(StyleRegistry $styleRegistry)
    {
        $this->styleRegistry = $styleRegistry;
    }

    /**
     * Returns the default style
     *
     * @return Style Default style
     */
    protected function getDefaultStyle()
    {
        // By construction, the default style has ID 0
        return $this->styleRegistry->getRegisteredStyles()[0];
    }

    /**
     * Registers the given style as a used style.
     * Duplicate styles won't be registered more than once.
     *
     * @param Style $style The style to be registered
     * @return Style The registered style, updated with an internal ID.
     */
    public function registerStyle($style)
    {
        return $this->styleRegistry->registerStyle($style);
    }

    /**
     * Apply additional styles if the given row needs it.
     * Typically, set "wrap text" if a cell contains a new line.
     *
     * @param Cell $cell
     * @return Style
     */
    public function applyExtraStylesIfNeeded(Cell $cell)
    {
        $updatedStyle = $this->applyWrapTextIfCellContainsNewLine($cell);

        return $updatedStyle;
    }

    /**
     * Set the "wrap text" option if a cell of the given row contains a new line.
     *
     * @NOTE: There is a bug on the Mac version of Excel (2011 and below) where new lines
     *        are ignored even when the "wrap text" option is set. This only occurs with
     *        inline strings (shared strings do work fine).
     *        A workaround would be to encode "\n" as "_x000D_" but it does not work
     *        on the Windows version of Excel...
     *
     * @param Cell $cell The cell the style should be applied to
     * @return \Box\Spout\Writer\Common\Entity\Style\Style The eventually updated style
     */
    protected function applyWrapTextIfCellContainsNewLine(Cell $cell)
    {
        // if the "wrap text" option is already set, no-op
        if ($cell->getStyle()->hasSetWrapText()) {
            return $cell->getStyle();
        }
        if ($cell->isString() && strpos($cell->getValue(), "\n") !== false) {
            $cell->getStyle()->setShouldWrapText();
        }

        return $cell->getStyle();
    }
}