sdr/search/SDRServiceRequest.php5

<?php
class SDRServiceRequest extends SObject {

    const DEFAULT_NUM_PER_PAGE = 10;

    const PRESET_FIND_QUICK = 1;        // Do a quick search using param 'ss'
    const PRESET_FIND_ADVANCED = 2;     // Do an advanced search using fields and values
    const PRESET_FIND_LIST = 3;         // Get a catalog listing.
    const PRESET_METADATA_BY_CSERD_ID = 20;
    const PRESET_ALL_DATA_BY_CSERD_ID = 21; // Get all data associated with param 'cserdId'
    const PRESET_METADATA_AND_REVIEWS_BY_CSERD_ID = 22; // Get metadata and reviews for param 'cserdId'
    const PRESET_METADATA_BY_FIELDS = 25;
    const PRESET_TSD_BY_FIELDS = 26;
    const PRESET_VOCAB = 30;

    protected $method = null;           // The method to use - Default is to search.
    protected $type = null;             // The type of search - Default is quick search.
    protected $filterProject = array(); // Only find items related to these projects
    protected $filterProjectType = '';  // If this is "and", items will have to be in ALL projects
    protected $startingResult = null;   // How many results to skip before returning results?
    protected $resultsPerPage = self::DEFAULT_NUM_PER_PAGE; // The number of items to show per page
    protected $XMLData = null;          // the XML payload submitted to POST
    protected $key = null;              // An authentication key, if needed
    protected $constraints = array();   // The user-defined search constraints
    protected $dataSections = array();  // The data sections requested
    protected $state = 'live';          // The state of resources we should return

    public function __construct($method = SDRContract::METHOD_FIND,
                                $type = SDRContract::REQUEST_TYPE_DEFAULT) {
        parent::__construct();
        $this->method = $method;
        $this->type = $type;
        $this->searchBase = SPath::getFullPath('SDRService') . '/';

        // Choose default state according to the current server
        if (SConfig::getDefault('common.server') == 'newdev') {
            $this->state = 'dev';
        } else if (SConfig::getDefault('common.server') == 'www') {
            $this->state = 'live';
        }
        
        // Testing purposes only, if you want to control the search base:
        //$this->searchBase = 'http://shodor.org/sdr/';
    }

    public function buildQueryURL() {
        $sr = $this->startingResult;
        $numPerPage = $this->resultsPerPage;
        $state = $this->state;
        $filter = $this->constraints;
        if ($sr < 0) $sr = 0;

        $search = $this->searchBase;
        $search .= "$this->method/?";

        switch ($this->method) {
            // Search the catalog
            case SDRContract::METHOD_FIND:
                $search .= "type=$this->type";
                // Options specific to find types returning resources
                if ($this->type != SDRContract::REQUEST_TYPE_VOCAB) {
                    if (count($this->filterProject))
                        $search .= "&filterProject=" . implode(',', array_keys($this->filterProject));
                    if ($this->filterProjectType != '')
                        $search .= '&filterProjectType=' . $this->filterProjectType;
                }
                // Options that can be used for all find types
                if ($sr != 0)               $search .= "&sr=$sr";
                if ($state != '')           $search .= "&state=$state";
                if ($numPerPage != self::DEFAULT_NUM_PER_PAGE)  $search .= "&rp=$numPerPage";
                if (array_key_exists('orderBy', $this->constraints))    $search .= "&orderBy=".$this->constraints['orderBy'];

                switch ($this->type) {
                    // List everything in the catalog that fits the project filters
                    case SDRContract::REQUEST_TYPE_LIST:
                        return ($search . $this->getDataSectionsForURL());

                    // Fetch entries in the catalog that fit multiple filters
                    case SDRContract::REQUEST_TYPE_ADVANCED:
                        if (is_array($filter)) {
                            foreach($filter as $key=>$value) {
                                if ($value != '')
                                    $search .= '&' . $key .'=' . $value;
                                else $search .= '&' . $key;
                            }
                        }
                        $ds = ($this->getDataSectionsForURL());
                        return ($search . $ds);

                    // Search the catalog on one string
                    case SDRContract::REQUEST_TYPE_QUICK:
                        return ($search . "&ss=$filter[ss]" . $this->getDataSectionsForURL());

                    // Fetch controlled vocabulary information
                    case SDRContract::REQUEST_TYPE_VOCAB:
                        return ($search . "&field=" . $filter['field']);
                }
            // Submit a metadata entry
            case SDRContract::METHOD_SUBMIT:
                return $search;
            case SDRContract::METHOD_APPROVE:
                return $search;

            default:
                $this->setError('Unknown method: "' . $this->method . '"');
                return false;
        }
    }

