InstapageCmsPluginHelper.php in Instapage plugin 8.3

File

core/InstapageCmsPluginHelper.php

<?php

/**
 * Helper containing commonly used static functions.
 */
class InstapageCmsPluginHelper {

  /**
   * Loads content of a given template and prints it or returns it as a string.
   *
   * @param string $tmpl Name of the template to load.
   * @param bool $print If set to true, content of the template will be printed to stdio. In other case it will be returned. Default: true.
   *
   * @throws \Exception if template file is not found.
   *
   * @return string|void Content of the template as a string or void, if print === true.
   */
  public static function loadTemplate($tmpl, $print = true) {
    $templateFile = INSTAPAGE_PLUGIN_PATH . '/views/' . $tmpl . '.php';
    if (file_exists($templateFile)) {
      if (!$print) {
        ob_start();
      }
      require $templateFile;
      if (!$print) {
        $contents = ob_get_contents();
        ob_end_clean();
        return $contents;
      }
    }
    else {
      throw new Exception(InstapageCmsPluginConnector::lang('Template file (%s) not found', $templateFile));
    }
  }

  /**
   * Loads 'messages' template to initiate a container for plugin system messages.
   */
  public static function initMessagesSystem() {
    self::loadTemplate('messages');
  }

  /**
   * Returns a string representation of Instapage icon in SVG format.
   *
   * @return string string representation of SVG icon
   */
  public static function getMenuIcon() {
    return 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjgiIGhlaWdodD0iMzIiIHZpZXdCb3g9IjAgMCAyOCAzMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4NCjxwYXRoIGQ9Ik02LjQ0MTIyIDI4LjA4MTlWMy43Njk4OUM2LjQzODE5IDMuNTQ0MzggNi4yNzkwOCAzLjM1Mjk2IDYuMDYyMyAzLjMxNDA0TDQuNjQ1NDggMy4xMjgzMkM0LjUxOTYgMy4xMTAwNCA0LjM5MjA3IDMuMTQ3NDMgNC4yOTQ2NSAzLjIzMTE1QzQuMTk3MjQgMy4zMTQ4OCA0LjEzOTEyIDMuNDM3MDcgNC4xMzQ3NyAzLjU2NzI5VjI4LjI4NDVDNC4xMzgxMiAyOC40MTY0IDQuMTk1MjkgMjguNTQwOCA0LjI5MjM3IDI4LjYyNzRDNC4zODk0NSAyOC43MTQxIDQuNTE3NTQgMjguNzU1IDQuNjQ1NDggMjguNzQwM0w2LjA2MjMgMjguNTIwOEM2LjI4MjA5IDI4LjUwMDQgNi40NDgyMyAyOC4zMDc5IDYuNDQxMjIgMjguMDgxOVoiIGZpbGw9IndoaXRlIi8+DQo8cGF0aCBkPSJNNi40NDEyMiAyOC4wODE5VjMuNzY5ODlDNi40MzgxOSAzLjU0NDM4IDYuMjc5MDggMy4zNTI5NiA2LjA2MjMgMy4zMTQwNEw0LjY0NTQ4IDMuMTI4MzJDNC41MTk2IDMuMTEwMDQgNC4zOTIwNyAzLjE0NzQzIDQuMjk0NjUgMy4yMzExNUM0LjE5NzI0IDMuMzE0ODggNC4xMzkxMiAzLjQzNzA3IDQuMTM0NzcgMy41NjcyOVYyOC4yODQ1QzQuMTM4MTIgMjguNDE2NCA0LjE5NTI5IDI4LjU0MDggNC4yOTIzNyAyOC42Mjc0QzQuMzg5NDUgMjguNzE0MSA0LjUxNzU0IDI4Ljc1NSA0LjY0NTQ4IDI4Ljc0MDNMNi4wNjIzIDI4LjUyMDhDNi4yODIwOSAyOC41MDA0IDYuNDQ4MjMgMjguMzA3OSA2LjQ0MTIyIDI4LjA4MTlaIiBmaWxsPSJ1cmwoI3BhaW50MF9saW5lYXIpIi8+DQo8cGF0aCBkPSJNMi4zMDY0NiAyNS44MDI2VjUuOTQ3NzlDMi4zMDcxMSA1LjcxNDg1IDIuMTM2ODggNS41MTg1OSAxLjkxMTA2IDUuNDkxOTRMMC40OTQyNDEgNS4zNTY4OEMwLjM2ODA4NCA1LjM0Mjk2IDAuMjQyMTA5IDUuMzg0NzIgMC4xNDc3OTUgNS40NzE3QzAuMDUzNDgxOCA1LjU1ODY5IC0wLjAwMDI1OTQ3MyA1LjY4MjY5IDkuNDIwNDllLTA3IDUuODEyNzNWMjUuOTg4M0MwLjAwMjI2MjE1IDI2LjExNzUgMC4wNTY3NDgzIDI2LjIzOTkgMC4xNTA0NSAyNi4zMjYzQzAuMjQ0MTUxIDI2LjQxMjcgMC4zNjg2NTggMjYuNDU1NCAwLjQ5NDI0MSAyNi40NDQxTDEuOTExMDYgMjYuMjc1M0MyLjEzMjk3IDI2LjIyOTEgMi4yOTU4OCAyNi4wMzQ0IDIuMzA2NDYgMjUuODAyNloiIGZpbGw9IndoaXRlIi8+DQo8cGF0aCBkPSJNMi4zMDY0NiAyNS44MDI2VjUuOTQ3NzlDMi4zMDcxMSA1LjcxNDg1IDIuMTM2ODggNS41MTg1OSAxLjkxMTA2IDUuNDkxOTRMMC40OTQyNDEgNS4zNTY4OEMwLjM2ODA4NCA1LjM0Mjk2IDAuMjQyMTA5IDUuMzg0NzIgMC4xNDc3OTUgNS40NzE3QzAuMDUzNDgxOCA1LjU1ODY5IC0wLjAwMDI1OTQ3MyA1LjY4MjY5IDkuNDIwNDllLTA3IDUuODEyNzNWMjUuOTg4M0MwLjAwMjI2MjE1IDI2LjExNzUgMC4wNTY3NDgzIDI2LjIzOTkgMC4xNTA0NSAyNi4zMjYzQzAuMjQ0MTUxIDI2LjQxMjcgMC4zNjg2NTggMjYuNDU1NCAwLjQ5NDI0MSAyNi40NDQxTDEuOTExMDYgMjYuMjc1M0MyLjEzMjk3IDI2LjIyOTEgMi4yOTU4OCAyNi4wMzQ0IDIuMzA2NDYgMjUuODAyNloiIGZpbGw9InVybCgjcGFpbnQxX2xpbmVhcikiLz4NCjxwYXRoIGZpbGwtcnVsZT0iZXZlbm9kZCIgY2xpcC1ydWxlPSJldmVub2RkIiBkPSJNMjcuMDY4MyAzLjk3MjUxTDguNzk3ODcgMC44OTk3NDhDOC42NzE0MSAwLjg3ODAwNiA4LjU0MiAwLjkxNDExNiA4LjQ0Mzc1IDAuOTk4NTZDOC4zNDU1IDEuMDgzIDguMjg4MjggMS4yMDczMSA4LjI4NzE1IDEuMzM4NzFWMzAuNzgzMkM4LjI4NTM1IDMwLjkxNTYgOC4zNDE3NiAzMS4wNDE5IDguNDQwNzggMzEuMTI3QzguNTM5OCAzMS4yMTIxIDguNjcwOTMgMzEuMjQ3MSA4Ljc5Nzg3IDMxLjIyMjJMMjcuMDY4MyAyNy45MTNDMjcuMjc5MiAyNy44ODAyIDI3LjQzMzkgMjcuNjkyNyAyNy40MzA3IDI3LjQ3NDFWNC40MTE0OEMyNy40NDAxIDQuMTkwNjkgMjcuMjgyMyAzLjk5OTYgMjcuMDY4MyAzLjk3MjUxWk0yNS4xMjQyIDI1LjM4MDZDMjUuMTIxMiAyNS42MDYxIDI0Ljk2MjEgMjUuNzk3NSAyNC43NDUzIDI1LjgzNjRMMTEuODQ1NyAyNy43MjczQzExLjcxNzEgMjcuNzQ1NCAxMS41ODcyIDI3LjcwNTYgMTEuNDg5MyAyNy42MTgyQzExLjM5MTUgMjcuNTMwOSAxMS4zMzUyIDI3LjQwNDUgMTEuMzM1IDI3LjI3MTVWNS4xNzEyM0MxMS4zMzQ3IDUuMDQxMiAxMS4zODg0IDQuOTE3MiAxMS40ODI4IDQuODMwMjFDMTEuNTc3MSA0Ljc0MzIyIDExLjcwMyA0LjcwMTQ3IDExLjgyOTIgNC43MTUzOEwyNC43Mjg4IDYuMzY5OTVDMjQuOTQ4NSA2LjQwMzY1IDI1LjExMDIgNi41OTgyMSAyNS4xMDc4IDYuODI1OFYyNS4zODA2SDI1LjEyNDJaIiBmaWxsPSJ3aGl0ZSIvPg0KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0yNy4wNjgzIDMuOTcyNTFMOC43OTc4NyAwLjg5OTc0OEM4LjY3MTQxIDAuODc4MDA2IDguNTQyIDAuOTE0MTE2IDguNDQzNzUgMC45OTg1NkM4LjM0NTUgMS4wODMgOC4yODgyOCAxLjIwNzMxIDguMjg3MTUgMS4zMzg3MVYzMC43ODMyQzguMjg1MzUgMzAuOTE1NiA4LjM0MTc2IDMxLjA0MTkgOC40NDA3OCAzMS4xMjdDOC41Mzk4IDMxLjIxMjEgOC42NzA5MyAzMS4yNDcxIDguNzk3ODcgMzEuMjIyMkwyNy4wNjgzIDI3LjkxM0MyNy4yNzkyIDI3Ljg4MDIgMjcuNDMzOSAyNy42OTI3IDI3LjQzMDcgMjcuNDc0MVY0LjQxMTQ4QzI3LjQ0MDEgNC4xOTA2OSAyNy4yODIzIDMuOTk5NiAyNy4wNjgzIDMuOTcyNTFaTTI1LjEyNDIgMjUuMzgwNkMyNS4xMjEyIDI1LjYwNjEgMjQuOTYyMSAyNS43OTc1IDI0Ljc0NTMgMjUuODM2NEwxMS44NDU3IDI3LjcyNzNDMTEuNzE3MSAyNy43NDU0IDExLjU4NzIgMjcuNzA1NiAxMS40ODkzIDI3LjYxODJDMTEuMzkxNSAyNy41MzA5IDExLjMzNTIgMjcuNDA0NSAxMS4zMzUgMjcuMjcxNVY1LjE3MTIzQzExLjMzNDcgNS4wNDEyIDExLjM4ODQgNC45MTcyIDExLjQ4MjggNC44MzAyMUMxMS41NzcxIDQuNzQzMjIgMTEuNzAzIDQuNzAxNDcgMTEuODI5MiA0LjcxNTM4TDI0LjcyODggNi4zNjk5NUMyNC45NDg1IDYuNDAzNjUgMjUuMTEwMiA2LjU5ODIxIDI1LjEwNzggNi44MjU4VjI1LjM4MDZIMjUuMTI0MloiIGZpbGw9InVybCgjcGFpbnQyX2xpbmVhcikiLz4NCjxkZWZzPg0KPGxpbmVhckdyYWRpZW50IGlkPSJwYWludDBfbGluZWFyIiB4MT0iNS4yODgxIiB5MT0iMy4xMjM3OCIgeDI9IjUuMjg4MSIgeTI9IjI4Ljc0MzIiIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4NCjxzdG9wIHN0b3AtY29sb3I9IndoaXRlIi8+DQo8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IndoaXRlIiBzdG9wLW9wYWNpdHk9IjAiLz4NCjwvbGluZWFyR3JhZGllbnQ+DQo8bGluZWFyR3JhZGllbnQgaWQ9InBhaW50MV9saW5lYXIiIHgxPSIxLjE1MzIzIiB5MT0iNS4zNTQyNSIgeDI9IjEuMTUzMjMiIHkyPSIyNi40NDU5IiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+DQo8c3RvcCBzdG9wLWNvbG9yPSJ3aGl0ZSIvPg0KPHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSJ3aGl0ZSIgc3RvcC1vcGFjaXR5PSIwIi8+DQo8L2xpbmVhckdyYWRpZW50Pg0KPGxpbmVhckdyYWRpZW50IGlkPSJwYWludDJfbGluZWFyIiB4MT0iMTcuODU5MSIgeTE9IjAuODkzNTU1IiB4Mj0iMTcuODU5MSIgeTI9IjMxLjIzIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+DQo8c3RvcCBzdG9wLWNvbG9yPSJ3aGl0ZSIvPg0KPHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSJ3aGl0ZSIgc3RvcC1vcGFjaXR5PSIwIi8+DQo8L2xpbmVhckdyYWRpZW50Pg0KPC9kZWZzPg0KPC9zdmc+DQo=';
  }

