PHP Class ArticleSearch, ojs

Exibir arquivo Open project: pkp/ojs Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor
formatResults ( &$results ) : array See SubmissionSearch::formatResults()
getDefaultOrderDir ( $orderBy ) See SubmissionSearch::getDefaultOrderDir()
getIndexFieldMap ( )
getKeywordsFromSearchFilters ( $searchFilters ) : array Load the keywords array from a given search filter.
getResultSetOrderingOptions ( $request ) See SubmissionSearch::getResultSetOrderingOptions()
getSearchFilters ( $request ) : array Retrieve the search filters from the request.
getSimilarityTerms ( $submissionId ) : null | array Identify similarity terms for a given submission.
getSparseArray ( &$unorderedResults, $orderBy, $orderDir, $exclude ) See SubmissionSearch::getSparseArray()

Protected Methods

Method Description
getSearchDao ( ) See SubmissionSearch::getSearchDao()

Method Details

__construct() public method

Constructor
public __construct ( )

formatResults() static public method

See SubmissionSearch::formatResults()
static public formatResults ( &$results ) : array
return array An array with the articles, published articles, issue, journal, section and the issue availability.

getDefaultOrderDir() public method

See SubmissionSearch::getDefaultOrderDir()
public getDefaultOrderDir ( $orderBy )

getIndexFieldMap() public method

public getIndexFieldMap ( )

getKeywordsFromSearchFilters() public method

Load the keywords array from a given search filter.
public getKeywordsFromSearchFilters ( $searchFilters ) : array
$searchFilters array Search filters as returned from ArticleSearch::getSearchFilters()
return array Keyword array as required by SubmissionSearch::retrieveResults()

getResultSetOrderingOptions() public method

See SubmissionSearch::getResultSetOrderingOptions()
public getResultSetOrderingOptions ( $request )

getSearchDao() protected method

See SubmissionSearch::getSearchDao()
protected getSearchDao ( )

getSearchFilters() public method

Retrieve the search filters from the request.
public getSearchFilters ( $request ) : array
$request Request
return array All search filters (empty and active)

getSimilarityTerms() public method

Identify similarity terms for a given submission.
public getSimilarityTerms ( $submissionId ) : null | array
$submissionId integer
return null | array An array of string keywords or null if some kind of error occurred.

getSparseArray() public method

See SubmissionSearch::getSparseArray()
public getSparseArray ( &$unorderedResults, $orderBy, $orderDir, $exclude )