    public function addConstraints($constraints) {
        foreach($constraints as $key => $value) {
            if (array_key_exists($key, $this->constraints))
                $this->setWarning('Overwriting existing constraint for key ' . $key);
            $this->constraints[$key] = $value;
        }
    }

    public function getConstraints() {
        return $this->constraints;
    }

    public function getConstraint($key) {
        if (!isset($this->constraints[$key])) return '';
        return $this->constraints[$key];
    }

    public function usePreset($preset, $params = array()) {
        switch($preset) {
            case self::PRESET_FIND_QUICK:
                if(!isset($params['ss'])) {
                    $this->setError('Requires a search string ss');
                    return false;
                }
                $this->setMethod(SDRContract::METHOD_FIND);
                $this->setType(SDRContract::REQUEST_TYPE_QUICK);
                $this->addConstraints(array('ss' => $params['ss']));
                if (isset($params['sr']))
                    $this->setStartingResult($params['sr']);
                return true;
            case self::PRESET_FIND_ADVANCED:
                $this->setMethod(SDRContract::METHOD_FIND);
                $this->setType(SDRContract::REQUEST_TYPE_ADVANCED);
                if (isset($params['ss']))
                    $this->addConstraints(array('ss'=>$params['ss']));
                if (isset($params['sr']))
                    $this->setStartingResult($params['sr']);
                return true;
            case self::PRESET_FIND_LIST:
                $this->setMethod(SDRContract::METHOD_FIND);
                $this->setType(SDRContract::REQUEST_TYPE_LIST);
                return true;
            case self::PRESET_ALL_DATA_BY_CSERD_ID:
                if(!isset($params['cserdId'])) {
                    $this->setError('Requires a cserdId');
                    return false;
                }
                $this->setMethod(SDRContract::METHOD_FIND);
                $this->setType(SDRContract::REQUEST_TYPE_ADVANCED);
                $this->addConstraints(array('cserdId' => $params['cserdId']));
                $this->addDataSection(array(SDRContract::DATA_METADATA,
                                            SDRContract::DATA_REVIEWS,
                                            SDRContract::DATA_ALIGNMENTS,
                                            SDRContract::DATA_RELATIONSHIPS));
                return true;
            case self::PRESET_METADATA_BY_CSERD_ID:
                if(!isset($params['cserdId'])) {
                    $this->setError('Requires a cserdId');
                    return false;
                }
                $this->setMethod(SDRContract::METHOD_FIND);
                $this->setType(SDRContract::REQUEST_TYPE_ADVANCED);
                $this->addConstraints(array('cserdId' => $params['cserdId']));
                $this->addDataSection(array(SDRContract::DATA_METADATA));
                return true;
            case self::PRESET_METADATA_BY_FIELDS:
                $this->setMethod(SDRContract::METHOD_FIND);
                $this->setType(SDRContract::REQUEST_TYPE_ADVANCED);
                $this->addConstraints($params);
                $this->addDataSection(array(SDRContract::DATA_METADATA));
                return true;
            case self::PRESET_TSD_BY_FIELDS:
                $this->setMethod(SDRContract::METHOD_FIND);
                $this->setType(SDRContract::REQUEST_TYPE_ADVANCED);
                $this->addConstraints($params);
                $this->addDataSection(array(SDRContract::DATA_METADATA,
                                            SDRContract::DATA_ALIGNMENTS,
                                            SDRContract::DATA_RELATIONSHIPS));
                return true;
            case self::PRESET_METADATA_AND_REVIEWS_BY_CSERD_ID:
                if(!isset($params['cserdId'])) {
                    $this->setError('Requires a cserdId');
                    return false;
                }
                $this->setMethod(SDRContract::METHOD_FIND);
                $this->setType(SDRContract::REQUEST_TYPE_ADVANCED);
                $this->addConstraints(array('cserdId' => $params['cserdId']));
                $this->addDataSection(array(SDRContract::DATA_METADATA,
                                            SDRContract::DATA_REVIEWS));
                return true;
            case self::PRESET_VOCAB:
                if(!isset($params['field'])) {
                    $this->setError('Requires a vocab field');
                    return false;
                }
                $this->setMethod(SDRContract::METHOD_FIND);
                $this->setType(SDRContract::REQUEST_TYPE_VOCAB);
                $this->addConstraints(array('field' => $params['field']));
                return true;
            default:
                $this->setError('Unknown preset ' . $preset);
                return false;
        }
    }

