Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Bodycopy_Container_Edit_Fns Class Reference
Inheritance diagram for Bodycopy_Container_Edit_Fns:
Asset_Edit_Fns MySource_Object Bodycopy_Div_Edit_Fns Bodycopy_Table_Edit_Fns

Public Member Functions

 __construct ()
 
 setAttribute (Array &$attributes, $name, $value)
 
 paintBackendJsData (Bodycopy_Container $asset, $prefix)
 
 paintGenericBackend (Bodycopy_Container $asset, Backend_Outputter $o, $prefix)
 
 paint (Bodycopy_Container $asset, $editing=FALSE, $generating=FALSE)
 
 paintContainer (Bodycopy_Container $asset, Backend_Outputter $o, $prefix)
 
 processContainer (Bodycopy_Container $asset, Backend_Outputter $o, $prefix, $bc_action, $bc_name, Array $bc_data, Array $bc_saved)
 
 generateContentFile (Bodycopy_Container $asset)
 
 createContentLinks (Bodycopy_Container $asset, $output=NULL)
 
 _contentsUpdated (Bodycopy_Container $asset)
 
 paintBodycopyContainer (Bodycopy_Container $asset, Backend_Outputter $o, $prefix)
 
- 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 ()
 

Data Fields

position __pad0__:absolute
 
width __pad1__: 1px
 
height __pad2__: 1px
 
visibility __pad3__: hidden
 
- Data Fields inherited from Asset_Edit_Fns
 $static_screens
 
- Data Fields inherited from MySource_Object
 $_tmp
 

Protected Member Functions

 _saveCssIds (Backend_Outputter $o)
 

Detailed Description

Definition at line 33 of file bodycopy_container_edit_fns.inc.

Constructor & Destructor Documentation

__construct ( )

Constructor

Definition at line 41 of file bodycopy_container_edit_fns.inc.

Member Function Documentation

_contentsUpdated ( Bodycopy_Container  $asset)

gets called when a bodycopy container's contents are updated to notify anyone who cares about this

Parameters
Bodycopy_Container$assetthe asset that is getting updated
Returns
boolean public

Definition at line 508 of file bodycopy_container_edit_fns.inc.

_saveCssIds ( Backend_Outputter  $o)
protected

Save the ids of all css files attached to this url to be used by the wysiwyg editor later on

Parameters
Backend_Outputter$othe Backend_Outputter class
Returns
mixed array|NULL private

Definition at line 525 of file bodycopy_container_edit_fns.inc.

createContentLinks ( Bodycopy_Container  $asset,
  $output = NULL 
)

Creates and deletes NOTICE links based on the assets being linked to within the contents of this container For shadow assets it

Parameters
Bodycopy_Container$assetthe container
string | NULL$outputthe content of the bodycopy container, leave NULL to have it generated for you
Returns
boolean public

Definition at line 361 of file bodycopy_container_edit_fns.inc.

generateContentFile ( Bodycopy_Container  $asset)

Creates a PHP file to print on the frontend instead of doing processing there

Parameters
Bodycopy_Container$assetthe container
Returns
boolean public

Definition at line 259 of file bodycopy_container_edit_fns.inc.

paint ( Bodycopy_Container  $asset,
  $editing = FALSE,
  $generating = FALSE 
)

Paints this container as HTML

Parameters
Bodycopy_Container$assetthe container whose interface we are painting
boolean$editingare we printing an editing interface
boolean$generatingare we generating the content file
Returns
void public

Definition at line 117 of file bodycopy_container_edit_fns.inc.

paintBackendJsData ( Bodycopy_Container  $asset,
  $prefix 
)

Prints the JavaScript needed by the backend functions for this table

Parameters
Bodycopy_Container$assetthe container object being printed
string$prefixprefix for form fields
Returns
void public

Definition at line 85 of file bodycopy_container_edit_fns.inc.

paintBodycopyContainer ( Bodycopy_Container  $asset,
Backend_Outputter  $o,
  $prefix 
)

When this bodycopycontainer is painted on its own without being a part of the 'contents' of a bodycopy, draw the editing info by itself. Most of the code is directly taken from the Bodycopy_Edit_Fns class as the functionality is so similar. Perhaps going to aggregate it out to a separate class though once it is understood better.

Parameters
Bodycopy_Container$assetthe container whose interface we are painting
Backend_Outputter$othe outputter class
string$prefixprefix for the form element
Returns
boolean public

Definition at line 571 of file bodycopy_container_edit_fns.inc.

paintContainer ( Bodycopy_Container  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint the interface for editing this container

Parameters
Bodycopy_Container$assetthe container whose interface we are painting
Backend_Outputter$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 133 of file bodycopy_container_edit_fns.inc.

paintGenericBackend ( Bodycopy_Container  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint JS data that containers need to use to do their processing

Parameters
Bodycopy_Container$assetthe bodycopy being printed
Backend_Outputter$othe outputter class
string$prefixprefix for the form element
Returns
void public

Definition at line 101 of file bodycopy_container_edit_fns.inc.

processContainer ( Bodycopy_Container  $asset,
Backend_Outputter  $o,
  $prefix,
  $bc_action,
  $bc_name,
Array  $bc_data,
Array  $bc_saved 
)

Process the interface for editing this container

Parameters
Bodycopy_Container$assetthe container whose interface we are painting
Backend_Outputter$othe outputter class
string$prefixprefix for the form element
string$bc_actiona global bodycopy action to perform
string$bc_namethe name of the bodycopy that submitted the action
array$bc_dataan array of data needed to perform the action
array$bc_savedany saved changes that were performed without committing
Returns
boolean public

Definition at line 193 of file bodycopy_container_edit_fns.inc.

setAttribute ( Array &  $attributes,
  $name,
  $value 
)

Set an attribute value in the attributes var

Internal checking of these attributes has to go here as they will not be checked by the system

Parameters
array&$attributesa reference to the attributes var of the BodyCopy_Container object
string$namethe name of the attribute
string$valuethe value of the attribute
Returns
boolean public

Definition at line 64 of file bodycopy_container_edit_fns.inc.


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