| alpha--util

# Class: AlphaKPI Source Location: /util/AlphaKPI.inc ## Class AlphaKPI Class Overview
A Key Performance Indicator (KPI) logging class Located in /util/AlphaKPI.inc [line 52]
Author(s): John Collins <dev@alphaframework.org> Information Tags:
Version: | $Id: AlphaKPI.inc 1454 2011-12-04 15:14:05Z johnc $
Copyright: | Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.
     Redistribution and use in source and binary forms, with or
     without modification, are permitted provided that the
     following conditions are met:

     * Redistributions of source code must retain the above
       copyright notice, this list of conditions and the
       following disclaimer.
     * Redistributions in binary form must reproduce the above
       copyright notice, this list of conditions and the
       following disclaimer in the documentation and/or other
       materials provided with the distribution.
     * Neither the name of the Alpha Framework nor the names
       of its contributors may be used to endorse or promote
       products derived from this software without specific
       prior written permission.

     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
     OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Since: | 1.1
License: | The BSD License
| Methods __construct log logStep storeStartTimeInSession
[ Top ] Method Summary
AlphaKPI | __construct() | Constructor
void | log() | Writes the KPI event to a log file named logs/kpi-'.$this->name->getValue().'.csv, which will be created if it does not exist.
void | logStep() | Writes a step in the KPI event to a log file named logs/kpi-'.$this->name->getValue().'.csv, which will be created if it does not exist.
void | storeStartTimeInSession() | Stores the current startTime for the KPI in the session, useful for multi-request KPI tracking.
[ Top ] Methods Constructor __construct [line 108]
`AlphaKPI __construct( string $name )`
Constructor Parameters:
string | $name: | The name of the KPI which is used in the log files, must only be letters and/or numbers.
API Tags:
Access: | public
Information Tags:
Throws: | IllegalArguementException
Since: | 1.1
[ Top ] log [line 146]
`void log( )`
Writes the KPI event to a log file named logs/kpi-'.$this->name->getValue().'.csv, which will be created if it does not exist. API Tags:
Access: | public
Information Tags:
Since: | 1.1
[ Top ] logStep [line 168]
`void logStep( $stepName )`
Writes a step in the KPI event to a log file named logs/kpi-'.$this->name->getValue().'.csv, which will be created if it does not exist. Parameters:
| $stepName: |
API Tags:
Access: | public
Information Tags:
Since: | 1.1
[ Top ] storeStartTimeInSession [line 136]
`void storeStartTimeInSession( )`
Stores the current startTime for the KPI in the session, useful for multi-request KPI tracking. API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] Documentation generated on Tue, 13 Dec 2011 20:26:09 +0000 by phpDocumentor 1.4.3