Docs Goabase

SqlInParams
in package

Read onlyYes
FinalYes

Table of Contents

Methods

inInt()  : array{in: string, params: array}
Builds a safe "IN (...)" placeholder list for integer IDs.
inIntOrNull()  : array{in: string, params: array}|null
Same as params()->inInt(), but returns null if the list is empty.
inString()  : array{in: string, params: array}
Builds a safe "IN (...)" placeholder list for string values.
inStringOrNull()  : array{in: string, params: array}|null
Same as makeInStringParams(), but returns null if the list is empty.
generatePlaceholder()  : array<string|int, mixed>

Methods

inInt()

Builds a safe "IN (...)" placeholder list for integer IDs.

public inInt(array<string|int, mixed> $ids[, string $prefix = 'id' ]) : array{in: string, params: array}
Parameters
$ids : array<string|int, mixed>

list of IDs (mixed)

$prefix : string = 'id'

placeholder prefix, e.g. "id" => :id0, :id1, ...

Return values
array{in: string, params: array}

inIntOrNull()

Same as params()->inInt(), but returns null if the list is empty.

public inIntOrNull(array<string|int, mixed> $ids[, string $prefix = 'id' ]) : array{in: string, params: array}|null
Parameters
$ids : array<string|int, mixed>
$prefix : string = 'id'
Tags
SuppressWarnings

(PHPMD.ShortVariable)

Return values
array{in: string, params: array}|null

inString()

Builds a safe "IN (...)" placeholder list for string values.

public inString(array<string|int, mixed> $values[, string $prefix = 'v' ][, int $maxLen = 191 ]) : array{in: string, params: array}
Parameters
$values : array<string|int, mixed>

list of values (mixed)

$prefix : string = 'v'

placeholder prefix, e.g. "t" => :t0, :t1, ...

$maxLen : int = 191

optional guard to avoid huge cache keys / queries

Tags
SuppressWarnings

(PHPMD.ShortVariable)

Return values
array{in: string, params: array}

inStringOrNull()

Same as makeInStringParams(), but returns null if the list is empty.

public inStringOrNull(array<string|int, mixed> $values[, string $prefix = 'v' ][, int $maxLen = 191 ]) : array{in: string, params: array}|null
Parameters
$values : array<string|int, mixed>
$prefix : string = 'v'
$maxLen : int = 191
Tags
SuppressWarnings

(PHPMD.ShortVariable)

Return values
array{in: string, params: array}|null

generatePlaceholder()

private generatePlaceholder(array<string|int, mixed> $ids, string $prefix) : array<string|int, mixed>
Parameters
$ids : array<string|int, mixed>
$prefix : string
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results