Condorcet\ElectionProcess\VotesProcess

Complexity

Total Complexity

55

Size/Duplication

Total Lines	282
Duplicated Lines	11.7 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

90.83%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	ignoreMaxVote()	0	4	1
A	countVotes()	0	4	1
A	getVotesList()	0	4	1
A	getVotesListAsString()	0	4	1
A	getVotesManager()	0	3	1
A	getVoteKey()	0	3	1
A	addVote()	0	13	4
A	prepareModifyVote()	0	10	2
C	checkVoteCandidate()	0	30	11
A	registerVote()	0	16	2
B	removeVote()	0	30	4
A	prepareVoteInput()	0	11	3
D	jsonVotes()	0	32	10
C	parseVotes()	33	78	13

<?php
/*
    Condorcet PHP Class, with Schulze Methods and others !

    By Julien Boudry - MIT LICENSE (Please read LICENSE.txt)
    https://github.com/julien-boudry/Condorcet
*/
declare(strict_types=1);

namespace Condorcet\ElectionProcess;

use Condorcet\CondorcetException;
use Condorcet\CondorcetUtil;
use Condorcet\Vote;
use Condorcet\DataManager\VotesManager;

// Manage Results for Election class
trait VotesProcess
{

/////////// CONSTRUCTOR ///////////

    // Data and global options
    protected $_Votes; // Votes list
    protected $_ignoreStaticMaxVote = false;


    public function ignoreMaxVote (bool $state = true) : bool
    {
        return $this->_ignoreStaticMaxVote = $state;
    }


/////////// VOTES LIST ///////////

    // How many votes are registered ?
    public function countVotes ($tag = null, bool $with = true) : int
    {
        return $this->_Votes->countVotes(VoteUtil::tagsConvert($tag),$with);
    }

    // Get the votes registered list
    public function getVotesList ($tag = null, bool $with = true) : array
    {
        return $this->_Votes->getVotesList(VoteUtil::tagsConvert($tag), $with);
    }

    public function getVotesListAsString () : string
    {
        return $this->_Votes->getVotesListAsString();
    }

    public function getVotesManager () : VotesManager {
        return $this->_Votes;
    }

    public function getVoteKey (Vote $vote) {
        return $this->_Votes->getVoteKey($vote);
    }


/////////// ADD & REMOVE VOTE ///////////

    // Add a single vote. Array key is the rank, each candidate in a rank are separate by ',' It is not necessary to register the last rank.
    public function addVote ($vote, $tag = null) : Vote
    {
        $this->prepareVoteInput($vote, $tag);

        // Check Max Vote Count
        if ( self::$_maxVoteNumber !== null && !$this->_ignoreStaticMaxVote && $this->countVotes() >= self::$_maxVoteNumber ) :
            throw new CondorcetException(16, self::$_maxVoteNumber);
        endif;


        // Register vote
        return $this->registerVote($vote, $tag); // Return the vote object
    }

