Alpha Framework alpha--util--metrics
[ class tree: alpha--util--metrics ] [ index: alpha--util--metrics ] [ all elements ]

Class: AlphaMetrics

Source Location: /util/metrics/AlphaMetrics.inc

Class AlphaMetrics

Class Overview

Utility class for calcualting some software metics related to a project

Located in /util/metrics/AlphaMetrics.inc [line 57]



		
				Author(s):
		
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: AlphaMetrics.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.0
License:  The BSD License

Methods

[ Top ]
Method Summary
AlphaMetrics   __construct()   Constructor, default $rootDir is .
void   calculateLOC()   Calculates the Lines of Code (LOC)
string   resultsToHTML()   Generates a HTML table containing the metrics results

[ Top ]
Methods
Constructor __construct  [line 153]

  AlphaMetrics __construct( [string $rootDir = '.']  )

Constructor, default $rootDir is .

Parameters:
string   $rootDir: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
calculateLOC  [line 164]

  void calculateLOC( )

Calculates the Lines of Code (LOC)


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
resultsToHTML  [line 197]

  string resultsToHTML( )

Generates a HTML table containing the metrics results


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:26:11 +0000 by phpDocumentor 1.4.3