    public function isAdvanced() {
        return $this->type == SDRContract::REQUEST_TYPE_ADVANCED;
    }

    public function setMethod($method) {
        $this->method = $method;
    }

    public function getMethod() {
        return $this->method;
    }

    public function setState($state) {
        $this->state = $state;
    }

    public function getState() {
        return $this->state;
    }

    public function setType($type) {
        $this->type = $type;
    }

    public function getType() {
        return $this->type;
    }

    public function addProjectFilter($proj) {
        $this->filterProject[$proj] = true;
    }

    public function removeProjectFilter($proj) {
        if (isset($this->filterProject[$proj]))
            unset($this->filterProject[$proj]);
    }

    public function setProjectFilter($proj) {
        $this->filterProject = array($proj => true);
    }

    public function clearProjectFilters() {
        $this->filterProject = array();
    }

    public function addCSERDFilter() {
        $this->addProjectFilter(SDRContract::PROJECT_CSERD);
    }

    public function clearCSERDFilter() {
        $this->removeProjectFilter(SDRContract::PROJECT_CSERD);
    }

    public function setFilterProjectType($fpt) {
        $this->filterProjectType = $fpt;
    }

    public function getFilterProjectType() {
        return $this->filterProjectType;
    }


    public function setStartingResult($sr) {
        $this->startingResult = $sr;
    }

    public function setNumResultsPerPage($numPerPage) {
        $this->resultsPerPage = $numPerPage;
    }

    public function getNumResultsPerPage() {
        return $this->resultsPerPage;
    }

    public function setKey($key) {
        $this->key = $key;
    }

    public function getKey() {
        return $this->key;
    }

    public function setXMLData($data) {
        $this->XMLData = $data;
    }

    public function getXMLData() {
        return $this->XMLData;
    }

    public function addDataSection($section) {
        if (is_array($section)) {
            foreach($section as $s) {
                $this->dataSections []= $s;
            }
        } else {
            $this->dataSections []= $section;
        }
    }

    public function getDataSectionsForURL() {
        return '&' . implode('&', $this->dataSections);
    }

    public function toString() {
        switch ($this->method) {
            case SDRContract::METHOD_FIND:
                switch($this->type) {
                    case SDRContract::REQUEST_TYPE_QUICK:
                        if ($this->constraints['ss'] == '') return 'No Search Terms';
                        return '<b>Quick Search</b> for <b>' . $this->constraintsToString() . '</b>';
                    case SDRContract::REQUEST_TYPE_ADVANCED:
                        return 'Advanced Search:'.$this->constraintsToString();
                    case SDRContract::REQUEST_TYPE_LIST:
                        return 'Catalog Listing';
                    default:
                        return '';
                }
            default:
                return '';
        }
    }
    
    
    public function constraintsToString() {
        switch ($this->method) {
            case SDRContract::METHOD_FIND:
                switch($this->type) {
                    case SDRContract::REQUEST_TYPE_QUICK:
                        if ($this->constraints['ss'] == '') return 'No Search Terms';
                        return 'Searched for &ldquo;' . htmlspecialchars(strip_tags($this->constraints['ss'])) . '&rdquo;</b>';
                    case SDRContract::REQUEST_TYPE_ADVANCED:
                        $constraintString = '';
                        if (array_key_exists('ss', $this->constraints) && $this->constraints['ss'] != '') {
                            $constraintString .= ", Search String&nbsp;=&nbsp;&ldquo;" . $this->constraints['ss']. "&rdquo;";
                        }
                        foreach ($this->constraints as $field=>$value) {
                            if ($value != '' && $field != 'orderBy' && $field != 'ss')
                                $constraintString .= ", $field&nbsp;=&nbsp;$value";
                        }
                        return substr($constraintString, 1);
                    case SDRContract::REQUEST_TYPE_LIST:
                        return '';
                    default:
                        return '';
                }
            default:
                return '';
        }
    }
    


    public function typeToString() {
        switch ($this->method) {
            case SDRContract::METHOD_FIND:
                switch($this->type) {
                    case SDRContract::REQUEST_TYPE_QUICK:
                        return 'Quick Search';
                    case SDRContract::REQUEST_TYPE_ADVANCED:
                        return 'Advanced Search';
                    case SDRContract::REQUEST_TYPE_LIST:
                        return 'Catalog Listing';
                    default:
                        return '';
                }
            default:
                return '';
        }
    }
}

?>

---