Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Report_Links_Edit_Fns Class Reference
Inheritance diagram for Report_Links_Edit_Fns:
Report_Edit_Fns Page_Edit_Fns Asset_Edit_Fns MySource_Object

Public Member Functions

 __construct ()
 
 generateReport (&$job, &$step_data, $prefix)
 
 _addReportContent ($content, $link_info, $results=Array('valid'=>'0','description'=>''))
 
 validateInternalLink ($link)
 
 validateExternalLink ($url)
 
 _checkResponse ($headers, $response, $info)
 
 validateEmailLink ($mailto)
 
 paintReport (&$asset, &$o, $prefix)
 
 _getAssetReportInfo ($assetid)
 
 paintDisplayOptions (&$asset, &$o, $prefix)
 
 processDisplayOptions (&$asset, &$o, $prefix)
 
 paintStatusSelection (&$asset, &$o, $prefix)
 
 processStatusSelection (&$asset, &$o, $prefix)
 
 paintExport (&$asset, &$o, $prefix)
 
 processExport (&$asset, &$o, $prefix)
 
 paintFutureRegenerate (&$asset, &$o, $prefix)
 
 processFutureRegenerate (&$asset, &$o, $prefix)
 
 paintReportBrokenLink (&$asset, &$o, $prefix)
 
 processReportBrokenLink (&$asset, &$o, $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 31 of file report_links_edit_fns.inc.

Constructor & Destructor Documentation

__construct ( )

Constructor

Definition at line 39 of file report_links_edit_fns.inc.

Member Function Documentation

_addReportContent (   $content,
  $link_info,
  $results = Array('valid'=>'0','description'=>'') 
)

Add Report Content

Parameters
string$contentThe content field (in case something is added before this
array$link_infoThe link type and url
array$resultsThe validated results in the format
Returns
string private

Definition at line 292 of file report_links_edit_fns.inc.

_checkResponse (   $headers,
  $response,
  $info 
)

Check the response of the external link

Parameters
string$headersthe captured headers
string$responsethe captured response
array$infothe captured stream info
Returns
array private

Definition at line 509 of file report_links_edit_fns.inc.

_getAssetReportInfo (   $assetid)

Get reporting information about an asset Returns array('assetid', 'type', 'string', 'bg')

Parameters
string$assetidthe id of the asset we are getting reporting info for
Returns
array private

Definition at line 934 of file report_links_edit_fns.inc.

generateReport ( $job,
$step_data,
  $prefix 
)

Generate this report until complete

Parameters
object&$joba reference to the array of information about
array&$step_dataa reference to the array of information about the current step of the HIPO job that is running this report
string$prefixprefix for form vars
Returns
boolean public

Definition at line 58 of file report_links_edit_fns.inc.

paintDisplayOptions ( $asset,
$o,
  $prefix 
)

Paints the display options available for this report

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form element
Returns
boolean public

Definition at line 1013 of file report_links_edit_fns.inc.

paintExport ( $asset,
$o,
  $prefix 
)

Paints the export block

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 1307 of file report_links_edit_fns.inc.

paintFutureRegenerate ( $asset,
$o,
  $prefix 
)

Paints the future regeneration cron job section

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 1501 of file report_links_edit_fns.inc.

paintReport ( $asset,
$o,
  $prefix 
)

Paint the interface for viewing a report

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form element
Returns
boolean public

Definition at line 661 of file report_links_edit_fns.inc.

paintReportBrokenLink ( $asset,
$o,
  $prefix 
)

Paints the report broken links option

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 1682 of file report_links_edit_fns.inc.

paintStatusSelection ( $asset,
$o,
  $prefix 
)

Paint the interface for selecting statuses

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 1236 of file report_links_edit_fns.inc.

processDisplayOptions ( $asset,
$o,
  $prefix 
)

Paints the display options available for this report

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form element
Returns
boolean public

Definition at line 1196 of file report_links_edit_fns.inc.

processExport ( $asset,
$o,
  $prefix 
)

Processes the export block

This will generate a CSV file, and present a download box to the user

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 1340 of file report_links_edit_fns.inc.

processFutureRegenerate ( $asset,
$o,
  $prefix 
)

Processes the future regeneration cron job section

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 1603 of file report_links_edit_fns.inc.

processReportBrokenLink ( $asset,
$o,
  $prefix 
)

Processes the report broken links option

This will send emails to asset admins, reporting broken links found

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 1722 of file report_links_edit_fns.inc.

processStatusSelection ( $asset,
$o,
  $prefix 
)

Processes the interface for selecting statuses

Parameters
object&$assetthe asset to which we belong
object&$othe outputter class
string$prefixprefix for the form element
Returns
boolean public

Definition at line 1281 of file report_links_edit_fns.inc.

validateEmailLink (   $mailto)

Check the validity of an mailto

Parameters
string$mailtothe mailto being validated
Returns
array public

Definition at line 635 of file report_links_edit_fns.inc.

validateExternalLink (   $url)

Check the validity of an external link

Parameters
string$urlthe url being validated
Returns
array public

Definition at line 387 of file report_links_edit_fns.inc.

validateInternalLink (   $link)

Check the validity of an internal link

Parameters
array$linkthe internal link in the format: Array ( [0] => ./?a=123#anchor_name [1] => 142 [2] => anchor_name )
Returns
array public

Definition at line 318 of file report_links_edit_fns.inc.


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