Skip to content

CsvResponseFormatter

Type
Class
Namespace
craft\web
Inherits
craft\web\CsvResponseFormatter » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable, yii\web\ResponseFormatterInterface
Since
3.4.0

CsvResponseFormatter formats the given data into CSV response content.

It is used by yii\web\Response to format response data.

View source

Public Properties

PropertyDescription
behaviorsyii\base\Behavior – List of behaviors attached to this component.
contentTypestring – The Content-Type header for the response
delimiterstring – The field delimiter (one character only)
enclosurestring – The field enclosure (one character only)
escapeCharstring – The escape character (one character only)
headersstring[] – The header row values.
includeHeaderRowboolean – Whether the response data should include a header row

contentType

Type
string
Default value
'text/csv'

The Content-Type header for the response

View source

delimiter

Type
string
Default value
','

The field delimiter (one character only)

View source

enclosure

Type
string
Default value
'"'

The field enclosure (one character only)

View source

escapeChar

Type
string
Default value
"\\"

The escape character (one character only)

View source

headers

Type
string[]
Default value
null

The header row values. The unique keys across all rows in yii\web\Response::$data will be used by default.

View source

includeHeaderRow

Type
boolean
Default value
true

Whether the response data should include a header row

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()Returns the value of a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be null.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
format()Formats the specified response.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
trigger()Triggers an event.

format()

Formats the specified response.

View source

Arguments