VuFind API Documentation

LuceneSyntaxHelperTest extends TestCase
in package
Uses ReflectionTrait

Unit tests for Lucene syntax helper

Tags
category

VuFind

author

David Maus maus@hab.de

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link
https://vufind.org

Table of Contents

capitalizeBooleansProvider()  : array<string|int, mixed>
Data provider for testCapitalizeBooleans
capitalizeRangesProvider()  : array<string|int, mixed>
Data provider for testCapitalizeRanges
colonNormalizationProvider()  : array<string|int, mixed>
Data provider for testColonNormalization
extractSearchTermsProvider()  : array<string|int, mixed>
Data provider for testExtractSearchTerms.
testCapitalizeBooleans()  : void
Test capitalizeBooleans functionality.
testCapitalizeRanges()  : void
Test capitalizeRanges functionality.
testCaseInsensitiveRangeNormalization()  : void
Test case insensitive range normalization
testColonNormalization()  : void
Test colon normalization
testContainsAdvancedLuceneSyntaxWithCaseInsensitivity()  : void
Test advanced query detection (with case insensitivity)
testContainsAdvancedLuceneSyntaxWithDefaults()  : void
Test advanced query detection (default settings)
testContainsBooleans()  : void
Test that booleans are detected properly.
testExtractSearchTerms()  : void
Test search term extraction
testGetBoolsToCap()  : void
Test getBoolsToCap().
testHasCaseSensitiveBooleans()  : void
Test hasCaseSensitiveBooleans().
testSelectiveBooleanCapitalization()  : void
Test the selective capitalization functionality of capitalizeBooleans.
testUnquotedNormalization()  : void
Test normalization of unquoted special characters
unquotedNormalizationProvider()  : array<string|int, mixed>
Data provider for testUnquotedNormalization
callMethod()  : mixed
Call protected or private method for side-effect and result.
getProperty()  : mixed
Return protected or private property.
setProperty()  : void
Set protected or private property.

Methods

capitalizeBooleansProvider()

Data provider for testCapitalizeBooleans

public static capitalizeBooleansProvider() : array<string|int, mixed>
Return values
array<string|int, mixed>

capitalizeRangesProvider()

Data provider for testCapitalizeRanges

public static capitalizeRangesProvider() : array<string|int, mixed>
Return values
array<string|int, mixed>

colonNormalizationProvider()

Data provider for testColonNormalization

public static colonNormalizationProvider() : array<string|int, mixed>
Return values
array<string|int, mixed>

extractSearchTermsProvider()

Data provider for testExtractSearchTerms.

public static extractSearchTermsProvider() : array<string|int, mixed>
Return values
array<string|int, mixed>

testCapitalizeBooleans()

Test capitalizeBooleans functionality.

public testCapitalizeBooleans( $input,  $expected) : void
Parameters
$input :

Input to test

$expected :

Expected output

Tags
dataProvider

capitalizeBooleansProvider

Return values
void

testCapitalizeRanges()

Test capitalizeRanges functionality.

public testCapitalizeRanges( $input,  $expected) : void
Parameters
$input :

Input to test

$expected :

Expected output

Tags
dataProvider

capitalizeRangesProvider

Return values
void

testCaseInsensitiveRangeNormalization()

Test case insensitive range normalization

public testCaseInsensitiveRangeNormalization() : void
Return values
void

testColonNormalization()

Test colon normalization

public testColonNormalization( $input,  $expected) : void
Parameters
$input :

Input to test

$expected :

Expected output

Tags
dataProvider

colonNormalizationProvider

Return values
void

testContainsAdvancedLuceneSyntaxWithCaseInsensitivity()

Test advanced query detection (with case insensitivity)

public testContainsAdvancedLuceneSyntaxWithCaseInsensitivity() : void
Return values
void

testContainsAdvancedLuceneSyntaxWithDefaults()

Test advanced query detection (default settings)

public testContainsAdvancedLuceneSyntaxWithDefaults() : void
Return values
void

testContainsBooleans()

Test that booleans are detected properly.

public testContainsBooleans() : void
Return values
void

testExtractSearchTerms()

Test search term extraction

public testExtractSearchTerms( $input,  $expected) : void
Parameters
$input :

Input to test

$expected :

Expected output

Tags
dataProvider

extractSearchTermsProvider

Return values
void

testGetBoolsToCap()

Test getBoolsToCap().

public testGetBoolsToCap() : void
Return values
void

testHasCaseSensitiveBooleans()

Test hasCaseSensitiveBooleans().

public testHasCaseSensitiveBooleans() : void
Return values
void

testSelectiveBooleanCapitalization()

Test the selective capitalization functionality of capitalizeBooleans.

public testSelectiveBooleanCapitalization() : void
Return values
void

testUnquotedNormalization()

Test normalization of unquoted special characters

public testUnquotedNormalization(string $input, string $expected) : void
Parameters
$input : string

Input string

$expected : string

Expected result

Tags
dataProvider

unquotedNormalizationProvider

Return values
void

unquotedNormalizationProvider()

Data provider for testUnquotedNormalization

public static unquotedNormalizationProvider() : array<string|int, mixed>
Return values
array<string|int, mixed>

callMethod()

Call protected or private method for side-effect and result.

protected callMethod(object|string $object, string $method[, array<string|int, mixed> $arguments = [] ]) : mixed

Uses PHP's reflection API in order to modify method accessibility.

Parameters
$object : object|string

Object or class name

$method : string

Method name

$arguments : array<string|int, mixed> = []

Method arguments

Tags
throws
ReflectionException

Method does not exist

Return values
mixed

getProperty()

Return protected or private property.

protected getProperty(object|string $object, string $property) : mixed

Uses PHP's reflection API in order to modify property accessibility.

Parameters
$object : object|string

Object or class name

$property : string

Property name

Tags
throws
ReflectionException

Property does not exist

Return values
mixed

setProperty()

Set protected or private property.

protected setProperty(object|string $object, string $property, mixed $value) : void

Uses PHP's reflection API in order to modify property accessibility.

Parameters
$object : object|string

Object or class name

$property : string

Property name

$value : mixed

Property value

Tags
throws
ReflectionException

Property does not exist

Return values
void

Search results