Api

Version

mediamosa-30

Class

mediamosa_rest_call_asset_supplement_delete

Code

File: /sites/all/modules/mediamosa/modules/asset/supplement/mediamosa_asset_supplement.rest.class.inc
<?php

/**
 * URI: /asset/$asset_id/supplement/$supplement_id/delete
 *      /supplement/delete (FIXME: this (internal) URL should never would have worked under 1.x?)
 *      /supplement/$supplement_id/delete (deprecated)
 * Method: POST
 *
 * Update the asset supplement.
 *
 * 1.x media_management_delete_asset_supplement
 */
class mediamosa_rest_call_asset_supplement_delete extends mediamosa_rest_call {
  // ---------------------------------------------------------=--------- Consts.
  // Rest vars;
  const SUPPLEMENT_ID = 'supplement_id';
  const ASSET_ID = 'asset_id';
  const USER_ID = 'user_id';

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

    $var_setup = array(
      self::VARS => array(
        self::SUPPLEMENT_ID => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_SUPPLEMENT_ID,
          self::VAR_DESCRIPTION => 'The supplement ID.',
          self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
        ),
        self::USER_ID => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_USER_ID,
          self::VAR_DESCRIPTION => 'The user ID.',
          self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
        ),
        self::ASSET_ID => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_ASSET_ID,
          self::VAR_DESCRIPTION => 'The asset ID.',
          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() {
    $mediamosa = mediamosa::get();

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

    // Test webservice.
    mediamosa_webservice_app::webservice_must_be_active(mediamosa_webservice_app::HANDLE_MEDIA_MANAGEMENT, $app_ids);

    // Get args.
    $supplement_id = $this->get_param_value(self::SUPPLEMENT_ID);
    $user_id = $this->get_param_value(self::USER_ID);

    // Delete it.
    mediamosa_asset_supplement::delete($app_id, $user_id, $supplement_id);

    // Set ok.
    $mediamosa->set_result_okay();
  }
}