Api

Version

mediamosa-30

Class

mediamosa_rest_call_asset_metadata_property_delete

Code

File: /sites/all/modules/mediamosa/modules/asset/metadata/property/mediamosa_asset_metadata_property.rest.class.inc
<?php

/**
 * URI: /metadata_tag/delete
 * Delete a asset metadata property.
 *
 * 1.x: media_management_metadata_definition_delete
 */
class mediamosa_rest_call_asset_metadata_property_delete extends mediamosa_rest_call {

  // ------------------------------------------------------------------ Consts.
  // Rest vars;
  const NAME = 'name'; // Enter property name.
  const DELETE = 'delete';

  // ------------------------------------------------------------------ Get Var Setup.
  public function get_var_setup() {
    $a_var_setup = array(
      mediamosa_rest_call::VARS => array(
        self::NAME => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_ALPHA_NUM_UNDERSCORE,
          self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
          self::DESCRIPTION => 'The name of the property to delete.',
          self::VAR_RANGE_END => mediamosa_asset_metadata_property_db::NAME_LENGTH,
        ),
        self::DELETE => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_STRING,
          self::VAR_ALLOWED_VALUES => array('cascade', ''),
          self::DESCRIPTION => "Specify as 'cascade' to delete all metadata as well. Deletion will fail if you try to delete an property that still has metadata.",
        ),
      ),
    );

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

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

    // Get the app_id.
    $app_ids = $this->get_param_value_app();
    $app_id = reset($app_ids);

    // Name of the new property.
    $name = $this->get_param_value(self::NAME);

    // Type of the new property.
    $delete = $this->get_param_value(self::DELETE);

    // Create the property. Any problems will throw exception.
    mediamosa_asset_metadata_property::property_delete($app_id, $name, $delete);

    // If we get here, it was successful. We have no output, but we are ok.
    $mediamosa->set_result_okay();
  }
}