  /**
   * Sets an AJAX endpoint for Instapage plugin.
   */
  public static function initAjaxURL() {
    echo '<script>var INSTAPAGE_AJAXURL = \'' . InstapageCmsPluginConnector::getAjaxURL() . '\';</script>';
  }

  /**
   * Gets plugin's options stored in the database.
   *
   * @param bool $configOnly Return only configuration, ommit JSON options.
   *
   * @return object Options object.
   */
  public static function getOptions($configOnly = false) {
    $db = InstapageCmsPluginDBModel::getInstance();
    if ($configOnly) {
      $sql = 'SELECT config FROM ' . $db->optionsTable;
      $row = $db
        ->getRow($sql);
      if (isset($row->config)) {
        return json_decode($row->config);
      }
      return new stdClass();
    }
    else {
      $sql = 'SELECT * FROM ' . $db->optionsTable;
      $options = $db
        ->getRow($sql);
      if ($options === false) {
        return new stdClass();
      }
      if (isset($options->config)) {
        $options->config = json_decode($options->config);
      }
      return $options;
    }
  }

  /**
   * Gets a single value from plugin's options.
   *
   * @param string $name Option name.
   * @param mixed $default Default value of the option. Defaulf: false.
   *
   * @uses \InstapageHelper::getOptions().
   * @uses \InstapageHelper::getVar() to check the existence of the option.
   *
   * @return mixed Option value or default value passed to the function.
   */
  public static function getOption($name, $default = false) {
    $options = self::getOptions();
    if (in_array($name, array(
      'plugin_hash',
      'user_name',
      'api_keys',
    ))) {
      return isset($options->{$name}) ? $options->{$name} : $default;
    }
    else {
      return isset($options->config->{$name}) ? $options->config->{$name} : $default;
    }
  }