    // return True or throw an Exception
    public function prepareModifyVote (Vote $existVote)
    {
        try {
            $this->prepareVoteInput($existVote);
            $this->setStateToVote();

It seems like setStateToVote() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
        catch (\Exception $e) {
            throw $e;
        }
    }

    public function checkVoteCandidate (Vote $vote) : bool
    {
        $linkCount = $vote->countLinks();
        $links = $vote->getLinks();

        $mirror = $vote->getRanking();
        $change = false;
        foreach ($vote as $rank => $choice) :
            foreach ($choice as $choiceKey => $candidate) :
                if ( !$this->existCandidateId($candidate, true) ) :

It seems like existCandidateId() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    if ($candidate->getProvisionalState() && $this->existCandidateId($candidate, false)) :

It seems like existCandidateId() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                        if ( $linkCount === 0 || ($linkCount === 1 && reset($links) === $this) ) :
                            $mirror[$rank][$choiceKey] = $this->_Candidates[$this->getCandidateKey((string) $candidate)];

The property _Candidates does not exist. Did you maybe forget to declare it?

It seems like getCandidateKey() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                            $change = true;
                        else :
                            return false;
                        endif;
                    endif;
                endif;
            endforeach;
        endforeach;

        if ($change) :
            $vote->setRanking(  $mirror,
                                ( abs($vote->getTimestamp() - microtime(true)) > 0.5 ) ? ($vote->getTimestamp() + 0.001) : null
            );
        endif;

        return true;
    }

    // Write a new vote
    protected function registerVote (Vote $vote, $tag = null) : Vote
    {
        // Vote identifiant
        $vote->addTags($tag);
        
        // Register
        try {
            $vote->registerLink($this);
            $this->_Votes[] = $vote;
        } catch (CondorcetException $e) {
            // Security : Check if vote object not already register
            throw new CondorcetException(6,'Vote object already registred');
        }

        return $vote;
    }

    public function removeVote ($in, bool $with = true) : array
    {    
        $rem = [];

        if ($in instanceof Vote) :
            $key = $this->getVoteKey($in);
            if ($key !== false) :
                $this->_Votes[$key]->destroyLink($this);

                $rem[] = $this->_Votes[$key];

                unset($this->_Votes[$key]);
            endif;
        else :
            // Prepare Tags
            $tag = VoteUtil::tagsConvert($in);

            // Deleting
            foreach ($this->getVotesList($tag, $with) as $key => $value) :
                $this->_Votes[$key]->destroyLink($this);

                $rem[] = $this->_Votes[$key];

                unset($this->_Votes[$key]);
            endforeach;

        endif;

        return $rem;
    }


/////////// PARSE VOTE ///////////

    // Return the well formated vote to use.
    protected function prepareVoteInput (&$vote, $tag = null) : void
    {
        if (!($vote instanceof Vote)) :
            $vote = new Vote ($vote, $tag);
        endif;

        // Check array format && Make checkVoteCandidate
        if ( !$this->checkVoteCandidate($vote) ) :
            throw new CondorcetException(5);
        endif;
    }

    public function jsonVotes (string $input)
    {
        $input = CondorcetUtil::prepareJson($input);
        if ($input === false) :
            return $input;
        endif;

            //////

        $adding = [];

        foreach ($input as $record) :
            if (empty($record['vote'])) :
                continue;
            endif;

            $tags = (!isset($record['tag'])) ? null : $record['tag'];
            $multi = (!isset($record['multi'])) ? 1 : $record['multi'];

            for ($i = 0; $i < $multi; $i++) :
                if (self::$_maxParseIteration !== null && $this->countVotes() >= self::$_maxParseIteration) :
                    throw new CondorcetException(12, self::$_maxParseIteration);
                endif;

                try {
                    $adding[] = $this->addVote($record['vote'], $tags);
                } catch (\Exception $e) {}

Consider adding a comment why this CATCH block is empty.

            endfor;
        endforeach;

        return $adding;
    }

    public function parseVotes (string $input, bool $allowFile = true)
    {
        $input = CondorcetUtil::prepareParse($input, $allowFile);
        if ($input === false) :
            return $input;
        endif;

        // Check each lines
        $adding = [];
        foreach ($input as $line) :
            // Empty Line
            if (empty($line)) :
                continue;
            endif;

            // Multiples
            $is_multiple = mb_strpos($line, '*');
            if ($is_multiple !== false) :

This code seems to be duplicated across your project.

                $multiple = trim( substr($line, $is_multiple + 1) );

                // Errors
                if ( !is_numeric($multiple) ) :
                    throw new CondorcetException(13, null);
                endif;

                $multiple = intval($multiple);

                // Reformat line
                $line = substr($line, 0, $is_multiple);
            else :
                $multiple = 1;
            endif;

            // Vote Weight
            $is_voteWeight = mb_strpos($line, '^');
            if ($is_voteWeight !== false) :

This code seems to be duplicated across your project.

                $weight = trim( substr($line, $is_voteWeight + 1) );

                // Errors
                if ( !is_numeric($weight) ) :
                    throw new CondorcetException(13, null);
                endif;

                $weight = intval($weight);

                // Reformat line
                $line = substr($line, 0, $is_voteWeight);
            else :
                $weight = 1;
            endif;

            // Tags + vote
            if (mb_strpos($line, '||') !== false) :
                $data = explode('||', $line);

                $vote = $data[1];
                $tags = $data[0];
            // Vote without tags
            else :
                $vote = $line;
                $tags = null;
            endif;

            // addVote
            for ($i = 0; $i < $multiple; $i++) :
                if (self::$_maxParseIteration !== null && count($adding) >= self::$_maxParseIteration) :

This code seems to be duplicated across your project.

                    throw new CondorcetException(12, self::$_maxParseIteration);
                endif;

                try {
                    $adding[] = ($newVote = $this->addVote($vote, $tags));
                    $newVote->setWeight($weight);
                } catch (CondorcetException $e) {}

Consider adding a comment why this CATCH block is empty.

            endfor;
        endforeach;

        return $adding;
    }

}