Source of file ModuleRatingSortalgoInterface.php

Size: 1,282 Bytes - Last Modified: 2016-05-18T03:08:27+02:00

buildproject/core/module_rating/system/ModuleRatingSortalgoInterface.php

12345678910111213141516171819202122232425262728293031323334353637383940
<?php
/*"******************************************************************************************************
*   (c) 2004-2006 by MulchProductions, www.mulchprod.de                                                 *
*   (c) 2007-2016 by Kajona, www.kajona.de                                                              *
*       Published under the GNU LGPL v2.1, see /system/licence_lgpl.txt                                 *
*-------------------------------------------------------------------------------------------------------*
*   $Id$                         *
********************************************************************************************************/

namespace Kajona\Rating\System;


/**
 * Interface to be implemented by all rating-sort-algorithms designed to calculate the lists
 *
 * @package module_rating
 */
interface ModuleRatingSortalgoInterface
{

    /**
     * Sets an array of elements to be sorted.
     * Elements have to be an instance of SortableRatingInterface.
     *
     * @param array $arrElements
     *
     * @return void
     */
    public function setElementsArray($arrElements);

    /**
     * Does the sorting and returns the sorted array of elements.
     *
     * @return array
     */
    public function doSorting();


}