COUNTER\Reports Class Reference
Inheritance diagram for COUNTER\Reports:
Public Member Functions | |
| __construct ($reports) | |
| addReport ($report) | |
| asDOMDocument () | |
| getReports () | |
 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 reports base class
Definition at line 334 of file COUNTER.php.
Constructor & Destructor Documentation
◆ __construct()
| COUNTER\Reports::__construct | ( | $reports | ) |
Construct the object
- Parameters
-
array $reports COUNTER\Report array
- Returns
- void
- Exceptions
-
Exception
Definition at line 350 of file COUNTER.php.
References COUNTER\ReportBuilder\validateOneOrMoreOf().
Member Function Documentation
◆ addReport()
| COUNTER\Reports::addReport | ( | $report | ) |
Add a report
- Parameters
-
object $report CounterReport
- Returns
- void
- Exceptions
-
Exception
Definition at line 381 of file COUNTER.php.
References COUNTER\ReportBuilder\validateOneOf().
◆ asDOMDocument()
| COUNTER\Reports::asDOMDocument | ( | ) |
Output this object as a DOMDocument
- Returns
- DOMDocument
Reimplemented from COUNTER\ReportBuilder.
Definition at line 397 of file COUNTER.php.
◆ build()
|
static |
Construct the object from an array
- Parameters
-
array $array Hash of key-values
- Returns
- \self
- Exceptions
-
Exception
Reimplemented from COUNTER\ReportBuilder.
Definition at line 360 of file COUNTER.php.
◆ getReports()
| COUNTER\Reports::getReports | ( | ) |
Get an array of reports
- Returns
- array COUNTER\Report array
Definition at line 389 of file COUNTER.php.
The documentation for this class was generated from the following file:
