Nextcloud PHP API (master)

ISearchComparison extends ISearchOperator
in

Tags
since
12.0.0
psalm-type

ParamSingleValue = \DateTime|int|string|bool

psalm-type

ParamValue = ParamSingleValue|list<ParamSingleValue>

Table of Contents

Constants

COMPARE_DEFINED  = 'is-defined'
COMPARE_EQUAL  = 'eq'
COMPARE_GREATER_THAN  = 'gt'
COMPARE_GREATER_THAN_EQUAL  = 'gte'
COMPARE_IN  = 'in'
COMPARE_LESS_THAN  = 'lt'
COMPARE_LESS_THAN_EQUAL  = 'lte'
COMPARE_LIKE  = 'like'
COMPARE_LIKE_CASE_SENSITIVE  = 'clike'
HINT_PATH_EQ_HASH  = 'path_eq_hash'

Methods

getExtra()  : string
extra means data are not related to the main files table
getField()  : string
Get the name of the field to compare with
getQueryHint()  : mixed
Get a query builder hint by name
getType()  : string
Get the type of comparison, one of the ISearchComparison::COMPARE_* constants
getValue()  : ParamValue
Get the value to compare the field with
setQueryHint()  : void
Get a query builder hint

Constants

COMPARE_DEFINED

public mixed COMPARE_DEFINED = 'is-defined'
Tags
since
28.0.0

COMPARE_GREATER_THAN

public mixed COMPARE_GREATER_THAN = 'gt'
Tags
since
12.0.0

COMPARE_GREATER_THAN_EQUAL

public mixed COMPARE_GREATER_THAN_EQUAL = 'gte'
Tags
since
12.0.0

COMPARE_LESS_THAN_EQUAL

public mixed COMPARE_LESS_THAN_EQUAL = 'lte'
Tags
since
12.0.0

COMPARE_LIKE_CASE_SENSITIVE

public mixed COMPARE_LIKE_CASE_SENSITIVE = 'clike'
Tags
since
23.0.0

HINT_PATH_EQ_HASH

public mixed HINT_PATH_EQ_HASH = 'path_eq_hash'
Tags
since
23.0.0

Methods

getExtra()

extra means data are not related to the main files table

public getExtra() : string
Tags
since
28.0.0
Return values
string

getField()

Get the name of the field to compare with

public getField() : string

i.e. 'size', 'name' or 'mimetype'

Tags
since
12.0.0
Return values
string

getQueryHint()

Get a query builder hint by name

public getQueryHint(string $name,  $default) : mixed
Parameters
$name : string
$default :
Tags
since
23.0.0

getType()

Get the type of comparison, one of the ISearchComparison::COMPARE_* constants

public getType() : string
Tags
since
12.0.0
Return values
string

getValue()

Get the value to compare the field with

public getValue() : ParamValue
Tags
since
12.0.0
Return values
ParamValue

setQueryHint()

Get a query builder hint

public setQueryHint(string $name,  $value) : void
Parameters
$name : string
$value :
Tags
since
23.0.0 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results