phpOMS/Business/Marketing/NetPromoterScore.php

<?php
/**
 * Jingga
 *
 * PHP Version 8.1
 *
 * @package   phpOMS\Business\Marketing
 * @copyright Dennis Eichhorn
 * @license   OMS License 2.0
 * @version   1.0.0
 * @link      https://jingga.app
 */
declare(strict_types=1);

namespace phpOMS\Business\Marketing;

/**
 * Net Promoter Score
 *
 * The net promoter score is a basic evaluation of the happiness of customers.
 * Instead of customers the NPS can also be transferred to non-customers.
 *
 * @package phpOMS\Business\Marketing
 * @license OMS License 2.0
 * @link    https://jingga.app
 * @since   1.0.0
 */
final class NetPromoterScore
{
    /**
     * Score values
     *
     * @var int[]
     * @since 1.0.0
     */
    private array $scores = [];

    /**
     * Add score.
     *
     * @param int $score Net promoter score
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function add(int $score) : void
    {
        $this->scores[] = $score;
    }

    /**
     * Get total NPS.
     *
     * Values of > 0 are considered good and above 50 is considered excellent.
     * Remark: Amazon had a NPS of 69 in NA in 2016
     *
     * @latex NPS = Promoters - Detractors
     *
     * @return int Retunrs the NPS
     *
     * @since 1.0.0
     */
    public function getScore() : int
    {
        $promoters  = 0;
        $passives   = 0;
        $detractors = 0;

        foreach ($this->scores as $score) {
            if ($score > 8) {
                ++$promoters;
            } elseif ($score > 6) {
                ++$passives;
            } else {
                ++$detractors;
            }
        }

        $total = $promoters + $passives + $detractors;

        return $total === 0 ? 0 : ((int) ($promoters * 100 / $total)) - ((int) ($detractors * 100 / $total));
    }

    /**
     * Count detractors
     *
     * Detractors are all ratings below 7.
     *
     * @return int Returns the amount of detractors (>= 0)
     *
     * @since 1.0.0
     */
    public function countDetractors() : int
    {
        $count = 0;
        foreach ($this->scores as $score) {
            if ($score < 7) {
                ++$count;
            }
        }

        return $count;
    }

    /**
     * Count passives
     *
     * Passives are all ratings between 7 and 8 (inclusive)
     *
     * @return int Returns the amount of passives (>= 0)
     *
     * @since 1.0.0
     */
    public function countPassives() : int
    {
        $count = 0;
        foreach ($this->scores as $score) {
            if ($score > 6 && $score < 9) {
                ++$count;
            }
        }

        return $count;
    }

    /**
     * Count promoters
     *
     * Promoters are all ratings larger 8
     *
     * @return int Returns the amount of promoters (>= 0)
     *
     * @since 1.0.0
     */
    public function countPromoters() : int
    {
        $count = 0;
        foreach ($this->scores as $score) {
            if ($score > 8) {
                ++$count;
            }
        }

        return $count;
    }
}