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

/**
 * Represents a result having the completions format.
 */
class Completions implements Result, \Countable, \IteratorAggregate {
    private $completions;

    /**
     * @internal
     * @param array $completions
     */
    public function __construct(array $completions = array ()) {
        $this->completions = $completions;
    }

    /**
     * Get the number of completions found.
     *
     * @return int
     *            The number of completions.
     */
    public function count() {
        return count($this->completions);
    }

    /**
     * Check if this result is empty.
     *
     * @return boolean
     *            True if there are no completions, otherwise false.
     */
    public function isEmpty() {
        return count($this->completions) === 0;
    }

    /**
     * Get a list of the completions.
     *
     * @return Completion[]
     *            The list of completions.
     */
    public function getCompletions() {
        return $this->completions;
    }

    public function getIterator() {
        return new \ArrayIterator($this->completions);
    }

    public function getType() {
        return ResultType::COMPLETIONS;
    }

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