Api

Version

mediamosa-30

Class

mediamosa_rest_call_statistics_get_most_popular_words

Code

File: /sites/all/modules/mediamosa/modules/statistics/mediamosa_statistics.rest.class.inc
<?php

/**
 * URI: /statistics/mostsearchedwords
 *      /statistics/searchedwords
 *
 * Method: GET
 *
 * 1.x: vpx_statistics_get_most_popular_words
 *
 */
class mediamosa_rest_call_statistics_get_most_popular_words extends mediamosa_rest_call {
  // ------------------------------------------------------------------ Consts.
  // Rest vars;
  const BEGINDATE = 'begindate';
  const ENDDATE = 'enddate';

  // ------------------------------------------------------------------ Get Var Setup.
  public function get_var_setup() {
    $var_setup = array();

    $var_setup = array(
      self::VARS => array(
        self::BEGINDATE => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_DATETIME,
          self::VAR_DESCRIPTION => 'Begin date of the period.',
          self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
        ),
        self::ENDDATE => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_DATETIME,
          self::VAR_DESCRIPTION => 'End date of the period.',
        ),
      )
    );

    // Enrich with limit, offset.
    $var_setup = self::get_var_setup_range($var_setup, mediamosa_settings::LIMIT_MAX, mediamosa_settings::LIMIT_DEFAULT_STATISTICS);

    // Enrich with order by.
    $var_setup = self::get_var_setup_order_by($var_setup, '', array(), mediamosa_type::ORDER_DIRECTION_DESC);

    // Enrich with required REST vars.
    return self::get_var_setup_default($var_setup, FALSE);
  }

  // ------------------------------------------------------------------ Do Call.
  public function do_call() {
    $o_mediamosa = mediamosa::get();

    $app_ids = $this->get_param_value_app();
    $app_id = reset($app_ids);

    $order_by = $this->get_param_value_order_by();
    $order_direction = $this->get_param_value_order_direction();
    $limit = $this->get_param_value_limit();
    $offset =  $this->get_param_value_offset();

    $begindate = $this->get_param_value(self::BEGINDATE);
    $enddate = $this->get_param_value(self::ENDDATE);

    // Allowed Order By List
    $a_order_by = array(
      'app_id' => array('column' => 'app_id'),
      'word' => array('column' => 'keyword'),
      'count' => array('column' => 'count'),
    );

    if (!isset($a_order_by[$order_by])) {
      $order_by = 'count';
    }

    $a_query = array();
    $a_query[mediamosa_db_query::A_FROM][] = '{mediamosa_statistics_search_request}';

    // Select this
    $a_query[mediamosa_db_query::A_SELECT_EXPR][] = 'keyword AS word';
    $a_query[mediamosa_db_query::A_SELECT_EXPR][] = 'COUNT(keyword) AS count';

    $a_query[mediamosa_db_query::A_WHERE][] = sprintf("searched >= '%s'", $begindate);
    if (!is_null($enddate)) {
      $a_query[mediamosa_db_query::A_WHERE][] = sprintf("searched < '%s'", $enddate);
    }
    elseif (!is_null($enddate)) {
      $a_query[mediamosa_db_query::A_WHERE][] = sprintf("searched < DATE_ADD('%s', INTERVAL 1 MONTH)", $begindate);
    }

    $a_query[mediamosa_db_query::A_GROUP_BY][] = 'keyword';

    // Order by....
    $a_query[mediamosa_db_query::A_ORDER_BY][] = $a_order_by[$order_by]['column'] . ' ' . $order_direction;

    // Limit...
    $a_query[mediamosa_db_query::LIMIT] = $limit;

     // Offset...
    $a_query[mediamosa_db_query::OFFSET] = $offset;

    // Do query.
    $query = mediamosa_db_query::query_select($a_query, array(mediamosa_db_query::SQL_CALC_FOUND_ROWS => TRUE));

    $result = mediamosa_db::db_query($query);

    // Set total.
    $o_mediamosa->item_count_total = mediamosa_db_query::found_rows();

    // Fill items.
    foreach ($result as $row) {
      $o_mediamosa->add_item($row);
    }
  }
}