  /**
   * Udated the plugin's options in database.
   *
   * @param $data Options object with updated values.
   *
   * @uses \InstapageCmsPluginDBModel::query to update the database.
   *
   * @return mixed Query result of false on query of false on query error. Exception message is logged in standard error log.
   */
  public static function updateOptions($data) {
    $userName = isset($data->userName) ? $data->userName : null;
    $userToken = isset($data->userToken) ? $data->userToken : null;
    if ($userName === null) {
      $userName = isset($data->user_name) ? $data->user_name : null;
    }
    if ($userToken === null) {
      $userToken = isset($data->plugin_hash) ? $data->plugin_hash : null;
    }
    $configJson = !empty($data->config) ? json_encode($data->config) : '';
    $metadataJson = !empty($data->metadata) ? json_encode($data->metadata) : '';
    $db = InstapageCmsPluginDBModel::getInstance();
    $sql = 'INSERT INTO ' . $db->optionsTable . '(id, plugin_hash, api_keys, user_name, config, metadata) VALUES(1, %s, %s, %s, %s, %s) ON DUPLICATE KEY UPDATE plugin_hash = %s, api_keys = %s, user_name = %s, config = %s, metadata=%s';
    return $db
      ->query($sql, $userToken, '', $userName, $configJson, $metadataJson, $userToken, '', $userName, $configJson, $metadataJson);
  }

