Documentation

SwapDelimiter extends php_user_filter
in package

FinalYes

Table of Contents

Constants

MODE_READ  = 'read'
MODE_WRITE  = 'write'
FILTER_NAME  = 'string.league.csv.delimiter'

Properties

$replace  : string
$search  : string

Methods

addTo()  : void
Static method to attach the stream filter to a CSV Reader or Writer instance.
appendTo()  : resource
filter()  : int
getFiltername()  : string
onCreate()  : bool
prependTo()  : resource
register()  : void
Static method to register the class as a stream filter.

Constants

FILTER_NAME

private mixed FILTER_NAME = 'string.league.csv.delimiter'

Properties

Methods

addTo()

Static method to attach the stream filter to a CSV Reader or Writer instance.

public static addTo(AbstractCsv $csv, string $inputDelimiter) : void
Parameters
$csv : AbstractCsv
$inputDelimiter : string

appendTo()

public static appendTo(resource $stream, string $inputDelimiter, string $delimiter) : resource
Parameters
$stream : resource
$inputDelimiter : string
$delimiter : string
Tags
throws
TypeError
throws
RuntimeException
Return values
resource

filter()

public filter(mixed $in, mixed $out, mixed &$consumed, bool $closing) : int
Parameters
$in : mixed
$out : mixed
$consumed : mixed
$closing : bool
Return values
int

getFiltername()

public static getFiltername() : string
Return values
string

prependTo()

public static prependTo(resource $stream, string $inputDelimiter, string $delimiter) : resource
Parameters
$stream : resource
$inputDelimiter : string
$delimiter : string
Tags
throws
TypeError
throws
RuntimeException
Return values
resource

register()

Static method to register the class as a stream filter.

public static register() : void

        
On this page

Search results