CBench Class Reference

Benching library.
Is automatically loaded by CaMykS, when loading page with head param "_cBench=<output_mode>"
Developers can add their own steps in CaMykS running bench, or create their own bench. More...

Public Member Functions
	__construct ($params=array())
	start ($title='Start')
	add_steps ($title='Step')
	stop ($title='Stop')
	export ($output='')
	get_results ()

Private Member Functions
	_export_toSharedData ()
	_export_toSession ()
	_export_toCaMykSLogs ()
	_export_toHTML ()
	_compute_results ()

Private Attributes
	$params = array('output' =>'html')
	CBench parameters. More...
	$status = 'idle'
	CBench status. More...
	$bench = array()
	CBench saved steps. More...
	$results = array()
	CBench computed results. More...

Detailed Description

Benching library.
Is automatically loaded by CaMykS, when loading page with head param "_cBench=<output_mode>"
Developers can add their own steps in CaMykS running bench, or create their own bench.

Engine / Object Library

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.1.1

Date

Creation: Mar 2014

Modification: Jul 2025

Copyright

2014 - 2025 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. CBench class.

Constructor & Destructor Documentation

__construct()

CBench::__construct

(

$params = array()

)

Object constructor

Parameters

array

$params

- Available parameters are string output - none / shared / session / logs / html

Member Function Documentation

start()

CBench::start

(

$title = 'Start'

)

Start bench.

Parameters

string

$title

Returns

mixed

add_steps()

CBench::add_steps

(

$title = 'Step'

)

Add a step to bench.

Parameters

string

$title

Returns

void

stop()

CBench::stop

(

$title = 'Stop'

)

Stop bench.

Parameters

string

$title

Returns

void

export()

CBench::export

(

$output = ''

)

Export results.

Returns

void

get_results()

CBench::get_results

(

)

Return results.

Returns

array

_export_toSharedData()

CBench::_export_toSharedData ( )

private

Export results to CaMykS shared data.

Returns

void

_export_toSession()

CBench::_export_toSession ( )

private

Export results to session.

Returns

void

_export_toCaMykSLogs()

CBench::_export_toCaMykSLogs ( )

private

Export results to CaMykS logs.

Returns

void

_export_toHTML()

CBench::_export_toHTML ( )

private

Export results to HTML.

Returns

void

_compute_results()

CBench::_compute_results ( )

private

Compute results.

Returns

void

Member Data Documentation

$params

array CBench::$params = array('output' =>'html')

private

CBench parameters.

$status

string CBench::$status = 'idle'

private

CBench status.

$bench

array CBench::$bench = array()

private

CBench saved steps.

$results

array CBench::$results = array()

private

CBench computed results.

---

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

• CaMykS/engine/lib/object/CBench.php.inc