View source: [ raw ] [ highlight ]

View on GitHub open_in_new

Below is the content for the selected file.

Class: \District5\Mondoc\Db\Service\Traits\Aggregation\PercentileOfNumberFieldTrait

<?php
/**
 * District5 Mondoc Library
 *
 * @author      District5 <hello@district5.co.uk>
 * @copyright   District5 <hello@district5.co.uk>
 * @link        https://www.district5.co.uk
 *
 * MIT LICENSE
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

namespace District5\Mondoc\Db\Service\Traits\Aggregation;

use District5\Mondoc\Exception\MondocConfigConfigurationException;
use District5\Mondoc\Helper\FilterFormatter;
use MongoDB\Collection;
use MongoDB\Driver\Cursor;
use MongoDB\Model\BSONDocument;

/**
 * Trait PercentileOfNumberFieldTrait.
 *
 * @package District5\Mondoc\Db\Service\Traits\Aggregation
 */
trait PercentileOfNumberFieldTrait
{
    /**
     * Get the value of the X percentile of a $fieldName by a given filter. By default, the ordering is ascending (1),
     * but you can provide -1 to sort descending.
     *
     * @param string $fieldName
     * @param float $percentile
     * @param int $sortDirection (1 or -1)
     * @param array $filter
     *
     * @return null|float|int
     * @throws MondocConfigConfigurationException
     */
    public function getPercentile(string $fieldName, float $percentile, int $sortDirection = 1, array $filter = []): float|int|null
    {
        $collection = $this->service::getCollection($this->service);
        /* @var $collection Collection */
        $query = [
            [
                '$sort' => [
                    $fieldName => $sortDirection
                ]
            ],
            [
                '$group' => [
                    '_id' => null,
                    'doc' => [
                        '$first' => '$$ROOT'
                    ],
                    'values' => [
                        '$push' => '$' . $fieldName
                    ]
                ]
            ],
            [
                '$project' => [
                    $fieldName . 'Percentile' => [
                        '$arrayElemAt' => [
                            '$values',
                            [
                                '$floor' => [
                                    '$multiply' => [
                                        $percentile,
                                        [
                                            '$size' => '$values'
                                        ]
                                    ]
                                ]
                            ]
                        ]
                    ]
                ]
            ]
        ];
        if (!empty($filter)) {
            array_unshift(
                $query,
                [
                    '$match' => FilterFormatter::format($filter)
                ]
            );
        }
        $cursor = $collection->aggregate(
            array_values($query)
        );
        /* @var $cursor Cursor */
        $records = $cursor->toArray();
        /* @var $records BSONDocument[] */
        if (1 === count($records)) {
            $array = $records[0]->getArrayCopy();
            if (array_key_exists($fieldName . 'Percentile', $array)) {
                return $array[$fieldName . 'Percentile'];
            }
        }

        return null;
    }
}

Back to Mondoc sourcefast_rewind