ExtendedStrings\Strings\Instrument\InstrumentBase

Complexity

Total Complexity

5

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	3
	getDefaultNames()	0	1	?
	getDefaultStopLength()	0	1	?
A	getStringFrequencies()	0	4	1
A	getStopLength()	0	4	1

<?php

declare(strict_types = 1);

namespace ExtendedStrings\Strings\Instrument;

use ExtendedStrings\Strings\Note;

abstract class InstrumentBase implements InstrumentInterface
{
    protected $defaultStopLength;

    private $stringFrequencies = [];
    private $stopLength;

    /**
     * Violin constructor.
     *
     * @param array|null $stringFrequencies
     * @param float      $stopLength
     */
    public function __construct(array $stringFrequencies = null, float $stopLength = null)
    {
        if (null === $stringFrequencies) {
            $stringFrequencies = array_map(function ($name) {
                return Note::fromName($name)->getFrequency();
            }, $this->getDefaultNames());
        }
        if (null === $stopLength) {
            $stopLength = $this->getDefaultStopLength();
        }

        $this->stringFrequencies = $stringFrequencies;
        $this->stopLength = $stopLength;
    }

    /**
     * @return string[] The default strings of the instrument, as note names
     *                  (e.g. 'A4', 'D3').
     */
    abstract protected function getDefaultNames(): array;

    /**
     * @return float The default stop length of the instrument (mm).
     */
    abstract protected function getDefaultStopLength(): float;

    /**
     * {@inheritdoc}
     */
    public function getStringFrequencies(): array
    {
        return $this->stringFrequencies;
    }

    /**
     * {@inheritdoc}
     */
    public function getStopLength(): float
    {
        return $this->stopLength;
    }
}