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: 
<?php
namespace Apptus\ESales\Connector;

/**
 * Represents a single element in a result having the completions format.
 */
class Completion {
    private $ticket;
    private $text;
    private $rank;
    private $relevance;

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

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

    /**
     * Get the notification ticket of this completion.
     *
     * @return string
     *            The ticket.
     */
    public function getTicket() {
        return $this->ticket;
    }

    /**
     * Get the rank of this completion.
     *
     * @return int
     *            The rank.
     */
    public function getRank() {
        return $this->rank;
    }

    /**
     * Get the relevance of this completion.
     *
     * @return float
     *            The relevance.
     */
    public function getRelevance() {
        return $this->relevance;
    }

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