Documentation

StreamFilter
in package

FinalYes

Table of Contents

Methods

appendOnReadTo()  : resource|AbstractCsv
appendOnWriteTo()  : resource|AbstractCsv
prependOnReadTo()  : resource|AbstractCsv
prependOnWriteTo()  : resource|AbstractCsv
remove()  : bool
Remove a filter from a stream.
appendFilter()  : resource|AbstractCsv
filterFiltername()  : void
filterStream()  : void
Validate the resource given.
prependFilter()  : resource|AbstractCsv

Methods

appendOnReadTo()

public static appendOnReadTo(resource|AbstractCsv $stream, string $filtername[, mixed $params = null ]) : resource|AbstractCsv
Parameters
$stream : resource|AbstractCsv
$filtername : string
$params : mixed = null
Tags
throws
TypeError
throws
RuntimeException
Return values
resource|AbstractCsv

appendOnWriteTo()

public static appendOnWriteTo(resource|AbstractCsv $stream, string $filtername[, mixed $params = null ]) : resource|AbstractCsv
Parameters
$stream : resource|AbstractCsv
$filtername : string
$params : mixed = null
Tags
throws
TypeError
throws
RuntimeException
Return values
resource|AbstractCsv

prependOnReadTo()

public static prependOnReadTo(resource|AbstractCsv $stream, string $filtername[, mixed $params = null ]) : resource|AbstractCsv
Parameters
$stream : resource|AbstractCsv
$filtername : string
$params : mixed = null
Tags
throws
TypeError
throws
RuntimeException
Return values
resource|AbstractCsv

prependOnWriteTo()

public static prependOnWriteTo(resource|AbstractCsv $stream, string $filtername[, mixed $params = null ]) : resource|AbstractCsv
Parameters
$stream : resource|AbstractCsv
$filtername : string
$params : mixed = null
Tags
throws
TypeError
throws
RuntimeException
Return values
resource|AbstractCsv

remove()

Remove a filter from a stream.

public static remove(resource $stream_filter) : bool
Parameters
$stream_filter : resource
Return values
bool

appendFilter()

private static appendFilter(int $mode, resource|AbstractCsv $stream, string $filtername, mixed $params) : resource|AbstractCsv
Parameters
$mode : int
$stream : resource|AbstractCsv
$filtername : string
$params : mixed
Tags
throws
TypeError
throws
RuntimeException
Return values
resource|AbstractCsv

filterFiltername()

private static filterFiltername(string $filtername) : void
Parameters
$filtername : string

filterStream()

Validate the resource given.

private static filterStream(mixed $stream) : void
Parameters
$stream : mixed
Tags
throws
TypeError

if the resource given is not a stream

prependFilter()

private static prependFilter(int $mode, resource|AbstractCsv $stream, string $filtername, mixed $params) : resource|AbstractCsv
Parameters
$mode : int
$stream : resource|AbstractCsv
$filtername : string
$params : mixed
Tags
throws
TypeError
throws
RuntimeException
Return values
resource|AbstractCsv 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results