CsvResponseFormatter

Type
Class
Namespace
craft\web
Inherits
craft\web\CsvResponseFormatter » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window), yii\web\ResponseFormatterInterface (opens new window)
Since
3.4.0

CsvResponseFormatter formats the given data into CSV response content.

It is used by yii\web\Response (opens new window) to format response data.

View source (opens new window)

# Public Properties

Property Description
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component
contentType string (opens new window) – The Content-Type header for the response
delimiter string (opens new window) – The field delimiter (one character only)
enclosure string (opens new window) – The field enclosure (one character only)
escapeChar string (opens new window) – The escape character (one character only)
headers string (opens new window)[] – The header row values.
includeHeaderRow boolean (opens new window) – Whether the response data should include a header row

# contentType

Type
string (opens new window)
Default value
'text/csv'

The Content-Type header for the response

View source (opens new window)

# delimiter

Type
string (opens new window)
Default value
','

The field delimiter (one character only)

View source (opens new window)

# enclosure

Type
string (opens new window)
Default value
'"'

The field enclosure (one character only)

View source (opens new window)

# escapeChar

Type
string (opens new window)
Default value
"\\"

The escape character (one character only)

View source (opens new window)

# headers

Type
string (opens new window)[]
Default value
null

The header row values. The array keys of first result in yii\web\Response::$data (opens new window) will be used by default.

View source (opens new window)

# includeHeaderRow

Type
boolean (opens new window)
Default value
true

Whether the response data should include a header row

View source (opens new window)

# Public Methods

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

# format()

Formats the specified response.

View source (opens new window)

Arguments