raideus/wp-advanced-search

View on GitHub
wpas.php

Summary

Maintainability
A
3 hrs
Test Coverage
<?php
/*
Plugin Name: WP Advanced Search Framework
Plugin URI: http://wpadvancedsearch.com
Version: 1.4.3
Author: Sean Butze
Author URI: http://seanbutze.com
License: GPLv2 or later
*/

$WPAS_FORMS = array();

require_once('lib.php');
require_once('init.php');
require_once('config/form.default.php');

class WP_Advanced_Search {
    private $factory;
    private $errors;
    private $args;
    private $request;
    private $debug;
    private $ajax;
    private $query;
    public $debug_level;

    function __construct($id = '', $request = null) {
        $this->errors = array();
        $this->request = array();
        $this->args = $this->get_form_args($id);
        $this->args = $this->process_args($this->args);
        $this->ajax = $this->args['form']['ajax'];
        $this->debug = $this->args['debug'];
        $this->debug_level = $this->args['debug_level'];
        $this->factory = new WPAS\Factory($this->args, $request);
        $this->query = $this->factory->buildQueryObject();
    }

    /**
     * Get arguments for a form based on its registered ID
     *
     * @param $id
     * @return array|mixed
     */
    private function get_form_args($id) {
        global $WPAS_FORMS;

        if (empty($WPAS_FORMS)) {
            $this->errors[] = "No forms have been configured.";
            return array();
        }
        if (empty($id)) {
            if (!empty($WPAS_FORMS['default'])) return $WPAS_FORMS['default'];
            else return reset($WPAS_FORMS);
        } else if (empty($WPAS_FORMS[$id])) {
            $this->errors[] = "WPAS form with ID \"".$id."\" is not registered.";
            return array();
        }
        return $WPAS_FORMS[$id];
    }

    /**
     * Print HTML content of the search form
     */
    public function the_form() {
        $form = $this->factory->getForm();
        if ($this->debug) $form->addClass('wpas-debug-enabled');
        echo $form->toHTML();
    }

    /**
     * Create and return WP_Query object for the search instance
     *
     * @return WP_Query
     */
    public function query() {
        if (!$this->ajax_enabled()) $this->print_debug();
        return $this->query;
    }

    /**
     * Displays range of results displayed on the current page.
     *
     * @return string
     */
    function results_range( $args = array() ) {
        return WPAS\Helper\ResultsRange::make($this->query, $args);
    }

    /**
     * Displays pagination links
     */
    public function pagination( $args = array() ) {
        echo WPAS\Helper\Pagination::make($this->query, $args, $this->ajax_enabled());
    }

    /**
     * Create string of debug information
     *
     * For use when WPAS_DEBUG is enabled, or when calling the
     * print_debug() method.
     *
     * When $log is set to 'verbose', the output will contain a full var dump
     * of the generated WP_Query object.
     *
     * @param string $level
     * @return string
     */
    public function create_debug_output() {
        $level = $this->debug_level;
        $errors = $this->get_errors();
        $wp_query_obj = $this->factory->getWPQuery();


        $output = "WPAS DEBUG\n";

        $output .= "------------------------------------\n";
        $output .= "|| Errors\n";
        $output .= "------------------------------------\n";

        if (empty($errors)) {
            $output .= "No errors detected.\n";
        } else {
            $output .= count($errors) . " errors detected:\n";
            $output .= print_r($errors, true) . "\n";
        }

        $output .= "------------------------------------\n";
        $output .= "|| WP_Query Arguments\n";
        $output .= "------------------------------------\n";

        $output .= print_r($wp_query_obj->query, true) . "\n";

        $output .= "------------------------------------\n";
        $output .= "|| MySQL Query \n";
        $output .= "------------------------------------\n";

        $output .= print_r($wp_query_obj->request, true) . "\n";

        $output .= "------------------------------------\n";
        $output .= "|| Request Data \n";
        $output .= "------------------------------------\n";

        $output .= print_r($this->get_request(), true) . "\n";

        if ($level == 'verbose') {
            $output .= "------------------------------------\n";
            $output .= "|| WP_Query Object Dump\n";
            $output .= "------------------------------------\n";
            $output .= print_r($wp_query_obj, true);
        }

        return $output;
    }

    /**
     * Print debug information
     */
    public function print_debug() {
        if ($this->debug === false) return;
        $output = $this->create_debug_output();
        echo '<pre>' . $output . '</pre>';
    }

    /**
     * @return bool
     */
    public function debug_enabled() {
       return $this->debug;
    }

    /**
     * Get array of errors generated during setup/configuration of search
     * instance
     *
     * @return array
     */
    public function get_errors() {
        $errors = $this->errors;
        if (is_object($this->factory)) {
            $errors = array_merge($this->errors, $this->factory->getErrors());
        }
        return $errors;
    }

    public function set_error($err_msg) {
        $this->errors[] = $err_msg;
    }

    /**
     * Get Ajax configuration
     *
     * @return mixed
     */
    public function get_ajax() {
        return $this->ajax;
    }

    /**
     * Returns true if ajax is enabled for the current search instance
     *
     * @return bool
     */
    public function ajax_enabled() {
        return $this->ajax->isEnabled();
    }

    /**
     * Pre process arguments, translate argument blocks into config objects
     *
     * @param $args
     * @return mixed
     */
    private function process_args($args) {
        // Establish AJAX configuration
        $args = $this->set_ajax_config($args);

        // Set debug mode and debug level
        $args = $this->set_debug_args($args);

        return $args;
    }

    private function set_ajax_config($args) {
        $ajax_args = array();

        if (!isset($args['form'])) $args['form'] = array();

        if (isset($args['form']['ajax'])) {
            $ajax_args = $args['form']['ajax'];
        }
        $args['form']['ajax'] = new WPAS\AjaxConfig($ajax_args);

        return $args;
    }

    private function set_debug_args($args)
    {
        $debug = false;
        if (defined('WPAS_DEBUG') && WPAS_DEBUG) {
            $debug = true;
        } else if (!empty($args['debug']) && $args['debug']) {
            $debug = true;
        }

        $debug_level = 'log';

        if (defined('WPAS_DEBUG_LEVEL') && WPAS_DEBUG_LEVEL) {
            $debug_level = WPAS_DEBUG_LEVEL;
        } else if (!empty($args['debug_level']) && $args['debug_level']) {
            $debug_level = $args['debug_level'];
        }

        $args['debug'] = $debug;
        $args['debug_level'] = $debug_level;

        return $args;
    }

    private function get_request() {
        $request = $this->factory->getRequest();
        return $request->all();
    }
}