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:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 
<?php
namespace Apptus\ESales\Connector\Report;

/**
 * A class that holds data for a {@see SessionStatisticsReport}.
 */
class SessionStatistics {
    private $purchases = 0;
    private $visits = 0;
    private $purchasesFromRecommendations = 0;
    private $recommendationDisplays = 0;
    private $searches = 0;
    private $recommendationClicks = 0;
    private $abandonedCarts = 0;
    private $purchasesFromSearches = 0;

    /**
     * @return int|float
     *            The number of visits that has resulted in at least one order.
     */
    public function purchases() {
        return $this->purchases;
    }

    /**
     * @internal
     * @param string
     */
    function addToPurchases($purchases) {
        $this->purchases += $purchases;
    }

    /**
     * @return int|float
     *            The number of visits. Each session counts as one visit.
     */
    public function visits() {
        return $this->visits;
    }

    /**
     * @internal
     * @param string
     */
    function addToVisits($visits) {
        $this->visits += $visits;
    }

    /**
     * @return int|float
     *            The number of visits that has resulted in a payment from a recommendation panel.
     *            This includes payments on products that has been added to cart from a recommendation panel.
     */
    public function purchasesFromRecommendations() {
        return $this->purchasesFromRecommendations;
    }

    /**
     * @internal
     * @param string
     */
    function addToPurchasesFromRecommendations($purchasesFromRecommendations) {
        $this->purchasesFromRecommendations += $purchasesFromRecommendations;
    }

    /**
     * @return int|float
     *            The number of visits where a recommendation panel has been displayed.
     */
    public function recommendationDisplays() {
        return $this->recommendationDisplays;
    }

    /**
     * @internal
     * @param string
     */
    function addToRecommendationDisplays($recommendationDisplays) {
        $this->recommendationDisplays += $recommendationDisplays;
    }

    /**
     * @return int|float
     *            The number of visits where a search panel has been displayed.
     */
    public function searches() {
        return $this->searches;
    }

    /**
     * @internal
     * @param string
     */
    function addToSearches($searches) {
        $this->searches += $searches;
    }

    /**
     * @return int|float
     *            The number of visits where a recommendation panel has been clicked on.
     */
    public function recommendationClicks() {
        return $this->recommendationClicks;
    }

    /**
     * @internal
     * @param string
     */
    function addToRecommendationClicks($recommendationClicks) {
        $this->recommendationClicks += $recommendationClicks;
    }

    /**
     * @return int|float
     *            The number of visits that has ended with products left in the shopping cart.
     */
    public function abandonedCarts() {
        return $this->abandonedCarts;
    }

    /**
     * @internal
     * @param string
     */
    function addToAbandonedCarts($abandonedCarts) {
        $this->abandonedCarts += $abandonedCarts;
    }

    /**
     * @return int|float
     *            The number of visits that has resulted in a payment from a search panel.
     *            This includes payments on products that has been added to cart from a search panel.
     */
    public function purchasesFromSearches() {
        return $this->purchasesFromSearches;
    }

    /**
     * @internal
     * @param string
     */
    function addToPurchasesFromSearches($purchasesFromSearches) {
        $this->purchasesFromSearches += $purchasesFromSearches;
    }

    public function __toString() {
        return 'SessionStatistics{' .
               'purchases=' . $this->purchases .
               ', visits=' . $this->visits .
               ', purchasesFromRecommendations=' . $this->purchasesFromRecommendations .
               ', recommendationDisplays=' . $this->recommendationDisplays .
               ', searches=' . $this->searches .
               ', recommendationClicks=' . $this->recommendationClicks .
               ', abandonedCarts=' . $this->abandonedCarts .
               ', purchasesFromSearches=' . $this->purchasesFromSearches .
               '}';
    }
}
Apptus ESales Connector PHP API documentation generated by ApiGen