RatingControl

EDIT: Plugin se nyní nalézá v extras

STARÝ POST:

Zdravím,

rád bych se chtěl ujistit, že tento návrh komponenty (i když malé) není špatný, co se týče implementace. Pokud ne, tak bych to dal do extras. Je to spíš proto abych měl jasno v tvoření komponent.

Jedná se o RatingControl, tedy jednoduchou komponentu, která zobrazí nějaké ty hvězdičky třebas pod článkem, nebo produktem, nebo v nějaké tabulce, s možností hlasovat o hodnocení:

RatingModel interface

Pro získání informací pro RatingControl (aktuální rating, počet hlasů, bylo hlasováno, …) a pro vložení nového ratingu:

$ratable může být cokoliv (předává se v šabloně, viz dále), z čeho programátor dostane ty informace, např. ID článku nebo samotný objekt článku:

$id je unikátní ID pro ten control (získaný přes getUniqueId)

interface IRatingModel
{
    public function wasVoted($id);
    public function getUniqueId($ratable);
    public function getRating($ratable);
    public function getVoteCount($ratable);
    public function addRating($id, $newRating);
}

Třída

Samotná třída je jednoduchá, pouze musíme nastavit model implementující IRatingControl. Teď koukám, že createTemplate by se měla ještě změnit (nemít tam ten hardcoded soubor s šablonou)

/**
 * RatingControl
 *
 * @author Radek Ježdík
 */
class RatingControl extends Control
{
    /**
     * Model interface instance for getting rating information
     * @var IRatingModel
     */
    private $model = null;

    /**
     * Number of stars, default 5 stars
     * @var int
     */
    private $total = 5;

    /**
     * Sets Rating Model, to get the information from
     * @param IRatingModel implementation
     */
    public function setRatingModel($model) {
        $this->model = $model;
    }

    /**
     * Set total number of stars
     * @param int
     */
    public function setTotal($stars) {
        $this->total = $stars;
    }

    /**
     * Rate signal, user voted
     * @param int unique ID of rating control
     * @param int new rating specified by user
     */
    public function handleRate($id, $newRating) {
        if($this->model->wasVoted($id))
            return;

        $newRating = max(1, (int)$newRating);
        $newRating = min($newRating, $this->total);

        $this->model->addRating($id, $newRating);
        $this->invalidateControl();
    }

    public function createTemplate() {
        $template = parent::createTemplate();
        $template->setFile(APP_DIR.'/controls/ratingControl.phtml');

        return $template;
    }

    /**
     * Renders the rating control
     *
     * @param mixed is passed to Rating Model methods
     */
    public function render($ratable)
    {
        if($this->model != null) {
            $this->template->total = $this->total;

            $this->template->id = $this->model->getUniqueId($ratable);
            $this->template->rating = round((float)$this->model->getRating($ratable));
            $this->template->voteCount = (int)$this->model->getVoteCount($ratable);
            $this->template->voted = $this->model->wasVoted($this->template->id);

            $stars = array();
            for($i=1; $i <= $this->total; $i++)
                $stars[$i] = (bool)($i <= $this->template->rating);
            $this->template->stars = $stars;

            $this->template->render();
        }
    }
}

Příklad šablony

{snippet $id}
	{foreach $stars as $i => $st}
        	{if !$voted}<a href="{link rate $id, $i}" class="ajax">{/if}
        		<button {attr class('rate-star') class('star-full', $st)}></button>
            	{if !$voted}</a>{/if}
       	{/foreach}
       	{if $voted}<small>thank you for voting!</small>{/if}
       	<div><small>({$voteCount} votes)</small></div>
{/snippet}

Příklad použití

implementace modelu, nechtělo se mi psát těla metod, neboť skoro všechny jen šahají do databáze.

class RatingControlModel implements IRatingModel
{
    public function wasVoted($id){
        //vrací bool, zda bylo tímto uživatelem hlasováno
    }
    public function getUniqueId($ratable) {
        //vrací unikátní ID, třeba ID produktu
    }
    public function getRating($ratable) {
        //vrací aktuální rating pro $ratable
    }
    public function getVoteCount($ratable) {
        //vrací int s počtem hlasování pro $ratable
    }
    public function addRating($id, $newRating) {
        //bylo hlasováno, uložení do session, do databáze, cokoliv...
	//vložení nového hlasování do databáze
    }
}

továrnička v presenteru:

	public function createComponentRating($name)
	{
	$rating = new RatingControl($this, $name);
	$rating->setRatingModel(new RatingControlModel());
		return $rating;
	}

šablona:

@{control rating $product}

nebo třeba pro nějaký výpis:

{foreach $products as $prod}
	@{control rating $prod}
{/foreach}

$product, resp. $prod v posledních dvou šablonách, může být objekt produktu, ten se pak předává v modelu jako $ratable (může to taky být třeba ID toho produktu {control rating $prod->id} ).

Doufám, že takovýto návrh použití stejného objektu komponenty, pro více různých použití, není špatným návrhem.

Díky za jakékoliv návrhy, připomínky.

Editoval redhead (4. 8. 2010 13:59)