Skip to content
Snippets Groups Projects
Base.php 2.02 KiB
Newer Older
  • Learn to ignore specific revisions
  • <?php
    /**
     * Base controller class.
     *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
     * @since 5.25
    
     */
    
    namespace CiviCRM_WP_REST\Controller;
    
    use CiviCRM_WP_REST\Endpoint\Endpoint_Interface;
    
    abstract class Base extends \WP_REST_Controller implements Endpoint_Interface {
    
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      /**
       * @var string
       * Route namespace.
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @since 5.25
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       */
      protected $namespace = 'civicrm/v3';
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      /**
       * Gets the endpoint namespace.
       *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @since 5.25
       *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @return string $namespace
       */
      public function get_namespace() {
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
        return $this->namespace;
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      }
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      /**
       * Gets the rest base route.
       *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @since 5.25
       *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @return string $rest_base
       */
      public function get_rest_base() {
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
        return '/' . $this->rest_base;
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      }
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      /**
       * Retrieves the endpoint ie. '/civicrm/v3/rest'.
       *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @since 5.25
       *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @return string $rest_base
       */
      public function get_endpoint() {
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
        return '/' . $this->get_namespace() . $this->get_rest_base();
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      }
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      /**
       * Checks whether the requested route is equal to this endpoint.
       *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @since 5.25
       *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @param WP_REST_Request $request
       * @return bool $is_current_endpoint True if it's equal, false otherwise
       */
      public function is_current_endpoint($request) {
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
        return $this->get_endpoint() == $request->get_route();
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      }
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      /**
       * Authorization status code.
       *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @since 5.25
       *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @return int $status
       */
      protected function authorization_status_code() {
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
        $status = 401;
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
        if (is_user_logged_in()) {
          $status = 403;
        }
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
        return $status;
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      }
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
      /**
       * Wrapper for WP_Error.
       *
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @since 5.25
       *
    
       * @param string|\CRM_Core_Exception|\WP_Error $error
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
       * @param mixed $data Error data
       * @return WP_Error $error
       */
      protected function civi_rest_error($error, $data = []) {
    
        if ($error instanceof \CRM_Core_Exception) {
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
          return $error->getExtraParams();
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
        }
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
        elseif ($error instanceof \WP_Error) {
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
          return $error;
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
        }
    
    Kevin Cristiano's avatar
    Kevin Cristiano committed
        return new \WP_Error('civicrm_rest_api_error', $error, empty($data) ? ['status' => $this->authorization_status_code()] : $data);
    
      }