Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Public Member Functions | Protected Member Functions | Protected Attributes
Site_Edit_Fns Class Reference
Inheritance diagram for Site_Edit_Fns:
Folder_Edit_Fns Asset_Edit_Fns MySource_Object Web_Folder_Edit_Fns Web_Folder_Designs_Edit_Fns Web_Folder_Media_Edit_Fns Web_Folder_Users_Edit_Fns Web_Folder_Web_Services_Edit_Fns

Public Member Functions

 __construct ()
 
 paintURLs (Site $asset, Backend_Outputter $o, $prefix)
 
 processURLs (Site $asset, Backend_Outputter $o, $prefix, $updatelookups=TRUE)
 
 paintIndexPage (Site $asset, Backend_Outputter $o, $prefix)
 
 processIndexPage (Site $asset, Backend_Outputter $o, $prefix)
 
 paintArchivedPage (Site $asset, Backend_Outputter $o, $prefix)
 
 processArchivedPage (Site $asset, Backend_Outputter $o, $prefix)
 
 paintForbiddenPage (Site $asset, Backend_Outputter $o, $prefix)
 
 processForbiddenPage (Site $asset, Backend_Outputter $o, $prefix)
 
 paintNotFoundPage (Site $asset, Backend_Outputter $o, $prefix)
 
 processNotFoundPage (Site $asset, Backend_Outputter $o, $prefix)
 
 paintNotFoundPageDesign (Site $asset, Backend_Outputter $o, $prefix)
 
 processNotFoundPageDesign (Site $asset, Backend_Outputter $o, $prefix)
 
 paintNotFoundPagePaintLayout (Site $asset, Backend_Outputter $o, $prefix)
 
 processNotFoundPagePaintLayout (Site $asset, Backend_Outputter $o, $prefix)
 
 paintAuthURLs (Site $asset, Backend_Outputter $o, $prefix)
 
 processAuthURLs (Site $asset, Backend_Outputter $o, $prefix)
 
- Public Member Functions inherited from Folder_Edit_Fns
 Folder_Edit_Fns ()
 
- 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 ()
 

Protected Member Functions

 _paintURL (Backend_Outputter $o, $prefix, $i, Array $url_info, $write_access)
 
 _isCircularReference (Array $urls)
 

Protected Attributes

 $protos = Array('http', 'https')
 

Additional Inherited Members

- Data Fields inherited from Asset_Edit_Fns
 $static_screens
 

Detailed Description

Definition at line 32 of file site_edit_fns.inc.

Constructor & Destructor Documentation

__construct ( )

Constructor

Definition at line 45 of file site_edit_fns.inc.

Member Function Documentation

_isCircularReference ( Array  $urls)
protected

Checks the URL list to see if there is a circular reference that would cause a redirect loop

Algorithm:

  • Start on each from URL ID, traverse to the to URL ID, and that becomes the next "from".
  • If at any point we hit a "no redirect", then there is no loop with that particular URL.
  • If at any point we hit a URL ID that we have seen before from a particular, then we have looped, so return TRUE. (Obviously we start afresh from each starting point.)

Example: Example URL setup Circular? ============================== ========= A => B, B => A YES A => B, B => C, C => A YES A => B, B => C, C => NULL NO

Parameters
array$urlsarray of URL IDs
Returns
boolean private

Definition at line 870 of file site_edit_fns.inc.

_paintURL ( Backend_Outputter  $o,
  $prefix,
  $i,
Array  $url_info,
  $write_access 
)
protected

Paint the interface for individual URLs

Parameters
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
int$ithe count for this URL
array$url_infothe urls info
boolean$write_accesswhether the user can edit this url
Returns
boolean protected

Definition at line 220 of file site_edit_fns.inc.

paintArchivedPage ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint the interface for setting the "archived 404" page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 460 of file site_edit_fns.inc.

paintAuthURLs ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint the interface for setting authentication redirects for the site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 630 of file site_edit_fns.inc.

paintForbiddenPage ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint the interface for setting the forbidden page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 494 of file site_edit_fns.inc.

paintIndexPage ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint the interface for setting the index page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 426 of file site_edit_fns.inc.

paintNotFoundPage ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint the interface for setting the not found page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 528 of file site_edit_fns.inc.

paintNotFoundPageDesign ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint the interface for the design setting the not found page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 562 of file site_edit_fns.inc.

paintNotFoundPagePaintLayout ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint the interface for the paint layout setting the not found page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 596 of file site_edit_fns.inc.

paintURLs ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint the interface for the asset urls

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 64 of file site_edit_fns.inc.

processArchivedPage ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Processes the setting of the "archived 404" page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 477 of file site_edit_fns.inc.

processAuthURLs ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Process the interface for setting authentication redirects for the site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 749 of file site_edit_fns.inc.

processForbiddenPage ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Processes the setting of the forbidden page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 511 of file site_edit_fns.inc.

processIndexPage ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Processes the setting of the index page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 443 of file site_edit_fns.inc.

processNotFoundPage ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Processes the setting of the not found page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 545 of file site_edit_fns.inc.

processNotFoundPageDesign ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Processes the design setting of the not found page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 579 of file site_edit_fns.inc.

processNotFoundPagePaintLayout ( Site  $asset,
Backend_Outputter  $o,
  $prefix 
)

Processes the design setting of the not found page for this site

Parameters
Site$assetthe asset whose interface we are painting
Backend_Outputter$othe Backend Outputter object
string$prefixprefix for the form element
Returns
boolean public

Definition at line 613 of file site_edit_fns.inc.

processURLs ( Site  $asset,
Backend_Outputter  $o,
  $prefix,
  $updatelookups = TRUE 
)

Processes the URLs posted from the paintURLs fn above

Parameters
object&$assetthe asset whose interface we are painting
object&$othe Backend Outputter object
string$prefixprefix for the form element
boolean$updatelookupsTRUE = run HIPO job as normal, FALSE = don't run HIPO job
Returns
boolean public

Definition at line 292 of file site_edit_fns.inc.

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