Overview

Namespaces

  • NGS
    • Client
      • Exception
    • Converter
    • Patterns
  • PHP

Classes

  • ApplicationProxy
  • CrudProxy
  • DomainProxy
  • HttpRequest
  • QueryString
  • ReportingProxy
  • RestHttp
  • StandardProxy
  • Overview
  • Namespace
  • Class
  • Tree

Class ReportingProxy

Proxy service to reporting operations such as document generation, report population and history lookup. Report should be used to minimize calls to server.

Namespace: NGS\Client
Located at Client/ReportingProxy.php
Methods summary
public
# __construct( NGS\Client\RestHttp $http = null )

Create a new ReportingProxy instance

Create a new ReportingProxy instance

Parameters

$http
NGS\Client\RestHttp
$http RestHttp instance used for http request. Optionally specify an instance, otherwise use a singleton instance
public static NGS\Client\ReportingProxy
# instance( )

Gets singleton instance of Reporting.svc proxy

Gets singleton instance of Reporting.svc proxy

Returns

NGS\Client\ReportingProxy
public mixed
# populateReport( mixed $report )

Populate report. Send message to server with serialized report specification.

Populate report. Send message to server with serialized report specification.

Parameters

$report
mixed
$report

Returns

mixed

Todo:

API change, Report/Result
public string
# createReport( mixed $report, string $templater )

Create document from report. Send message to server with serialized report specification. Server will return template populated with found data.

Create document from report. Send message to server with serialized report specification. Server will return template populated with found data.

Parameters

$report
mixed
$report Report instance
$templater
string
$templater Templater name

Returns

string
Report contents
public string
# olapCubeWithSpecification( NGS\Patterns\OlapCube $cube, NGS\Patterns\Specification $specification, string $templater, array $dimensions, array $facts, array $order = array() )

Perform data analysis on specified data source. Data source is filtered using provided specification. Analysis is performed by grouping data by dimensions and aggregating information using specified facts.

Perform data analysis on specified data source. Data source is filtered using provided specification. Analysis is performed by grouping data by dimensions and aggregating information using specified facts.

Parameters

$cube
NGS\Patterns\OlapCube
$cube
$specification
NGS\Patterns\Specification
$specification
$templater
string
$templater
$dimensions
array
$dimensions
$facts
array
$facts
$order
array
$order

Returns

string
Report contents
public string
# olapCube( NGS\Patterns\OlapCube $cube, string $templater, array $dimensions, array $facts, array $order = array() )

Perform data analysis on specified data source. Analysis is performed by grouping data by dimensions and aggregating information using specified facts.

Perform data analysis on specified data source. Analysis is performed by grouping data by dimensions and aggregating information using specified facts.

Parameters

$cube
NGS\Patterns\OlapCube
$cube
$templater
string
$templater
$dimensions
array
$dimensions
$facts
array
$facts
$order
array
$order

Returns

string
Report contents
public array
# getHistory( string $class, string $uri )

Get aggregate root history. History is collection of snapshots made at state changes.

Get aggregate root history. History is collection of snapshots made at state changes.

Parameters

$class
string
$class Object class name
$uri
string
$uri Object URI

Returns

array
List of history entries
public string
# findTemplater( string $file, string $class, string $uri = null )

Populate template using found domain object. Optionally convert document to pdf.

Populate template using found domain object. Optionally convert document to pdf.

Parameters

$file
string
$file Template file to populate
$class
string
$class Object class
$uri
string
$uri Object URI

Returns

string
Populated template contents
public string
# searchTemplater( string $file, NGS\Patterns\Specification $specification )

Populate template using domain objects which satisfy {@ses NGS\Patterns\Specification}. Optionally convert document to pdf.

Populate template using domain objects which satisfy {@ses NGS\Patterns\Specification}. Optionally convert document to pdf.

Parameters

$file
string
$file Template file to populate
$specification
NGS\Patterns\Specification
Specification to be searched

Returns

string
Populated template contents
public string
# searchTemplaterGeneric( string $file, NGS\Patterns\GenericSearch $search )

Populate template using domain objects which satisfy {@ses NGS\Patterns\GenericSearch}.

Populate template using domain objects which satisfy {@ses NGS\Patterns\GenericSearch}.

Parameters

$file
string
$file Template file to populate
$search
string
\NGS\Patterns\GenericSearch

Returns

string
Populated template contents
Constants summary
string REPORTING_URI 'Reporting.svc'
#
Properties summary
protected mixed $http
#
protected static mixed $instance
#
API documentation generated by ApiGen 2.8.0