Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Metadata_Schema_Edit_Fns Class Reference
Inheritance diagram for Metadata_Schema_Edit_Fns:
Folder_Edit_Fns Asset_Edit_Fns MySource_Object

Public Member Functions

 __construct ()
 
 paintNewSection (Metadata_Schema $asset, Backend_Outputter $o, $prefix)
 
 processNewSection (Metadata_Schema $asset, Backend_Outputter $o, $prefix)
 
 paintRegenerate (Metadata_Schema $asset, Backend_Outputter $o, $prefix)
 
 processRegenerate (Metadata_Schema $asset, Backend_Outputter $o, $prefix)
 
 paintSections (Metadata_Schema $asset, Backend_Outputter $o, $prefix)
 
 processSections (Metadata_Schema $asset, Backend_Outputter $o, $prefix)
 
 paintInlineValueInterface (Metadata_Schema $asset, Backend_Outputter $o, $values, $write_access, $print_cascade_values_option=TRUE, $type_code=NULL)
 
 processInlineValueInterface (Metadata_Schema $asset, Array &$new_values, Array &$schema_cascade_values_asset_ids, $type_code=NULL)
 
 requiredFieldsComplete (Metadata_Schema $asset, Array $values, $type_code=NULL)
 
 generateMetadata (Metadata_Schema $asset, Array &$values, Array &$tag_values, Array &$keywords, $type_code=NULL)
 
 paintUsage (Metadata_Schema $asset, Backend_Outputter $o, $prefix)
 
 _getTreeTops (Metadata_Schema $asset, Array $treeids)
 
- 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 ()
 

Additional Inherited Members

- Data Fields inherited from Asset_Edit_Fns
 $static_screens
 

Detailed Description

Definition at line 30 of file metadata_schema_edit_fns.inc.

Constructor & Destructor Documentation

__construct ( )

Constructor

Definition at line 38 of file metadata_schema_edit_fns.inc.

Member Function Documentation

_getTreeTops ( Metadata_Schema  $asset,
Array  $treeids 
)

Get the "tree tops" in the supplied list of assets

An asset is a "tree top" in a set of assets if none of its ancestors in the asset tree are in the set with it. Conversely if an asset's parent or grandparent etc is in the set, then that asset is not a tree top.

Returns an array indexed by treeid, where each value is another array containing assetid and number of children of that assetid found in the set.

Parameters
array$assetidsThe assetids we are analysing
Returns
array public

Definition at line 526 of file metadata_schema_edit_fns.inc.

generateMetadata ( Metadata_Schema  $asset,
Array &  $values,
Array &  $tag_values,
Array &  $keywords,
  $type_code = NULL 
)

Output the complete metadata tags for this schema

Parameters
Metadata_Schema$assetthe asset whose interface we are painting
array&$valuesthe current metadata values
array&$tag_valuesthe metadata tag values
array&$keywordsan array we can put keywords in that need replacing
string$type_codeThe type_code of the asset that the metadata is being printed
Returns
boolean public

Definition at line 336 of file metadata_schema_edit_fns.inc.

paintInlineValueInterface ( Metadata_Schema  $asset,
Backend_Outputter  $o,
  $values,
  $write_access,
  $print_cascade_values_option = TRUE,
  $type_code = NULL 
)

Paint the interface for filling in metadata values

Parameters
Metadata_Schema$assetthe asset whose interface we are painting
Backend_Outputter$othe outputter class
string$valuesthe current value for this field in the asset (NOT $asset) NULL means that there is no current value set
boolean$write_accessdoes the current user have write access to the asset that we are setting metadata for (NOT THE SAME AS $asset)
boolean$print_cascade_values_optionprint the Metadata Field checkbox option to 'Cascade Values'
string$type_codeThe type_code of the asset that the metadata is being printed
Returns
boolean public

Definition at line 242 of file metadata_schema_edit_fns.inc.

paintNewSection ( Metadata_Schema  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint the interface for creating a new metadata section

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

Definition at line 57 of file metadata_schema_edit_fns.inc.

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

Paint the interface for regenerating metadata files

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

Definition at line 106 of file metadata_schema_edit_fns.inc.

paintSections ( Metadata_Schema  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paint the interface for editing metadata sections

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

Definition at line 158 of file metadata_schema_edit_fns.inc.

processInlineValueInterface ( Metadata_Schema  $asset,
Array &  $new_values,
Array &  $schema_cascade_values_asset_ids,
  $type_code = NULL 
)

Process the interface for filling in metadata values

Returns true if at least one section processed something

Parameters
Metadata_Schema$assetthe asset whose interface we are painting
array&$new_valuesan array we can store the new values in
string$type_codeThe type_code of the asset that the metadata is being printed
Returns
boolean public

Definition at line 274 of file metadata_schema_edit_fns.inc.

processNewSection ( Metadata_Schema  $asset,
Backend_Outputter  $o,
  $prefix 
)

Processes the interface for creating a new metadata section

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

Definition at line 77 of file metadata_schema_edit_fns.inc.

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

Processes the interface for regenerating metadata files

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

Definition at line 132 of file metadata_schema_edit_fns.inc.

processSections ( Metadata_Schema  $asset,
Backend_Outputter  $o,
  $prefix 
)

Processes the interface for editing metadata sections

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

Definition at line 197 of file metadata_schema_edit_fns.inc.

requiredFieldsComplete ( Metadata_Schema  $asset,
Array  $values,
  $type_code = NULL 
)

Check if all required fields have been completed in the values supplied

Parameters
Metadata_Schema$assetthe asset whose metadata we are checking
array$valuesthe current metadata values
string$type_codeThe type_code of the asset that the metadata is being printed
Returns
boolean public

Definition at line 307 of file metadata_schema_edit_fns.inc.


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