Api

Version

mediamosa-23

Class

mediamosa_rest_call_collection_delete

Code

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

/**
 * URI: /collection/$coll_id/delete
 * Method: POST
 *
 * 1.x: media_management_delete_collection
 */
class mediamosa_rest_call_collection_delete extends mediamosa_rest_call {
  // ------------------------------------------------------------------ Consts.
  // Rest vars;
  const COLL_ID = 'coll_id';
  const USER_ID = 'user_id';
  const DELETE = 'delete';

  // ------------------------------------------------------- Functions (public).
  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.',
          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::DELETE => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_STRING,
          self::VAR_DESCRIPTION => 'Delete mode. Use this parameter with value \'cascade\' to delete *all* of the underlying items: assets with metadata, mediafiles, stills.

The collection is deleted only if all underlying assets successfully removed.',
          self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_NO,
          self::VAR_ALLOWED_VALUES => array('', 'cascade'),
          self::VAR_DEFAULT_VALUE => '',
        ),
      ),
    );

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

  public function do_call() {
    $o_mediamosa = mediamosa::get();

    $app_ids = $this->get_param_value_app();
    $app_id = reset($app_ids);
    $is_app_admin = $this->get_param_value(self::IS_APP_ADMIN);

    $coll_id = $this->get_param_value(self::COLL_ID);
    $user_id = $this->get_param_value(self::USER_ID);
    $delete = $this->get_param_value(self::DELETE);

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

    // Collection must exist.
    $collection = mediamosa_collection::must_exists($coll_id);

    // Must be owner / app_admin to update.
    mediamosa_aut::owner_check($app_id, $user_id, $collection[mediamosa_collection_db::APP_ID], $collection[mediamosa_collection_db::OWNER_ID], $is_app_admin);

    // Count the links between this collection and possible assets.
    $asset_ids = mediamosa_db::db_query(
      'SELECT #asset_id FROM {#mediamosa_asset_collection} WHERE #coll_id = :coll_id',
      array(
        '#asset_id' => mediamosa_asset_collection_db::ASSET_ID,
        '#mediamosa_asset_collection' => mediamosa_asset_collection_db::TABLE_NAME,
        '#coll_id' => mediamosa_asset_collection_db::COLL_ID,
        ':coll_id' => $coll_id
      )
    )->fetchCol();

    // Check if there are assets in our collection.
    if (count($asset_ids)) {
      if ($delete != 'cascade') {
        throw new mediamosa_exception_error(mediamosa_error::ERRORCODE_COLLECTION_NOT_EMPTY, array('@asset_count' => count($asset_ids)));
      }

      foreach ($asset_ids as $asset_id) {
        $result = mediamosa_response::SUCCESS;
        $result_id = mediamosa_error::ERRORCODE_OKAY;
        $result_description = mediamosa_error::error_code_find_description(mediamosa_error::ERRORCODE_OKAY);

        try {
          mediamosa_asset::delete($asset_id, TRUE);
        }
        catch (mediamosa_exception $e) {
          $result = mediamosa_response::ERROR;
          $result_id = $e->getCode();
          $result_description = $e->getMessage();
        }

        // Add result of asset deletion.
        $o_mediamosa->add_item(
          array(
            'asset_id' => $asset_id,
            'result' => $result,
            'result_id' => $result_id,
            'result_description' => $result_description
          )
        );
      }

      // Now count if any assets are still left in collection.
      $count_assets_in_collection = mediamosa_db::db_count_rows(mediamosa_asset_collection_db::TABLE_NAME, array(mediamosa_asset_collection_db::COLL_ID => $coll_id));
      if ($count_assets_in_collection) {
        throw new mediamosa_exception_error(mediamosa_error::ERRORCODE_COLLECTION_NOT_EMPTY, array('@asset_count' => $count_assets_in_collection));
      }

      // Now delete the collection.
      mediamosa_collection::delete($coll_id);

      // All ok.
      $o_mediamosa->set_result_okay();
    }
    else {
      // Now delete the collection.
      mediamosa_collection::delete($coll_id);

      // All ok.
      $o_mediamosa->set_result_okay();
    }
  }
}