sdr/search/SDRContract.php5

<?php
class SDRContract {
    // Define the names of the methods used to access SDR
    const METHOD_FIND = 'find';
    const METHOD_SUBMIT = 'submit';
    const METHOD_APPROVE = 'approve';

    // Define the types of requests (method calls) that can be made
    const REQUEST_TYPE_DEFAULT = 'default';
    const REQUEST_TYPE_QUICK = 'quick';
    const REQUEST_TYPE_LIST = 'list';
    const REQUEST_TYPE_ADVANCED = 'advanced';
    const REQUEST_TYPE_VOCAB = 'vocab';
    const REQUEST_TYPE_ALIGNMENTS = 'alignments';
    const REQUEST_TYPE_PENDING = 'pending';

    // Define the types of results that can be returned
    const RESULT_TYPE_DEFAULT = 'default';  // the most basic result that can be returned
    const RESULT_TYPE_RESOURCES = 'resources';  // a list of metadata records
    const RESULT_TYPE_VOCAB = 'vocab';      // a vocabulary
    const RESULT_TYPE_ALIGNMENTS = 'alignments'; // a list of alignments

    // Define the limiters that determine what segment of a result is returned
    const RESULTS_PER_PAGE = 'rp';
    const STARTING_RESULT = 'sr';

    // Define the filters that limit the projects from which items are returned
    const FILTER_PROJECT = 'filterProject'; // limit to items from a particular project
    const FILTER_CSERD = 'filterCSERD';     // limit to projects that are listed in CSERD proper

    // Define the supported data sections that can be added to a method
    const DATA_METADATA = 'metadata';
    const DATA_ALIGNMENTS = 'alignments';
    const DATA_RELATIONSHIPS = 'relationships';
    const DATA_REVIEWS = 'reviews';

    // Define the projects for which a filter can be set
    const PROJECT_CSERD = 'CSERD';
    const PROJECT_NCSI_RESOURCES = 'NCSI Resources';
    const PROJECT_INTERACTIVATE = 'Interactivate';
    const PROJECT_MASTER = 'MASTER Tools';
    const PROJECT_SUCCEED_CURRICULUM = 'SUCCEED Curriculum';
    const PROJECT_HPCU = 'HPCU';
    const PROJECT_JOCSE = 'JOCSE';
    const PROJECT_BIO_PORTAL = 'BioPortal';
    const PROJECT_PETASCALE = 'Petascale';

    // Define the contract of what methods support what types support what results, etc.
    // TODO :This should be finished off in a more elegant fashion. It could be used for checking
    // requests before they are called from the client, or after they arrive at the server.
    public static $CONTRACT = array (
        self::METHOD_FIND => array (
            'types' => array (
                self::TYPE_DEFAULT,
                self::TYPE_QUICK,
                self::TYPE_LIST,
                self::TYPE_ADVANCED,
                self::TYPE_VOCAB,
                self::TYPE_ALIGNMENTS,
                self::TYPE_PENDING
                )
            ),
        self::METHOD_SUBMIT => array (
            'types' => array (
                self::TYPE_DEFAULT
                )
            ),
        self::METHOD_APPROVE => array (
            'types' => array (
                self::TYPE_DEFAULT
                )
            )
        );


    public static function resultType($method, $type) {
        switch($method) {
            case self::METHOD_FIND:
                switch($type) {
                    case self::REQUEST_TYPE_DEFAULT:
                    case self::REQUEST_TYPE_QUICK:
                    case self::REQUEST_TYPE_ADVANCED:
                    case self::REQUEST_TYPE_LIST:
                    case self::REQUEST_TYPE_PENDING:
                        return self::RESULT_TYPE_RESOURCES;
                    case self::REQUEST_TYPE_VOCAB:
                        return self::RESULT_TYPE_VOCAB;
                    case self::REQUEST_TYPE_ALIGNMENTS:
                        return self::RESULT_TYPE_ALIGNMENTS;
                }
            default:
                // unknown method/type combo
                return false;
        }
    }
}
?>

---