  /**
   * Updates plugin's options, stored an JSON.
   *
   * @param string $key Name of the param to update.
   * @param string $value Value of the param to update.
   */
  public static function updateMetadata($key, $value) {
    $metadata = self::getMetadata();
    $metadata[$key] = $value;
    $db = InstapageCmsPluginDBModel::getInstance();
    $sql = 'INSERT INTO ' . $db->optionsTable . '(id, metadata) VALUES(1, %s) ON DUPLICATE KEY UPDATE metadata = %s';
    $metadataJson = !empty($metadata) ? json_encode($metadata) : '';
    return $db
      ->query($sql, $metadataJson, $metadataJson);
  }

  /**
   * Gest an option value from plugin's metadata.
   *
   * @param string $key Name of the param to get.
   * @param string $default Default value.
   *
   * @return mixed Option value.
   */
  public static function getMetadata($key = '', $default = null) {
    $db = InstapageCmsPluginDBModel::getInstance();
    $sql = 'SELECT metadata FROM ' . $db->optionsTable;
    $row = $db
      ->getRow($sql);
    $metadata = array();
    if (isset($row->metadata) && $row->metadata) {
      $metadata = (array) json_decode($row->metadata);
    }
    if (!empty($key)) {
      return isset($metadata[$key]) ? $metadata[$key] : $default;
    }
    return $metadata;
  }

