Gitee
\
app
common
behavior
controller
library
token
logic
model
service
taglib
developer
admin
model
example
admin
home
model
validate
finance
admin
home
model
index
home
install
home
product
admin
home
model
report
admin
home
model
shop
admin
home
model
shouyin
admin
home
model
system
admin
home
model
validate
user
admin
home
model
validate
warehouse
admin
home
model
BigintTest
Complex
Composer
Autoload
GuzzleHttp
Cookie
Exception
Handler
Promise
Psr7
hisi
League
Csv
Polyfill
Matrix
Operators
MyCLabs
Enum
PHPUnit
PhpOffice
PhpSpreadsheet
Calculation
Engine
Token
Cell
Chart
Renderer
Collection
Document
Helper
Reader
Ods
Security
Xls
Color
Style
Xlsx
RichText
Shared
Escher
DgContainer
SpgrContainer
DggContainer
BstoreContainer
BSE
JAMA
OLE
PPS
Trend
Style
Worksheet
Writer
Ods
Cell
Pdf
Xls
Xlsx
plugins
hisiphp
Psr
Http
Message
Log
Test
SimpleCache
Symfony
Polyfill
Mbstring
tests
think
cache
driver
captcha
composer
config
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
db
builder
connector
exception
debug
exception
facade
helper
hash
image
gif
log
driver
model
concern
relation
paginator
driver
process
exception
pipes
response
route
dispatch
session
driver
template
driver
taglib
validate
view
driver
traits
controller
ZipStream
Exception
Option

\League\CsvEncloseField

A stream filter to improve enclosure character usage.

Summary

Methods
Properties
Constants
getFiltername()
register()
addTo()
onCreate()
filter()
$filtername
$params
FILTERNAME
isValidSequence()
$sequence
$force_enclosure
N/A
No private methods found
No private properties found
N/A

Constants

FILTERNAME

FILTERNAME = 'convert.league.csv.enclosure'

Properties

$filtername

$filtername : string

the filter name used to instantiate the class with.

Type

string

$params

$params : mixed

Contents of the params parameter passed to stream_filter_append or stream_filter_prepend functions.

Type

mixed

$sequence

$sequence : string

Default sequence.

Type

string

$force_enclosure

$force_enclosure : string

Characters that triggers enclosure in PHP.

Type

string

Methods

getFiltername()

getFiltername()

Static method to return the stream filter filtername.

register()

register()

Static method to register the class as a stream filter.

addTo()

addTo(\League\Csv\Writer  $csv, \League\Csv\string  $sequence)

Static method to add the stream filter to a {@link Writer} object.

Parameters

\League\Csv\Writer $csv
\League\Csv\string $sequence

Throws

\InvalidArgumentException

if the sequence is malformed

onCreate()

onCreate()

{@inheritdoc}

filter()

filter(  $in,   $out,   $consumed,   $closing)

{@inheritdoc}

Parameters

$in
$out
$consumed
$closing

isValidSequence()

isValidSequence(\League\Csv\string  $sequence)

Filter type and sequence parameters.

The sequence to force enclosure MUST contains one of the following character ("\n\r\t ")

Parameters

\League\Csv\string $sequence