# Class AlphaKPI

A Key Performance Indicator (KPI) logging class

Package: alpha::util
Copyright: Copyright (c) 2012, 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.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: AlphaKPI.inc 1567 2012-08-05 19:57:34Z alphadevx $
Since: 1.1
Located at util/AlphaKPI.inc

Methods summary
`public` | # `__construct( string $name )` Constructor Constructor #### Parameters $name `string` $name The name of the KPI which is used in the log files, must only be letters and/or numbers. #### Throws ``IllegalArguementException`` #### Since 1.1
`public` | # `storeStartTimeInSession( )` Stores the current startTime for the KPI in the session, useful for multi-request KPI tracking. Stores the current startTime for the KPI in the session, useful for multi-request KPI tracking. #### Since 1.0
`public` | # `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. Writes the KPI event to a log file named logs/kpi-'.$this->name->getValue().'.csv, which will be created if it does not exist. #### Since 1.1
`public` | # `logStep( mixed $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. 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. #### Since 1.1

Properties summary
`private `Timestamp`` | $timeStamp | `` | # The date/time of the KPI event The date/time of the KPI event #### Since 1.1
`private `String`` | $name | `` | # The name of the KPI The name of the KPI #### Since 1.1
`private string` | $sessionID | `` | # The session ID of the current HTTP session The session ID of the current HTTP session #### Since 1.1
`private float` | $startTime | `` | # The start time of the KPI event (UNIX timestamp in seconds) The start time of the KPI event (UNIX timestamp in seconds) #### Since 1.1
`private float` | $endTime | `` | # The end time of the KPI event (UNIX timestamp in seconds) The end time of the KPI event (UNIX timestamp in seconds) #### Since 1.1
`private float` | $duration | `` | # The duration in seconds The duration in seconds #### Since 1.1