  /**
   * Gets API tokens stored in the DB.
   *
   * @return array Stored tokens.
   */
  public static function getTokens() {
    $config = self::getOptions(true);
    $tokens = array();
    if (!isset($config->tokens) || !is_array($config->tokens)) {
      return array();
    }
    foreach ($config->tokens as $token) {
      $tokens[] = $token->value;
    }
    return $tokens;
  }

  /**
   * Checks if one of the custom params, stored in plugin's settings, are present in curent URL.
   *
   * @return boolean
   */
  public static function isCustomParamPresent() {
    $slug = self::extractSlug(InstapageCmsPluginConnector::getHomeUrl());
    $defaultExcludedParams = array(
      's' => null,
      'post_type' => null,
      'preview' => 'true',
    );
    $customParamsOption = explode('|', stripslashes(self::getOption('customParams', '')));
    $customParams = array();
    $paramArr = null;
    $key = null;
    $value = null;
    foreach ($customParamsOption as $param) {
      $paramArr = explode('=', $param);
      $key = isset($paramArr[0]) ? $paramArr[0] : null;
      $value = isset($paramArr[1]) ? str_replace('"', '', $paramArr[1]) : null;
      $customParams[$key] = $value;
    }
    if (count($customParams)) {
      $excludedParams = array_merge($defaultExcludedParams, $customParams);
    }
    foreach ($excludedParams as $key => $value) {
      $isDefaultParam = array_key_exists($key, $defaultExcludedParams) ? true : false;
      if (!empty($key) && $value == null && (isset($_GET[$key]) || !$isDefaultParam && strpos($slug, $key) !== false) || !empty($key) && $value !== null && isset($_GET[$key]) && $_GET[$key] == $value) {
        return true;
      }
    }
    return false;
  }

  /**
   * Cleans an URL for sedning to Instapage app.
   *
   * @param string $url URL to prepare.
   *
   * @return string Prepared URL.
   */
  public static function prepareUrlForUpdate($url) {
    return trim(str_replace(array(
      'http://',
      'https://',
    ), '', $url), '/');
  }

  /**
   * Check if request uri has duplicated slashes.
   *
   * @return boolean True if requested uri has duplicated slashes, false if uri is ok
   */
  public static function checkIfRequestUriHasDuplicatedSlashes() {
    $url = $_SERVER['REQUEST_URI'];
    if (($pos = strpos($url, '?')) !== false) {
      $url = substr($url, 0, $pos);
    }
    return strpos($url, '//') !== false;
  }

