Overview

Namespaces

  • Apptus
    • ESales
      • Connector
        • Report
        • Time
    • Util
      • Cache
  • PHP
  • Overview
  • Namespace
  • Class
  • Tree
 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 
<?php
namespace Apptus\ESales\Connector;

/**
 * Represents a single element in a result having the values format.
 */
class Value {
    private $ticket = "-";
    private $text;
    private $count;
    private $relevance;
    private $selected;

    /**
     * @internal
     * @param string|null $ticket
     * @param string|null $text
     * @param int|null $count
     * @param float $relevance
     * @param bool $selected
     */
    public function __construct($ticket = null, $text = null, $count = 0, $relevance = 0.0, $selected = false) {
        $this->ticket = $ticket;
        $this->text = $text;
        $this->count = $count;
        $this->relevance = $relevance;
        $this->selected = $selected;
    }

    /**
     * Get the text of the value.
     *
     * @return string
     *            The text.
     */
    public function getText() {
        return $this->text;
    }

    /**
     * Get the relevance associated with this value.
     *
     * @deprecated No longer outputted by the server, except for test queries,
     * and will return 0.0.
     * @return float
     *            The relevance or 0.0.
     */
    public function getRelevance() {
        return $this->relevance;
    }

    /**
     * Get the product count associated with this value.
     *
     * @return int
     *            The product count.
     */
    public function getCount() {
        return $this->count;
    }

    /**
     * Returns a dummy-ticket.
     *
     * @deprecated This ticket is no longer needed. You can safely stop notifying
     * clicks on values.
     *
     * @return string
     *            A valid dummy-ticket.
     */
    public function getTicket() {
        return $this->ticket;
    }

    /**
     * Check if this value is a selected facet value.
     * 
     * @return boolean
     *            True if the value is a facet value that was included in the facets parameter to the panel.
     */
    public function isSelected()
    {
        return $this->selected;
    }

    public function __toString() {
        return $this->text . ' (' . $this->count . ')';
    }
}
Apptus ESales Connector PHP API documentation generated by ApiGen