Api

Version

mediamosa-30

Class

mediamosa_rest_call_job_analyse_mediafile

Code

File: /sites/all/modules/mediamosa/modules/job/mediamosa_job.rest.class.inc
<?php

/**
 * URI: /mediafile/$mediafile_id/analyse
 * Method: POST
 *
 *
 * 1.x: vpx_jobs_analyse_mediafile
 *
 */
class mediamosa_rest_call_job_analyse_mediafile extends mediamosa_rest_call {
  // ------------------------------------------------------------------ Consts.
  // Rest vars;
  const MEDIAFILE_ID = 'mediafile_id';

  const USER_ID = 'user_id';
  const HINT = 'hint';
  const NO_HINT = 'no_hint';
  const PRIORITY = 'priority';
  const PRIORITY_RANGE_START = -100;
  const PRIORITY_RANGE_END = 100;

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

    $var_setup = array(
      self::VARS => array(
        self::MEDIAFILE_ID => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_MEDIAFILE_ID,
          self::VAR_DESCRIPTION => 'The mediafile 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, must be the owner of the mediafile.',
          self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
        ),
        self::HINT => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_BOOL,
          self::VAR_DESCRIPTION => 'Setting to TRUE or FALSE overrules the global ega-setting. possible values: TRUE, FALSE, NULL. Default: NULL',
          self::VAR_DEFAULT_VALUE => NULL,
        ),
        self::NO_HINT => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_BOOL,
          self::VAR_DESCRIPTION => 'When true and "hint" parameter is not defined then, regardless of the ega setting, do not add hinting to the mediafile. Deprecated.',
          self::VAR_DEFAULT_VALUE => 'FALSE',
        ),
        self::PRIORITY => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_INT,
          self::VAR_DESCRIPTION => 'Priority of the job.',
          self::VAR_RANGE_START => self::PRIORITY_RANGE_START,
          self::VAR_RANGE_END => self::PRIORITY_RANGE_END,
        ),
      )
    );

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

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

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

    // Get params.
    $mediafile_id = $this->get_param_value(self::MEDIAFILE_ID);
    $user_id = $this->get_param_value(self::USER_ID);
    $priority = $this->get_param_value(self::PRIORITY);

    $hint = $this->get_param_value(self::HINT);
    $no_hint = $this->get_param_value(self::NO_HINT);
    // If hint is null, and no_hint is true, then do the old way.
    if (is_null($hint) && $no_hint === TRUE) {
      $hint = FALSE;
    }

    // Create it.
    $job_id = mediamosa_job::create(mediamosa_job_db::JOB_TYPE_ANALYSE, $app_id, $user_id, $is_app_admin, $mediafile_id, FALSE, array(), $priority, $hint);

    // Add job_id.
    $mediamosa->add_item(array('job_id' => $job_id));
  }
}