  /**
   * Extracts a slug from current URL. Slug will be compared with values stored in plugin's database to find a landing page to display.
   *
   * @param string $homeUrl URL of the home page.
   *
   * @return string Trimmed slug, ready to compare with values stored in the DB.
   */
  public static function extractSlug($homeUrl) {
    $uriSegments = explode('?', $_SERVER['REQUEST_URI']);
    self::writeDiagnostics($uriSegments, 'checkCustomUrl: $uriSegments');
    $path = trim(parse_url($homeUrl, PHP_URL_PATH), '/');
    $segment = trim($uriSegments[0], '/');
    if ($path) {
      $pos = strpos($segment, $path);
      if ($pos !== false) {
        $segment = substr_replace($segment, '', $pos, strlen($path));
      }
    }
    $slug = trim($segment, '/');

    // removing duplicated slashes from obtained almost final slug form
    $slug = preg_replace('~\\/{2,}~', '/', $slug);
    self::writeDiagnostics($slug, 'checkCustomUrl: $slug');
    return $slug;
  }

  /**
   * Decodes data passed as a JSON.
   *
   * @return object Object passed via POST method.
   */
  public static function getPostData() {
    return isset($_POST['data']) ? json_decode(urldecode($_POST['data'])) : null;
  }

  /**
   * Encodes a message as a JSON object.
   *
   * @param string $text Text of the message
   * @param string $status. Status of a message. Typically 'OK' or 'ERROR'.
   *
   * @return string encoded JSON message object.
   */
  public static function formatJsonMessage($text, $status = 'OK') {
    self::writeDiagnostics($text, 'Message');
    return json_encode((object) array(
      'status' => $status,
      'message' => $text,
    ));
  }

  /**
   * Checks Instapage API response.
   *
   * @param object $response Response object.
   * @param string $message A message to store in debug log or display to user after checking.
   * @param bool $print If message should be shown to user a a system message.
   *
   * @return bool Returns true on success, false on failure.
   */
  public static function checkResponse($response, $message = '', $print = true) {
    if (is_null($response)) {
      $msgText = InstapageCmsPluginConnector::lang('Can\'t decode API response. %s', $message);
      if ($print) {
        echo self::formatJsonMessage($msgText, 'ERROR');
      }
      else {
        self::writeDiagnostics($msgText, 'message');
      }
      return false;
    }
    if (!$response->success) {
      $text = isset($response->message) ? $response->message : '';
      if ($print) {
        if ($text) {
          echo self::formatJsonMessage(InstapageCmsPluginConnector::lang($text), 'ERROR');
        }
        else {
          echo self::formatJsonMessage(InstapageCmsPluginConnector::lang('API returned an error. %s', $message), 'ERROR');
        }
      }
      else {
        self::writeDiagnostics($text, 'message');
      }
      return false;
    }
    return true;
  }

  /**
   * Writes an entry in debug log, if diagnostic mode is on.
   *
   * @param mixed $value Value to be stored.
   * @param string $name Name of the value. Default: ''.
   */
  public static function writeDiagnostics($value, $name = '') {
    $log = InstapageCmsPluginDebugLogModel::getInstance();
    if ($log
      ->isDiagnosticMode()) {
      $log
        ->write($value, $name);
    }
  }

  /**
   * Writes an entry in debug log.
   *
   * @param mixed $value Value to be stored.
   * @param string $name Name of the value. Default: ''.
   */
  public static function writeLog($value, $name = '') {
    $log = InstapageCmsPluginDebugLogModel::getInstance();
    $log
      ->write($value);
  }

  /**
   * Prepares an Auth header for API requests.
   *
   * @param array $tokens Tokens to encode in Auth header.
   * @return string Encoded Auth header.
   */
  public static function getAuthHeader($tokens) {
    self::writeDiagnostics($tokens, 'Decoded tokens');
    return base64_encode(json_encode($tokens));
  }

  /**
   * Gets a variant of a landing page to display.
   *
   * @param string $cookieString A cookie string.
   *
   * @return string|null A variant to display, or null if a variant is not present.
   */
  public static function getVariant($cookieString) {
    $pattern = '/instapage-variant-\\d*?=(.*?);/';
    $matches = array();
    preg_match($pattern, $cookieString, $matches);
    return isset($matches[1]) ? $matches[1] : null;
  }

