CodiceFiscale\Calculator

Complexity

Total Complexity

21

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	calculate()	0	8	1
A	calculateSmallString()	0	8	1
A	calculateBelfioreCode()	0	4	1
A	cleanString()	0	4	1
A	__construct()	0	8	2
A	calculateAllPossibilities()	0	10	2
A	calculateSurname()	0	12	2
A	calculateName()	0	14	3
A	calculateBirthDateAndGender()	0	11	2
A	calculateOmocodia()	0	16	3
A	calculateOmocodiaSection()	0	9	3

<?php

namespace CodiceFiscale;

/**
 * Codice Fiscale calculator.
 *
 * @author davidepastore
 */
class Calculator extends AbstractCalculator
{
    private $subject;
    private $omocodiaLevel = 0;

    /**
     * Array of available vowels.
     */
    private $vowels = array('A', 'E', 'I', 'O', 'U');

    /**
     * Create a Codice Fiscale instance.
     *
     * @param Subject $subject The subject that will have the codice fiscale.
     * @param $properties An array with additional properties.
     */
    public function __construct(Subject $subject, $properties = array())
    {
        $this->subject = $subject;

        if (array_key_exists('omocodiaLevel', $properties)) {
            $this->omocodiaLevel = $properties['omocodiaLevel'];
        }
    }

    /**
     * Calculate the code fiscale.
     *
     * @returns Returns the complete codice fiscale.
     */
    public function calculate()
    {
        $temporaryCodiceFiscale = $this->calculateSurname().$this->calculateName().
               $this->calculateBirthDateAndGender().$this->calculateBelfioreCode();
        $temporaryCodiceFiscale = $this->calculateOmocodia($temporaryCodiceFiscale);

        return $temporaryCodiceFiscale.$this->calculateCheckDigit($temporaryCodiceFiscale);
    }

    /**
     * Calculate all possibilities for the code fiscale.
     *
     * @returns Returns the complete codice fiscale.
     */
    public function calculateAllPossibilities()
    {
        $allPossibilities = array();
        for ($i = 0; $i < 128; ++$i) {
            $this->omocodiaLevel = $i;
            $allPossibilities[] = $this->calculate();
        }

        return $allPossibilities;
    }

    /**
     * Calculate the surname part of the codice fiscale.
     *
     * @returns Returns the surname part of the codice fiscale.
     */
    private function calculateSurname()
    {
        $consonants = str_replace($this->vowels, '', strtoupper($this->subject->getSurname()));
        $consonants = $this->cleanString($consonants);
        if (strlen($consonants) > 2) {
            $result = substr($consonants, 0, 3);
        } else {
            $result = $this->calculateSmallString($consonants, $this->subject->getSurname());
        }

        return $result;
    }

    /**
     * Calculate the name part of the codice fiscale.
     *
     * @returns Returns the name part of the codice fiscale.
     */
    private function calculateName()
    {
        $consonants = str_replace($this->vowels, '', strtoupper($this->subject->getName()));
        $consonants = $this->cleanString($consonants);
        if (strlen($consonants) > 3) {
            $result = $consonants[0].$consonants[2].$consonants[3];
        } elseif (strlen($consonants) == 3) {
            $result = $consonants;
        } else {
            $result = $this->calculateSmallString($consonants, $this->subject->getName());
        }

        return $result;
    }

    /**
     * Calculate small string for the given parameters (used by name and surname).
     *
     * @param $consonants A consonants string.
     * @param $string The small string.
     * @returns Returns the calculated result for the small string.
     */
    private function calculateSmallString($consonants, $string)
    {
        $string = $this->cleanString($string);
        $vowels = str_replace(str_split($consonants), '', strtoupper($string));
        $result = substr($consonants.$vowels.'XXX', 0, 3);

        return $result;
    }

    /**
     * Calculate the birth date and the gender.
     *
     * @returns Returns the birth date and gender part of the codice fiscale.
     */
    private function calculateBirthDateAndGender()
    {
        $year = $this->subject->getBirthDate()->format('y');
        $month = $this->months[$this->subject->getBirthDate()->format('n')];
        $day = $this->subject->getBirthDate()->format('d');
        if (strtoupper($this->subject->getGender()) == self::CHR_WOMEN) {
            $day += 40;
        }

        return $year.$month.$day;
    }

    /**
     * Calculate the Belfiore code.
     *
     * @returns Returns the Belfiore code.
     */
    private function calculateBelfioreCode()
    {
        return strtoupper($this->subject->getBelfioreCode());
    }

    /**
     * Calculate the omocodia case (additional translation).
     *
     * @param $temporaryCodiceFiscale The first part of the codice fiscale.
     * @returns Returns the new codice fiscale.
     */
    private function calculateOmocodia($temporaryCodiceFiscale)
    {
        if ($this->omocodiaLevel > 0) {
            if ($this->omocodiaLevel) {
                $temporaryCodiceFiscale = $this->calculateOmocodiaSection(2, $temporaryCodiceFiscale, 1, 1, 14);
                $temporaryCodiceFiscale = $this->calculateOmocodiaSection(4, $temporaryCodiceFiscale, 2, 3, 13);
                $temporaryCodiceFiscale = $this->calculateOmocodiaSection(8, $temporaryCodiceFiscale, 4, 7, 12);
                $temporaryCodiceFiscale = $this->calculateOmocodiaSection(16, $temporaryCodiceFiscale, 8, 15, 10);
                $temporaryCodiceFiscale = $this->calculateOmocodiaSection(32, $temporaryCodiceFiscale, 16, 31, 9);
                $temporaryCodiceFiscale = $this->calculateOmocodiaSection(64, $temporaryCodiceFiscale, 32, 63, 7);
                $temporaryCodiceFiscale = $this->calculateOmocodiaSection(128, $temporaryCodiceFiscale, 64, 127, 6);
            }
        }

        return $temporaryCodiceFiscale;
    }

    /**
     * Calculate a section of the omocodia.
     *
     * @param $divider The divider.
     * @param $temporaryCodiceFiscale The first part of the codice fiscale on which make the substitutions.
     * @param $startingIndex The starting index.
     * @param $endingIndex The ending index.
     * @param $characterIndex The index to use to make the substitutions on the $temporaryCodiceFiscale.
     * @returns Returns the temporary codice fiscale with the substitutions made.
     */
    private function calculateOmocodiaSection($divider, $temporaryCodiceFiscale, $startingIndex, $endingIndex, $characterIndex)
    {
        if ($this->omocodiaLevel % $divider >= $startingIndex && $this->omocodiaLevel % $divider <= $endingIndex) {
            $k = $temporaryCodiceFiscale{$characterIndex};
            $newChar = $this->omocodiaCodes[$k];
            $temporaryCodiceFiscale{$characterIndex} = $newChar;
        }
        return $temporaryCodiceFiscale;
    }

    /**
     * Clean the string removing some characters.
     *
     * @param $string The string to clean.
     * @returns Returns a clean string.
     */
    private function cleanString($string)
    {
        return preg_replace('/[\s\'"`]+/', '', $string);
    }
}