Service/WindowsAzure/Log/Writer/WindowsAzure.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service_WindowsAzure  
Subpackage
Storage  
Version
$Id$  

\Zend_Service_WindowsAzure_Log_Writer_WindowsAzure

Package: Zend\Service\WindowsAzure\Log
Parent(s)
\Zend_Log_Writer_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Version
$Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $  

Properties

>VPropertyprotectedbool $_bufferMessages = false
Whether to keep all messages to be logged in an external buffer until the script ends and only then to send the messages in batch to the logging component.
Default valuefalseDetails
Type
bool
>VPropertyprotectedarray $_filters = array()
inherited

of Zend_Log_Filter_Interface

Inherited from: \Zend_Log_Writer_Abstract::$$_filters
Default valuearray()Details
Type
array
Inherited_from
\Zend_Log_Writer_Abstract::$$_filters  
>VPropertyprotected\Zend_Service_Log_Formatter_Interface $_formatter
Formats the log message before writing.
Details
Type
\Zend_Service_Log_Formatter_Interface
>VPropertyprotectedarray $_messageBuffer = array()
If message buffering is activated, it will store all the messages in this buffer and only write them to table storage (in a batch transaction) when the script ends.
Default valuearray()Details
Type
array
>VPropertyprotectedstring $_tableName = null
Name of the table to use for logging purposes
Default valuenullDetails
Type
string
>VPropertyprotected\Zend_Service_Service_WindowsAzure_Storage_Table $_tableStorageConnection = null
Connection to a windows Azure
Default valuenullDetails
Type
\Zend_Service_Service_WindowsAzure_Storage_Table

Methods

methodpublic__construct(\Zend_Service_Service_WindowsAzure_Storage_Table | \Zend_Service_WindowsAzure_Storage_Table $tableStorageConnection, string $tableName, bool $createTable = true, bool $bufferMessages = true) : void

Parameters
NameTypeDescription
$tableStorageConnection\Zend_Service_Service_WindowsAzure_Storage_Table | \Zend_Service_WindowsAzure_Storage_Table
$tableNamestring
$createTablebool

create the Windows Azure table for logging if it does not exist

$bufferMessagesbool
Throws
ExceptionDescription
\Zend_Service_Log_Exception
methodprotected_parseConfig(array | \Zend_Config $config) : array
staticinherited

Validate and optionally convert the config to array

Inherited from: \Zend_Log_Writer_Abstract::_parseConfig()
Parameters
NameTypeDescription
$configarray | \Zend_Config

Zend_Config or Array

Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Log_Exception
methodprotected_write(array $event) : void

Write a message to the table storage.

If buffering is activated, then messages will just be added to an internal buffer.

Parameters
NameTypeDescription
$eventarray
Details
Todo
format the event using a formatted, not in this method  
methodpublicaddFilter(\Zend_Log_Filter_Interface $filter) : \Zend_Log_Writer_Abstract
inherited

Add a filter specific to this writer.

Inherited from: \Zend_Log_Writer_Abstract::addFilter()
Parameters
NameTypeDescription
$filter\Zend_Log_Filter_Interface
Returns
TypeDescription
\Zend_Log_Writer_Abstract
methodpublicfactory(array $config) : \Zend_Service_Log_Writer_WindowsAzure
static

Create a new instance of Zend_Service_Log_Writer_WindowsAzure

Parameters
NameTypeDescription
$configarray
Returns
TypeDescription
\Zend_Service_Log_Writer_WindowsAzure
Throws
ExceptionDescription
\Zend_Service_Log_Exception
methodpublicsetFormatter(\Zend_Log_Formatter_Interface $formatter) : \Zend_Log_Writer_Abstract

The only formatter accepted is already loaded in the constructor

Parameters
NameTypeDescription
$formatter\Zend_Log_Formatter_Interface
Returns
TypeDescription
\Zend_Log_Writer_Abstract
Details
Todo
enable custom formatters using the WindowsAzure_Storage_DynamicTableEntity class  
methodpublicshutdown() : void

If the log messages have been stored in the internal buffer, just send them to table storage.

methodpublicwrite(array $event) : void
inherited

Log a message to this writer.

Inherited from: \Zend_Log_Writer_Abstract::write()
Parameters
NameTypeDescription
$eventarray

log data event

Documentation was generated by phpDocumentor 2.0.0a12.