Inheritance diagram for Search_Log_Report_Edit_Fns:

Public Member Functions
	generateReport (&$job, &$step_data, $prefix)

	_updateTerm ($term, $result, &$meta)

	_updateTermValues ($term, $result, &$data)

&	_readTerm ($term, $term_dir_path)

	_writeTerm ($term, $term_dir_path, &$data)

	_updateIndex (&$array, $index, $value, $limit)

	_generateReportCache (&$meta, &$indices)

	_performRollover (&$report, $date)

	_getSearchAssetids ($term_dir_path)

	_getTermHash ($term)

	paintReport (&$asset, &$o, $prefix)

	paintRegenerate (&$asset, &$o, $prefix)

	_getPreviousDate ($report)

Public Member Functions inherited from Log_Report_Edit_Fns
	__construct ()

	paintRegenerate (Log_Report $asset, Backend_Outputter $o, $prefix)

	_processRegenerate (Log_Report $asset, Backend_Outputter $o, $prefix)

	paintReport (Log_Report $asset, Backend_Outputter $o, $prefix)

	generateReport (HIPO_Job $job, Array &$step_data, $prefix)

Public Member Functions inherited from Report_Edit_Fns
	__construct ()

	paintRegenerate (Report $asset, Backend_Outputter $o, $prefix)

	processRegenerate (Report $asset, Backend_Outputter $o, $prefix)

	paintRootNode (Report $asset, Backend_Outputter $o, $prefix)

	processRootNode (Report $asset, Backend_Outputter $o, $prefix)

	getRootAssetid (Report $asset)

	paintReport (Report $asset, Backend_Outputter $o, $prefix)

	processReport (Report $asset, Backend_Outputter $o, $prefix)

	generateReport (HIPO_Job $job, Array &$step_data, $prefix)

Public Member Functions inherited from Page_Edit_Fns
	__construct ()

Public Member Functions inherited from Asset_Edit_Fns
	Asset_Edit_Fns ()

	paintPaths (&$asset, &$o, $prefix)

	paintEditRemapURLs (&$asset, &$o, $prefix)

	processPaths (&$asset, &$o, $prefix)

	processEditRemapURLs (&$asset, &$o, $prefix)

	paintURLs (&$asset, &$o, $prefix)

	paintAddRemapURLs (&$asset, &$o, $prefix)

	processAddRemapURLs (&$asset, &$o, $prefix)

	isWorkflowComplete (&$asset)

	paintNoticeLinkedAsset (&$asset, $link_value, $type_codes=Array(), $field_name='', $multiple=FALSE)

	processNoticeLinkedAsset (&$asset, $link_value, $field_name='', $multiple=FALSE)

	isSearchInstalled (&$asset, $prefix)

	isBeingCreated (&$asset)

	isNotBeingCreated (&$asset)

	paintAutomaticRemapSetting (&$asset, &$o, $prefix)

	paintCreateLink (&$asset, &$o, $prefix)

Public Member Functions inherited from MySource_Object
	MySource_Object ()

	__sleep ()

	__wakeup ()

Additional Inherited Members
Data Fields inherited from Asset_Edit_Fns
	$static_screens

Detailed Description

Definition at line 32 of file search_log_report_edit_fns.inc.

Member Function Documentation

_generateReportCache	(	&	$meta,
		&	$indices
	)

Generates the report cache from the search-term cache

Parameters

array	&$meta	the metadata array
array	&$indices	the indices array

Returns: boolean private

Definition at line 531 of file search_log_report_edit_fns.inc.

_getPreviousDate ( $report )

Get previous date from last rotated search report, if any

Parameters

object $report

Returns: int|null private

Definition at line 857 of file search_log_report_edit_fns.inc.

_getSearchAssetids ( $term_dir_path )

Returns a list of the search_page assets that have logged search results

Parameters

string $term_dir_path the path to the terms

Returns: array private

Definition at line 719 of file search_log_report_edit_fns.inc.

_getTermHash ( $term )

Hashes a term into the format '/12/34', where the numbers are the ascii values for the first two characters of the term

Parameters

string $term the term to hash

Returns: mixed boolean|string private

Definition at line 747 of file search_log_report_edit_fns.inc.

_performRollover	(	&	$report,
			$date
	)

Moves the generated report and updates the generated_reports attribute

Parameters

object	&$report	the report to use when determining the destination path, and saving settings
int	$date	the date that refers to the report and cache

Returns: boolean private

Definition at line 670 of file search_log_report_edit_fns.inc.

& _readTerm	(	$term,
		$term_dir_path
	)

Reads and returns the lines taken from a cache of term results

Parameters

string	$term	the term to read
string	$term_dir_path	the path to the term

Returns: array private

Definition at line 415 of file search_log_report_edit_fns.inc.

_updateIndex	(	&	$array,
			$index,
			$value,
			$limit
	)

Updates a specified index in a passed array, but only keeps the top $limit results. NOTE: Assumes that $array is already sorted in DESCENDING order

Parameters

array	&$array	the array containing the values to update
string	$index	the index to update
int	$value	the value to set the index to
int	$limit	the number of elements to limit the array to

Returns: boolean private

Definition at line 493 of file search_log_report_edit_fns.inc.

_updateTerm	(		$term,
			$result,
		&	$meta
	)

Updates the stats for a specific term

The metadata matches the same format as that of the log_manager, except for the addition of 'search_assetid', and the lack of 'data':

 Array(
    'userid'            => int                  // the id of the logging user
    'user'              => string               // the name of the logging user
    'date'              => int                  // the date the line was logged
    'level'             => int                  // the level of the error
    'search_assetid'    => string               // the assetid of the search page (optional)
    'report'            => object Log_Report    // the search_log_report
 );

Parameters

string	$term	the term to update
int	$result	the numbers of results for this term
array	&$meta	the metadata array

Returns: boolean private

Definition at line 310 of file search_log_report_edit_fns.inc.

_updateTermValues	(		$term,
			$result,
		&	$data
	)

Updates the values for a term

Parameters

string	$term	the term to update
int	$result	the result for the term
array	&$data	the array containing data about the searches

Returns: boolean private

Definition at line 362 of file search_log_report_edit_fns.inc.

_writeTerm	(		$term,
			$term_dir_path,
		&	$data
	)

Writes the updated results to the term's cache file

Parameters

string	$term	the term to write
string	$term_dir_path	the path to the term
array	&$data	the data to write

Returns: boolean private

Definition at line 450 of file search_log_report_edit_fns.inc.

generateReport	(	&	$job,
		&	$step_data,
			$prefix
	)

Generate this report until complete

Parameters

object	&$job	a reference to the array of information about
array	&$step_data	a reference to the array of information about the current step of the HIPO job that is running this report
string	$prefix	prefix for form vars

Returns: boolean public

Definition at line 46 of file search_log_report_edit_fns.inc.

paintRegenerate	(	&	$asset,
		&	$o,
			$prefix
	)

Paint the interface for regenerating the report

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form element

Returns: boolean public

Definition at line 830 of file search_log_report_edit_fns.inc.

paintReport	(	&	$asset,
		&	$o,
			$prefix
	)

Paint the interface for viewing a report

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form element

Returns: boolean public

Definition at line 781 of file search_log_report_edit_fns.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/search/log_reports/search_log_report/search_log_report_edit_fns.inc

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation