Api

Version

mediamosa-30

Class

mediamosa_rest_call_ftp_batch_get

Code

File: /sites/all/modules/mediamosa/modules/ftp_batch/mediamosa_ftp_batch.rest.class.inc
<?php

/**
 * URI: /ftp_batch/$batch_id
 * Method: GET
 *
 * 1.x: vpx_ftp_batch_get
 *
 */
class mediamosa_rest_call_ftp_batch_get extends mediamosa_rest_call {
  // ------------------------------------------------------------------ Consts.
  // Rest vars;
  const BATCH_ID = 'batch_id';

  // ------------------------------------------------------------------ Public Functions.
  public function get_var_setup() {
    $a_var_setup = array();

    $a_var_setup = array(
      self::VARS => array(
        self::BATCH_ID => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_INT,
          self::VAR_DESCRIPTION => 'The ID of the batch.',
          self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
        ),
      )
    );

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

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

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

    $batch_id = $this->get_param_value(self::BATCH_ID);

    // Batch must exist.
    mediamosa_db::db_must_exists(mediamosa_ftp_batch_db::TABLE_NAME, array(mediamosa_ftp_batch_db::APP_ID => $app_id, mediamosa_ftp_batch_db::ID => $batch_id));

    // Get the batch.
    $row = mediamosa_ftp_batch::get($batch_id);

    // UTC -> App timezone.
    $row[mediamosa_ftp_batch_db::STARTED] = mediamosa::utcdate2appdate($row[mediamosa_ftp_batch_db::STARTED]);
    $row[mediamosa_ftp_batch_db::FINISHED] = mediamosa::utcdate2appdate($row[mediamosa_ftp_batch_db::FINISHED]);

    // Return the item.
    $o_mediamosa->add_item($row);
  }
}