Api

Version

mediamosa-30

Class

mediamosa_rest_call_collection_favorites_count

Code

File: /sites/all/modules/mediamosa/modules/collection/mediamosa_collection.rest.class.inc
<?php

/**
 * URI: /collection/$coll_id/favorites/count
 *      /collection/$coll_id/count_favorites (deprecated)
 * Method: GET
 *
 * 1.x: media_management_favorites_count_collection
 */
class mediamosa_rest_call_collection_favorites_count extends mediamosa_rest_call {
  // ------------------------------------------------------------------ Consts.
  // Rest vars;
  const COLL_ID = 'coll_id';
  const FAV_TYPE= 'fav_type';

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

    $var_setup = array(
      self::VARS => array(
        self::COLL_ID => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_COLLECTION_ID,
          self::VAR_DESCRIPTION => 'The collection ID to find its favorites.',
          self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
        ),
      ),
    );

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

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

    $collection_id = $this->get_param_value(self::COLL_ID);

    // FIXME:
    // Any app can get any count from any asset.... behavor copied from 1.x.

    // Set total count.
    $o_mediamosa->item_count_total = mediamosa_user_favorite::count_items(mediamosa_user_favorite_db::FAV_TYPE_COLLECTION, $collection_id);

    $o_mediamosa->set_result_okay();
  }
}