  /**
   * Sets a proper header with response code.
   *
   * @param int $code HTTP Response Code. Default: 200.
   */
  public static function httpResponseCode($code = 200) {
    if (function_exists('http_response_code')) {
      http_response_code($code);
      return;
    }
    if ($code === null) {
      $code = 200;
    }
    switch ($code) {
      case 100:
        $text = 'Continue';
        break;
      case 101:
        $text = 'Switching Protocols';
        break;
      case 200:
        $text = 'OK';
        break;
      case 201:
        $text = 'Created';
        break;
      case 202:
        $text = 'Accepted';
        break;
      case 203:
        $text = 'Non-Authoritative Information';
        break;
      case 204:
        $text = 'No Content';
        break;
      case 205:
        $text = 'Reset Content';
        break;
      case 206:
        $text = 'Partial Content';
        break;
      case 300:
        $text = 'Multiple Choices';
        break;
      case 301:
        $text = 'Moved Permanently';
        break;
      case 302:
        $text = 'Moved Temporarily';
        break;
      case 303:
        $text = 'See Other';
        break;
      case 304:
        $text = 'Not Modified';
        break;
      case 305:
        $text = 'Use Proxy';
        break;
      case 400:
        $text = 'Bad Request';
        break;
      case 401:
        $text = 'Unauthorized';
        break;
      case 402:
        $text = 'Payment Required';
        break;
      case 403:
        $text = 'Forbidden';
        break;
      case 404:
        $text = 'Not Found';
        break;
      case 405:
        $text = 'Method Not Allowed';
        break;
      case 406:
        $text = 'Not Acceptable';
        break;
      case 407:
        $text = 'Proxy Authentication Required';
        break;
      case 408:
        $text = 'Request Time-out';
        break;
      case 409:
        $text = 'Conflict';
        break;
      case 410:
        $text = 'Gone';
        break;
      case 411:
        $text = 'Length Required';
        break;
      case 412:
        $text = 'Precondition Failed';
        break;
      case 413:
        $text = 'Request Entity Too Large';
        break;
      case 414:
        $text = 'Request-URI Too Large';
        break;
      case 415:
        $text = 'Unsupported Media Type';
        break;
      case 500:
        $text = 'Internal Server Error';
        break;
      case 501:
        $text = 'Not Implemented';
        break;
      case 502:
        $text = 'Bad Gateway';
        break;
      case 503:
        $text = 'Service Unavailable';
        break;
      case 504:
        $text = 'Gateway Time-out';
        break;
      case 505:
        $text = 'HTTP Version not supported';
        break;
      default:
        $code = 200;
        $text = 'OK';
        break;
    }
    $protocol = isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.1';
    if (!headers_sent()) {
      header($protocol . ' ' . $code . ' ' . $text);
    }
    $GLOBALS['http_response_code'] = $code;
  }

  /**
   * Sets a proper headers to disable caching by browsers and CDNs.
   */
  public static function disableCaching() {
    if (!headers_sent()) {
      header('Cache-Control: no-cache, no-store, must-revalidate');
      header('Pragma: no-cache');
      header('Expires: 0');
      setcookie('no-cache', 'true');
    }
  }

  /**
   * Returns true if given version number seems to be MariaDB
   * @param  string $version Version number from InstapageCmsPluginConnector::getMySQLVersion()
   * @return bool
   */
  public static function isMariaDBMySQL($version) {
    return strpos($version, 'MariaDB') !== false;
  }

  /**
   * Returns true if given version number seems to be regular MySQL
   * @param  string $version Version number from InstapageCmsPluginConnector::getMySQLVersion()
   * @uses   self::isMariaDBMySQL()
   * @return bool
   */
  public static function isRegularMySQL($version) {
    return !self::isMariaDBMySQL($version);
  }

  /**
   * Returns only number of version string
   * @param  string $version Version number from InstapageCmsPluginConnector::getMySQLVersion()
   * @uses   self::isMariaDBMySQL()
   * @return string
   */
  public static function getRawVersion($version) {
    $data = explode('-', $version, 2);
    return $data[0];
  }

}

Classes

Name	Description
InstapageCmsPluginHelper	Helper containing commonly used static functions.