Documentation

BlueprintSchema extends BlueprintSchema
in package
implements ExportInterface uses Export

Class BlueprintSchema

Table of Contents

Interfaces

ExportInterface

Properties

$filter  : array<string|int, mixed>
$ignoreFormKeys  : array<string|int, mixed>

Methods

filter()  : array<string|int, mixed>
Filter data by using blueprints.
flattenData()  : array<string|int, mixed>
Flatten data by using blueprints.
getNestedRules()  : array<string|int, mixed>|null
getType()  : array<string|int, mixed>
getTypes()  : array<string|int, mixed>
processForm()  : array<string|int, mixed>
validate()  : void
Validate data against blueprints.
buildIgnoreNested()  : bool
checkRequired()  : array<string|int, mixed>
dynamicConfig()  : void
filterArray()  : array<string|int, mixed>|null
flattenArray()  : array<string|int, mixed>
processFormRecursive()  : array<string|int, mixed>|null
validateArray()  : array<string|int, mixed>

Properties

$filter

protected array<string|int, mixed> $filter = ['validation' => true, 'xss_check' => true]

$ignoreFormKeys

protected array<string|int, mixed> $ignoreFormKeys = ['title' => true, 'help' => true, 'placeholder' => true, 'placeholder_key' => true, 'placeholder_value' => true, 'fields' => true]

Methods

filter()

Filter data by using blueprints.

public filter(array<string|int, mixed> $data[, bool $missingValuesAsNull = false ][, bool $keepEmptyValues = false ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Incoming data, for example from a form.

$missingValuesAsNull : bool = false

Include missing values as nulls.

$keepEmptyValues : bool = false

Include empty values.

Return values
array<string|int, mixed>

flattenData()

Flatten data by using blueprints.

public flattenData(array<string|int, mixed> $data[, bool $includeAll = false ][, string $name = '' ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Data to be flattened.

$includeAll : bool = false

True if undefined properties should also be included.

$name : string = ''

Property which will be flattened, useful for flattening repeating data.

Return values
array<string|int, mixed>

getNestedRules()

public getNestedRules(string $name) : array<string|int, mixed>|null
Parameters
$name : string
Return values
array<string|int, mixed>|null

getType()

public getType(string $name) : array<string|int, mixed>
Parameters
$name : string
Return values
array<string|int, mixed>

getTypes()

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

processForm()

public processForm(array<string|int, mixed> $data[, array<string|int, mixed> $toggles = [] ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$toggles : array<string|int, mixed> = []
Return values
array<string|int, mixed>

validate()

Validate data against blueprints.

public validate(array<string|int, mixed> $data[, array<string|int, mixed> $options = [] ]) : void
Parameters
$data : array<string|int, mixed>
$options : array<string|int, mixed> = []
Tags
throws
RuntimeException

buildIgnoreNested()

protected buildIgnoreNested(array<string|int, mixed> $nested[, string $parent = '' ]) : bool
Parameters
$nested : array<string|int, mixed>
$parent : string = ''
Return values
bool

checkRequired()

protected checkRequired(array<string|int, mixed> $data, array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$fields : array<string|int, mixed>
Return values
array<string|int, mixed>

dynamicConfig()

protected dynamicConfig(array<string|int, mixed> &$field, string $property, array<string|int, mixed> &$call) : void
Parameters
$field : array<string|int, mixed>
$property : string
$call : array<string|int, mixed>

filterArray()

protected filterArray(array<string|int, mixed> $data, array<string|int, mixed> $rules, string $parent, bool $missingValuesAsNull, bool $keepEmptyValues) : array<string|int, mixed>|null
Parameters
$data : array<string|int, mixed>
$rules : array<string|int, mixed>
$parent : string
$missingValuesAsNull : bool
$keepEmptyValues : bool
Return values
array<string|int, mixed>|null

flattenArray()

protected flattenArray(array<string|int, mixed> $data, array<string|int, mixed> $rules, string $prefix) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$rules : array<string|int, mixed>
$prefix : string
Return values
array<string|int, mixed>

processFormRecursive()

protected processFormRecursive(array<string|int, mixed>|null $data, array<string|int, mixed> $toggles, array<string|int, mixed> $nested) : array<string|int, mixed>|null
Parameters
$data : array<string|int, mixed>|null
$toggles : array<string|int, mixed>
$nested : array<string|int, mixed>
Return values
array<string|int, mixed>|null

validateArray()

protected validateArray(array<string|int, mixed> $data, array<string|int, mixed> $rules, bool $strict[, bool $xss = true ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$rules : array<string|int, mixed>
$strict : bool
$xss : bool = true
Tags
throws
RuntimeException
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results