API Documentation

# \ConsumerStrategies_FileConsumer

Consumes messages and writes them to a file

## Summary

Methods
Properties
Constants
__construct()
getNumThreads()
persist()
No public properties found
No constants found
_encode()
_handleError()
_log()
_debug()
$_options
N/A
No private methods found
$_defaults
$_file
N/A

File
  ConsumerStrategies/FileConsumer.php
Package
  Default
Class hierarchy
  \Base_MixpanelBase
  \ConsumerStrategies_AbstractConsumer
  \ConsumerStrategies_FileConsumer

## Tags

None found

## Properties

### $_options

    $_options : array

An array of options to be used by the Mixpanel library.

#### Type

array

#

Inherited from
  \Base_MixpanelBase

## Tags

None found

### $_defaults

    $_defaults : array

Default options that can be overridden via the $options constructor arg

#### Type

array

#

Inherited from
  \Base_MixpanelBase

## Tags

None found

### $_file

    $_file : string

#### Type

string — path to a file that we want to write the messages to

#

## Tags

None found

## Methods

### __construct()

    __construct(array  $options)

Creates a new FileConsumer and assigns properties from the $options array

#### Parameters

array | $options |

#

## Tags

None found

### getNumThreads()

    getNumThreads() : integer

Number of requests/batches that will be processed in parallel.

#### Returns

integer

#

Inherited from
  \ConsumerStrategies_AbstractConsumer

## Tags

None found

### persist()

    persist(array  $batch) : boolean

Append $batch to a file

#### Parameters

array | $batch | an array of messages to consume

#### Returns

boolean

#

## Tags

None found

### _encode()

    _encode(array  $params) : string

Encode an array to be persisted

#### Parameters

array | $params |

#### Returns

string

#

Inherited from
  \ConsumerStrategies_AbstractConsumer

## Tags

None found

### _handleError()

    _handleError(  $code,   $msg)

Handles errors that occur in a consumer

#### Parameters

| $code |
| $msg |

#

Inherited from
  \ConsumerStrategies_AbstractConsumer

## Tags

None found

### _log()

    _log(  $msg)

Log a message to PHP's error log

#### Parameters

| $msg |

#

Inherited from
  \Base_MixpanelBase

## Tags

None found

### _debug()

    _debug() : boolean

Returns true if in debug mode, false if in production mode

#### Returns

boolean

#

Inherited from
  \Base_MixpanelBase

## Tags

None found

### FileConsumer.php