Open Journal Systems  3.3.0
COUNTER\Metric Class Reference
Inheritance diagram for COUNTER\Metric:
COUNTER\ReportBuilder

Public Member Functions

 __construct ($period, $category, $instances, $pubYrFrom=NULL, $pubYrTo=NULL, $pubYr=NULL)
 
 asDOMDocument ()
 
- Public Member Functions inherited from COUNTER\ReportBuilder
 __toString ()
 

Static Public Member Functions

static build ($array)
 

Additional Inherited Members

- Data Fields inherited from COUNTER\ReportBuilder
const COUNTER_NAMESPACE = 'http://www.niso.org/schemas/counter'
 
- Protected Member Functions inherited from COUNTER\ReportBuilder
 buildMultiple ($classname, $array)
 
 getAttributeTypes ()
 
 getCategories ()
 
 getContributorIdentifierTypes ()
 
 getDateTypes ()
 
 getIdentifierTypes ()
 
 getItemDataTypes ()
 
 getMetricTypes ()
 
 validateOneOf ($object, $className)
 
 validateOneOrMoreOf ($objects, $className)
 
 validatePositiveInteger ($int)
 
 validateString ($string)
 
 validateStrings ($array)
 
 validateZeroOrMoreOf ($objects, $className)
 
 validateZeroOrOneOf ($object, $className)
 
- Static Protected Member Functions inherited from COUNTER\ReportBuilder
static isAssociative ($array)
 

Detailed Description

COUNTER performance counter class

Definition at line 1711 of file COUNTER.php.

Constructor & Destructor Documentation

◆ __construct()

COUNTER\Metric::__construct (   $period,
  $category,
  $instances,
  $pubYrFrom = NULL,
  $pubYrTo = NULL,
  $pubYr = NULL 
)

Construct the object

Parameters
array$periodCOUNTER\DateRange array
array$categoryCOUNTER\Category array
array$instancesCOUNTER\PerformanceCounter array
intpubYrFrom optional
intpubYrTo optional
intpubYr optional
Returns
void
Exceptions
Exception

Definition at line 1772 of file COUNTER.php.

References COUNTER\ReportBuilder\getCategories(), COUNTER\ReportBuilder\validateOneOf(), COUNTER\ReportBuilder\validateOneOrMoreOf(), COUNTER\ReportBuilder\validatePositiveInteger(), and COUNTER\ReportBuilder\validateString().

Member Function Documentation

◆ asDOMDocument()

COUNTER\Metric::asDOMDocument ( )

Output this object as a DOMDocument

Returns
DOMDocument

Reimplemented from COUNTER\ReportBuilder.

Definition at line 1818 of file COUNTER.php.

◆ build()

static COUNTER\Metric::build (   $array)
static

Construct the object from an array

Parameters
array$arrayHash of key-values
Returns
\self
Exceptions
Exception

Reimplemented from COUNTER\ReportBuilder.

Definition at line 1796 of file COUNTER.php.

References COUNTER\DateRange\build().


The documentation for this class was generated from the following file: