From 8207e9f825cbb79a827729607044a2578a667443 Mon Sep 17 00:00:00 2001 From: Ben Woodhead Date: Thu, 14 Jul 2011 16:30:46 -0300 Subject: [PATCH] started adding documentation --- .gitignore | 1 + CollectionClass.inc | 6 +- CollectionPolicy.inc | 6 +- ConnectionHelper.inc | 5 + ContentModel.inc | 6 +- MimeClass.inc | 5 + ObjectHelper.inc | 6 +- SearchClass.inc | 5 + SecurityClass.inc | 5 + XMLDatastream.inc | 6 +- api/dublin_core.inc | 5 + api/fedora_collection.inc | 5 + api/fedora_export.inc | 7 +- api/fedora_item.inc | 7 +- api/fedora_utils.inc | 6 + api/rels-ext.inc | 5 + api/tagging.inc | 5 + docs/Islandora/API/Dublin_Core.html | 479 ++ docs/Islandora/API/Fedora_Item.html | 1521 +++++++ docs/Islandora/API/RelsExt.html | 308 ++ docs/Islandora/API/TagSet.html | 361 ++ .../Islandora/API/_api---dublin_core.inc.html | 139 + .../API/_api---fedora_collection.inc.html | 247 ++ .../API/_api---fedora_export.inc.html | 387 ++ .../Islandora/API/_api---fedora_item.inc.html | 182 + .../API/_api---fedora_utils.inc.html | 317 ++ docs/Islandora/API/_api---rels-ext.inc.html | 139 + docs/Islandora/API/_api---tagging.inc.html | 139 + docs/Islandora/IslandoraBook.html | 405 ++ docs/Islandora/Newspaper.html | 325 ++ .../ShowILivesStreamsInFieldSets.html | 210 + docs/Islandora/_ilives---book.inc.html | 342 ++ ...ives---image_rotator_tagger_block.inc.html | 192 + ...dora_attach---fedora_attach.admin.inc.html | 146 + ...--islandora_newspaper---Newspaper.inc.html | 139 + .../plugins/CollectionFormBuilder.html | 243 + docs/Islandora/plugins/CreateCollection.html | 219 + docs/Islandora/plugins/DarwinCore.html | 434 ++ docs/Islandora/plugins/DemoFormBuilder.html | 243 + docs/Islandora/plugins/DocumentConverter.html | 228 + docs/Islandora/plugins/Exiftool.html | 252 ++ docs/Islandora/plugins/FedoraObject.html | 213 + docs/Islandora/plugins/Ffmpeg.html | 219 + docs/Islandora/plugins/FlvFormBuilder.html | 243 + docs/Islandora/plugins/FormBuilder.html | 504 +++ docs/Islandora/plugins/Herbarium.html | 363 ++ docs/Islandora/plugins/ImageManipulation.html | 429 ++ docs/Islandora/plugins/ModsFormBuilder.html | 602 +++ .../plugins/PersonalCollectionClass.html | 411 ++ docs/Islandora/plugins/QtFormBuilder.html | 243 + docs/Islandora/plugins/Refworks.html | 535 +++ .../plugins/ShowDemoStreamsInFieldSets.html | 210 + .../plugins/ShowMapStreamsInFieldSets.html | 210 + .../plugins/ShowQtStreamsInFieldSets.html | 371 ++ .../plugins/ShowSlideStreamsInFieldSets.html | 210 + .../plugins/ShowStreamsInFieldSets.html | 445 ++ .../_plugins---CollectionFormBuilder.inc.html | 139 + .../_plugins---CreateCollection.inc.html | 139 + .../plugins/_plugins---DarwinCore.inc.html | 139 + .../_plugins---DemoFormBuilder.inc.html | 139 + .../_plugins---DocumentConverter.inc.html | 139 + .../plugins/_plugins---Exiftool.inc.html | 139 + .../plugins/_plugins---Ffmpeg.inc.html | 139 + .../Islandora/plugins/_plugins---Flv.inc.html | 139 + .../_plugins---FlvFormBuilder.inc.html | 139 + .../plugins/_plugins---FormBuilder.inc.html | 139 + .../_plugins---ImageManipulation.inc.html | 139 + .../_plugins---ModsFormBuilder.inc.html | 139 + ...plugins---PersonalCollectionClass.inc.html | 139 + .../plugins/_plugins---QtFormBuilder.php.html | 139 + .../plugins/_plugins---Refworks.inc.html | 139 + ...gins---ShowDemoStreamsInFieldSets.inc.html | 139 + ..._plugins---ShowStreamsInFieldSets.inc.html | 139 + .../plugins/_plugins---fedoraObject.inc.html | 139 + .../plugins/_plugins---herbarium.inc.html | 139 + .../plugins/_plugins---map_viewer.inc.html | 139 + .../plugins/_plugins---qt_viewer.inc.html | 139 + .../plugins/_plugins---slide_viewer.inc.html | 139 + .../plugins/_plugins---tagging_form.inc.html | 228 + .../rootdirectory/CollectionClass.html | 1015 +++++ .../rootdirectory/CollectionPolicy.html | 1063 +++++ .../rootdirectory/ConnectionHelper.html | 252 ++ .../Islandora/rootdirectory/ContentModel.html | 3227 ++++++++++++++ docs/Islandora/rootdirectory/MimeClass.html | 301 ++ .../Islandora/rootdirectory/ObjectHelper.html | 1308 ++++++ docs/Islandora/rootdirectory/SearchClass.html | 710 +++ .../rootdirectory/SecurityClass.html | 380 ++ .../rootdirectory/XMLDatastream.html | 890 ++++ .../rootdirectory/_CollectionClass.inc.html | 139 + .../rootdirectory/_CollectionPolicy.inc.html | 139 + .../rootdirectory/_ConnectionHelper.inc.html | 139 + .../rootdirectory/_ContentModel.inc.html | 139 + .../rootdirectory/_MimeClass.inc.html | 139 + .../rootdirectory/_ObjectHelper.inc.html | 139 + .../rootdirectory/_SearchClass.inc.html | 139 + .../rootdirectory/_SecurityClass.inc.html | 139 + .../rootdirectory/_XMLDatastream.inc.html | 142 + .../_fedora_repository.solutionpacks.inc.html | 210 + .../rootdirectory/_formClass.inc.html | 139 + docs/Islandora/rootdirectory/formClass.html | 679 +++ docs/blank.html | 13 + docs/classtrees_Islandora.html | 153 + docs/elementindex.html | 3911 +++++++++++++++++ docs/elementindex_Islandora.html | 3908 ++++++++++++++++ docs/errors.html | 149 + docs/index.html | 24 + docs/li_Islandora.html | 683 +++ docs/media/banner.css | 32 + docs/media/images/AbstractClass.png | Bin 0 -> 620 bytes docs/media/images/AbstractClass_logo.png | Bin 0 -> 1232 bytes docs/media/images/AbstractMethod.png | Bin 0 -> 696 bytes docs/media/images/AbstractPrivateClass.png | Bin 0 -> 848 bytes .../images/AbstractPrivateClass_logo.png | Bin 0 -> 1615 bytes docs/media/images/AbstractPrivateMethod.png | Bin 0 -> 874 bytes docs/media/images/Class.png | Bin 0 -> 570 bytes docs/media/images/Class_logo.png | Bin 0 -> 1600 bytes docs/media/images/Constant.png | Bin 0 -> 752 bytes docs/media/images/Constructor.png | Bin 0 -> 865 bytes docs/media/images/Destructor.png | Bin 0 -> 956 bytes docs/media/images/Function.png | Bin 0 -> 596 bytes docs/media/images/Global.png | Bin 0 -> 712 bytes docs/media/images/I.png | Bin 0 -> 148 bytes docs/media/images/Index.png | Bin 0 -> 584 bytes docs/media/images/Interface.png | Bin 0 -> 1083 bytes docs/media/images/Interface_logo.png | Bin 0 -> 1600 bytes docs/media/images/L.png | Bin 0 -> 153 bytes docs/media/images/Lminus.png | Bin 0 -> 219 bytes docs/media/images/Lplus.png | Bin 0 -> 224 bytes docs/media/images/Method.png | Bin 0 -> 661 bytes docs/media/images/Page.png | Bin 0 -> 592 bytes docs/media/images/Page_logo.png | Bin 0 -> 1369 bytes docs/media/images/PrivateClass.png | Bin 0 -> 790 bytes docs/media/images/PrivateClass_logo.png | Bin 0 -> 1836 bytes docs/media/images/PrivateMethod.png | Bin 0 -> 918 bytes docs/media/images/PrivateVariable.png | Bin 0 -> 772 bytes docs/media/images/StaticMethod.png | Bin 0 -> 661 bytes docs/media/images/StaticVariable.png | Bin 0 -> 688 bytes docs/media/images/T.png | Bin 0 -> 152 bytes docs/media/images/Tminus.png | Bin 0 -> 207 bytes docs/media/images/Tplus.png | Bin 0 -> 222 bytes docs/media/images/Variable.png | Bin 0 -> 688 bytes docs/media/images/blank.png | Bin 0 -> 144 bytes docs/media/images/class_folder.png | Bin 0 -> 633 bytes docs/media/images/empty.png | Bin 0 -> 90 bytes docs/media/images/file.png | Bin 0 -> 462 bytes docs/media/images/folder.png | Bin 0 -> 492 bytes docs/media/images/function_folder.png | Bin 0 -> 605 bytes docs/media/images/minus.gif | Bin 0 -> 54 bytes docs/media/images/next_button.png | Bin 0 -> 657 bytes docs/media/images/next_button_disabled.png | Bin 0 -> 543 bytes docs/media/images/package.png | Bin 0 -> 668 bytes docs/media/images/package_folder.png | Bin 0 -> 564 bytes docs/media/images/plus.gif | Bin 0 -> 56 bytes docs/media/images/previous_button.png | Bin 0 -> 644 bytes .../media/images/previous_button_disabled.png | Bin 0 -> 541 bytes docs/media/images/private_class_logo.png | Bin 0 -> 1836 bytes docs/media/images/tutorial.png | Bin 0 -> 431 bytes docs/media/images/tutorial_folder.png | Bin 0 -> 572 bytes docs/media/images/up_button.png | Bin 0 -> 668 bytes docs/media/lib/classTree.js | 454 ++ docs/media/stylesheet.css | 181 + docs/packages.html | 32 + docs/ric_README.html | 30 + fedora_repository.solutionpacks.inc | 5 + formClass.inc | 6 +- plugins/CollectionFormBuilder.inc | 5 + plugins/CreateCollection.inc | 5 + plugins/DarwinCore.inc | 6 +- plugins/DemoFormBuilder.inc | 6 + plugins/DocumentConverter.inc | 7 +- plugins/Exiftool.inc | 6 + plugins/Ffmpeg.inc | 6 + plugins/Flv.inc | 6 + plugins/FlvFormBuilder.inc | 6 + plugins/FormBuilder.inc | 7 +- plugins/ImageManipulation.inc | 7 +- plugins/ModsFormBuilder.inc | 8 +- plugins/PersonalCollectionClass.inc | 6 + plugins/QtFormBuilder.php | 8 + plugins/Refworks.inc | 7 + plugins/ShowDemoStreamsInFieldSets.inc | 6 + plugins/ShowStreamsInFieldSets.inc | 6 + plugins/fedoraObject.inc | 7 + plugins/herbarium.inc | 8 +- plugins/map_viewer.inc | 7 + plugins/qt_viewer.inc | 6 + plugins/slide_viewer.inc | 6 + plugins/tagging_form.inc | 6 + 188 files changed, 37325 insertions(+), 14 deletions(-) create mode 100644 .gitignore create mode 100644 docs/Islandora/API/Dublin_Core.html create mode 100644 docs/Islandora/API/Fedora_Item.html create mode 100644 docs/Islandora/API/RelsExt.html create mode 100644 docs/Islandora/API/TagSet.html create mode 100644 docs/Islandora/API/_api---dublin_core.inc.html create mode 100644 docs/Islandora/API/_api---fedora_collection.inc.html create mode 100644 docs/Islandora/API/_api---fedora_export.inc.html create mode 100644 docs/Islandora/API/_api---fedora_item.inc.html create mode 100644 docs/Islandora/API/_api---fedora_utils.inc.html create mode 100644 docs/Islandora/API/_api---rels-ext.inc.html create mode 100644 docs/Islandora/API/_api---tagging.inc.html create mode 100644 docs/Islandora/IslandoraBook.html create mode 100644 docs/Islandora/Newspaper.html create mode 100644 docs/Islandora/ShowILivesStreamsInFieldSets.html create mode 100644 docs/Islandora/_ilives---book.inc.html create mode 100644 docs/Islandora/_ilives---image_rotator_tagger_block.inc.html create mode 100644 docs/Islandora/_plugins---fedora_attach---fedora_attach.admin.inc.html create mode 100644 docs/Islandora/_plugins---islandora_newspaper---Newspaper.inc.html create mode 100644 docs/Islandora/plugins/CollectionFormBuilder.html create mode 100644 docs/Islandora/plugins/CreateCollection.html create mode 100644 docs/Islandora/plugins/DarwinCore.html create mode 100644 docs/Islandora/plugins/DemoFormBuilder.html create mode 100644 docs/Islandora/plugins/DocumentConverter.html create mode 100644 docs/Islandora/plugins/Exiftool.html create mode 100644 docs/Islandora/plugins/FedoraObject.html create mode 100644 docs/Islandora/plugins/Ffmpeg.html create mode 100644 docs/Islandora/plugins/FlvFormBuilder.html create mode 100644 docs/Islandora/plugins/FormBuilder.html create mode 100644 docs/Islandora/plugins/Herbarium.html create mode 100644 docs/Islandora/plugins/ImageManipulation.html create mode 100644 docs/Islandora/plugins/ModsFormBuilder.html create mode 100644 docs/Islandora/plugins/PersonalCollectionClass.html create mode 100644 docs/Islandora/plugins/QtFormBuilder.html create mode 100644 docs/Islandora/plugins/Refworks.html create mode 100644 docs/Islandora/plugins/ShowDemoStreamsInFieldSets.html create mode 100644 docs/Islandora/plugins/ShowMapStreamsInFieldSets.html create mode 100644 docs/Islandora/plugins/ShowQtStreamsInFieldSets.html create mode 100644 docs/Islandora/plugins/ShowSlideStreamsInFieldSets.html create mode 100644 docs/Islandora/plugins/ShowStreamsInFieldSets.html create mode 100644 docs/Islandora/plugins/_plugins---CollectionFormBuilder.inc.html create mode 100644 docs/Islandora/plugins/_plugins---CreateCollection.inc.html create mode 100644 docs/Islandora/plugins/_plugins---DarwinCore.inc.html create mode 100644 docs/Islandora/plugins/_plugins---DemoFormBuilder.inc.html create mode 100644 docs/Islandora/plugins/_plugins---DocumentConverter.inc.html create mode 100644 docs/Islandora/plugins/_plugins---Exiftool.inc.html create mode 100644 docs/Islandora/plugins/_plugins---Ffmpeg.inc.html create mode 100644 docs/Islandora/plugins/_plugins---Flv.inc.html create mode 100644 docs/Islandora/plugins/_plugins---FlvFormBuilder.inc.html create mode 100644 docs/Islandora/plugins/_plugins---FormBuilder.inc.html create mode 100644 docs/Islandora/plugins/_plugins---ImageManipulation.inc.html create mode 100644 docs/Islandora/plugins/_plugins---ModsFormBuilder.inc.html create mode 100644 docs/Islandora/plugins/_plugins---PersonalCollectionClass.inc.html create mode 100644 docs/Islandora/plugins/_plugins---QtFormBuilder.php.html create mode 100644 docs/Islandora/plugins/_plugins---Refworks.inc.html create mode 100644 docs/Islandora/plugins/_plugins---ShowDemoStreamsInFieldSets.inc.html create mode 100644 docs/Islandora/plugins/_plugins---ShowStreamsInFieldSets.inc.html create mode 100644 docs/Islandora/plugins/_plugins---fedoraObject.inc.html create mode 100644 docs/Islandora/plugins/_plugins---herbarium.inc.html create mode 100644 docs/Islandora/plugins/_plugins---map_viewer.inc.html create mode 100644 docs/Islandora/plugins/_plugins---qt_viewer.inc.html create mode 100644 docs/Islandora/plugins/_plugins---slide_viewer.inc.html create mode 100644 docs/Islandora/plugins/_plugins---tagging_form.inc.html create mode 100644 docs/Islandora/rootdirectory/CollectionClass.html create mode 100644 docs/Islandora/rootdirectory/CollectionPolicy.html create mode 100644 docs/Islandora/rootdirectory/ConnectionHelper.html create mode 100644 docs/Islandora/rootdirectory/ContentModel.html create mode 100644 docs/Islandora/rootdirectory/MimeClass.html create mode 100644 docs/Islandora/rootdirectory/ObjectHelper.html create mode 100644 docs/Islandora/rootdirectory/SearchClass.html create mode 100644 docs/Islandora/rootdirectory/SecurityClass.html create mode 100644 docs/Islandora/rootdirectory/XMLDatastream.html create mode 100644 docs/Islandora/rootdirectory/_CollectionClass.inc.html create mode 100644 docs/Islandora/rootdirectory/_CollectionPolicy.inc.html create mode 100644 docs/Islandora/rootdirectory/_ConnectionHelper.inc.html create mode 100644 docs/Islandora/rootdirectory/_ContentModel.inc.html create mode 100644 docs/Islandora/rootdirectory/_MimeClass.inc.html create mode 100644 docs/Islandora/rootdirectory/_ObjectHelper.inc.html create mode 100644 docs/Islandora/rootdirectory/_SearchClass.inc.html create mode 100644 docs/Islandora/rootdirectory/_SecurityClass.inc.html create mode 100644 docs/Islandora/rootdirectory/_XMLDatastream.inc.html create mode 100644 docs/Islandora/rootdirectory/_fedora_repository.solutionpacks.inc.html create mode 100644 docs/Islandora/rootdirectory/_formClass.inc.html create mode 100644 docs/Islandora/rootdirectory/formClass.html create mode 100644 docs/blank.html create mode 100644 docs/classtrees_Islandora.html create mode 100644 docs/elementindex.html create mode 100644 docs/elementindex_Islandora.html create mode 100644 docs/errors.html create mode 100644 docs/index.html create mode 100644 docs/li_Islandora.html create mode 100644 docs/media/banner.css create mode 100644 docs/media/images/AbstractClass.png create mode 100644 docs/media/images/AbstractClass_logo.png create mode 100644 docs/media/images/AbstractMethod.png create mode 100644 docs/media/images/AbstractPrivateClass.png create mode 100644 docs/media/images/AbstractPrivateClass_logo.png create mode 100644 docs/media/images/AbstractPrivateMethod.png create mode 100644 docs/media/images/Class.png create mode 100644 docs/media/images/Class_logo.png create mode 100644 docs/media/images/Constant.png create mode 100644 docs/media/images/Constructor.png create mode 100644 docs/media/images/Destructor.png create mode 100644 docs/media/images/Function.png create mode 100644 docs/media/images/Global.png create mode 100644 docs/media/images/I.png create mode 100644 docs/media/images/Index.png create mode 100644 docs/media/images/Interface.png create mode 100644 docs/media/images/Interface_logo.png create mode 100644 docs/media/images/L.png create mode 100644 docs/media/images/Lminus.png create mode 100644 docs/media/images/Lplus.png create mode 100644 docs/media/images/Method.png create mode 100644 docs/media/images/Page.png create mode 100644 docs/media/images/Page_logo.png create mode 100644 docs/media/images/PrivateClass.png create mode 100644 docs/media/images/PrivateClass_logo.png create mode 100644 docs/media/images/PrivateMethod.png create mode 100644 docs/media/images/PrivateVariable.png create mode 100644 docs/media/images/StaticMethod.png create mode 100644 docs/media/images/StaticVariable.png create mode 100644 docs/media/images/T.png create mode 100644 docs/media/images/Tminus.png create mode 100644 docs/media/images/Tplus.png create mode 100644 docs/media/images/Variable.png create mode 100644 docs/media/images/blank.png create mode 100644 docs/media/images/class_folder.png create mode 100644 docs/media/images/empty.png create mode 100644 docs/media/images/file.png create mode 100644 docs/media/images/folder.png create mode 100644 docs/media/images/function_folder.png create mode 100644 docs/media/images/minus.gif create mode 100644 docs/media/images/next_button.png create mode 100644 docs/media/images/next_button_disabled.png create mode 100644 docs/media/images/package.png create mode 100644 docs/media/images/package_folder.png create mode 100644 docs/media/images/plus.gif create mode 100644 docs/media/images/previous_button.png create mode 100644 docs/media/images/previous_button_disabled.png create mode 100644 docs/media/images/private_class_logo.png create mode 100644 docs/media/images/tutorial.png create mode 100644 docs/media/images/tutorial_folder.png create mode 100644 docs/media/images/up_button.png create mode 100644 docs/media/lib/classTree.js create mode 100644 docs/media/stylesheet.css create mode 100644 docs/packages.html create mode 100644 docs/ric_README.html diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..14bc68c7 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/nbproject/private/ \ No newline at end of file diff --git a/CollectionClass.inc b/CollectionClass.inc index a7c369a3..3040dbd6 100644 --- a/CollectionClass.inc +++ b/CollectionClass.inc @@ -1,7 +1,11 @@ + + + + + Docs For Class Dublin_Core + + + + + +
+

Class Dublin_Core

+ + +
+
Description
+
+ Description | + Vars (details) + | Methods (details) + +
+
+ +

+ Located in /api/dublin_core.inc (line 15) +

+ + + 

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																																

+					 
+					mixed
+					$dc
+				

+																

+					 
+					mixed
+					$owner
+				

+											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																			
+				

+					 
+					static 						void
+										create_dc_from_dict
+										()
+									

+															
+				

+					 
+					static 						Dublin_Core
+										import_from_xml_string
+											(string $dc_xml)
+									

+																																			
+				

+					 
+											Dublin_Core
+										Dublin_Core
+											([ $item = NULL])
+									

+															
+				

+					 
+											void
+										add_element
+											( $element_name,  $value)
+									

+															
+				

+					 
+											void
+										as_xml
+											([ $with_preamble = FALSE])
+									

+																															
+				

+					 
+											void
+										save
+											([ $alt_owner = NULL])
+									

+															
+				

+					 
+											void
+										set_element
+											( $element_name, array $values, string $elemnt_name)
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+
+

+
+	

+		
+		
+			mixed
+			$dc
+			 = array(
    'dc:title' => array(),'dc:creator'=>array(),'dc:subject'=>array(),'dc:description'=>array(),'dc:publisher'=>array(),'dc:contributor'=>array(),'dc:date'=>array(),'dc:type'=>array(),'dc:format'=>array(),'dc:identifier'=>array(),'dc:source'=>array(),'dc:language'=>array(),'dc:relation'=>array(),'dc:coverage'=>array(),'dc:rights'=>array(),)			(line 16)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$owner
+						(line 33)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		static create_dc_from_dict (line 96)
+	
 
+	
+	
+	
+	

+		static void
+		
+			create_dc_from_dict
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		static import_from_xml_string (line 113)
+	
 
+	
+	
+
Creates a new instance of the class by parsing dc_xml

+	
+	

+		static Dublin_Core
+		
+			import_from_xml_string
+		
+					(string $dc_xml)
+			

+	
+			
    
+					
  • 
+				string
+				$dc_xml			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Constructor Dublin_Core (line 40)
+	
 
+	
+	
+
Constructs a Dublin_Core object from a Fedora_Item object and populates  the $dc array.

+	
+	

+		Dublin_Core
+		
+			Dublin_Core
+		
+					([ $item = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$item			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		add_element (line 53)
+	
 
+	
+	
+	
+	

+		void
+		
+			add_element
+		
+					( $element_name,  $value)
+			

+	
+			
    
+					
  • 
+				
+				$element_name			
    • 
+					
  • 
+				
+				$value			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		as_xml (line 76)
+	
 
+	
+	
+
Serialize this object to XML and return it.

+	
+	

+		void
+		
+			as_xml
+		
+					([ $with_preamble = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$with_preamble			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		save (line 100)
+	
 
+	
+	
+	
+	

+		void
+		
+			save
+		
+					([ $alt_owner = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$alt_owner			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		set_element (line 64)
+	
 
+	
+	
+
Replace the given DC element with the values in $values

+	
+	

+		void
+		
+			set_element
+		
+					( $element_name, array $values, string $elemnt_name)
+			

+	
+			
    
+					
  • 
+				string
+				$elemnt_name			
    • 
+					
  • 
+				array
+				$values			
    • 
+					
  • 
+				
+				$element_name			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/API/Fedora_Item.html b/docs/Islandora/API/Fedora_Item.html
new file mode 100644
index 00000000..d63b2e7c
--- /dev/null
+++ b/docs/Islandora/API/Fedora_Item.html
@@ -0,0 +1,1521 @@
+
+
+  
+		
+			
+			Docs For Class Fedora_Item
+			
+						
+												
+					
+		
+			
			
+
 Class Fedora_Item

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+		

+			Located in /api/fedora_item.inc (line 13)
+		

+		
+				
+		

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																																								

+					 
+					mixed
+					$datastreams
+				

+																

+					 
+					mixed
+					$objectProfile
+				

+																

+					 
+					mixed
+					$pid
+				

+											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																			
+				

+					 
+					static 						void
+										create_object_FOXML
+											([string $pid = ''], [string $state = 'A'], [ $label = 'Untitled'], [ $owner = ''])
+									

+																															
+				

+					 
+					static 						void
+										fedora_item_exists
+											( $pid)
+									

+															
+				

+					 
+					static 						Array
+										find_objects_by_pattern
+											([string $pattern = '*'], [string $field = 'pid'], [int $max_results = 100], [ $resultFields = array()])
+									

+																																																																															
+				

+					 
+					static 						void
+										get_next_PID_in_namespace
+											([ $pid_namespace = ''])
+									

+																							
+				

+					 
+					static 						void
+										ingest_from_FOXML
+											( $foxml)
+									

+															
+				

+					 
+					static 						void
+										ingest_from_FOXML_file
+											( $foxml_file)
+									

+															
+				

+					 
+					static 						void
+										ingest_from_FOXML_files_in_directory
+											( $path)
+									

+															
+				

+					 
+					static 						void
+										ingest_new_item
+											([ $pid = ''], [ $state = 'A'], [ $label = ''], [ $owner = ''])
+									

+																																																																							
+				

+					 
+					static 						void
+										soap_call
+											( $function_name,  $params_array, [ $quiet = FALSE])
+									

+																											
+				

+					 
+											Fedora_Item
+										__construct
+											(string $pid)
+									

+															
+				

+					 
+											void
+										add_datastream_from_file
+											( $datastream_file,  $datastream_id, [ $datastream_label = NULL], [ $datastream_mimetype = ''], [ $controlGroup = 'M'], [ $logMessage = null])
+									

+															
+				

+					 
+											void
+										add_datastream_from_string
+											( $str,  $datastream_id, [ $datastream_label = NULL], [ $datastream_mimetype = 'text/xml'], [ $controlGroup = 'M'], [ $logMessage = null])
+									

+															
+				

+					 
+											void
+										add_datastream_from_url
+											( $datastream_url,  $datastream_id, [ $datastream_label = NULL], [ $datastream_mimetype = ''], [ $controlGroup = 'M'], [ $logMessage = null])
+									

+															
+				

+					 
+											void
+										add_relationship
+											(string $relationship,  $object, [ $namespaceURI = RELS_EXT_URI])
+									

+																							
+				

+					 
+											void
+										exists
+										()
+									

+															
+				

+					 
+											void
+										export_as_foxml
+										()
+									

+																															
+				

+					 
+											void
+										get_datastream
+											( $dsid, [ $as_of_date_time = ""])
+									

+															
+				

+					 
+											array
+										get_datastreams_list_as_array
+										()
+									

+															
+				

+					 
+											SimpleXMLElement
+										get_datastreams_list_as_SimpleXML
+										()
+									

+															
+				

+					 
+											void
+										get_datastream_dissemination
+											( $dsid, [ $as_of_date_time = ""])
+									

+															
+				

+					 
+											void
+										get_datastream_history
+											( $dsid)
+									

+															
+				

+					 
+											datastream
+										get_datastream_info
+											(string $dsid, [ $as_of_date_time = ""])
+									

+															
+				

+					 
+											void
+										get_dissemination
+											( $service_definition_pid,  $method_name, [ $parameters = array()], [ $as_of_date_time = null])
+									

+															
+				

+					 
+											string
+										get_mimetype_of_datastream
+											(string $dsid)
+									

+																							
+				

+					 
+											void
+										get_relationships
+											([String $relationship = NULL])
+									

+																																															
+				

+					 
+											void
+										modify_datastream_by_reference
+											( $external_url,  $dsid,  $label,  $mime_type, [ $force = FALSE], [ $logMessage = 'Modified by Islandora API'], [ $quiet = FALSE])
+									

+															
+				

+					 
+											void
+										modify_datastream_by_value
+											( $content,  $dsid,  $label,  $mime_type, [ $force = FALSE], [ $logMessage = 'Modified by Islandora API'], [ $quiet = FALSE])
+									

+															
+				

+					 
+											void
+										modify_object
+											([ $label = ''], [ $state = null], [ $ownerId = null], [ $logMessage = 'Modified by Islandora API'], [ $quiet = TRUE])
+									

+															
+				

+					 
+											void
+										purge
+											([ $log_message = 'Purged using Islandora API.'], [ $force = FALSE])
+									

+															
+				

+					 
+											void
+										purge_datastream
+											( $dsID, [ $start_date = NULL], [ $end_date = NULL], [ $log_message = 'Purged datastream using Islandora API'], [ $force = FALSE])
+									

+															
+				

+					 
+											void
+										purge_relationship
+											(string $relationship, string $object)
+									

+															
+				

+					 
+											void
+										save_relationships
+											( $relationships)
+									

+																							
+				

+					 
+											void
+										url
+										()
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+
+

+
+	

+		
+		
+			mixed
+			$datastreams
+			 =  NULL			(line 18)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$objectProfile
+			 =  NULL			(line 16)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$pid
+			 =  NULL			(line 15)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		static create_object_FOXML (line 739)
+	
 
+	
+	
+
Creates the minimal FOXML for a new Fedora object, which is then passed to  ingest_from_FOXML to be added to the repository.

+	
+	

+		static void
+		
+			create_object_FOXML
+		
+					([string $pid = ''], [string $state = 'A'], [ $label = 'Untitled'], [ $owner = ''])
+			

+	
+			
    
+					
  • 
+				string
+				$pid: if none given, getnextpid will be called.			
    • 
+					
  • 
+				string
+				$state: The initial state, A - Active, I - Inactive, D - Deleted			
    • 
+					
  • 
+				
+				$label			
    • 
+					
  • 
+				
+				$owner			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static fedora_item_exists (line 790)
+	
 
+	
+	
+	
+	

+		static void
+		
+			fedora_item_exists
+		
+					( $pid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static find_objects_by_pattern (line 240)
+	
 
+	
+	
+
Does a search using the "query" format followed by the Fedora REST APi.

+	
    
+				
  • return: of pid => title pairs that match the results
    • 
+			

+	
+	

+		static Array
+		
+			find_objects_by_pattern
+		
+					([string $pattern = '*'], [string $field = 'pid'], [int $max_results = 100], [ $resultFields = array()])
+			

+	
+			
    
+					
  • 
+				string
+				$pattern: to search for, including wildcards.			
    • 
+					
  • 
+				string
+				$field: The field to search on, e.g. pid, title, cDate. See http://www.fedora-commons.org/confluence/display/FCR30/REST+API#RESTAPI-findObjects for details			
    • 
+					
  • 
+				int
+				$max_results: not used at this time			
    • 
+					
  • 
+				
+				$resultFields			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static get_next_PID_in_namespace (line 566)
+	
 
+	
+	
+	
+	

+		static void
+		
+			get_next_PID_in_namespace
+		
+					([ $pid_namespace = ''])
+			

+	
+			
    
+					
  • 
+				
+				$pid_namespace			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static ingest_from_FOXML (line 589)
+	
 
+	
+	
+	
+	

+		static void
+		
+			ingest_from_FOXML
+		
+					( $foxml)
+			

+	
+			
    
+					
  • 
+				
+				$foxml			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static ingest_from_FOXML_file (line 595)
+	
 
+	
+	
+	
+	

+		static void
+		
+			ingest_from_FOXML_file
+		
+					( $foxml_file)
+			

+	
+			
    
+					
  • 
+				
+				$foxml_file			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static ingest_from_FOXML_files_in_directory (line 601)
+	
 
+	
+	
+	
+	

+		static void
+		
+			ingest_from_FOXML_files_in_directory
+		
+					( $path)
+			

+	
+			
    
+					
  • 
+				
+				$path			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static ingest_new_item (line 786)
+	
 
+	
+	
+	
+	

+		static void
+		
+			ingest_new_item
+		
+					([ $pid = ''], [ $state = 'A'], [ $label = ''], [ $owner = ''])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$state			
    • 
+					
  • 
+				
+				$label			
    • 
+					
  • 
+				
+				$owner			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static soap_call (line 667)
+	
 
+	
+	
+	
+	

+		static void
+		
+			soap_call
+		
+					( $function_name,  $params_array, [ $quiet = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$function_name			
    • 
+					
  • 
+				
+				$params_array			
    • 
+					
  • 
+				
+				$quiet			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Constructor __construct (line 29)
+	
 
+	
+	
+
Create an object to represent an item in the Fedora repository.

+
Throws a SOAPException if the PID is not in the repository.

+	
+	

+		Fedora_Item
+		
+			__construct
+		
+					(string $pid)
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		add_datastream_from_file (line 63)
+	
 
+	
+	
+	
+	

+		void
+		
+			add_datastream_from_file
+		
+					( $datastream_file,  $datastream_id, [ $datastream_label = NULL], [ $datastream_mimetype = ''], [ $controlGroup = 'M'], [ $logMessage = null])
+			

+	
+			
    
+					
  • 
+				
+				$datastream_file			
    • 
+					
  • 
+				
+				$datastream_id			
    • 
+					
  • 
+				
+				$datastream_label			
    • 
+					
  • 
+				
+				$datastream_mimetype			
    • 
+					
  • 
+				
+				$controlGroup			
    • 
+					
  • 
+				
+				$logMessage			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		add_datastream_from_string (line 110)
+	
 
+	
+	
+	
+	

+		void
+		
+			add_datastream_from_string
+		
+					( $str,  $datastream_id, [ $datastream_label = NULL], [ $datastream_mimetype = 'text/xml'], [ $controlGroup = 'M'], [ $logMessage = null])
+			

+	
+			
    
+					
  • 
+				
+				$str			
    • 
+					
  • 
+				
+				$datastream_id			
    • 
+					
  • 
+				
+				$datastream_label			
    • 
+					
  • 
+				
+				$datastream_mimetype			
    • 
+					
  • 
+				
+				$controlGroup			
    • 
+					
  • 
+				
+				$logMessage			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		add_datastream_from_url (line 84)
+	
 
+	
+	
+	
+	

+		void
+		
+			add_datastream_from_url
+		
+					( $datastream_url,  $datastream_id, [ $datastream_label = NULL], [ $datastream_mimetype = ''], [ $controlGroup = 'M'], [ $logMessage = null])
+			

+	
+			
    
+					
  • 
+				
+				$datastream_url			
    • 
+					
  • 
+				
+				$datastream_id			
    • 
+					
  • 
+				
+				$datastream_label			
    • 
+					
  • 
+				
+				$datastream_mimetype			
    • 
+					
  • 
+				
+				$controlGroup			
    • 
+					
  • 
+				
+				$logMessage			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		add_relationship (line 127)
+	
 
+	
+	
+
Add a relationship string to this object's RELS-EXT.

+
does not support rels-int yet.

+	
+	

+		void
+		
+			add_relationship
+		
+					(string $relationship,  $object, [ $namespaceURI = RELS_EXT_URI])
+			

+	
+			
    
+					
  • 
+				string
+				$relationship			
    • 
+					
  • 
+				
+				$object			
    • 
+					
  • 
+				
+				$namespaceURI			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		exists (line 59)
+	
 
+	
+	
+	
+	

+		void
+		
+			exists
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		export_as_foxml (line 222)
+	
 
+	
+	
+	
+	

+		void
+		
+			export_as_foxml
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		get_datastream (line 315)
+	
 
+	
+	
+	
+	

+		void
+		
+			get_datastream
+		
+					( $dsid, [ $as_of_date_time = ""])
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$as_of_date_time			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_datastreams_list_as_array (line 422)
+	
 
+	
+	
+
Returns an associative array of this object's datastreams. Results look like this:

+
'DC' =>     array       'label' => string 'Dublin Core Record for this object' (length=34)       'MIMEType' => string 'text/xml' (length=8)   'RELS-EXT' =>     array       'label' => string 'RDF Statements about this object' (length=32)       'MIMEType' => string 'application/rdf+xml' (length=19)

+	
+	

+		array
+		
+			get_datastreams_list_as_array
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		get_datastreams_list_as_SimpleXML (line 365)
+	
 
+	
+	
+
Retrieves and returns a SimpleXML list of this item's datastreams, and stores them  as an instance variable for caching purposes.

+	
+	

+		SimpleXMLElement
+		
+			get_datastreams_list_as_SimpleXML
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		get_datastream_dissemination (line 298)
+	
 
+	
+	
+	
+	

+		void
+		
+			get_datastream_dissemination
+		
+					( $dsid, [ $as_of_date_time = ""])
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$as_of_date_time			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_datastream_history (line 326)
+	
 
+	
+	
+	
+	

+		void
+		
+			get_datastream_history
+		
+					( $dsid)
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_datastream_info (line 398)
+	
 
+	
+	
+
*  DatastreamControlGroup controlGroup - String restricted to the values of "X", "M", "R", or "E" (InlineXML,Managed Content,Redirect, or External Referenced).

+
String ID - The datastream ID (64 characters max).  String versionID - The ID of the most recent datastream version  String[] altIDs - Alternative IDs for the datastream, if any.  String label - The Label of the datastream.  boolean versionable - Whether the datastream is versionable.  String MIMEType - The mime-type for the datastream, if set.  String formatURI - The format uri for the datastream, if set.  String createDate - The date the first version of the datastream was created.  long size - The size of the datastream in Fedora. Only valid for inline XML metadata and managed content datastreams.  String state - The state of the datastream. Will be "A" (active), "I" (inactive) or "D" (deleted).  String location - If the datastream is an external reference or redirect, the url to the contents. TODO: Managed?  String checksumType - The algorithm used to compute the checksum. One of "DEFAULT", "DISABLED", "MD5", "SHA-1", "SHA-256", "SHA-385", "SHA-512".  String checksum - The value of the checksum represented as a hexadecimal string.

+	
    
+				
  • return: object  get the mimetype size etc. in one shot.  instead of iterating throught the datastream list for what we need
    • 
+			

+	
+	

+		datastream
+		
+			get_datastream_info
+		
+					(string $dsid, [ $as_of_date_time = ""])
+			

+	
+			
    
+					
  • 
+				string
+				$dsid			
    • 
+					
  • 
+				
+				$as_of_date_time			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_dissemination (line 340)
+	
 
+	
+	
+	
+	

+		void
+		
+			get_dissemination
+		
+					( $service_definition_pid,  $method_name, [ $parameters = array()], [ $as_of_date_time = null])
+			

+	
+			
    
+					
  • 
+				
+				$service_definition_pid			
    • 
+					
  • 
+				
+				$method_name			
    • 
+					
  • 
+				
+				$parameters			
    • 
+					
  • 
+				
+				$as_of_date_time			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_mimetype_of_datastream (line 458)
+	
 
+	
+	
+
Returns a MIME type string for the given Datastream ID.

+	
+	

+		string
+		
+			get_mimetype_of_datastream
+		
+					(string $dsid)
+			

+	
+			
    
+					
  • 
+				string
+				$dsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_relationships (line 479)
+	
 
+	
+	
+
Currently the Fedora API call getRelationships is reporting an uncaught  exception so we will parse the RELS-EXT ourselves and simulate the  documented behaviour.

+	
+	

+		void
+		
+			get_relationships
+		
+					([String $relationship = NULL])
+			

+	
+			
    
+					
  • 
+				String
+				$relationship: - filter the results to match this string.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		modify_datastream_by_reference (line 633)
+	
 
+	
+	
+	
+	

+		void
+		
+			modify_datastream_by_reference
+		
+					( $external_url,  $dsid,  $label,  $mime_type, [ $force = FALSE], [ $logMessage = 'Modified by Islandora API'], [ $quiet = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$external_url			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$label			
    • 
+					
  • 
+				
+				$mime_type			
    • 
+					
  • 
+				
+				$force			
    • 
+					
  • 
+				
+				$logMessage			
    • 
+					
  • 
+				
+				$quiet			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		modify_datastream_by_value (line 650)
+	
 
+	
+	
+	
+	

+		void
+		
+			modify_datastream_by_value
+		
+					( $content,  $dsid,  $label,  $mime_type, [ $force = FALSE], [ $logMessage = 'Modified by Islandora API'], [ $quiet = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$content			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$label			
    • 
+					
  • 
+				
+				$mime_type			
    • 
+					
  • 
+				
+				$force			
    • 
+					
  • 
+				
+				$logMessage			
    • 
+					
  • 
+				
+				$quiet			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		modify_object (line 620)
+	
 
+	
+	
+	
+	

+		void
+		
+			modify_object
+		
+					([ $label = ''], [ $state = null], [ $ownerId = null], [ $logMessage = 'Modified by Islandora API'], [ $quiet = TRUE])
+			

+	
+			
    
+					
  • 
+				
+				$label			
    • 
+					
  • 
+				
+				$state			
    • 
+					
  • 
+				
+				$ownerId			
    • 
+					
  • 
+				
+				$logMessage			
    • 
+					
  • 
+				
+				$quiet			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		purge (line 539)
+	
 
+	
+	
+
Removes this object form the repository.

+	
+	

+		void
+		
+			purge
+		
+					([ $log_message = 'Purged using Islandora API.'], [ $force = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$log_message			
    • 
+					
  • 
+				
+				$force			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		purge_datastream (line 549)
+	
 
+	
+	
+	
+	

+		void
+		
+			purge_datastream
+		
+					( $dsID, [ $start_date = NULL], [ $end_date = NULL], [ $log_message = 'Purged datastream using Islandora API'], [ $force = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$dsID			
    • 
+					
  • 
+				
+				$start_date			
    • 
+					
  • 
+				
+				$end_date			
    • 
+					
  • 
+				
+				$log_message			
    • 
+					
  • 
+				
+				$force			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		purge_relationship (line 177)
+	
 
+	
+	
+
Removes the given relationship from the item's RELS-EXT and re-saves it.

+	
+	

+		void
+		
+			purge_relationship
+		
+					(string $relationship, string $object)
+			

+	
+			
    
+					
  • 
+				string
+				$relationship			
    • 
+					
  • 
+				string
+				$object			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		save_relationships (line 516)
+	
 
+	
+	
+
Creates a RELS-EXT XML stream from the supplied array and saves it to  the item on the server.

+	
+	

+		void
+		
+			save_relationships
+		
+					( $relationships)
+			

+	
+			
    
+					
  • 
+				
+				$relationships			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		url (line 561)
+	
 
+	
+	
+	
+	

+		void
+		
+			url
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/API/RelsExt.html b/docs/Islandora/API/RelsExt.html
new file mode 100644
index 00000000..625b5603
--- /dev/null
+++ b/docs/Islandora/API/RelsExt.html
@@ -0,0 +1,308 @@
+
+
+  
+		
+			
+			Docs For Class RelsExt
+			
+						
+												
+					
+		
+			
			
+
 Class RelsExt

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+
Description of relsext

+	
    
+				
  • author: aoneill
    • 
+			

+		

+			Located in /api/rels-ext.inc (line 19)
+		

+		
+				
+		

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																								

+					 
+					mixed
+					$relsExtArray
+				

+											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																							
+				

+					 
+											RelsExt
+										RelsExt
+											(Fedora_Item $item)
+									

+															
+				

+					 
+											void
+										modified
+										()
+									

+															
+				

+					 
+											void
+										save
+										()
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+
+

+
+	

+		
+		
+			mixed
+			$relsExtArray
+			 = array()			(line 21)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor RelsExt (line 30)
+	
 
+	
+	
+
Constructor that builds itself by retrieving the RELS-EXT stream from  the repository for the given Fedora_Item.

+	
+	

+		RelsExt
+		
+			RelsExt
+		
+					(Fedora_Item $item)
+			

+	
+			
+		
+			
+	

+
+

+	
+	

+		
+		modified (line 35)
+	
 
+	
+	
+	
+	

+		void
+		
+			modified
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		save (line 44)
+	
 
+	
+	
+
Save the current state of the RELS-EXT array out to the repository item  as a datastream.

+	
+	

+		void
+		
+			save
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/API/TagSet.html b/docs/Islandora/API/TagSet.html
new file mode 100644
index 00000000..cada803a
--- /dev/null
+++ b/docs/Islandora/API/TagSet.html
@@ -0,0 +1,361 @@
+
+
+  
+		
+			
+			Docs For Class TagSet
+			
+						
+												
+					
+		
+			
			
+
 Class TagSet

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+
Description of tagging

+	
    
+				
  • author: aoneill
    • 
+			

+		

+			Located in /api/tagging.inc (line 18)
+		

+		
+				
+		

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																																								

+					 
+					mixed
+					$item
+				

+																

+					 
+					mixed
+					$tags
+				

+																

+					 
+					mixed
+					$tagsDSID
+				

+											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																							
+				

+					 
+											TagSet
+										TagSet
+											([ $item = NULL])
+									

+															
+				

+					 
+											void
+										load
+										()
+									

+															
+				

+					 
+											void
+										save
+										()
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+
+

+
+	

+		
+		
+			mixed
+			$item
+			 =  NULL			(line 20)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$tags
+			 = array()			(line 19)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$tagsDSID
+			 =  'TAGS'			(line 21)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor TagSet (line 23)
+	
 
+	
+	
+	
+	

+		TagSet
+		
+			TagSet
+		
+					([ $item = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$item			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		load (line 30)
+	
 
+	
+	
+	
+	

+		void
+		
+			load
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		save (line 50)
+	
 
+	
+	
+
Saves an associative array of tags to a datastream.

+	
+	

+		void
+		
+			save
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/API/_api---dublin_core.inc.html b/docs/Islandora/API/_api---dublin_core.inc.html
new file mode 100644
index 00000000..ebca446e
--- /dev/null
+++ b/docs/Islandora/API/_api---dublin_core.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page dublin_core.inc
+			
+						
+												
+					
+		
+			
			
+
File/api/dublin_core.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						Dublin_Core
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/API/_api---fedora_collection.inc.html b/docs/Islandora/API/_api---fedora_collection.inc.html
new file mode 100644
index 00000000..d58e5b79
--- /dev/null
+++ b/docs/Islandora/API/_api---fedora_collection.inc.html
@@ -0,0 +1,247 @@
+
+
+  
+		
+			
+			Docs for page fedora_collection.inc
+			
+						
+												
+					
+		
+			
			
+
File/api/fedora_collection.inc

+
+
+

+	
Description

+	

+					Description |
+															Functions
+			

+	
	
+		
+		
+			

+

+		
+
+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+															Functions
+		

+		
	
+			
+

+	
+	

+		
+		export_collection (line 23)
+	
 
+
+	
+
Exports a fedora collection object and all of its children in a format  that will let you import them into another repository.

+	

+		void
+		
+			export_collection
+		
+					( $collection_pid, [ $relationship = 'isMemberOfCollection'], [ $format = 'info:fedora/fedora-system:FOXML-1.1'])
+			

+
+			
    
+					
  • 
+				
+				$format			
    • 
+					
  • 
+				
+				$collection_pid			
    • 
+					
  • 
+				
+				$relationship			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		get_related_items_as_array (line 125)
+	
 
+
+	
+	

+		void
+		
+			get_related_items_as_array
+		
+					( $collection_pid, [ $relationship = 'isMemberOfCollection'], [ $limit = 10000], [ $offset = 0], [ $active_objects_only = TRUE], [ $cmodel = NULL], [ $orderby = '$title'])
+			

+
+			
    
+					
  • 
+				
+				$collection_pid			
    • 
+					
  • 
+				
+				$relationship			
    • 
+					
  • 
+				
+				$limit			
    • 
+					
  • 
+				
+				$offset			
    • 
+					
  • 
+				
+				$active_objects_only			
    • 
+					
  • 
+				
+				$cmodel			
    • 
+					
  • 
+				
+				$orderby			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		get_related_items_as_xml (line 73)
+	
 
+
+	
+
Returns an array of pids that match the query contained in teh collection  object's QUERY datastream or in the suppled $query parameter.

+	

+		void
+		
+			get_related_items_as_xml
+		
+					( $collection_pid, [ $relationship = array('isMemberOfCollection')], [ $limit = 10000], [ $offset = 0], [ $active_objects_only = TRUE], [ $cmodel = NULL], [ $orderby = '$title'],  $query,  $query_format)
+			

+
+			
    
+					
  • 
+				
+				$collection_pid			
    • 
+					
  • 
+				
+				$query			
    • 
+					
  • 
+				
+				$query_format: R			
    • 
+					
  • 
+				
+				$relationship			
    • 
+					
  • 
+				
+				$limit			
    • 
+					
  • 
+				
+				$offset			
    • 
+					
  • 
+				
+				$active_objects_only			
    • 
+					
  • 
+				
+				$cmodel			
    • 
+					
  • 
+				
+				$orderby			
    • 
+				

+		
+	
+

+		

+	

+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/API/_api---fedora_export.inc.html b/docs/Islandora/API/_api---fedora_export.inc.html
new file mode 100644
index 00000000..6a46a1d4
--- /dev/null
+++ b/docs/Islandora/API/_api---fedora_export.inc.html
@@ -0,0 +1,387 @@
+
+
+  
+		
+			
+			Docs for page fedora_export.inc
+			
+						
+												
+					
+		
+			
			
+
File/api/fedora_export.inc

+
+
+

+	
Description

+	

+					Description |
+											Constants
+			|									Functions
+			

+	
	
+		
+		
+			

+

+		
+
+	
+		
+	

+		
Constants

+		

+			Description |
+									Constants
+			|										Functions
+					

+		
	
+			
+

+	
+	

+		
+		
+			ATOMZip_11 = 'info:fedora/fedora-system:ATOMZip-1.1'
+			(line 15)
+		
+	

+	
+	
+	
+		
+

+
+

+	
+	

+		
+		
+			ATOM_11 = 'info:fedora/fedora-system:ATOM-1.1'
+			(line 14)
+		
+	

+	
+	
+	
+		
+

+
+

+	
+	

+		
+		
+			FOXML_10 = 'info:fedora/fedora-system:FOXML-1.0'
+			(line 10)
+		
+	

+	
+	
+	
+		
+

+
+

+	
+	

+		
+		
+			FOXML_11 = 'info:fedora/fedora-system:FOXML-1.1'
+			(line 11)
+		
+	

+	
+	
+	
+		
+

+
+

+	
+	

+		
+		
+			METS_10 = 'info:fedora/fedora-system:METSFedoraExt-1.0'
+			(line 12)
+		
+	

+	
+	
+	
+		
+

+
+

+	
+	

+		
+		
+			METS_11 = 'info:fedora/fedora-system:METSFedoraExt-1.1'
+			(line 13)
+		
+	

+	
+	
+	
+		
+

+		

+	

+	
+	
+		
+	

+		
Functions

+		

+			Description |
+													Constants
+				|									Functions
+		

+		
	
+			
+

+	
+	

+		
+		export_foxml_for_pid (line 66)
+	
 
+
+	
+	

+		void
+		
+			export_foxml_for_pid
+		
+					( $pid,  $dir,  $paths,  &$log, [ $format = FOXML_11], [ $remove_islandora = FALSE])
+			

+
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dir			
    • 
+					
  • 
+				
+				$paths			
    • 
+					
  • 
+				
+				&$log			
    • 
+					
  • 
+				
+				$format			
    • 
+					
  • 
+				
+				$remove_islandora			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		export_objects_for_pid (line 32)
+	
 
+
+	
+	

+		void
+		
+			export_objects_for_pid
+		
+					( $pid,  $dir,  &$log)
+			

+
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dir			
    • 
+					
  • 
+				
+				&$log			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		export_to_export_area (line 20)
+	
 
+
+	
+
Function to to export all objects assocoiated with a given pid to the export area

+	

+		void
+		
+			export_to_export_area
+		
+					( $pid,  $foxml_dir,  $ob_dir, [ &$log = array()])
+			

+
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$foxml_dir			
    • 
+					
  • 
+				
+				$ob_dir			
    • 
+					
  • 
+				
+				&$log			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		get_file_extension (line 178)
+	
 
+
+	
+	

+		void
+		
+			get_file_extension
+		
+					( $mimeType)
+			

+
+			
    
+					
  • 
+				
+				$mimeType			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		log_line (line 182)
+	
 
+
+	
+	

+		void
+		
+			log_line
+		
+					( $msg, [ $severity = 'info'], [ $sep = "\t"])
+			

+
+			
    
+					
  • 
+				
+				$msg			
    • 
+					
  • 
+				
+				$severity			
    • 
+					
  • 
+				
+				$sep			
    • 
+				

+		
+	
+

+		

+	

+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/API/_api---fedora_item.inc.html b/docs/Islandora/API/_api---fedora_item.inc.html
new file mode 100644
index 00000000..6caaab14
--- /dev/null
+++ b/docs/Islandora/API/_api---fedora_item.inc.html
@@ -0,0 +1,182 @@
+
+
+  
+		
+			
+			Docs for page fedora_item.inc
+			
+						
+												
+					
+		
+			
			
+
File/api/fedora_item.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+			|									Constants
+										

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+			|										Constants
+															

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						Fedora_Item
+					
+											
+										

+		

+	

+
+	
+		
+	

+		
Constants

+		

+			Description |
+							Classes
+				|									Constants
+											

+		
	
+			
+

+	
+	

+		
+		
+			FEDORA_MODEL_URI = 'info:fedora/fedora-system:def/model#'
+			(line 11)
+		
+	

+	
+	
+	
+		
+

+
+

+	
+	

+		
+		
+			RELS_EXT_URI = 'info:fedora/fedora-system:def/relations-external#'
+			(line 10)
+		
+	

+	
+	
+	
+		
+

+		

+	

+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/API/_api---fedora_utils.inc.html b/docs/Islandora/API/_api---fedora_utils.inc.html
new file mode 100644
index 00000000..c8179b1f
--- /dev/null
+++ b/docs/Islandora/API/_api---fedora_utils.inc.html
@@ -0,0 +1,317 @@
+
+
+  
+		
+			
+			Docs for page fedora_utils.inc
+			
+						
+												
+					
+		
+			
			
+
File/api/fedora_utils.inc

+
+
+

+	
Description

+	

+					Description |
+															Functions
+			

+	
	
+		
+		
+			

+

+		
+
+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+															Functions
+		

+		
	
+			
+

+	
+	

+		
+		do_curl (line 35)
+	
 
+
+	
+	

+		void
+		
+			do_curl
+		
+					( $url, [ $return_to_variable = 1], [ $number_of_post_vars = 0], [ $post = NULL])
+			

+
+			
    
+					
  • 
+				
+				$url			
    • 
+					
  • 
+				
+				$return_to_variable			
    • 
+					
  • 
+				
+				$number_of_post_vars			
    • 
+					
  • 
+				
+				$post			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		fedora_available (line 74)
+	
 
+
+	
+	

+		void
+		
+			fedora_available
+		
+				()
+			

+
+		
+	
+

+
+

+	
+	

+		
+		fixDsid (line 115)
+	
 
+
+	
+	

+		void
+		
+			fixDsid
+		
+					( $dsid)
+			

+
+			
    
+					
  • 
+				
+				$dsid			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		fix_encoding (line 87)
+	
 
+
+	
+
Returns a UTF-8-encoded transcripiton of the string given in $in_str.

+	
    
+				
  • return: A UTF-8 encoded string.
    • 
+			

+	

+		string
+		
+			fix_encoding
+		
+					(string $in_str)
+			

+
+			
    
+					
  • 
+				string
+				$in_str			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		str_getcsv (line 17)
+	
 
+
+	
+	

+		void
+		
+			str_getcsv
+		
+					( $input, [ $delimiter = ','], [ $enclosure = '"'], [ $escape = null], [ $eol = null])
+			

+
+			
    
+					
  • 
+				
+				$input			
    • 
+					
  • 
+				
+				$delimiter			
    • 
+					
  • 
+				
+				$enclosure			
    • 
+					
  • 
+				
+				$escape			
    • 
+					
  • 
+				
+				$eol			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		validDsid (line 106)
+	
 
+
+	
+	

+		void
+		
+			validDsid
+		
+					( $dsid)
+			

+
+			
    
+					
  • 
+				
+				$dsid			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		validPid (line 97)
+	
 
+
+	
+	

+		void
+		
+			validPid
+		
+					( $pid)
+			

+
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+	
+

+		

+	

+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/API/_api---rels-ext.inc.html b/docs/Islandora/API/_api---rels-ext.inc.html
new file mode 100644
index 00000000..52d7a006
--- /dev/null
+++ b/docs/Islandora/API/_api---rels-ext.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page rels-ext.inc
+			
+						
+												
+					
+		
+			
			
+
File/api/rels-ext.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						RelsExt
+					
+											Description of relsext
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/API/_api---tagging.inc.html b/docs/Islandora/API/_api---tagging.inc.html
new file mode 100644
index 00000000..c0a0dc25
--- /dev/null
+++ b/docs/Islandora/API/_api---tagging.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page tagging.inc
+			
+						
+												
+					
+		
+			
			
+
File/api/tagging.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						TagSet
+					
+											Description of tagging
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/IslandoraBook.html b/docs/Islandora/IslandoraBook.html
new file mode 100644
index 00000000..8d4125b2
--- /dev/null
+++ b/docs/Islandora/IslandoraBook.html
@@ -0,0 +1,405 @@
+
+
+  
+		
+			
+			Docs For Class IslandoraBook
+			
+						
+												
+					
+		
+			
			
+
 Class IslandoraBook

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /ilives/book.inc (line 5)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																																																							
+				

+					 
+											IslandoraBook
+										__construct
+											([ $pid = ''])
+									

+															
+				

+					 
+											void
+										buildAddPagesForm
+											([ $form = array()])
+									

+															
+				

+					 
+											void
+										buildDrupalForm
+											([ $form = array()], [ $ingest_form = array()], [ &$form_state = array()])
+									

+															
+				

+					 
+											void
+										buildEditMetadataForm
+											([ $form = array()])
+									

+															
+				

+					 
+											void
+										handleEditMetadataForm
+											( $form_id,  $form_values)
+									

+															
+				

+					 
+											void
+										handleIngestForm
+											( $form_values,  &$form_state)
+									

+															
+				

+					 
+											void
+										showFieldSets
+										()
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 7)
+	
 
+	
+	
+	
+	

+		IslandoraBook
+		
+			__construct
+		
+					([ $pid = ''])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		buildAddPagesForm (line 158)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			buildAddPagesForm
+		
+					([ $form = array()])
+			

+	
+			
    
+					
  • 
+				
+				$form			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		buildDrupalForm (line 16)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			buildDrupalForm
+		
+					([ $form = array()], [ $ingest_form = array()], [ &$form_state = array()])
+			

+	
+			
    
+					
  • 
+				
+				$form			
    • 
+					
  • 
+				
+				$ingest_form			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		buildEditMetadataForm (line 69)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			buildEditMetadataForm
+		
+					([ $form = array()])
+			

+	
+			
    
+					
  • 
+				
+				$form			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		handleEditMetadataForm (line 88)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			handleEditMetadataForm
+		
+					( $form_id,  $form_values)
+			

+	
+			
    
+					
  • 
+				
+				$form_id			
    • 
+					
  • 
+				
+				$form_values			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		handleIngestForm (line 107)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			handleIngestForm
+		
+					( $form_values,  &$form_state)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showFieldSets (line 162)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			showFieldSets
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/Newspaper.html b/docs/Islandora/Newspaper.html
new file mode 100644
index 00000000..e7e8b5e7
--- /dev/null
+++ b/docs/Islandora/Newspaper.html
@@ -0,0 +1,325 @@
+
+
+  
+		
+			
+			Docs For Class Newspaper
+			
+						
+												
+					
+		
+			
			
+
 Class Newspaper

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/islandora_newspaper/Newspaper.inc (line 5)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																																							
+				

+					 
+											Newspaper
+										__construct
+											([ $pid = ''])
+									

+															
+				

+					 
+											void
+										buildDrupalForm
+											([ $form = array()], [ $ingest_form = array()], [ &$form_state = array()])
+									

+															
+				

+					 
+											void
+										handleIngestForm
+											( $form_values,  &$form_state)
+									

+															
+				

+					 
+											void
+										showFieldSets
+										()
+									

+															
+				

+					 
+											void
+										showPageFieldSets
+										()
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 7)
+	
 
+	
+	
+	
+	

+		Newspaper
+		
+			__construct
+		
+					([ $pid = ''])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		buildDrupalForm (line 16)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			buildDrupalForm
+		
+					([ $form = array()], [ $ingest_form = array()], [ &$form_state = array()])
+			

+	
+			
    
+					
  • 
+				
+				$form			
    • 
+					
  • 
+				
+				$ingest_form			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		handleIngestForm (line 41)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			handleIngestForm
+		
+					( $form_values,  &$form_state)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showFieldSets (line 90)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			showFieldSets
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		showPageFieldSets (line 131)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			showPageFieldSets
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/ShowILivesStreamsInFieldSets.html b/docs/Islandora/ShowILivesStreamsInFieldSets.html
new file mode 100644
index 00000000..70238e2c
--- /dev/null
+++ b/docs/Islandora/ShowILivesStreamsInFieldSets.html
@@ -0,0 +1,210 @@
+
+
+  
+		
+			
+			Docs For Class ShowILivesStreamsInFieldSets
+			
+						
+												
+					
+		
+			
			
+
 Class ShowILivesStreamsInFieldSets

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /ilives/image_rotator_tagger_block.inc (line 88)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											ShowILivesStreamsInFieldSets
+										ShowILivesStreamsInFieldSets
+											( $pid)
+									

+															
+				

+					 
+											void
+										showJPG
+										()
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor ShowILivesStreamsInFieldSets (line 92)
+	
 
+	
+	
+	
+	

+		ShowILivesStreamsInFieldSets
+		
+			ShowILivesStreamsInFieldSets
+		
+					( $pid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showJPG (line 97)
+	
 
+	
+	
+	
+	

+		void
+		
+			showJPG
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/_ilives---book.inc.html b/docs/Islandora/_ilives---book.inc.html
new file mode 100644
index 00000000..36121ff0
--- /dev/null
+++ b/docs/Islandora/_ilives---book.inc.html
@@ -0,0 +1,342 @@
+
+
+  
+		
+			
+			Docs for page book.inc
+			
+						
+												
+					
+		
+			
			
+
File/ilives/book.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+			|													Functions
+			

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+			|																Functions
+					

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						IslandoraBook
+					
+											
+										

+		

+	

+
+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+							Classes
+				|															Functions
+		

+		
	
+			
+

+	
+	

+		
+		book_add_pages_form (line 217)
+	
 
+
+	
+	

+		void
+		
+			book_add_pages_form
+		
+					( &$form_state,  $pid, [ $page_cmodel = 'ilives:pageCModel'], [ $relation = 'isMemberOf'])
+			

+
+			
    
+					
  • 
+				
+				&$form_state			
    • 
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$page_cmodel			
    • 
+					
  • 
+				
+				$relation			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		book_add_pages_form_submit (line 251)
+	
 
+
+	
+	

+		void
+		
+			book_add_pages_form_submit
+		
+					( $form,  &$form_state)
+			

+
+			
    
+					
  • 
+				
+				$form			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		book_add_pages_form_validate (line 245)
+	
 
+
+	
+	

+		void
+		
+			book_add_pages_form_validate
+		
+					( $form,  &$form_state)
+			

+
+			
    
+					
  • 
+				
+				$form			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		ilives_add_single_page_object (line 305)
+	
 
+
+	
+	

+		void
+		
+			ilives_add_single_page_object
+		
+					( $book_pid,  $page_file, [ $page_num = 1], [ $page_title = NULL], [ $page_cmodel = 'ilives:pageCModel'], [ $relation = 'isMemberOfCollection'])
+			

+
+			
    
+					
  • 
+				
+				$book_pid			
    • 
+					
  • 
+				
+				$page_file			
    • 
+					
  • 
+				
+				$page_num			
    • 
+					
  • 
+				
+				$page_title			
    • 
+					
  • 
+				
+				$page_cmodel			
    • 
+					
  • 
+				
+				$relation			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		ilives_create_page_objects (line 272)
+	
 
+
+	
+
Create a page object for each element in $image_list as a child object of $pid

+	

+		void
+		
+			ilives_create_page_objects
+		
+					( $pid, [ $image_list = array()], [ $page_cmodel = 'ilives:pageCModel'], [ $relation = 'isMemberOfCollection'])
+			

+
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$image_list			
    • 
+					
  • 
+				
+				$page_cmodel			
    • 
+					
  • 
+				
+				$relation			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		transform_mods_to_dc (line 314)
+	
 
+
+	
+	

+		void
+		
+			transform_mods_to_dc
+		
+					( $mods)
+			

+
+			
    
+					
  • 
+				
+				$mods			
    • 
+				

+		
+	
+

+		

+	

+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/_ilives---image_rotator_tagger_block.inc.html b/docs/Islandora/_ilives---image_rotator_tagger_block.inc.html
new file mode 100644
index 00000000..425d2250
--- /dev/null
+++ b/docs/Islandora/_ilives---image_rotator_tagger_block.inc.html
@@ -0,0 +1,192 @@
+
+
+  
+		
+			
+			Docs for page image_rotator_tagger_block.inc
+			
+						
+												
+					
+		
+			
			
+
File/ilives/image_rotator_tagger_block.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+			|													Functions
+			

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+			|																Functions
+					

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						ShowILivesStreamsInFieldSets
+					
+											
+										

+		

+	

+
+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+							Classes
+				|															Functions
+		

+		
	
+			
+

+	
+	

+		
+		get_random_image (line 9)
+	
 
+
+	
+	

+		void
+		
+			get_random_image
+		
+				()
+			

+
+		
+	
+

+
+

+	
+	

+		
+		_fedora_image_rotator_tagger_block_content (line 49)
+	
 
+
+	
+	

+		void
+		
+			_fedora_image_rotator_tagger_block_content
+		
+				()
+			

+
+		
+	
+

+		

+	

+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/_plugins---fedora_attach---fedora_attach.admin.inc.html b/docs/Islandora/_plugins---fedora_attach---fedora_attach.admin.inc.html
new file mode 100644
index 00000000..2d11bbe1
--- /dev/null
+++ b/docs/Islandora/_plugins---fedora_attach---fedora_attach.admin.inc.html
@@ -0,0 +1,146 @@
+
+
+  
+		
+			
+			Docs for page fedora_attach.admin.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/fedora_attach/fedora_attach.admin.inc

+
+
+

+	
Description

+	

+					Description |
+															Functions
+			

+	
	
+		
+		
+			

+

+		
+
+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+															Functions
+		

+		
	
+			
+

+	
+	

+		
+		fedora_attach_admin (line 16)
+	
 
+
+	
+
Form builder.  Configure Redmine parameters.

+	
    
+				
  • see: system_settings_form().
    • 
+			

+	

+		void
+		
+			fedora_attach_admin
+		
+				()
+			

+
+		
+	
+

+		

+	

+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/_plugins---islandora_newspaper---Newspaper.inc.html b/docs/Islandora/_plugins---islandora_newspaper---Newspaper.inc.html
new file mode 100644
index 00000000..35d25bf5
--- /dev/null
+++ b/docs/Islandora/_plugins---islandora_newspaper---Newspaper.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page Newspaper.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/islandora_newspaper/Newspaper.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						Newspaper
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/CollectionFormBuilder.html b/docs/Islandora/plugins/CollectionFormBuilder.html
new file mode 100644
index 00000000..d06cdba9
--- /dev/null
+++ b/docs/Islandora/plugins/CollectionFormBuilder.html
@@ -0,0 +1,243 @@
+
+
+  
+		
+			
+			Docs For Class CollectionFormBuilder
+			
+						
+												
+					
+		
+			
			
+
 Class CollectionFormBuilder

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/CollectionFormBuilder.inc (line 17)
+		

+		
+				
+		
FormBuilder
+   |
+   --CollectionFormBuilder

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											CollectionFormBuilder
+										CollectionFormBuilder
+										()
+									

+															
+				

+					 
+											void
+										createFedoraDataStreams
+											( $form_values,  &$dom,  &$rootElement)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor CollectionFormBuilder (line 18)
+	
 
+	
+	
+	
+	

+		CollectionFormBuilder
+		
+			CollectionFormBuilder
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		createFedoraDataStreams (line 23)
+	
 
+	
+	
+	
+	

+		void
+		
+			createFedoraDataStreams
+		
+					( $form_values,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			

+		
Redefinition of:

+		

+			
FormBuilder::createFedoraDataStreams()

+					

+			
+	

+							
Inherited Methods

+					
+									
+					
Inherited From FormBuilder

+					

+													 
+							FormBuilder::FormBuilder()

+													 
+							FormBuilder::buildQDCForm()

+													 
+							FormBuilder::createFedoraDataStreams()

+													 
+							FormBuilder::createQDCStream()

+													 
+							FormBuilder::createRelationShips()

+													 
+							FormBuilder::createStandardFedoraStuff()

+													 
+							FormBuilder::handleQDCForm()

+											

+										
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/CreateCollection.html b/docs/Islandora/plugins/CreateCollection.html
new file mode 100644
index 00000000..863dc166
--- /dev/null
+++ b/docs/Islandora/plugins/CreateCollection.html
@@ -0,0 +1,219 @@
+
+
+  
+		
+			
+			Docs For Class CreateCollection
+			
+						
+												
+					
+		
+			
			
+
 Class CreateCollection

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/CreateCollection.inc (line 15)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											CreateCollection
+										CreateCollection
+										()
+									

+															
+				

+					 
+											void
+										ingestCollectionPolicy
+											([ $parameterArray = NULL],  $dsid,  $file, [ $file_ext = NULL])
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor CreateCollection (line 16)
+	
 
+	
+	
+	
+	

+		CreateCollection
+		
+			CreateCollection
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		ingestCollectionPolicy (line 21)
+	
 
+	
+	
+	
+	

+		void
+		
+			ingestCollectionPolicy
+		
+					([ $parameterArray = NULL],  $dsid,  $file, [ $file_ext = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$parameterArray			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$file_ext			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/DarwinCore.html b/docs/Islandora/plugins/DarwinCore.html
new file mode 100644
index 00000000..d849c2fc
--- /dev/null
+++ b/docs/Islandora/plugins/DarwinCore.html
@@ -0,0 +1,434 @@
+
+
+  
+		
+			
+			Docs For Class DarwinCore
+			
+						
+												
+					
+		
+			
			
+
 Class DarwinCore

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/DarwinCore.inc (line 9)
+		

+		
+				
+		

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																																								

+					 
+					mixed
+					$darwinCoreXML
+				

+																

+					 
+					mixed
+					$dwcFields
+				

+																

+					 
+					mixed
+					$vocabulary
+				

+											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																							
+				

+					 
+											DarwinCore
+										__construct
+											([ $item = NULL])
+									

+															
+				

+					 
+											void
+										asHTML
+										()
+									

+															
+				

+					 
+											void
+										asXML
+										()
+									

+															
+				

+					 
+											void
+										buildDrupalForm
+											([ $form = array()])
+									

+															
+				

+					 
+											void
+										handleForm
+											( $form_values)
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+
+

+
+	

+		
+		
+			mixed
+			$darwinCoreXML
+			 =  '
<SimpleDarwinRecordSet xmlns="http://rs.tdwg.org/dwc/xsd/simpledarwincore/" xmlns:dc="http://purl.org/dc/terms/" xmlns:dwc="http://rs.tdwg.org/dwc/terms/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://rs.tdwg.org/dwc/xsd/simpledarwincore/ http://rs.tdwg.org/dwc/xsd/tdwg_dwc_simple.xsd">
  <SimpleDarwinRecord>
    <dc:type></dc:type>
    <dc:language>en</dc:language>
    <dwc:basisOfRecord></dwc:basisOfRecord>
    <dwc:scientificName></dwc:scientificName>
    <dwc:specificEpithet></dwc:specificEpithet>
    <dwc:family></dwc:family>
    <dwc:genus></dwc:genus>
    <dwc:vernacularName></dwc:vernacularName>
    <dwc:continent></dwc:continent>
    <dwc:country></dwc:country>
    <dwc:countryCode></dwc:countryCode>
    <dwc:stateProvince></dwc:stateProvince>
    <dwc:county></dwc:county>
    <dwc:locality></dwc:locality>
    <dwc:habitat></dwc:habitat>
    <dwc:occurrenceRemarks></dwc:occurrenceRemarks>
    <dwc:occurrenceID></dwc:occurrenceID>
    <dwc:institutionCode></dwc:institutionCode>
    <dwc:collectionCode></dwc:collectionCode>
    <dwc:catalogNumber></dwc:catalogNumber>
    <dwc:recordedBy></dwc:recordedBy>
    <dwc:eventDate></dwc:eventDate>
    <dwc:eventTime></dwc:eventTime>
  </SimpleDarwinRecord>
</SimpleDarwinRecordSet>'			(line 292)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$dwcFields
+			 = array(
    'dc:type',
    'dc:language',
    'dwc:basisofrecord',
    'dwc:scientificName',
    'dwc:specificName',
    'dwc:family',
    'dwc:genus',
    'dwc:vernacularName',
    'dwc:continent',
    'dwc:country',
    'dwc:countryCode',
    'dwc:stateProvince',
    'dwc:locality',
    'dwc:habitat',
    'dwc:occurrenceRemarks',
    'dwc:occurrenceID',
    'dwc:institutionCode',
    'dwc:collectionCode',
    'dwc:catalogNumber',
    'dwc:recordedBy',
    'dwc:eventDate',
    'dwc:eventTime',
  )			(line 266)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$vocabulary
+			 = array(
    'basisOfRecord' => array(
      'Occurrence' => 'Occurrence',
      'Event' => 'Event',
      'Location' => 'Location',
      'Taxon' => 'Taxon',
      'PreservedSpecimen' => 'PreservedSpecimen',
      'FossilSpecimen' => 'FossilSpecimen',
      'LivingSpecimen' => 'LivingSpecimen',
      'HumanObservation' => 'HumanObservation',
      'MachineObservation' => 'MachineObservation',
      'NomenclaturalChecklist' => 'NomenclaturalChecklist',
    ),)			(line 250)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 11)
+	
 
+	
+	
+	
+	

+		DarwinCore
+		
+			__construct
+		
+					([ $item = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$item			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		asHTML (line 219)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			asHTML
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		asXML (line 215)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			asXML
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		buildDrupalForm (line 24)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			buildDrupalForm
+		
+					([ $form = array()])
+			

+	
+			
    
+					
  • 
+				
+				$form			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		handleForm (line 180)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			handleForm
+		
+					( $form_values)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/DemoFormBuilder.html b/docs/Islandora/plugins/DemoFormBuilder.html
new file mode 100644
index 00000000..035094e9
--- /dev/null
+++ b/docs/Islandora/plugins/DemoFormBuilder.html
@@ -0,0 +1,243 @@
+
+
+  
+		
+			
+			Docs For Class DemoFormBuilder
+			
+						
+												
+					
+		
+			
			
+
 Class DemoFormBuilder

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/DemoFormBuilder.inc (line 18)
+		

+		
+				
+		
FormBuilder
+   |
+   --DemoFormBuilder

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											DemoFormBuilder
+										DemoFormBuilder
+										()
+									

+															
+				

+					 
+											void
+										createFedoraDataStreams
+											( $form_values,  &$dom,  &$rootElement)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor DemoFormBuilder (line 19)
+	
 
+	
+	
+	
+	

+		DemoFormBuilder
+		
+			DemoFormBuilder
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		createFedoraDataStreams (line 25)
+	
 
+	
+	
+	
+	

+		void
+		
+			createFedoraDataStreams
+		
+					( $form_values,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			

+		
Redefinition of:

+		

+			
FormBuilder::createFedoraDataStreams()

+					

+			
+	

+							
Inherited Methods

+					
+									
+					
Inherited From FormBuilder

+					

+													 
+							FormBuilder::FormBuilder()

+													 
+							FormBuilder::buildQDCForm()

+													 
+							FormBuilder::createFedoraDataStreams()

+													 
+							FormBuilder::createQDCStream()

+													 
+							FormBuilder::createRelationShips()

+													 
+							FormBuilder::createStandardFedoraStuff()

+													 
+							FormBuilder::handleQDCForm()

+											

+										
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/DocumentConverter.html b/docs/Islandora/plugins/DocumentConverter.html
new file mode 100644
index 00000000..e832bbab
--- /dev/null
+++ b/docs/Islandora/plugins/DocumentConverter.html
@@ -0,0 +1,228 @@
+
+
+  
+		
+			
+			Docs For Class DocumentConverter
+			
+						
+												
+					
+		
+			
			
+
 Class DocumentConverter

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+
This class implements document (doc, odt, pdf, etc.) conversion for a generic  multi-format document collection.

+		

+			Located in /plugins/DocumentConverter.inc (line 16)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											DocumentConverter
+										__construct
+											([ $converter_url = NULL])
+									

+															
+				

+					 
+											void
+										convert
+											([ $parameterArray = NULL],  $dsid,  $file,  $output_ext)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 20)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		DocumentConverter
+		
+			__construct
+		
+					([ $converter_url = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$converter_url			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		convert (line 25)
+	
 
+	
+	
+	
+	

+		void
+		
+			convert
+		
+					([ $parameterArray = NULL],  $dsid,  $file,  $output_ext)
+			

+	
+			
    
+					
  • 
+				
+				$parameterArray			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$output_ext			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/Exiftool.html b/docs/Islandora/plugins/Exiftool.html
new file mode 100644
index 00000000..ac945b5e
--- /dev/null
+++ b/docs/Islandora/plugins/Exiftool.html
@@ -0,0 +1,252 @@
+
+
+  
+		
+			
+			Docs For Class Exiftool
+			
+						
+												
+					
+		
+			
			
+
 Class Exiftool

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/Exiftool.inc (line 16)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																							
+				

+					 
+											Exiftool
+										__construct
+											( $pid)
+									

+															
+				

+					 
+											void
+										displayMetadata
+										()
+									

+															
+				

+					 
+											void
+										extractMetadata
+											( $parameterArray,  $dsid,  $file,  $file_ext)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 21)
+	
 
+	
+	
+	
+	

+		Exiftool
+		
+			__construct
+		
+					( $pid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		displayMetadata (line 39)
+	
 
+	
+	
+	
+	

+		void
+		
+			displayMetadata
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		extractMetadata (line 28)
+	
 
+	
+	
+	
+	

+		void
+		
+			extractMetadata
+		
+					( $parameterArray,  $dsid,  $file,  $file_ext)
+			

+	
+			
    
+					
  • 
+				
+				$parameterArray			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$file_ext			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/FedoraObject.html b/docs/Islandora/plugins/FedoraObject.html
new file mode 100644
index 00000000..5fb591ca
--- /dev/null
+++ b/docs/Islandora/plugins/FedoraObject.html
@@ -0,0 +1,213 @@
+
+
+  
+		
+			
+			Docs For Class FedoraObject
+			
+						
+												
+					
+		
+			
			
+
 Class FedoraObject

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/fedoraObject.inc (line 10)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											FedoraObject
+										__construct
+											([ $pid = ''])
+									

+															
+				

+					 
+											void
+										showFieldSets
+										()
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 11)
+	
 
+	
+	
+	
+	

+		FedoraObject
+		
+			__construct
+		
+					([ $pid = ''])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showFieldSets (line 20)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			showFieldSets
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/Ffmpeg.html b/docs/Islandora/plugins/Ffmpeg.html
new file mode 100644
index 00000000..e3a938d9
--- /dev/null
+++ b/docs/Islandora/plugins/Ffmpeg.html
@@ -0,0 +1,219 @@
+
+
+  
+		
+			
+			Docs For Class Ffmpeg
+			
+						
+												
+					
+		
+			
			
+
 Class Ffmpeg

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/Ffmpeg.inc (line 16)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											Ffmpeg
+										Ffmpeg
+										()
+									

+															
+				

+					 
+											void
+										extract_thumbnail
+											( $parameterArray,  $dsid,  $file,  $file_ext)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor Ffmpeg (line 17)
+	
 
+	
+	
+	
+	

+		Ffmpeg
+		
+			Ffmpeg
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		extract_thumbnail (line 20)
+	
 
+	
+	
+	
+	

+		void
+		
+			extract_thumbnail
+		
+					( $parameterArray,  $dsid,  $file,  $file_ext)
+			

+	
+			
    
+					
  • 
+				
+				$parameterArray			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$file_ext			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/FlvFormBuilder.html b/docs/Islandora/plugins/FlvFormBuilder.html
new file mode 100644
index 00000000..c304fa14
--- /dev/null
+++ b/docs/Islandora/plugins/FlvFormBuilder.html
@@ -0,0 +1,243 @@
+
+
+  
+		
+			
+			Docs For Class FlvFormBuilder
+			
+						
+												
+					
+		
+			
			
+
 Class FlvFormBuilder

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/FlvFormBuilder.inc (line 16)
+		

+		
+				
+		
FormBuilder
+   |
+   --FlvFormBuilder

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											FlvFormBuilder
+										FlvFormBuilder
+										()
+									

+															
+				

+					 
+											void
+										createFedoraDataStreams
+											( $form_values,  &$dom,  &$rootElement)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor FlvFormBuilder (line 17)
+	
 
+	
+	
+	
+	

+		FlvFormBuilder
+		
+			FlvFormBuilder
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		createFedoraDataStreams (line 25)
+	
 
+	
+	
+	
+	

+		void
+		
+			createFedoraDataStreams
+		
+					( $form_values,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			

+		
Redefinition of:

+		

+			
FormBuilder::createFedoraDataStreams()

+					

+			
+	

+							
Inherited Methods

+					
+									
+					
Inherited From FormBuilder

+					

+													 
+							FormBuilder::FormBuilder()

+													 
+							FormBuilder::buildQDCForm()

+													 
+							FormBuilder::createFedoraDataStreams()

+													 
+							FormBuilder::createQDCStream()

+													 
+							FormBuilder::createRelationShips()

+													 
+							FormBuilder::createStandardFedoraStuff()

+													 
+							FormBuilder::handleQDCForm()

+											

+										
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/FormBuilder.html b/docs/Islandora/plugins/FormBuilder.html
new file mode 100644
index 00000000..3bb2af08
--- /dev/null
+++ b/docs/Islandora/plugins/FormBuilder.html
@@ -0,0 +1,504 @@
+
+
+  
+		
+			
+			Docs For Class FormBuilder
+			
+						
+												
+					
+		
+			
			
+
 Class FormBuilder

+
+
+

+	
Description

+	

+					Description |
+							Descendents
+			|													Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/Flv.inc (line 16)
+		

+		
+				
+		

+	
+			

+

+
+	
+	

+		
Direct descendents

+		

+			Description |
+			Descendents
+			|															Methods (details)
+							
+								

+		

+			
+				
+					
+					
+				
+								
+					
+					
+				
+								
+					
+					
+				
+								
+					
+					
+				
+								
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						CollectionFormBuilder
+					
+											
+										

+						 class
+						DemoFormBuilder
+					
+											
+										

+						 class
+						FlvFormBuilder
+					
+											
+										

+						 class
+						ModsFormBuilder
+					
+											
+										

+						 class
+						QtFormBuilder
+					
+											
+										

+		

+	

+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+							Descendants |
+												Methods (details)
+		

+		
			
+			

+																																																																							
+				

+					 
+											FormBuilder
+										FormBuilder
+										()
+									

+															
+				

+					 
+											void
+										buildQDCForm
+											( &$form,  $ingest_form_definition,  &$form_values)
+									

+															
+				

+					 
+											void
+										createFedoraDataStreams
+											( $form_values,  &$dom,  &$rootElement)
+									

+															
+				

+					 
+											void
+										createQDCStream
+											( $form_values,  &$dom,  &$rootElement)
+									

+															
+				

+					 
+											void
+										createRelationShips
+											( $form_values,  &$dom,  &$rootElement)
+									

+															
+				

+					 
+											void
+										createStandardFedoraStuff
+											( $form_values,  &$dom,  &$rootElement)
+									

+															
+				

+					 
+											void
+										handleQDCForm
+											( $form_values)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+							Descendents |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor FormBuilder (line 17)
+	
 
+	
+	
+	
+	

+		FormBuilder
+		
+			FormBuilder
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		buildQDCForm (line 232)
+	
 
+	
+	
+	
+	

+		void
+		
+			buildQDCForm
+		
+					( &$form,  $ingest_form_definition,  &$form_values)
+			

+	
+			
    
+					
  • 
+				
+				&$form			
    • 
+					
  • 
+				
+				$ingest_form_definition			
    • 
+					
  • 
+				
+				&$form_values			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createFedoraDataStreams (line 118)
+	
 
+	
+	
+	
+	

+		void
+		
+			createFedoraDataStreams
+		
+					( $form_values,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			
+			

+		
Redefined in descendants as:

+		
+	

+
+

+	
+	

+		
+		createQDCStream (line 22)
+	
 
+	
+	
+	
+	

+		void
+		
+			createQDCStream
+		
+					( $form_values,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createRelationShips (line 171)
+	
 
+	
+	
+
creates the RELS-EXT for the foxml

+	
+	

+		void
+		
+			createRelationShips
+		
+					( $form_values,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createStandardFedoraStuff (line 205)
+	
 
+	
+	
+
creates the standard foxml properties

+	
+	

+		void
+		
+			createStandardFedoraStuff
+		
+					( $form_values,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		handleQDCForm (line 71)
+	
 
+	
+	
+	
+	

+		void
+		
+			handleQDCForm
+		
+					( $form_values)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/Herbarium.html b/docs/Islandora/plugins/Herbarium.html
new file mode 100644
index 00000000..bdd5aa5b
--- /dev/null
+++ b/docs/Islandora/plugins/Herbarium.html
@@ -0,0 +1,363 @@
+
+
+  
+		
+			
+			Docs For Class Herbarium
+			
+						
+												
+					
+		
+			
			
+
 Class Herbarium

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/herbarium.inc (line 11)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																																															
+				

+					 
+											Herbarium
+										__construct
+											([ $pid = ''])
+									

+															
+				

+					 
+											void
+										buildDrupalForm
+											([ $form = array()], [ $form_state = array()])
+									

+															
+				

+					 
+											void
+										buildEditMetadataForm
+											([ $form = array()])
+									

+															
+				

+					 
+											void
+										handleEditMetadataForm
+											( $form_id,  $form_values)
+									

+															
+				

+					 
+											void
+										handleIngestForm
+											( $form_values)
+									

+															
+				

+					 
+											void
+										showFieldSets
+										()
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 12)
+	
 
+	
+	
+	
+	

+		Herbarium
+		
+			__construct
+		
+					([ $pid = ''])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		buildDrupalForm (line 20)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			buildDrupalForm
+		
+					([ $form = array()], [ $form_state = array()])
+			

+	
+			
    
+					
  • 
+				
+				$form			
    • 
+					
  • 
+				
+				$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		buildEditMetadataForm (line 29)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			buildEditMetadataForm
+		
+					([ $form = array()])
+			

+	
+			
    
+					
  • 
+				
+				$form			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		handleEditMetadataForm (line 47)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			handleEditMetadataForm
+		
+					( $form_id,  $form_values)
+			

+	
+			
    
+					
  • 
+				
+				$form_id			
    • 
+					
  • 
+				
+				$form_values			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		handleIngestForm (line 65)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			handleIngestForm
+		
+					( $form_values)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showFieldSets (line 109)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			showFieldSets
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/ImageManipulation.html b/docs/Islandora/plugins/ImageManipulation.html
new file mode 100644
index 00000000..93fa131e
--- /dev/null
+++ b/docs/Islandora/plugins/ImageManipulation.html
@@ -0,0 +1,429 @@
+
+
+  
+		
+			
+			Docs For Class ImageManipulation
+			
+						
+												
+					
+		
+			
			
+
 Class ImageManipulation

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/ImageManipulation.inc (line 16)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																																																							
+				

+					 
+											ImageManipulation
+										ImageManipulation
+										()
+									

+															
+				

+					 
+											void
+										createJP2
+											([ $parameterArray = NULL],  $dsid,  $file,  $file_ext)
+									

+															
+				

+					 
+											void
+										createPNG
+											([ $parameterArray = NULL],  $dsid,  $file,  $file_ext)
+									

+															
+				

+					 
+											void
+										createPreview
+											( $parameterArray,  $dsid,  $file,  $file_ext)
+									

+															
+				

+					 
+											void
+										createThumbnail
+											( $parameterArray,  $dsid,  $file,  $file_ext)
+									

+															
+				

+					 
+											void
+										createThumbnailFromPDF
+											( $parameterArray,  $dsid,  $file,  $file_ext)
+									

+															
+				

+					 
+											void
+										manipulateImage
+											([ $parameterArray = NULL],  $dsid,  $file,  $file_ext)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor ImageManipulation (line 18)
+	
 
+	
+	
+	
+	

+		ImageManipulation
+		
+			ImageManipulation
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		createJP2 (line 77)
+	
 
+	
+	
+	
+	

+		void
+		
+			createJP2
+		
+					([ $parameterArray = NULL],  $dsid,  $file,  $file_ext)
+			

+	
+			
    
+					
  • 
+				
+				$parameterArray			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$file_ext			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createPNG (line 57)
+	
 
+	
+	
+	
+	

+		void
+		
+			createPNG
+		
+					([ $parameterArray = NULL],  $dsid,  $file,  $file_ext)
+			

+	
+			
    
+					
  • 
+				
+				$parameterArray			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$file_ext			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createPreview (line 22)
+	
 
+	
+	
+	
+	

+		void
+		
+			createPreview
+		
+					( $parameterArray,  $dsid,  $file,  $file_ext)
+			

+	
+			
    
+					
  • 
+				
+				$parameterArray			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$file_ext			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createThumbnail (line 193)
+	
 
+	
+	
+	
+	

+		void
+		
+			createThumbnail
+		
+					( $parameterArray,  $dsid,  $file,  $file_ext)
+			

+	
+			
    
+					
  • 
+				
+				$parameterArray			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$file_ext			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createThumbnailFromPDF (line 159)
+	
 
+	
+	
+	
+	

+		void
+		
+			createThumbnailFromPDF
+		
+					( $parameterArray,  $dsid,  $file,  $file_ext)
+			

+	
+			
    
+					
  • 
+				
+				$parameterArray			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$file_ext			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		manipulateImage (line 124)
+	
 
+	
+	
+	
+	

+		void
+		
+			manipulateImage
+		
+					([ $parameterArray = NULL],  $dsid,  $file,  $file_ext)
+			

+	
+			
    
+					
  • 
+				
+				$parameterArray			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$file_ext			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/ModsFormBuilder.html b/docs/Islandora/plugins/ModsFormBuilder.html
new file mode 100644
index 00000000..80bde5c0
--- /dev/null
+++ b/docs/Islandora/plugins/ModsFormBuilder.html
@@ -0,0 +1,602 @@
+
+
+  
+		
+			
+			Docs For Class ModsFormBuilder
+			
+						
+												
+					
+		
+			
			
+
 Class ModsFormBuilder

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/ModsFormBuilder.inc (line 12)
+		

+		
+				
+		
FormBuilder
+   |
+   --ModsFormBuilder

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																												

+					 
+					static mixed
+					$MODS_NS
+				

+																												

+					 
+					mixed
+					$cm
+				

+																

+					 
+					mixed
+					$item
+				

+																								

+					 
+					mixed
+					$pid
+				

+											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																																															
+				

+					 
+											ModsFormBuilder
+										__construct
+											([ $pid = null])
+									

+															
+				

+					 
+											void
+										buildEditMetadataForm
+										()
+									

+															
+				

+					 
+											void
+										createCollectionPolicy
+											( $form_values,  &$dom,  &$rootElement)
+									

+															
+				

+					 
+											void
+										createModsStream
+											( $form_values,  &$dom,  &$rootElement)
+									

+															
+				

+					 
+											void
+										createWorkflowStream
+											( $form_values,  &$dom,  &$rootElement)
+									

+															
+				

+					 
+											void
+										handleEditMetadataForm
+											( &$form_id,  &$form_values,  &$soap_client)
+									

+															
+				

+					 
+											void
+										handleModsForm
+											( &$form_values,  &$form_state)
+									

+															
+				

+					 
+											void
+										modsFromForm
+											( &$form_values,  &$dom)
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+

+
+	

+		
+		
+			static mixed
+			$MODS_NS
+			 =  'http://www.loc.gov/mods/v3'			(line 13)
+		
+	

+
+	
+	
+	
+		
+		
+
+

+
+
+

+
+	

+		
+		
+			mixed
+			$cm
+						(line 14)
+		
+	

+
+	
+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$item
+						(line 15)
+		
+	

+
+	
+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$pid
+						(line 16)
+		
+	

+
+	
+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 18)
+	
 
+	
+	
+	
+	

+		ModsFormBuilder
+		
+			__construct
+		
+					([ $pid = null])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		buildEditMetadataForm (line 45)
+	
 
+	
+	
+	
+	

+		void
+		
+			buildEditMetadataForm
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		createCollectionPolicy (line 309)
+	
 
+	
+	
+	
+	

+		void
+		
+			createCollectionPolicy
+		
+					( $form_values,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createModsStream (line 367)
+	
 
+	
+	
+	
+	

+		void
+		
+			createModsStream
+		
+					( $form_values,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createWorkflowStream (line 338)
+	
 
+	
+	
+	
+	

+		void
+		
+			createWorkflowStream
+		
+					( $form_values,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		handleEditMetadataForm (line 32)
+	
 
+	
+	
+	
+	

+		void
+		
+			handleEditMetadataForm
+		
+					( &$form_id,  &$form_values,  &$soap_client)
+			

+	
+			
    
+					
  • 
+				
+				&$form_id			
    • 
+					
  • 
+				
+				&$form_values			
    • 
+					
  • 
+				
+				&$soap_client			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		handleModsForm (line 240)
+	
 
+	
+	
+	
+	

+		void
+		
+			handleModsForm
+		
+					( &$form_values,  &$form_state)
+			

+	
+			
    
+					
  • 
+				
+				&$form_values			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		modsFromForm (line 388)
+	
 
+	
+	
+	
+	

+		void
+		
+			modsFromForm
+		
+					( &$form_values,  &$dom)
+			

+	
+			
    
+					
  • 
+				
+				&$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+				

+		
+			
+	

+							
Inherited Methods

+					
+									
+					
Inherited From FormBuilder

+					

+													 
+							FormBuilder::FormBuilder()

+													 
+							FormBuilder::buildQDCForm()

+													 
+							FormBuilder::createFedoraDataStreams()

+													 
+							FormBuilder::createQDCStream()

+													 
+							FormBuilder::createRelationShips()

+													 
+							FormBuilder::createStandardFedoraStuff()

+													 
+							FormBuilder::handleQDCForm()

+											

+										
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/PersonalCollectionClass.html b/docs/Islandora/plugins/PersonalCollectionClass.html
new file mode 100644
index 00000000..63bb6bdf
--- /dev/null
+++ b/docs/Islandora/plugins/PersonalCollectionClass.html
@@ -0,0 +1,411 @@
+
+
+  
+		
+			
+			Docs For Class PersonalCollectionClass
+			
+						
+												
+					
+		
+			
			
+
 Class PersonalCollectionClass

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/PersonalCollectionClass.inc (line 10)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																																																							
+				

+					 
+											PersonalCollectionClass
+										PersonalCollectionClass
+										()
+									

+															
+				

+					 
+											void
+										createChildPolicyStream
+											( $dom,  $rootElement,  $policyStream)
+									

+															
+				

+					 
+											void
+										createCollection
+											( $theUser,  $pid,  $soapClient)
+									

+															
+				

+					 
+											void
+										createCollectionPolicyStream
+											( $user,  $dom,  $rootElement)
+									

+															
+				

+					 
+											void
+										createDCStream
+											( $theUser,  &$dom,  &$rootElement)
+									

+															
+				

+					 
+											void
+										createPolicyStream
+											( $user,  $dom,  $rootElement)
+									

+															
+				

+					 
+											void
+										createStandardFedoraStuff
+											( $user,  &$dom,  &$rootElement)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor PersonalCollectionClass (line 11)
+	
 
+	
+	
+	
+	

+		PersonalCollectionClass
+		
+			PersonalCollectionClass
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		createChildPolicyStream (line 125)
+	
 
+	
+	
+	
+	

+		void
+		
+			createChildPolicyStream
+		
+					( $dom,  $rootElement,  $policyStream)
+			

+	
+			
    
+					
  • 
+				
+				$dom			
    • 
+					
  • 
+				
+				$rootElement			
    • 
+					
  • 
+				
+				$policyStream			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createCollection (line 15)
+	
 
+	
+	
+	
+	

+		void
+		
+			createCollection
+		
+					( $theUser,  $pid,  $soapClient)
+			

+	
+			
    
+					
  • 
+				
+				$theUser			
    • 
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$soapClient			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createCollectionPolicyStream (line 54)
+	
 
+	
+	
+	
+	

+		void
+		
+			createCollectionPolicyStream
+		
+					( $user,  $dom,  $rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$user			
    • 
+					
  • 
+				
+				$dom			
    • 
+					
  • 
+				
+				$rootElement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createDCStream (line 170)
+	
 
+	
+	
+	
+	

+		void
+		
+			createDCStream
+		
+					( $theUser,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$theUser			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createPolicyStream (line 97)
+	
 
+	
+	
+	
+	

+		void
+		
+			createPolicyStream
+		
+					( $user,  $dom,  $rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$user			
    • 
+					
  • 
+				
+				$dom			
    • 
+					
  • 
+				
+				$rootElement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createStandardFedoraStuff (line 144)
+	
 
+	
+	
+	
+	

+		void
+		
+			createStandardFedoraStuff
+		
+					( $user,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$user			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/QtFormBuilder.html b/docs/Islandora/plugins/QtFormBuilder.html
new file mode 100644
index 00000000..e2bcd855
--- /dev/null
+++ b/docs/Islandora/plugins/QtFormBuilder.html
@@ -0,0 +1,243 @@
+
+
+  
+		
+			
+			Docs For Class QtFormBuilder
+			
+						
+												
+					
+		
+			
			
+
 Class QtFormBuilder

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/QtFormBuilder.php (line 18)
+		

+		
+				
+		
FormBuilder
+   |
+   --QtFormBuilder

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											QtFormBuilder
+										QtFormBuilder
+										()
+									

+															
+				

+					 
+											void
+										createFedoraDataStreams
+											( $form_values,  &$dom,  &$rootElement)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor QtFormBuilder (line 19)
+	
 
+	
+	
+	
+	

+		QtFormBuilder
+		
+			QtFormBuilder
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		createFedoraDataStreams (line 28)
+	
 
+	
+	
+	
+	

+		void
+		
+			createFedoraDataStreams
+		
+					( $form_values,  &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			

+		
Redefinition of:

+		

+			
FormBuilder::createFedoraDataStreams()

+					

+			
+	

+							
Inherited Methods

+					
+									
+					
Inherited From FormBuilder

+					

+													 
+							FormBuilder::FormBuilder()

+													 
+							FormBuilder::buildQDCForm()

+													 
+							FormBuilder::createFedoraDataStreams()

+													 
+							FormBuilder::createQDCStream()

+													 
+							FormBuilder::createRelationShips()

+													 
+							FormBuilder::createStandardFedoraStuff()

+													 
+							FormBuilder::handleQDCForm()

+											

+										
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/Refworks.html b/docs/Islandora/plugins/Refworks.html
new file mode 100644
index 00000000..d8f509ba
--- /dev/null
+++ b/docs/Islandora/plugins/Refworks.html
@@ -0,0 +1,535 @@
+
+
+  
+		
+			
+			Docs For Class Refworks
+			
+						
+												
+					
+		
+			
			
+
 Class Refworks

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/Refworks.inc (line 19)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																																																																															
+				

+					 
+											Refworks
+										Refworks
+										()
+									

+															
+				

+					 
+											void
+										buildForm
+											( &$form,  $ingest_form_definition,  &$form_values)
+									

+															
+				

+					 
+											void
+										createFedoraDataStreams
+											( $form_values,  &$dom,  &$rootElement,  $reference)
+									

+															
+				

+					 
+											void
+										createQDCStream
+											( &$dom,  &$rootElement,  $reference)
+									

+															
+				

+					 
+											void
+										createRelationShips
+											( $form_values,  &$dom,  &$rootElement, [ $pid = NULL])
+									

+															
+				

+					 
+											void
+										createRomeoDataStream
+											( &$dom,  &$rootElement)
+									

+															
+				

+					 
+											void
+										createStandardFedoraStuff
+											( $form_values,  &$dom,  &$rootElement,  $reference)
+									

+															
+				

+					 
+											void
+										create_security_policies
+											(DOMDocument $dom,  &$rootElement, $rootElement $reference, array $form_values)
+									

+															
+				

+					 
+											void
+										handleForm
+											( &$form_values)
+									

+															
+				

+					 
+											SimpleXMLElement
+										parse_refworks_item
+											( &$form_values, array $form_values, SimpleXMLElement $dom)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor Refworks (line 26)
+	
 
+	
+	
+	
+	

+		Refworks
+		
+			Refworks
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		buildForm (line 30)
+	
 
+	
+	
+	
+	

+		void
+		
+			buildForm
+		
+					( &$form,  $ingest_form_definition,  &$form_values)
+			

+	
+			
    
+					
  • 
+				
+				&$form			
    • 
+					
  • 
+				
+				$ingest_form_definition			
    • 
+					
  • 
+				
+				&$form_values			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createFedoraDataStreams (line 358)
+	
 
+	
+	
+	
+	

+		void
+		
+			createFedoraDataStreams
+		
+					( $form_values,  &$dom,  &$rootElement,  $reference)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+					
  • 
+				
+				$reference			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createQDCStream (line 92)
+	
 
+	
+	
+	
+	

+		void
+		
+			createQDCStream
+		
+					( &$dom,  &$rootElement,  $reference)
+			

+	
+			
    
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+					
  • 
+				
+				$reference			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createRelationShips (line 307)
+	
 
+	
+	
+
Creates the RELS-EXT for the foxml

+	
+	

+		void
+		
+			createRelationShips
+		
+					( $form_values,  &$dom,  &$rootElement, [ $pid = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createRomeoDataStream (line 339)
+	
 
+	
+	
+	
+	

+		void
+		
+			createRomeoDataStream
+		
+					( &$dom,  &$rootElement)
+			

+	
+			
    
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createStandardFedoraStuff (line 385)
+	
 
+	
+	
+
Creates the standard foxml properties

+	
+	

+		void
+		
+			createStandardFedoraStuff
+		
+					( $form_values,  &$dom,  &$rootElement,  $reference)
+			

+	
+			
    
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				&$dom			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+					
  • 
+				
+				$reference			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		create_security_policies (line 417)
+	
 
+	
+	
+
Read the list of Users from the U1 field and Roles from the U2 field and add elements  to the security policy record for this item, then add the record as the security policy datastream.

+	
+	

+		void
+		
+			create_security_policies
+		
+					(DOMDocument $dom,  &$rootElement, $rootElement $reference, array $form_values)
+			

+	
+			
    
+					
  • 
+				array
+				$form_values			
    • 
+					
  • 
+				DOMDocument
+				$dom			
    • 
+					
  • 
+				$rootElement
+				$reference			
    • 
+					
  • 
+				
+				&$rootElement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		handleForm (line 206)
+	
 
+	
+	
+	
+	

+		void
+		
+			handleForm
+		
+					( &$form_values)
+			

+	
+			
    
+					
  • 
+				
+				&$form_values			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		parse_refworks_item (line 67)
+	
 
+	
+	
+
Read the input file and generate a list of Reference items.

+	
+	

+		SimpleXMLElement
+		
+			parse_refworks_item
+		
+					( &$form_values, array $form_values, SimpleXMLElement $dom)
+			

+	
+			
    
+					
  • 
+				array
+				$form_values			
    • 
+					
  • 
+				SimpleXMLElement
+				$dom			
    • 
+					
  • 
+				
+				&$form_values			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/ShowDemoStreamsInFieldSets.html b/docs/Islandora/plugins/ShowDemoStreamsInFieldSets.html
new file mode 100644
index 00000000..ff8feccc
--- /dev/null
+++ b/docs/Islandora/plugins/ShowDemoStreamsInFieldSets.html
@@ -0,0 +1,210 @@
+
+
+  
+		
+			
+			Docs For Class ShowDemoStreamsInFieldSets
+			
+						
+												
+					
+		
+			
			
+
 Class ShowDemoStreamsInFieldSets

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/ShowDemoStreamsInFieldSets.inc (line 15)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											ShowDemoStreamsInFieldSets
+										ShowDemoStreamsInFieldSets
+											( $pid)
+									

+															
+				

+					 
+											void
+										showMediumSize
+										()
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor ShowDemoStreamsInFieldSets (line 17)
+	
 
+	
+	
+	
+	

+		ShowDemoStreamsInFieldSets
+		
+			ShowDemoStreamsInFieldSets
+		
+					( $pid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showMediumSize (line 22)
+	
 
+	
+	
+	
+	

+		void
+		
+			showMediumSize
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/ShowMapStreamsInFieldSets.html b/docs/Islandora/plugins/ShowMapStreamsInFieldSets.html
new file mode 100644
index 00000000..06e066e5
--- /dev/null
+++ b/docs/Islandora/plugins/ShowMapStreamsInFieldSets.html
@@ -0,0 +1,210 @@
+
+
+  
+		
+			
+			Docs For Class ShowMapStreamsInFieldSets
+			
+						
+												
+					
+		
+			
			
+
 Class ShowMapStreamsInFieldSets

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/map_viewer.inc (line 11)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											ShowMapStreamsInFieldSets
+										ShowMapStreamsInFieldSets
+											( $pid)
+									

+															
+				

+					 
+											void
+										showJPG
+										()
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor ShowMapStreamsInFieldSets (line 14)
+	
 
+	
+	
+	
+	

+		ShowMapStreamsInFieldSets
+		
+			ShowMapStreamsInFieldSets
+		
+					( $pid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showJPG (line 18)
+	
 
+	
+	
+	
+	

+		void
+		
+			showJPG
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/ShowQtStreamsInFieldSets.html b/docs/Islandora/plugins/ShowQtStreamsInFieldSets.html
new file mode 100644
index 00000000..f618c736
--- /dev/null
+++ b/docs/Islandora/plugins/ShowQtStreamsInFieldSets.html
@@ -0,0 +1,371 @@
+
+
+  
+		
+			
+			Docs For Class ShowQtStreamsInFieldSets
+			
+						
+												
+					
+		
+			
			
+
 Class ShowQtStreamsInFieldSets

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/qt_viewer.inc (line 10)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																																																							
+				

+					 
+											ShowQtStreamsInFieldSets
+										ShowQtStreamsInFieldSets
+											( $pid)
+									

+															
+				

+					 
+											void
+										enableDownload
+										()
+									

+															
+				

+					 
+											void
+										fedoraObject
+										()
+									

+															
+				

+					 
+											void
+										getMediaDatastreamInfo
+											([ $dsid = 'OBJ'], [ $alt = array('')])
+									

+															
+				

+					 
+											void
+										getPosterFrameDatastreamInfo
+											([ $dsid = 'FULL_SIZE'])
+									

+															
+				

+					 
+											void
+										showQt
+										()
+									

+															
+				

+					 
+											void
+										technicalMetadata
+											([ $defaults = array()], [ $dsid = 'OBJ_EXIFTOOL'])
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor ShowQtStreamsInFieldSets (line 13)
+	
 
+	
+	
+	
+	

+		ShowQtStreamsInFieldSets
+		
+			ShowQtStreamsInFieldSets
+		
+					( $pid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		enableDownload (line 71)
+	
 
+	
+	
+	
+	

+		void
+		
+			enableDownload
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		fedoraObject (line 17)
+	
 
+	
+	
+	
+	

+		void
+		
+			fedoraObject
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getMediaDatastreamInfo (line 58)
+	
 
+	
+	
+	
+	

+		void
+		
+			getMediaDatastreamInfo
+		
+					([ $dsid = 'OBJ'], [ $alt = array('')])
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$alt			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getPosterFrameDatastreamInfo (line 50)
+	
 
+	
+	
+	
+	

+		void
+		
+			getPosterFrameDatastreamInfo
+		
+					([ $dsid = 'FULL_SIZE'])
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showQt (line 75)
+	
 
+	
+	
+	
+	

+		void
+		
+			showQt
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		technicalMetadata (line 21)
+	
 
+	
+	
+	
+	

+		void
+		
+			technicalMetadata
+		
+					([ $defaults = array()], [ $dsid = 'OBJ_EXIFTOOL'])
+			

+	
+			
    
+					
  • 
+				
+				$defaults			
    • 
+					
  • 
+				
+				$dsid			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/ShowSlideStreamsInFieldSets.html b/docs/Islandora/plugins/ShowSlideStreamsInFieldSets.html
new file mode 100644
index 00000000..18ac6cb2
--- /dev/null
+++ b/docs/Islandora/plugins/ShowSlideStreamsInFieldSets.html
@@ -0,0 +1,210 @@
+
+
+  
+		
+			
+			Docs For Class ShowSlideStreamsInFieldSets
+			
+						
+												
+					
+		
+			
			
+
 Class ShowSlideStreamsInFieldSets

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/slide_viewer.inc (line 10)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																															
+				

+					 
+											ShowSlideStreamsInFieldSets
+										ShowSlideStreamsInFieldSets
+											( $pid)
+									

+															
+				

+					 
+											void
+										showJPG
+										()
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor ShowSlideStreamsInFieldSets (line 14)
+	
 
+	
+	
+	
+	

+		ShowSlideStreamsInFieldSets
+		
+			ShowSlideStreamsInFieldSets
+		
+					( $pid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showJPG (line 19)
+	
 
+	
+	
+	
+	

+		void
+		
+			showJPG
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/ShowStreamsInFieldSets.html b/docs/Islandora/plugins/ShowStreamsInFieldSets.html
new file mode 100644
index 00000000..08291db5
--- /dev/null
+++ b/docs/Islandora/plugins/ShowStreamsInFieldSets.html
@@ -0,0 +1,445 @@
+
+
+  
+		
+			
+			Docs For Class ShowStreamsInFieldSets
+			
+						
+												
+					
+		
+			
			
+
 Class ShowStreamsInFieldSets

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /plugins/ShowStreamsInFieldSets.inc (line 13)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																																																																															
+				

+					 
+											ShowStreamsInFieldSets
+										ShowStreamsInFieldSets
+											( $pid)
+									

+															
+				

+					 
+											void
+										showArtInventoryTN
+										()
+									

+															
+				

+					 
+											void
+										showFlv
+										()
+									

+															
+				

+					 
+											void
+										showJP2
+											([ $collapsed = FALSE])
+									

+															
+				

+					 
+											void
+										showOBJLink
+										()
+									

+															
+				

+					 
+											void
+										showPDFPreview
+										()
+									

+															
+				

+					 
+											void
+										showQdc
+										()
+									

+															
+				

+					 
+											void
+										showRefworks
+										()
+									

+															
+				

+					 
+											void
+										showRomeo
+											([ $collapsed = FALSE])
+									

+															
+				

+					 
+											void
+										showTN
+										()
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor ShowStreamsInFieldSets (line 15)
+	
 
+	
+	
+	
+	

+		ShowStreamsInFieldSets
+		
+			ShowStreamsInFieldSets
+		
+					( $pid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showArtInventoryTN (line 52)
+	
 
+	
+	
+	
+	

+		void
+		
+			showArtInventoryTN
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		showFlv (line 19)
+	
 
+	
+	
+	
+	

+		void
+		
+			showFlv
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		showJP2 (line 174)
+	
 
+	
+	
+	
+	

+		void
+		
+			showJP2
+		
+					([ $collapsed = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$collapsed			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showOBJLink (line 132)
+	
 
+	
+	
+	
+	

+		void
+		
+			showOBJLink
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		showPDFPreview (line 64)
+	
 
+	
+	
+
Embed Google Docs' PDF viewer into the page.

+	
+	

+		void
+		
+			showPDFPreview
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		showQdc (line 119)
+	
 
+	
+	
+	
+	

+		void
+		
+			showQdc
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		showRefworks (line 142)
+	
 
+	
+	
+	
+	

+		void
+		
+			showRefworks
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		showRomeo (line 186)
+	
 
+	
+	
+	
+	

+		void
+		
+			showRomeo
+		
+					([ $collapsed = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$collapsed			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showTN (line 39)
+	
 
+	
+	
+	
+	

+		void
+		
+			showTN
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---CollectionFormBuilder.inc.html b/docs/Islandora/plugins/_plugins---CollectionFormBuilder.inc.html
new file mode 100644
index 00000000..b2c8aa4e
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---CollectionFormBuilder.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page CollectionFormBuilder.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/CollectionFormBuilder.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						CollectionFormBuilder
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---CreateCollection.inc.html b/docs/Islandora/plugins/_plugins---CreateCollection.inc.html
new file mode 100644
index 00000000..740eec77
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---CreateCollection.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page CreateCollection.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/CreateCollection.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						CreateCollection
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---DarwinCore.inc.html b/docs/Islandora/plugins/_plugins---DarwinCore.inc.html
new file mode 100644
index 00000000..d5650bab
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---DarwinCore.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page DarwinCore.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/DarwinCore.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						DarwinCore
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---DemoFormBuilder.inc.html b/docs/Islandora/plugins/_plugins---DemoFormBuilder.inc.html
new file mode 100644
index 00000000..e2a0206b
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---DemoFormBuilder.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page DemoFormBuilder.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/DemoFormBuilder.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						DemoFormBuilder
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---DocumentConverter.inc.html b/docs/Islandora/plugins/_plugins---DocumentConverter.inc.html
new file mode 100644
index 00000000..30e39671
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---DocumentConverter.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page DocumentConverter.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/DocumentConverter.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						DocumentConverter
+					
+											This class implements document (doc, odt, pdf, etc.) conversion for a generic  multi-format document collection.
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---Exiftool.inc.html b/docs/Islandora/plugins/_plugins---Exiftool.inc.html
new file mode 100644
index 00000000..a67622e0
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---Exiftool.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page Exiftool.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/Exiftool.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						Exiftool
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---Ffmpeg.inc.html b/docs/Islandora/plugins/_plugins---Ffmpeg.inc.html
new file mode 100644
index 00000000..1c524afb
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---Ffmpeg.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page Ffmpeg.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/Ffmpeg.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						Ffmpeg
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---Flv.inc.html b/docs/Islandora/plugins/_plugins---Flv.inc.html
new file mode 100644
index 00000000..5237288d
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---Flv.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page Flv.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/Flv.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						FormBuilder
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---FlvFormBuilder.inc.html b/docs/Islandora/plugins/_plugins---FlvFormBuilder.inc.html
new file mode 100644
index 00000000..7c941f2c
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---FlvFormBuilder.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page FlvFormBuilder.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/FlvFormBuilder.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						FlvFormBuilder
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---FormBuilder.inc.html b/docs/Islandora/plugins/_plugins---FormBuilder.inc.html
new file mode 100644
index 00000000..7707af0f
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---FormBuilder.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page FormBuilder.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/FormBuilder.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---ImageManipulation.inc.html b/docs/Islandora/plugins/_plugins---ImageManipulation.inc.html
new file mode 100644
index 00000000..61ee322f
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---ImageManipulation.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page ImageManipulation.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/ImageManipulation.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						ImageManipulation
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---ModsFormBuilder.inc.html b/docs/Islandora/plugins/_plugins---ModsFormBuilder.inc.html
new file mode 100644
index 00000000..5971ca0b
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---ModsFormBuilder.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page ModsFormBuilder.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/ModsFormBuilder.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						ModsFormBuilder
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---PersonalCollectionClass.inc.html b/docs/Islandora/plugins/_plugins---PersonalCollectionClass.inc.html
new file mode 100644
index 00000000..3770218f
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---PersonalCollectionClass.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page PersonalCollectionClass.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/PersonalCollectionClass.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						PersonalCollectionClass
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---QtFormBuilder.php.html b/docs/Islandora/plugins/_plugins---QtFormBuilder.php.html
new file mode 100644
index 00000000..f6d688ea
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---QtFormBuilder.php.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page QtFormBuilder.php
+			
+						
+												
+					
+		
+			
			
+
File/plugins/QtFormBuilder.php

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						QtFormBuilder
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---Refworks.inc.html b/docs/Islandora/plugins/_plugins---Refworks.inc.html
new file mode 100644
index 00000000..52243252
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---Refworks.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page Refworks.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/Refworks.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						Refworks
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---ShowDemoStreamsInFieldSets.inc.html b/docs/Islandora/plugins/_plugins---ShowDemoStreamsInFieldSets.inc.html
new file mode 100644
index 00000000..1df8ec47
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---ShowDemoStreamsInFieldSets.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page ShowDemoStreamsInFieldSets.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/ShowDemoStreamsInFieldSets.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						ShowDemoStreamsInFieldSets
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---ShowStreamsInFieldSets.inc.html b/docs/Islandora/plugins/_plugins---ShowStreamsInFieldSets.inc.html
new file mode 100644
index 00000000..0d81ae68
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---ShowStreamsInFieldSets.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page ShowStreamsInFieldSets.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/ShowStreamsInFieldSets.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						ShowStreamsInFieldSets
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---fedoraObject.inc.html b/docs/Islandora/plugins/_plugins---fedoraObject.inc.html
new file mode 100644
index 00000000..2f884cc5
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---fedoraObject.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page fedoraObject.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/fedoraObject.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						FedoraObject
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---herbarium.inc.html b/docs/Islandora/plugins/_plugins---herbarium.inc.html
new file mode 100644
index 00000000..ff3f011d
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---herbarium.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page herbarium.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/herbarium.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						Herbarium
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---map_viewer.inc.html b/docs/Islandora/plugins/_plugins---map_viewer.inc.html
new file mode 100644
index 00000000..062716ef
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---map_viewer.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page map_viewer.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/map_viewer.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						ShowMapStreamsInFieldSets
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---qt_viewer.inc.html b/docs/Islandora/plugins/_plugins---qt_viewer.inc.html
new file mode 100644
index 00000000..9b7bf1de
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---qt_viewer.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page qt_viewer.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/qt_viewer.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						ShowQtStreamsInFieldSets
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---slide_viewer.inc.html b/docs/Islandora/plugins/_plugins---slide_viewer.inc.html
new file mode 100644
index 00000000..22276198
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---slide_viewer.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page slide_viewer.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/slide_viewer.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						ShowSlideStreamsInFieldSets
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/plugins/_plugins---tagging_form.inc.html b/docs/Islandora/plugins/_plugins---tagging_form.inc.html
new file mode 100644
index 00000000..d710808e
--- /dev/null
+++ b/docs/Islandora/plugins/_plugins---tagging_form.inc.html
@@ -0,0 +1,228 @@
+
+
+  
+		
+			
+			Docs for page tagging_form.inc
+			
+						
+												
+					
+		
+			
			
+
File/plugins/tagging_form.inc

+
+
+

+	
Description

+	

+					Description |
+															Functions
+			

+	
	
+		
+		
+			

+

+		
+
+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+															Functions
+		

+		
	
+			
+

+	
+	

+		
+		fedora_repository_image_tagging_form (line 31)
+	
 
+
+	
+	

+		void
+		
+			fedora_repository_image_tagging_form
+		
+					( $form_state,  $pid)
+			

+
+			
    
+					
  • 
+				
+				$form_state			
    • 
+					
  • 
+				
+				$pid			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		fedora_repository_image_tagging_form_submit (line 107)
+	
 
+
+	
+	

+		void
+		
+			fedora_repository_image_tagging_form_submit
+		
+					( $form,  &$form_state)
+			

+
+			
    
+					
  • 
+				
+				$form			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		hook_imagebutton_process (line 97)
+	
 
+
+	
+	

+		void
+		
+			hook_imagebutton_process
+		
+					( $form)
+			

+
+			
    
+					
  • 
+				
+				$form			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		_show_subject_tags (line 15)
+	
 
+
+	
+	

+		void
+		
+			_show_subject_tags
+		
+					( $pid)
+			

+
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+	
+

+		

+	

+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/CollectionClass.html b/docs/Islandora/rootdirectory/CollectionClass.html
new file mode 100644
index 00000000..eaafd732
--- /dev/null
+++ b/docs/Islandora/rootdirectory/CollectionClass.html
@@ -0,0 +1,1015 @@
+
+
+  
+		
+			
+			Docs For Class CollectionClass
+			
+						
+												
+					
+		
+			
			
+
 Class CollectionClass

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+		

+			Located in /CollectionClass.inc (line 18)
+		

+		
+				
+		

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																				

+					 
+					static mixed
+					$COLLECTION_CLASS_COLLECTION_POLICY_STREAM
+				

+																

+					 
+					static mixed
+					$COLLECTION_CLASS_COLLECTION_VIEW_STREAM
+				

+																				

+					 
+					mixed
+					$collectionObject
+				

+																											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																																																																																																																																															
+				

+					 
+											CollectionClass
+										__construct
+											([string $pid = NULL])
+									

+															
+				

+					 
+											void
+										build_ingest_form
+											( &$form,  &$form_state,  $contentModelPid,  $contentModelDsid)
+									

+															
+				

+					 
+											void
+										callMethods
+											( $file,  $methods)
+									

+															
+				

+					 
+											void
+										createUserCollection
+											( &$user)
+									

+															
+				

+					 
+											void
+										getAllowedMimeTypes
+											( $contentModelPid,  $contentModel_dsid)
+									

+															
+				

+					 
+											void
+										getAndDoRules
+											( $file,  $mimetype,  $pid,  $dsid)
+									

+															
+				

+					 
+											void
+										getCollectionPolicyStream
+											( $collection_pid)
+									

+															
+				

+					 
+											void
+										getCollectionViewStream
+											( $collection_pid)
+									

+															
+				

+					 
+											void
+										getContentModels
+											( $collection_pid, [ $showError = TRUE])
+									

+															
+				

+					 
+											array
+										getFormHandler
+											(string $pid, string $dsid)
+									

+															
+				

+					 
+											void
+										getIngestInterface
+										()
+									

+															
+				

+					 
+											void
+										getNextPid
+											( $pid,  $dsid)
+									

+															
+				

+					 
+											void
+										getPidNameSpace
+											( $pid,  $dsid)
+									

+															
+				

+					 
+											void
+										getRelatedItems
+											( $pid, [ $itqlquery = NULL], [ $limit = NULL], [ $offset = NULL])
+									

+															
+				

+					 
+											void
+										getRelatedObjects
+											( $pid,  $limit,  $offset, [ $itqlquery = NULL])
+									

+															
+				

+					 
+											void
+										getRelationshipElement
+											( $collection_pid)
+									

+															
+				

+					 
+											void
+										getStream
+											( $pid,  $dsid, [ $showError = 1])
+									

+															
+				

+					 
+											void
+										getXslContent
+											( $pid,  $path, [ $canUseDefault = TRUE])
+									

+															
+				

+					 
+											void
+										renderCollection
+											( $content,  $pid,  $dsId,  $collection, [ $pageNumber = NULL])
+									

+															
+				

+					 
+											void
+										showFieldSets
+											( $page_number)
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+

+
+	

+		
+		
+			static mixed
+			$COLLECTION_CLASS_COLLECTION_POLICY_STREAM
+			 =  'COLLECTION_POLICY'			(line 20)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$COLLECTION_CLASS_COLLECTION_VIEW_STREAM
+			 =  'COLLECTION_VIEW'			(line 21)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+
+

+
+	

+		
+		
+			mixed
+			$collectionObject
+			 =  NULL			(line 25)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 33)
+	
 
+	
+	
+
Creates a collection object. Optionally can associate it with a single collection with parameter $pid.

+	
+	

+		CollectionClass
+		
+			__construct
+		
+					([string $pid = NULL])
+			

+	
+			
    
+					
  • 
+				string
+				$pid: The pid of the collection to represent.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		build_ingest_form (line 302)
+	
 
+	
+	
+
grabs a xml form definition from a content model and builds

+
the form using drupals forms api

+	
+	

+		void
+		
+			build_ingest_form
+		
+					( &$form,  &$form_state,  $contentModelPid,  $contentModelDsid)
+			

+	
+			
    
+					
  • 
+				
+				&$form			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+					
  • 
+				
+				$contentModelPid			
    • 
+					
  • 
+				
+				$contentModelDsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		callMethods (line 270)
+	
 
+	
+	
+
calls the methods defined in the content model rules .xml file stored in a Fedora object

+	
+	

+		void
+		
+			callMethods
+		
+					( $file,  $methods)
+			

+	
+			
    
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$methods			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createUserCollection (line 366)
+	
 
+	
+	
+	
+	

+		void
+		
+			createUserCollection
+		
+					( &$user)
+			

+	
+			
    
+					
  • 
+				
+				&$user			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getAllowedMimeTypes (line 225)
+	
 
+	
+	
+	
+	

+		void
+		
+			getAllowedMimeTypes
+		
+					( $contentModelPid,  $contentModel_dsid)
+			

+	
+			
    
+					
  • 
+				
+				$contentModelPid			
    • 
+					
  • 
+				
+				$contentModel_dsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getAndDoRules (line 243)
+	
 
+	
+	
+
Grabs the rules from the content model stream

+
file the file that has been uploaded

+	
+	

+		void
+		
+			getAndDoRules
+		
+					( $file,  $mimetype,  $pid,  $dsid)
+			

+	
+			
    
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$mimetype			
    • 
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getCollectionPolicyStream (line 103)
+	
 
+	
+	
+	
+	

+		void
+		
+			getCollectionPolicyStream
+		
+					( $collection_pid)
+			

+	
+			
    
+					
  • 
+				
+				$collection_pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getCollectionViewStream (line 123)
+	
 
+	
+	
+	
+	

+		void
+		
+			getCollectionViewStream
+		
+					( $collection_pid)
+			

+	
+			
    
+					
  • 
+				
+				$collection_pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getContentModels (line 156)
+	
 
+	
+	
+
gets a list of content models from a collection policy

+	
+	

+		void
+		
+			getContentModels
+		
+					( $collection_pid, [ $showError = TRUE])
+			

+	
+			
    
+					
  • 
+				
+				$collection_pid			
    • 
+					
  • 
+				
+				$showError			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getFormHandler (line 198)
+	
 
+	
+	
+
gets the form handler file, class and method and returns them in an array

+	
    
+				
  • return: The file, class and method name to handle the ingest form.
    • 
+			

+	
+	

+		array
+		
+			getFormHandler
+		
+					(string $pid, string $dsid)
+			

+	
+			
    
+					
  • 
+				string
+				$pid: The content model PID			
    • 
+					
  • 
+				string
+				$dsid: The content model DSID			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getIngestInterface (line 458)
+	
 
+	
+	
+	
+	

+		void
+		
+			getIngestInterface
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getNextPid (line 183)
+	
 
+	
+	
+
using the collection policies pid namespace get a new pid by calling fedora' get next pid and appending it to the namespace  $pid is the $pid of the content model  $dsid is the datastream id of the content model.

+	
+	

+		void
+		
+			getNextPid
+		
+					( $pid,  $dsid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getPidNameSpace (line 134)
+	
 
+	
+	
+	
+	

+		void
+		
+			getPidNameSpace
+		
+					( $pid,  $dsid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getRelatedItems (line 59)
+	
 
+	
+	
+
Gets objects related to this item.  It will query the object for a Query stream and use that as a itql query

+
or if there is no query stream it will use the default.  If you pass a query to this method it will use the passed in query no matter what

+	
+	

+		void
+		
+			getRelatedItems
+		
+					( $pid, [ $itqlquery = NULL], [ $limit = NULL], [ $offset = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$itqlquery			
    • 
+					
  • 
+				
+				$limit			
    • 
+					
  • 
+				
+				$offset			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getRelatedObjects (line 45)
+	
 
+	
+	
+	
+	

+		void
+		
+			getRelatedObjects
+		
+					( $pid,  $limit,  $offset, [ $itqlquery = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$limit			
    • 
+					
  • 
+				
+				$offset			
    • 
+					
  • 
+				
+				$itqlquery			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getRelationshipElement (line 111)
+	
 
+	
+	
+	
+	

+		void
+		
+			getRelationshipElement
+		
+					( $collection_pid)
+			

+	
+			
    
+					
  • 
+				
+				$collection_pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getStream (line 128)
+	
 
+	
+	
+	
+	

+		void
+		
+			getStream
+		
+					( $pid,  $dsid, [ $showError = 1])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$showError			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getXslContent (line 411)
+	
 
+	
+	
+
Queries a collection object for an xslt to format how the  collection of objects is displayed.

+	
+	

+		void
+		
+			getXslContent
+		
+					( $pid,  $path, [ $canUseDefault = TRUE])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$path			
    • 
+					
  • 
+				
+				$canUseDefault			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		renderCollection (line 481)
+	
 
+	
+	
+	
+	

+		void
+		
+			renderCollection
+		
+					( $content,  $pid,  $dsId,  $collection, [ $pageNumber = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$content			
    • 
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dsId			
    • 
+					
  • 
+				
+				$collection			
    • 
+					
  • 
+				
+				$pageNumber			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		showFieldSets (line 421)
+	
 
+	
+	
+	
+	

+		void
+		
+			showFieldSets
+		
+					( $page_number)
+			

+	
+			
    
+					
  • 
+				
+				$page_number			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/CollectionPolicy.html b/docs/Islandora/rootdirectory/CollectionPolicy.html
new file mode 100644
index 00000000..7ca843e6
--- /dev/null
+++ b/docs/Islandora/rootdirectory/CollectionPolicy.html
@@ -0,0 +1,1063 @@
+
+
+  
+		
+			
+			Docs For Class CollectionPolicy
+			
+						
+												
+					
+		
+			
			
+
 Class CollectionPolicy

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+		

+			Located in /CollectionPolicy.inc (line 11)
+		

+		
+				
+		
XMLDatastream
+   |
+   --CollectionPolicy

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+												

+					 
+					static mixed
+					$DEFAULT_DSID
+				

+																

+					 
+					static mixed
+					$SCHEMA_URI
+				

+																															

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																			
+				

+					 
+					static 						string
+										getDefaultDSID
+										()
+									

+																																																							
+				

+					 
+					static 						CollectionPolicy
+										ingestBlankPolicy
+											(string $pid, string $name,  $policyDsid, string $model_pid, string $model_namespace,  $relationship, string $searchField, string $searchValue, string $cpDsid, string $relationshiop)
+									

+															
+				

+					 
+					static 						CollectionPolicy
+										ingestFromCollection
+											(string $pid, string $name, string $cpDsid, string $copy_collection_pid)
+									

+															
+				

+					 
+					static 						CollectionPolicy
+										ingestFromFile
+											(string $pid, string $name, string $cpDsid, string $file)
+									

+															
+				

+					 
+					static 						CollectionPolicy
+										loadFromCollection
+											(string $pid, [boolean $preFetch = TRUE])
+									

+																																																											
+				

+					 
+											XMLDatastream
+										__construct
+											(string $xmlStr, [string $pid = NULL], [string $dsid = NULL])
+									

+															
+				

+					 
+											void
+										addModel
+											( $cm,  $namespace)
+									

+															
+				

+					 
+											boolean
+										addTerm
+											(string $field, string $value)
+									

+															
+				

+					 
+											void
+										convertFromOldSchema
+										()
+									

+															
+				

+					 
+											ContentModel[]
+										getContentModels
+										()
+									

+																							
+				

+					 
+											void
+										getName
+										()
+									

+															
+				

+					 
+											string
+										getNextPid
+											(string $dsid)
+									

+															
+				

+					 
+											string
+										getRelationship
+										()
+									

+															
+				

+					 
+											string[]
+										getSearchTerms
+											([boolean $asArray = FALSE], [boolean $recurse = FALSE], [boolean $cache = FALSE])
+									

+															
+				

+					 
+											string
+										getStagingArea
+											([BOOLEAN $recurse = TRUE])
+									

+																																															
+				

+					 
+											boolean
+										removeModel
+											(ContentModel $cm)
+									

+															
+				

+					 
+											boolean
+										removeTerm
+											(string $field)
+									

+															
+				

+					 
+											void
+										setDefaultTerm
+											( $field)
+									

+															
+				

+					 
+											boolean
+										setRelationship
+											(string $relationship)
+									

+															
+				

+					 
+											string
+										setStagingArea
+											(string $path)
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+

+
+	

+		
+		
+			static mixed
+			$DEFAULT_DSID
+			 =  'COLLECTION_POLICY'			(line 14)
+		
+	

+
+	
+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$SCHEMA_URI
+			 =  'http://syn.lib.umanitoba.ca/collection_policy.xsd'			(line 13)
+		
+	

+
+	
+	
+	
+		
+		
+
+

+
+							
Inherited Variables

+				
+									
Inherited from XMLDatastream

+					

+													
+							
+								XMLDatastream::$dsid

+							
+													
+							
+								XMLDatastream::$errors

+							
+													
+							
+								XMLDatastream::$forceSchema

+							
+													
+							
+								XMLDatastream::$pid

+							
+													
+							
+								XMLDatastream::$xml

+							
+													
+							
+								XMLDatastream::$XMLNS

+							
+											
 
+										
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		static getDefaultDSID (line 23)
+	
 
+	
+	
+
Gets the default DSID to use for ContentModel datastreams.

+	
+	

+		static string
+		
+			getDefaultDSID
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		static ingestBlankPolicy (line 138)
+	
 
+	
+	
+
Ingests a new minimum  Collection Policy datastream to the specified  PID with the DSID specified.  Initializes the policy with the specified values.

+
Returns false on failure

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static CollectionPolicy
+		
+			ingestBlankPolicy
+		
+					(string $pid, string $name,  $policyDsid, string $model_pid, string $model_namespace,  $relationship, string $searchField, string $searchValue, string $cpDsid, string $relationshiop)
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$name			
    • 
+					
  • 
+				string
+				$cpDsid			
    • 
+					
  • 
+				string
+				$model_pid			
    • 
+					
  • 
+				string
+				$model_namespace			
    • 
+					
  • 
+				string
+				$relationshiop			
    • 
+					
  • 
+				string
+				$searchField			
    • 
+					
  • 
+				string
+				$searchValue			
    • 
+					
  • 
+				
+				$policyDsid			
    • 
+					
  • 
+				
+				$relationship			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static ingestFromCollection (line 104)
+	
 
+	
+	
+
Ingests a new Collection Policy datastream to the specified  PID with the DSID specified.  Clones the collection policy from the  source collection pid. Returns false on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static CollectionPolicy
+		
+			ingestFromCollection
+		
+					(string $pid, string $name, string $cpDsid, string $copy_collection_pid)
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$name			
    • 
+					
  • 
+				string
+				$cpDsid			
    • 
+					
  • 
+				string
+				$copy_collection_pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static ingestFromFile (line 76)
+	
 
+	
+	
+
Ingests a new Collection Policy datastream to the specified  PID with the DSID specified.  The file should be a valid collection  policy XML.  Returns false on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static CollectionPolicy
+		
+			ingestFromFile
+		
+					(string $pid, string $name, string $cpDsid, string $file)
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$name			
    • 
+					
  • 
+				string
+				$cpDsid			
    • 
+					
  • 
+				string
+				$file			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static loadFromCollection (line 37)
+	
 
+	
+	
+
Constructs a new CollectionPolicy object from the specified  collection PID.  If preFetch is disabled, then Islandora will not get the datastream until needed.

+
(useful when cacheing)  Returns FALSE on failure.

+	
+	

+		static CollectionPolicy
+		
+			loadFromCollection
+		
+					(string $pid, [boolean $preFetch = TRUE])
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				boolean
+				$preFetch: = TRUE			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Constructor __construct (line 198)
+	
 
+	
+	
+
Constructor  NOTE: Use the static constructor methods whenever possible.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		XMLDatastream
+		
+			__construct
+		
+					(string $xmlStr, [string $pid = NULL], [string $dsid = NULL])
+			

+	
+			
    
+					
  • 
+				string
+				$xmlStr			
    • 
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$dsid			
    • 
+				

+		
+			

+		
Redefinition of:

+		

+			
XMLDatastream::__construct()

+						
Constructor  NOTE: Use the static constructor methods whenever possible.

+					

+			
+	

+
+

+	
+	

+		
+		addModel (line 588)
+	
 
+	
+	
+	
+	

+		void
+		
+			addModel
+		
+					( $cm,  $namespace)
+			

+	
+			
    
+					
  • 
+				
+				$cm			
    • 
+					
  • 
+				
+				$namespace			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		addTerm (line 482)
+	
 
+	
+	
+
Adds a search term to the collection policy.

+
Returns fase on failure.

+	
+	

+		boolean
+		
+			addTerm
+		
+					(string $field, string $value)
+			

+	
+			
    
+					
  • 
+				string
+				$field			
    • 
+					
  • 
+				string
+				$value			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		convertFromOldSchema (line 210)
+	
 
+	
+	
+
Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..

+	
    
+				
  • access: protected
    • 
+			

+	
+	

+		void
+		
+			convertFromOldSchema
+		
+				()
+			

+	
+		
+			

+		
Redefinition of:

+		

+			
XMLDatastream::convertFromOldSchema()

+						
Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..

+					

+			
+	

+
+

+	
+	

+		
+		getContentModels (line 392)
+	
 
+	
+	
+
Gets a list of ContentModel objects supported by this collection.

+	
+	

+		ContentModel[]
+		
+			getContentModels
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getName (line 613)
+	
 
+	
+	
+	
+	

+		void
+		
+			getName
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getNextPid (line 368)
+	
 
+	
+	
+
Gets the next available PID for the  content model specified by the DSID  parameter.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		string
+		
+			getNextPid
+		
+					(string $dsid)
+			

+	
+			
    
+					
  • 
+				string
+				$dsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getRelationship (line 262)
+	
 
+	
+	
+
Gets the name of the relationship to use  for members of this collection.

+
Returns FALSE on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		string
+		
+			getRelationship
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getSearchTerms (line 426)
+	
 
+	
+	
+
Gets a list of search terms from the Collection Policy.  If asArray is set  it will return an associative array with the value, field name, and the default value.

+
If not set, an array of just the values will be returned.  If $recurse is TRUE, it will  recurseively return the parents search terms if it has none until it returns a set of terms or reaches  the top level collection.  If $cache is TRUE, it will return a cached version (if available).

+	
+	

+		string[]
+		
+			getSearchTerms
+		
+					([boolean $asArray = FALSE], [boolean $recurse = FALSE], [boolean $cache = FALSE])
+			

+	
+			
    
+					
  • 
+				boolean
+				$asArray			
    • 
+					
  • 
+				boolean
+				$recurse			
    • 
+					
  • 
+				boolean
+				$cache			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getStagingArea (line 296)
+	
 
+	
+	
+
Gets the path to the staging area to use for this  collection. By default recurses to the parent collection  if the staging area is undefined

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		string
+		
+			getStagingArea
+		
+					([BOOLEAN $recurse = TRUE])
+			

+	
+			
    
+					
  • 
+				BOOLEAN
+				$recurse			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		removeModel (line 565)
+	
 
+	
+	
+
Removes the specified content model from the collection policy.  This will only  prevent future ingests of the removed model to the collection.  $cm should be  a valid ContentModel object.  Returns false on failure or when the CM was not found in  the collection policy.

+	
+	

+		boolean
+		
+			removeModel
+		
+					(ContentModel $cm)
+			

+	
+			
+		
+			
+	

+
+

+	
+	

+		
+		removeTerm (line 510)
+	
 
+	
+	
+
Removes the search term specified by the field parameter from the collection policy.

+	
+	

+		boolean
+		
+			removeTerm
+		
+					(string $field)
+			

+	
+			
    
+					
  • 
+				string
+				$field			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		setDefaultTerm (line 531)
+	
 
+	
+	
+	
+	

+		void
+		
+			setDefaultTerm
+		
+					( $field)
+			

+	
+			
    
+					
  • 
+				
+				$field			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		setRelationship (line 278)
+	
 
+	
+	
+
Sets the name of the relationship to use  for members of this collection.

+
Returns FALSE on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			setRelationship
+		
+					(string $relationship)
+			

+	
+			
    
+					
  • 
+				string
+				$relationship			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		setStagingArea (line 335)
+	
 
+	
+	
+
Sets the path to the staging area to use for this  collection. If specified path is blank (or false) it will  remove the staging are path element from the collection policy.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		string
+		
+			setStagingArea
+		
+					(string $path)
+			

+	
+			
    
+					
  • 
+				string
+				$path			
    • 
+				

+		
+			
+	

+							
Inherited Methods

+					
+									
+					
Inherited From XMLDatastream

+					

+													 
+							XMLDatastream::__construct()

+													 
+							XMLDatastream::convertFromOldSchema()

+													 
+							XMLDatastream::dumpXml()

+													 
+							XMLDatastream::getDSIDFromIdentifier()

+													 
+							XMLDatastream::getHistory()

+													 
+							XMLDatastream::getIdentifier()

+													 
+							XMLDatastream::getPidFromIdentifier()

+													 
+							XMLDatastream::loadFromFile()

+													 
+							XMLDatastream::purgeVersions()

+													 
+							XMLDatastream::saveToFedora()

+													 
+							XMLDatastream::validate()

+													 
+							XMLDatastream::validDsid()

+													 
+							XMLDatastream::validPid()

+											

+										
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/ConnectionHelper.html b/docs/Islandora/rootdirectory/ConnectionHelper.html
new file mode 100644
index 00000000..117b7f19
--- /dev/null
+++ b/docs/Islandora/rootdirectory/ConnectionHelper.html
@@ -0,0 +1,252 @@
+
+
+  
+		
+			
+			Docs For Class ConnectionHelper
+			
+						
+												
+					
+		
+			
			
+
 Class ConnectionHelper

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /ConnectionHelper.inc (line 17)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																							
+				

+					 
+											ConnectionHelper
+										ConnectionHelper
+										()
+									

+															
+				

+					 
+											void
+										getSoapClient
+											([ $url = NULL], [ $exceptions = TRUE])
+									

+															
+				

+					 
+											void
+										_fixURL
+											( $url,  $_name,  $_pass)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor ConnectionHelper (line 18)
+	
 
+	
+	
+	
+	

+		ConnectionHelper
+		
+			ConnectionHelper
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getSoapClient (line 43)
+	
 
+	
+	
+	
+	

+		void
+		
+			getSoapClient
+		
+					([ $url = NULL], [ $exceptions = TRUE])
+			

+	
+			
    
+					
  • 
+				
+				$url			
    • 
+					
  • 
+				
+				$exceptions			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		_fixURL (line 22)
+	
 
+	
+	
+	
+	

+		void
+		
+			_fixURL
+		
+					( $url,  $_name,  $_pass)
+			

+	
+			
    
+					
  • 
+				
+				$url			
    • 
+					
  • 
+				
+				$_name			
    • 
+					
  • 
+				
+				$_pass			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/ContentModel.html b/docs/Islandora/rootdirectory/ContentModel.html
new file mode 100644
index 00000000..85e39d69
--- /dev/null
+++ b/docs/Islandora/rootdirectory/ContentModel.html
@@ -0,0 +1,3227 @@
+
+
+  
+		
+			
+			Docs For Class ContentModel
+			
+						
+												
+					
+		
+			
			
+
 Class ContentModel

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+		

+			Located in /ContentModel.inc (line 11)
+		

+		
+				
+		
XMLDatastream
+   |
+   --ContentModel

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+												

+					 
+					static mixed
+					$DEFAULT_DSID
+				

+																																

+					 
+					static mixed
+					$SCHEMA_URI
+				

+																												

+					 
+					mixed
+					$name
+				

+																

+					 
+					mixed
+					$pid_namespace
+				

+																			

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																																																																																																																																																																																																																			
+				

+					 
+					static 						string
+										getDefaultDSID
+										()
+									

+																																																																																																																																																																							
+				

+					 
+					static 						ContentModel
+										ingestBlankModel
+											(string $pid, string $name, string $modelDsid, string $defaultMimetype,  $ingestFormDsid, integer $ingestFormPage,  $ingestFormHideChooser, string $ingestFormModule, string $ingestFormFile, string $ingestFormClass, string $ingestFormMethod, string $ingestFormHandler, string $ingestFromDsid, boolean $ingestFormHideFileChooser)
+									

+															
+				

+					 
+					static 						ContentModel
+										ingestFromFile
+											(string $pid, string $name, string $modelDsid, string $file)
+									

+															
+				

+					 
+					static 						ContentModel
+										ingestFromModel
+											(string $pid, string $name, string $modelDsid, string $copy_model_pid)
+									

+																							
+				

+					 
+					static 						ContentModel
+										loadFromModel
+											(string $pid, [string $dsid = NULL], [string $pid_namespace = NULL], [string $name = NULL])
+									

+															
+				

+					 
+					static 						ContentModel
+										loadFromObject
+											(string $pid)
+									

+																																																																																																																																											
+				

+					 
+											XMLDatastream
+										__construct
+											(string $xmlStr, [string $pid = NULL], [string $dsid = NULL], [string $pid_namespace = NULL], [string $name = NULL])
+									

+															
+				

+					 
+											void
+										addAppliesTo
+											( $rule_id,  $type)
+									

+															
+				

+					 
+											void
+										addAuthListItem
+											( $elementName,  $value, [ $label = ''])
+									

+															
+				

+					 
+											void
+										addDispMeth
+											( $dsid,  $module,  $file,  $class,  $method, [ $default = FALSE])
+									

+															
+				

+					 
+											void
+										addDs
+											( $dsid, [ $display_in_fieldset = FALSE])
+									

+															
+				

+					 
+											
+										addElementToForm
+											( $element,  $parent_element,  $element_definition)
+									

+															
+				

+					 
+											boolean
+										addForm
+											(string $element)
+									

+															
+				

+					 
+											boolean
+										addIngestFormElement
+											(String $name, String $label, String $type, boolean $required, [String $description = ''])
+									

+															
+				

+					 
+											void
+										addIngestMethod
+											( $rule_id,  $module,  $file,  $class,  $method,  $dsid,  $modified_files_ext)
+									

+															
+				

+					 
+											void
+										addIngestMethodParam
+											( $rule_id,  $module,  $file,  $class,  $method,  $name,  $value)
+									

+															
+				

+					 
+											void
+										addIngestRule
+											( $applies_to,  $module,  $file,  $class,  $method,  $dsid,  $modified_files_ext)
+									

+															
+				

+					 
+											boolean
+										addMimetype
+											(String $type)
+									

+															
+				

+					 
+											$form
+										buildEditMetadataForm
+											( $pid, string $dsid)
+									

+															
+				

+					 
+											string
+										buildIngestForm
+											(&$form &$form, &$form_state &$form_state)
+									

+															
+				

+					 
+											void
+										convertFromOldSchema
+										()
+									

+															
+				

+					 
+											boolean
+										decAuthListItem
+											(String $elementName, String $value)
+									

+															
+				

+					 
+											
+										decFormElement
+											( $form_element)
+									

+															
+				

+					 
+											boolean
+										decIngestFormElement
+											(String $name)
+									

+															
+				

+					 
+											string
+										displayExtraFieldset
+											(string $pid,  $page_number)
+									

+															
+				

+					 
+											void
+										displayInFieldset
+											( $dsid)
+									

+															
+				

+					 
+											void
+										editForm
+											(String $name,  $element)
+									

+															
+				

+					 
+											void
+										editFormElement
+											( $new_element,  $edit_element,  $element_definition,  $parent_element)
+									

+															
+				

+					 
+											void
+										editIngestFormAttributes
+											( $dsid,  $page, [ $hide_file_chooser = FALSE], [ $redirect = TRUE])
+									

+															
+				

+					 
+											void
+										editIngestFormBuilderMethod
+											( $module,  $file,  $class,  $method,  $handler)
+									

+															
+				

+					 
+											boolean
+										editIngestFormElement
+											(String $name, String $label, String $type, boolean $required, String $description)
+									

+															
+				

+					 
+											$result
+										execAddDatastreamMethods
+											(string $dsid,  $file, string $filen)
+									

+															
+				

+					 
+											boolean
+										execFormHandler
+											(&$formData &$data, &$form_state &$form_state)
+									

+															
+				

+					 
+											$result
+										execIngestRules
+											(string $file, string $mimetype, [boolean $preview = FALSE])
+									

+															
+				

+					 
+											void
+										getAddDsMethod
+											( $ds)
+									

+																							
+				

+					 
+											void
+										getDisplayMethods
+											( $ds)
+									

+															
+				

+					 
+											array
+										getEditFormNames
+										()
+									

+															
+				

+					 
+											String[]
+										getEditMetadataMethod
+										()
+									

+															
+				

+					 
+											DOMElement
+										getForm
+											(string $name)
+									

+															
+				

+					 
+											array
+										getFormNames
+										()
+									

+															
+				

+					 
+											void
+										getIngestFormAttributes
+										()
+									

+															
+				

+					 
+											void
+										getIngestFormBuilderMethod
+										()
+									

+															
+				

+					 
+											boolean
+										getIngestFormElementParams
+											( $name, String $elementName)
+									

+															
+				

+					 
+											string[]
+										getIngestFormElements
+										()
+									

+															
+				

+					 
+											array
+										getIngestFormNames
+										()
+									

+															
+				

+					 
+											void
+										getIngestRule
+											( $rule_id)
+									

+															
+				

+					 
+											void
+										getIngestRules
+										()
+									

+															
+				

+					 
+											string[]
+										getMimetypes
+										()
+									

+															
+				

+					 
+											String
+										getName
+										()
+									

+															
+				

+					 
+											String[]
+										getServices
+										()
+									

+															
+				

+					 
+											$result
+										handleEditMetadataForm
+											(&$form_id &$form_id, &$form_values &$form_state, &$soap_client &$soap_client)
+									

+															
+				

+					 
+											boolean
+										incAuthListItem
+											(String $elementName, String $value, [ $reorder = 'inc'], String $direction)
+									

+															
+				

+					 
+											
+										incFormElement
+											( $form_element)
+									

+															
+				

+					 
+											boolean
+										incIngestFormElement
+											(String $name, [String $reorder = 'inc'])
+									

+																																							
+				

+					 
+											string[]
+										listDatastreams
+										()
+									

+																															
+				

+					 
+											void
+										removeAppliesTo
+											( $rule_id,  $type)
+									

+															
+				

+					 
+											void
+										removeAuthListItem
+											( $elementName,  $value)
+									

+															
+				

+					 
+											void
+										removeDispMeth
+											( $dsid,  $module,  $file,  $class,  $method)
+									

+															
+				

+					 
+											void
+										removeDs
+											( $dsid)
+									

+															
+				

+					 
+											boolean
+										removeEditMetadataMethod
+										()
+									

+															
+				

+					 
+											boolean
+										removeForm
+											(string $name)
+									

+															
+				

+					 
+											boolean
+										removeIngestFormElement
+											(String $name)
+									

+															
+				

+					 
+											void
+										removeIngestMethod
+											( $rule_id,  $module,  $file,  $class,  $method)
+									

+															
+				

+					 
+											void
+										removeIngestMethodParam
+											( $rule_id,  $module,  $file,  $class,  $method,  $name)
+									

+															
+				

+					 
+											void
+										removeIngestRule
+											( $rule_id)
+									

+															
+				

+					 
+											boolean
+										removeMimetype
+											(String $type)
+									

+															
+				

+					 
+											void
+										setDefaultDispMeth
+											( $dsid,  $module,  $file,  $class,  $method)
+									

+															
+				

+					 
+											void
+										setDisplayInFieldset
+											( $dsid, [ $value = TRUE])
+									

+															
+				

+					 
+											boolean
+										setIngestFormElementParam
+											( $name, String $paramName, String $paramValue, String $elementName)
+									

+															
+				

+					 
+											boolean
+										updateEditMetadataMethod
+											(String $module, String $file, String $class, String $method, String $handler, String $dsid)
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+

+
+	

+		
+		
+			static mixed
+			$DEFAULT_DSID
+			 =  'ISLANDORACM'			(line 13)
+		
+	

+
+	
+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$SCHEMA_URI
+			 =  'http://localhost/islandoracm.xsd'			(line 12)
+		
+	

+
+	
+	
+	
+		
+		
+
+

+
+
+

+
+	

+		
+		
+			mixed
+			$name
+						(line 17)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$pid_namespace
+						(line 16)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+							
Inherited Variables

+				
+									
Inherited from XMLDatastream

+					

+													
+							
+								XMLDatastream::$dsid

+							
+													
+							
+								XMLDatastream::$errors

+							
+													
+							
+								XMLDatastream::$forceSchema

+							
+													
+							
+								XMLDatastream::$pid

+							
+													
+							
+								XMLDatastream::$xml

+							
+													
+							
+								XMLDatastream::$XMLNS

+							
+											
 
+										
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		static getDefaultDSID (line 25)
+	
 
+	
+	
+
Gets the default DSID to use for ContentModel datastreams.

+	
+	

+		static string
+		
+			getDefaultDSID
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		static ingestBlankModel (line 131)
+	
 
+	
+	
+
Ingests a minimum Content Model to the specified pid/dsid.

+
Returns false on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static ContentModel
+		
+			ingestBlankModel
+		
+					(string $pid, string $name, string $modelDsid, string $defaultMimetype,  $ingestFormDsid, integer $ingestFormPage,  $ingestFormHideChooser, string $ingestFormModule, string $ingestFormFile, string $ingestFormClass, string $ingestFormMethod, string $ingestFormHandler, string $ingestFromDsid, boolean $ingestFormHideFileChooser)
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$name			
    • 
+					
  • 
+				string
+				$modelDsid			
    • 
+					
  • 
+				string
+				$defaultMimetype			
    • 
+					
  • 
+				string
+				$ingestFromDsid			
    • 
+					
  • 
+				integer
+				$ingestFormPage			
    • 
+					
  • 
+				boolean
+				$ingestFormHideFileChooser			
    • 
+					
  • 
+				string
+				$ingestFormModule			
    • 
+					
  • 
+				string
+				$ingestFormFile			
    • 
+					
  • 
+				string
+				$ingestFormClass			
    • 
+					
  • 
+				string
+				$ingestFormMethod			
    • 
+					
  • 
+				string
+				$ingestFormHandler			
    • 
+					
  • 
+				
+				$ingestFormDsid			
    • 
+					
  • 
+				
+				$ingestFormHideChooser			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static ingestFromFile (line 63)
+	
 
+	
+	
+
Ingests a Content Model from a file to the specified pid/dsid .

+
Returns false on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static ContentModel
+		
+			ingestFromFile
+		
+					(string $pid, string $name, string $modelDsid, string $file)
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$name			
    • 
+					
  • 
+				string
+				$modelDsid			
    • 
+					
  • 
+				string
+				$file			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static ingestFromModel (line 91)
+	
 
+	
+	
+
Ingests a Content Model from an existing model to the specified pid/dsid .

+
Returns false on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static ContentModel
+		
+			ingestFromModel
+		
+					(string $pid, string $name, string $modelDsid, string $copy_model_pid)
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$name			
    • 
+					
  • 
+				string
+				$modelDsid			
    • 
+					
  • 
+				string
+				$copy_model_pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static loadFromModel (line 198)
+	
 
+	
+	
+
Constructs a ContentModel object from the PID of the model in Fedora.

+
If DSID is specified it will use that datastream as the model, otherwise it will  use the default (usually ISLANDORACM).  PID_NAMESPACE and name can also be initialized  from the collection policy.  Returns false on failure.
NOTE: $name will be overwritten with the content model name found in the datastream  when the model is first validated.\

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static ContentModel
+		
+			loadFromModel
+		
+					(string $pid, [string $dsid = NULL], [string $pid_namespace = NULL], [string $name = NULL])
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$dsid			
    • 
+					
  • 
+				string
+				$pid_namespace			
    • 
+					
  • 
+				string
+				$name			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static loadFromObject (line 36)
+	
 
+	
+	
+
Constructs a ContentModel object from a Fedora item  by getting the first content model from the hasModel relationship.

+
Returns false on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static ContentModel
+		
+			loadFromObject
+		
+					(string $pid)
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Constructor __construct (line 228)
+	
 
+	
+	
+
Constructor  NOTE: Use the static constructor methods whenever possible.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		XMLDatastream
+		
+			__construct
+		
+					(string $xmlStr, [string $pid = NULL], [string $dsid = NULL], [string $pid_namespace = NULL], [string $name = NULL])
+			

+	
+			
    
+					
  • 
+				string
+				$xmlStr			
    • 
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$dsid			
    • 
+					
  • 
+				string
+				$pid_namespace			
    • 
+					
  • 
+				string
+				$name			
    • 
+				

+		
+			

+		
Redefinition of:

+		

+			
XMLDatastream::__construct()

+						
Constructor  NOTE: Use the static constructor methods whenever possible.

+					

+			
+	

+
+

+	
+	

+		
+		addAppliesTo (line 1761)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			addAppliesTo
+		
+					( $rule_id,  $type)
+			

+	
+			
    
+					
  • 
+				
+				$rule_id			
    • 
+					
  • 
+				
+				$type			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		addAuthListItem (line 960)
+	
 
+	
+	
+
Adds an authority list item to a form element.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			addAuthListItem
+		
+					( $elementName,  $value, [ $label = ''])
+			

+	
+			
    
+					
  • 
+				
+				$elementName			
    • 
+					
  • 
+				
+				$value			
    • 
+					
  • 
+				
+				$label			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		addDispMeth (line 1698)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			addDispMeth
+		
+					( $dsid,  $module,  $file,  $class,  $method, [ $default = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$module			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$class			
    • 
+					
  • 
+				
+				$method			
    • 
+					
  • 
+				
+				$default			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		addDs (line 1586)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			addDs
+		
+					( $dsid, [ $display_in_fieldset = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$display_in_fieldset			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		addElementToForm (line 2169)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		
+		
+			addElementToForm
+		
+					( $element,  $parent_element,  $element_definition)
+			

+	
+			
    
+					
  • 
+				
+				$element_definition			
    • 
+					
  • 
+				
+				$parent_element			
    • 
+					
  • 
+				
+				$element			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		addForm (line 2120)
+	
 
+	
+	
+
Adds the named form.

+	
    
+				
  • return: TRUE on success, FALSE otherwise.
    • 
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			addForm
+		
+					(string $element)
+			

+	
+			
    
+					
  • 
+				string
+				$element: Name of the form to add.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		addIngestFormElement (line 819)
+	
 
+	
+	
+
Add an ingest form element to the model.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			addIngestFormElement
+		
+					(String $name, String $label, String $type, boolean $required, [String $description = ''])
+			

+	
+			
    
+					
  • 
+				String
+				$name			
    • 
+					
  • 
+				String
+				$label			
    • 
+					
  • 
+				String
+				$type			
    • 
+					
  • 
+				boolean
+				$required			
    • 
+					
  • 
+				String
+				$description			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		addIngestMethod (line 1779)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			addIngestMethod
+		
+					( $rule_id,  $module,  $file,  $class,  $method,  $dsid,  $modified_files_ext)
+			

+	
+			
    
+					
  • 
+				
+				$rule_id			
    • 
+					
  • 
+				
+				$module			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$class			
    • 
+					
  • 
+				
+				$method			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$modified_files_ext			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		addIngestMethodParam (line 1817)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			addIngestMethodParam
+		
+					( $rule_id,  $module,  $file,  $class,  $method,  $name,  $value)
+			

+	
+			
    
+					
  • 
+				
+				$rule_id			
    • 
+					
  • 
+				
+				$module			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$class			
    • 
+					
  • 
+				
+				$method			
    • 
+					
  • 
+				
+				$name			
    • 
+					
  • 
+				
+				$value			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		addIngestRule (line 1906)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			addIngestRule
+		
+					( $applies_to,  $module,  $file,  $class,  $method,  $dsid,  $modified_files_ext)
+			

+	
+			
    
+					
  • 
+				
+				$applies_to			
    • 
+					
  • 
+				
+				$module			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$class			
    • 
+					
  • 
+				
+				$method			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$modified_files_ext			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		addMimetype (line 1522)
+	
 
+	
+	
+
Adds an allowed mimetype to the model.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			addMimetype
+		
+					(String $type)
+			

+	
+			
    
+					
  • 
+				String
+				$type			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		buildEditMetadataForm (line 1092)
+	
 
+	
+	
+
Builds an edit metadata form using the method specified in the <edit_metadata_method> element

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		$form
+		
+			buildEditMetadataForm
+		
+					( $pid, string $dsid)
+			

+	
+			
    
+					
  • 
+				string
+				$dsid			
    • 
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		buildIngestForm (line 1011)
+	
 
+	
+	
+
Builds an ingest form using the method specified in  <form_builder_method> element of <ingest_form>  Returns FALSE on failure.

+	
    
+				
  • return: identifier
    • 
+				
  • access: public
    • 
+			

+	
+	

+		string
+		
+			buildIngestForm
+		
+					(&$form &$form, &$form_state &$form_state)
+			

+	
+			
    
+					
  • 
+				&$form
+				&$form			
    • 
+					
  • 
+				&$form_state
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		convertFromOldSchema (line 243)
+	
 
+	
+	
+
Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..

+	
    
+				
  • access: protected
    • 
+			

+	
+	

+		void
+		
+			convertFromOldSchema
+		
+				()
+			

+	
+		
+			

+		
Redefinition of:

+		

+			
XMLDatastream::convertFromOldSchema()

+						
Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..

+					

+			
+	

+
+

+	
+	

+		
+		decAuthListItem (line 851)
+	
 
+	
+	
+
Decrements an authority list item from a form element in the list of elements.

+
Updates the "order".  This method is simply an overload to the incAuthListItem  which has a direction parameter.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			decAuthListItem
+		
+					(String $elementName, String $value)
+			

+	
+			
    
+					
  • 
+				String
+				$elementName			
    • 
+					
  • 
+				String
+				$value			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		decFormElement (line 2233)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		
+		
+			decFormElement
+		
+					( $form_element)
+			

+	
+			
    
+					
  • 
+				
+				$form_element			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		decIngestFormElement (line 571)
+	
 
+	
+	
+
Decrements an ingest form element in the list of elements.

+
Updates the "order".  This method is simply an overload to the incIngestFormElement  which has a direction parameter.
TODO: Might be useful to move multiple places at once, or define  a method to move to an absolute position.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			decIngestFormElement
+		
+					(String $name)
+			

+	
+			
    
+					
  • 
+				String
+				$name			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		displayExtraFieldset (line 1447)
+	
 
+	
+	
+
Calls all defined display methods for the ContentModel.

+
The PID specified is passed to the constructor of the display  class(es) specified in the Content Model.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		string
+		
+			displayExtraFieldset
+		
+					(string $pid,  $page_number)
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				
+				$page_number			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		displayInFieldset (line 1621)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			displayInFieldset
+		
+					( $dsid)
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		editForm (line 2144)
+	
 
+	
+	
+
Edits a form element with attribute name='$name' from the 'forms' element.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			editForm
+		
+					(String $name,  $element)
+			

+	
+			
    
+					
  • 
+				String
+				$name			
    • 
+					
  • 
+				
+				$element			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		editFormElement (line 2180)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			editFormElement
+		
+					( $new_element,  $edit_element,  $element_definition,  $parent_element)
+			

+	
+			
    
+					
  • 
+				
+				$element_definition			
    • 
+					
  • 
+				
+				$parent_element			
    • 
+					
  • 
+				
+				$new_element			
    • 
+					
  • 
+				
+				$edit_element			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		editIngestFormAttributes (line 1974)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			editIngestFormAttributes
+		
+					( $dsid,  $page, [ $hide_file_chooser = FALSE], [ $redirect = TRUE])
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$page			
    • 
+					
  • 
+				
+				$hide_file_chooser			
    • 
+					
  • 
+				
+				$redirect			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		editIngestFormBuilderMethod (line 2010)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			editIngestFormBuilderMethod
+		
+					( $module,  $file,  $class,  $method,  $handler)
+			

+	
+			
    
+					
  • 
+				
+				$module			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$class			
    • 
+					
  • 
+				
+				$method			
    • 
+					
  • 
+				
+				$handler			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		editIngestFormElement (line 760)
+	
 
+	
+	
+
Edits the ingest form element specified.

+
NOTE: The element name can not be changed.  To update an elements name  it must be deleted and added with the new name.

+	
    
+				
  • return: success
    • 
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			editIngestFormElement
+		
+					(String $name, String $label, String $type, boolean $required, String $description)
+			

+	
+			
    
+					
  • 
+				String
+				$name			
    • 
+					
  • 
+				String
+				$label			
    • 
+					
  • 
+				String
+				$type			
    • 
+					
  • 
+				boolean
+				$required			
    • 
+					
  • 
+				String
+				$description: description			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		execAddDatastreamMethods (line 1258)
+	
 
+	
+	
+
Executes the add datastream method for the specified datastream on the specified file.

+
Returns FALSE on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		$result
+		
+			execAddDatastreamMethods
+		
+					(string $dsid,  $file, string $filen)
+			

+	
+			
    
+					
  • 
+				string
+				$dsid			
    • 
+					
  • 
+				string
+				$filen			
    • 
+					
  • 
+				
+				$file			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		execFormHandler (line 1385)
+	
 
+	
+	
+
Executes the form handler from the <form_builder_method> element of <ingest_form>.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			execFormHandler
+		
+					(&$formData &$data, &$form_state &$form_state)
+			

+	
+			
    
+					
  • 
+				&$formData
+				&$data			
    • 
+					
  • 
+				&$form_state
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		execIngestRules (line 1311)
+	
 
+	
+	
+
Executes the ingest rules that apply to the specified file/mimetype.

+
Returns FALSE on failure.
If $preview is TRUE, then only execute rules with  a parameter 'preview'.  Used to generate previews for the file chooser.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		$result
+		
+			execIngestRules
+		
+					(string $file, string $mimetype, [boolean $preview = FALSE])
+			

+	
+			
    
+					
  • 
+				string
+				$file			
    • 
+					
  • 
+				string
+				$mimetype			
    • 
+					
  • 
+				boolean
+				$preview			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getAddDsMethod (line 1715)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			getAddDsMethod
+		
+					( $ds)
+			

+	
+			
    
+					
  • 
+				
+				$ds			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getDisplayMethods (line 1570)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			getDisplayMethods
+		
+					( $ds)
+			

+	
+			
    
+					
  • 
+				
+				$ds			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getEditFormNames (line 2079)
+	
 
+	
+	
+	
    
+				
  • return: An array of form names that exist in this content model.
    • 
+				
  • access: public
    • 
+			

+	
+	

+		array
+		
+			getEditFormNames
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getEditMetadataMethod (line 1183)
+	
 
+	
+	
+
Gets an associative array describing the edit metadata method.

+
Array has the following keys: 'file', 'class', 'method', 'handler', 'dsid'

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		String[]
+		
+			getEditMetadataMethod
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getForm (line 2032)
+	
 
+	
+	
+
Find the form element with name $name.

+	
    
+				
  • return: The form element $name, if found FALSE otherwise.
    • 
+				
  • access: public
    • 
+			

+	
+	

+		DOMElement
+		
+			getForm
+		
+					(string $name)
+			

+	
+			
    
+					
  • 
+				string
+				$name: The name of the form element to find.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getFormNames (line 2042)
+	
 
+	
+	
+	
    
+				
  • return: An array of form names that exist in this content model.
    • 
+				
  • access: public
    • 
+			

+	
+	

+		array
+		
+			getFormNames
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getIngestFormAttributes (line 1961)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			getIngestFormAttributes
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getIngestFormBuilderMethod (line 1997)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			getIngestFormBuilderMethod
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getIngestFormElementParams (line 720)
+	
 
+	
+	
+
Gets a list of all parameters that belong to the specified ingest form element.

+	
    
+				
  • return: success
    • 
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			getIngestFormElementParams
+		
+					( $name, String $elementName)
+			

+	
+			
    
+					
  • 
+				String
+				$elementName			
    • 
+					
  • 
+				
+				$name			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getIngestFormElements (line 503)
+	
 
+	
+	
+
Gets an array of form elements to use in the ingest form.  The results of this array are passed  to the specified ingest form builder.  The form builder can optionally not use the elements as defined  in the form builder if more complex forms or behaviour is required.

+
Each element has the following keys: 'label', 'type', 'required', 'description', and if defined, 'authoritative_list' and/or 'parameters'

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		string[]
+		
+			getIngestFormElements
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getIngestFormNames (line 2061)
+	
 
+	
+	
+	
    
+				
  • return: An array of form names that exist in this content model.
    • 
+				
  • access: public
    • 
+			

+	
+	

+		array
+		
+			getIngestFormNames
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getIngestRule (line 1732)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			getIngestRule
+		
+					( $rule_id)
+			

+	
+			
    
+					
  • 
+				
+				$rule_id			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getIngestRules (line 1920)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			getIngestRules
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getMimetypes (line 1423)
+	
 
+	
+	
+
Gets a list of valid mimetypes that can apply to this model.

+
Returns FALSE on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		string[]
+		
+			getMimetypes
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getName (line 458)
+	
 
+	
+	
+
Gets the name of the ContentModel  Returns false on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		String
+		
+			getName
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getServices (line 428)
+	
 
+	
+	
+
Gets a list of service deployments that this model has.

+
NOTE: Not currently being used.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		String[]
+		
+			getServices
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		handleEditMetadataForm (line 1134)
+	
 
+	
+	
+
Handles the edit metadata form using the handler specified in the <edit_metadata_method> element  Returns FALSE on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		$result
+		
+			handleEditMetadataForm
+		
+					(&$form_id &$form_id, &$form_values &$form_state, &$soap_client &$soap_client)
+			

+	
+			
    
+					
  • 
+				&$form_id
+				&$form_id			
    • 
+					
  • 
+				&$form_values
+				&$form_state			
    • 
+					
  • 
+				&$soap_client
+				&$soap_client			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		incAuthListItem (line 864)
+	
 
+	
+	
+
Increments (or decrements) an authority list item from a form element in the list of elements.

+
Updates the "order".

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			incAuthListItem
+		
+					(String $elementName, String $value, [ $reorder = 'inc'], String $direction)
+			

+	
+			
    
+					
  • 
+				String
+				$elementName			
    • 
+					
  • 
+				String
+				$value			
    • 
+					
  • 
+				String
+				$direction			
    • 
+					
  • 
+				
+				$reorder			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		incFormElement (line 2216)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		
+		
+			incFormElement
+		
+					( $form_element)
+			

+	
+			
    
+					
  • 
+				
+				$form_element			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		incIngestFormElement (line 587)
+	
 
+	
+	
+
Increments (or decrements) ingest form element in the list of elements.

+
Updates the "order".  The $reorder parameter accepts 'inc' or 'dec' to  specify the direction to move (defaults to increment.)
TODO: Might be useful to move multiple places at once, or define  a method to move to an absolute position.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			incIngestFormElement
+		
+					(String $name, [String $reorder = 'inc'])
+			

+	
+			
    
+					
  • 
+				String
+				$name			
    • 
+					
  • 
+				String
+				$reorder			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		listDatastreams (line 1497)
+	
 
+	
+	
+
Gets a list of datastreams from the ContentModel  (not including the QDC ds if it is listed).

+
Returns FALSE on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		string[]
+		
+			listDatastreams
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		removeAppliesTo (line 1742)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			removeAppliesTo
+		
+					( $rule_id,  $type)
+			

+	
+			
    
+					
  • 
+				
+				$rule_id			
    • 
+					
  • 
+				
+				$type			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		removeAuthListItem (line 914)
+	
 
+	
+	
+
Removes an authority list item from a form element.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			removeAuthListItem
+		
+					( $elementName,  $value)
+			

+	
+			
    
+					
  • 
+				
+				$elementName			
    • 
+					
  • 
+				
+				$value			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		removeDispMeth (line 1675)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			removeDispMeth
+		
+					( $dsid,  $module,  $file,  $class,  $method)
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$module			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$class			
    • 
+					
  • 
+				
+				$method			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		removeDs (line 1610)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			removeDs
+		
+					( $dsid)
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		removeEditMetadataMethod (line 1205)
+	
 
+	
+	
+
Removes the edit data method from the Content Model.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			removeEditMetadataMethod
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		removeForm (line 2101)
+	
 
+	
+	
+
Removes the named form.

+	
    
+				
  • return: TRUE on success, FALSE otherwise.
    • 
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			removeForm
+		
+					(string $name)
+			

+	
+			
    
+					
  • 
+				string
+				$name: Name of the form to remove.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		removeIngestFormElement (line 621)
+	
 
+	
+	
+
Removes an ingest form element from the list of ingest form elements.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			removeIngestFormElement
+		
+					(String $name)
+			

+	
+			
    
+					
  • 
+				String
+				$name			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		removeIngestMethod (line 1797)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			removeIngestMethod
+		
+					( $rule_id,  $module,  $file,  $class,  $method)
+			

+	
+			
    
+					
  • 
+				
+				$rule_id			
    • 
+					
  • 
+				
+				$module			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$class			
    • 
+					
  • 
+				
+				$method			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		removeIngestMethodParam (line 1859)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			removeIngestMethodParam
+		
+					( $rule_id,  $module,  $file,  $class,  $method,  $name)
+			

+	
+			
    
+					
  • 
+				
+				$rule_id			
    • 
+					
  • 
+				
+				$module			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$class			
    • 
+					
  • 
+				
+				$method			
    • 
+					
  • 
+				
+				$name			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		removeIngestRule (line 1898)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			removeIngestRule
+		
+					( $rule_id)
+			

+	
+			
    
+					
  • 
+				
+				$rule_id			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		removeMimetype (line 1550)
+	
 
+	
+	
+
Removes an allowed mimetype from the model.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			removeMimetype
+		
+					(String $type)
+			

+	
+			
    
+					
  • 
+				String
+				$type			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		setDefaultDispMeth (line 1644)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			setDefaultDispMeth
+		
+					( $dsid,  $module,  $file,  $class,  $method)
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$module			
    • 
+					
  • 
+				
+				$file			
    • 
+					
  • 
+				
+				$class			
    • 
+					
  • 
+				
+				$method			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		setDisplayInFieldset (line 1629)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			setDisplayInFieldset
+		
+					( $dsid, [ $value = TRUE])
+			

+	
+			
    
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$value			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		setIngestFormElementParam (line 650)
+	
 
+	
+	
+
Sets a parameter of an ingest form element.  If the value of the element is FALSE the parameter  will be removed entirely (if you want to store false as a value, then send the String "false").

+	
    
+				
  • return: success
    • 
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			setIngestFormElementParam
+		
+					( $name, String $paramName, String $paramValue, String $elementName)
+			

+	
+			
    
+					
  • 
+				String
+				$elementName			
    • 
+					
  • 
+				String
+				$paramName			
    • 
+					
  • 
+				String
+				$paramValue			
    • 
+					
  • 
+				
+				$name			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		updateEditMetadataMethod (line 1228)
+	
 
+	
+	
+
Update the Edit Metadata Method defined in the Content Model

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			updateEditMetadataMethod
+		
+					(String $module, String $file, String $class, String $method, String $handler, String $dsid)
+			

+	
+			
    
+					
  • 
+				String
+				$module			
    • 
+					
  • 
+				String
+				$file			
    • 
+					
  • 
+				String
+				$class			
    • 
+					
  • 
+				String
+				$method			
    • 
+					
  • 
+				String
+				$handler			
    • 
+					
  • 
+				String
+				$dsid			
    • 
+				

+		
+			
+	

+							
Inherited Methods

+					
+									
+					
Inherited From XMLDatastream

+					

+													 
+							XMLDatastream::__construct()

+													 
+							XMLDatastream::convertFromOldSchema()

+													 
+							XMLDatastream::dumpXml()

+													 
+							XMLDatastream::getDSIDFromIdentifier()

+													 
+							XMLDatastream::getHistory()

+													 
+							XMLDatastream::getIdentifier()

+													 
+							XMLDatastream::getPidFromIdentifier()

+													 
+							XMLDatastream::loadFromFile()

+													 
+							XMLDatastream::purgeVersions()

+													 
+							XMLDatastream::saveToFedora()

+													 
+							XMLDatastream::validate()

+													 
+							XMLDatastream::validDsid()

+													 
+							XMLDatastream::validPid()

+											

+										
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/MimeClass.html b/docs/Islandora/rootdirectory/MimeClass.html
new file mode 100644
index 00000000..4232b422
--- /dev/null
+++ b/docs/Islandora/rootdirectory/MimeClass.html
@@ -0,0 +1,301 @@
+
+
+  
+		
+			
+			Docs For Class MimeClass
+			
+						
+												
+					
+		
+			
			
+
 Class MimeClass

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+
This class inspired by Chris Jean's work, here:  http://chrisjean.com/2009/02/14/generating-mime-type-in-php-is-not-magic/

+
It does some MIME trickery, inspired by the need to to deal with Openoffice  and MS Office 2007 file formats -- which are often mis-interpreted by  mime-magic, fileinfo, and the *nix `file` command.
In Drupal 6, we also make use of file_get_mimetype. See:  http://api.drupal.org/api/function/file_get_mimetype/6  ... however this only provides a uni-directional lookup (ext->mime).  While I don't have a specific use case for a mime->extension lookup, I think  it's good to have in here.
Drupal 7 will have better mime handlers.  See:  http://api.drupal.org/api/function/file_default_mimetype_mapping/7

+		

+			Located in /MimeClass.inc (line 29)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																															
+				

+					 
+											MimeClass
+										__construct
+										()
+									

+															
+				

+					 
+											void
+										getType
+											( $filename)
+									

+															
+				

+					 
+											void
+										get_extension
+											( $mime_type, [ $debug = FALSE])
+									

+															
+				

+					 
+											void
+										get_mimetype
+											( $filename, [ $debug = FALSE])
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 204)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		MimeClass
+		
+			__construct
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getType (line 221)
+	
 
+	
+	
+
function: getType  description: An alias to get_mimetype,  for backwards-compatibility with our old mimetype class.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			getType
+		
+					( $filename)
+			

+	
+			
    
+					
  • 
+				
+				$filename			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_extension (line 267)
+	
 
+	
+	
+
function: get_extension

+
description: returns *one* valid file extension for a given $mime_type

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			get_extension
+		
+					( $mime_type, [ $debug = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$mime_type			
    • 
+					
  • 
+				
+				$debug			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_mimetype (line 229)
+	
 
+	
+	
+
function: get_mimetype

+
description: returns a mimetype associated with the file extension of $filename

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		void
+		
+			get_mimetype
+		
+					( $filename, [ $debug = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$filename			
    • 
+					
  • 
+				
+				$debug			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/ObjectHelper.html b/docs/Islandora/rootdirectory/ObjectHelper.html
new file mode 100644
index 00000000..dea96ace
--- /dev/null
+++ b/docs/Islandora/rootdirectory/ObjectHelper.html
@@ -0,0 +1,1308 @@
+
+
+  
+		
+			
+			Docs For Class ObjectHelper
+			
+						
+												
+					
+		
+			
			
+
 Class ObjectHelper

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+		

+			Located in /ObjectHelper.inc (line 15)
+		

+		
+				
+		

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+												

+					 
+					static mixed
+					$ADD_FEDORA_STREAMS
+				

+																								

+					 
+					static mixed
+					$DISPLAY_ALWAYS
+				

+																

+					 
+					static mixed
+					$DISPLAY_NEVER
+				

+																

+					 
+					static mixed
+					$DISPLAY_NO_MODEL_OUTPUT
+				

+																

+					 
+					static mixed
+					$EDIT_FEDORA_METADATA
+				

+																

+					 
+					static mixed
+					$EDIT_TAGS_DATASTREAM
+				

+																

+					 
+					static mixed
+					$INGEST_FEDORA_OBJECTS
+				

+																

+					 
+					static mixed
+					$OBJECT_HELPER_VIEW_FEDORA
+				

+																

+					 
+					static mixed
+					$PURGE_FEDORA_OBJECTSANDSTREAMS
+				

+																

+					 
+					static mixed
+					$VIEW_DETAILED_CONTENT_LIST
+				

+																												

+					 
+					mixed
+					$availableDataStreamsText
+				

+																																																																																			

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																																																																																																																																																			
+				

+					 
+					static 						void
+										warnIfMisconfigured
+											( $app)
+									

+																			
+				

+					 
+											ObjectHelper
+										ObjectHelper
+										()
+									

+															
+				

+					 
+											void
+										createExtraFieldsets
+											( $pid,  $contentModel,  $page_number)
+									

+															
+				

+					 
+											void
+										create_link_for_ds
+											($pid $pid, $dataStreamValue $dataStreamValue)
+									

+															
+				

+					 
+											void
+										fedora_repository_access
+											( $op,  $pid)
+									

+															
+				

+					 
+											void
+										getBreadcrumbs
+											( $pid,  &$breadcrumbs, [ $level = 10])
+									

+															
+				

+					 
+											void
+										getCollectionInfo
+											( $pid, [ $query = NULL])
+									

+															
+				

+					 
+											void
+										getDatastreamInfo
+											( $pid,  $dsID)
+									

+															
+				

+					 
+											void
+										getFormattedDC
+											( $item)
+									

+															
+				

+					 
+											void
+										getMimeType
+											( $pid,  $dsID)
+									

+															
+				

+					 
+											void
+										getObject
+											( $pid, [ $context = 'archive'], [ $format = FOXML_11])
+									

+															
+				

+					 
+											String
+										getQDC
+											($pid $pid)
+									

+															
+				

+					 
+											void
+										getStream
+											( $pid,  $dsid, [ $showError = FALSE])
+									

+															
+				

+					 
+											void
+										get_all_related_pids
+											( $pid)
+									

+															
+				

+					 
+											boolean
+										get_and_do_datastream_rules
+											(string $pid, string $dsid, [ $file = ''])
+									

+															
+				

+					 
+											void
+										get_child_pids
+											( $pids)
+									

+															
+				

+					 
+											void
+										get_content_models_list
+											( $pid, [ $include_fedora_system_content_models = FALSE])
+									

+															
+				

+					 
+											String
+										get_formatted_datastream_list
+											($object_pid $object_pid,  $contentModels,  &$fedoraItem)
+									

+															
+				

+					 
+											unknown
+										get_parent_objects
+											(unknown_type $pid)
+									

+															
+				

+					 
+											void
+										get_parent_objects_asHTML
+											( $pid)
+									

+															
+				

+					 
+											void
+										makeObject
+											($pid $pid, $dsID $dsID, [ $asAttachment = FALSE], [ $label = NULL], [ $filePath = FALSE], [ $version = NULL], [ $forceSoap = TRUE])
+									

+															
+				

+					 
+											void
+										parseContent
+											($content $content,  $pid,  $dsId,  $collection, [ $pageNumber = NULL])
+									

+																			

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+

+
+	

+		
+		
+			static mixed
+			$ADD_FEDORA_STREAMS
+			 =  'add fedora datastreams'			(line 21)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$DISPLAY_ALWAYS
+			 =  0			(line 25)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$DISPLAY_NEVER
+			 =  1			(line 26)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$DISPLAY_NO_MODEL_OUTPUT
+			 =  2			(line 27)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$EDIT_FEDORA_METADATA
+			 =  'edit fedora meta data'			(line 19)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$EDIT_TAGS_DATASTREAM
+			 =  'edit tags datastream'			(line 23)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$INGEST_FEDORA_OBJECTS
+			 =  'ingest new fedora objects'			(line 22)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$OBJECT_HELPER_VIEW_FEDORA
+			 =  'view fedora collection'			(line 18)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$PURGE_FEDORA_OBJECTSANDSTREAMS
+			 =  'purge objects and datastreams'			(line 20)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$VIEW_DETAILED_CONTENT_LIST
+			 =  'view detailed list of content'			(line 24)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+
+

+
+	

+		
+		
+			mixed
+			$availableDataStreamsText
+			 =  'Detailed list of content'			(line 29)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		static warnIfMisconfigured (line 892)
+	
 
+	
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static void
+		
+			warnIfMisconfigured
+		
+					( $app)
+			

+	
+			
    
+					
  • 
+				
+				$app			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Constructor ObjectHelper (line 31)
+	
 
+	
+	
+	
+	

+		ObjectHelper
+		
+			ObjectHelper
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		createExtraFieldsets (line 730)
+	
 
+	
+	
+
gets a list of datastreams and related function that we should use to show datastreams in their own fieldsets

+
from the content model associated with the object

+	
+	

+		void
+		
+			createExtraFieldsets
+		
+					( $pid,  $contentModel,  $page_number)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$contentModel			
    • 
+					
  • 
+				
+				$page_number			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		create_link_for_ds (line 257)
+	
 
+	
+	
+
internal function

+	
+	

+		void
+		
+			create_link_for_ds
+		
+					($pid $pid, $dataStreamValue $dataStreamValue)
+			

+	
+			
    
+					
  • 
+				$pid
+				$pid: String			
    • 
+					
  • 
+				$dataStreamValue
+				$dataStreamValue: Object			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		fedora_repository_access (line 554)
+	
 
+	
+	
+	
+	

+		void
+		
+			fedora_repository_access
+		
+					( $op,  $pid)
+			

+	
+			
    
+					
  • 
+				
+				$op			
    • 
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getBreadcrumbs (line 853)
+	
 
+	
+	
+
Builds an array of drupal links for use in breadcrumbs.

+	
+	

+		void
+		
+			getBreadcrumbs
+		
+					( $pid,  &$breadcrumbs, [ $level = 10])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				&$breadcrumbs			
    • 
+					
  • 
+				
+				$level			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getCollectionInfo (line 186)
+	
 
+	
+	
+	
+	

+		void
+		
+			getCollectionInfo
+		
+					( $pid, [ $query = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$query			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getDatastreamInfo (line 224)
+	
 
+	
+	
+	
+	

+		void
+		
+			getDatastreamInfo
+		
+					( $pid,  $dsID)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dsID			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getFormattedDC (line 318)
+	
 
+	
+	
+	
+	

+		void
+		
+			getFormattedDC
+		
+					( $item)
+			

+	
+			
    
+					
  • 
+				
+				$item			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getMimeType (line 196)
+	
 
+	
+	
+
returns the mime type

+	
+	

+		void
+		
+			getMimeType
+		
+					( $pid,  $dsID)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dsID			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getObject (line 842)
+	
 
+	
+	
+
Returns XML description of the object (export).

+	
+	

+		void
+		
+			getObject
+		
+					( $pid, [ $context = 'archive'], [ $format = FOXML_11])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$context			
    • 
+					
  • 
+				
+				$format			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getQDC (line 364)
+	
 
+	
+	
+
Queries fedora for what we call the qualified dublin core.  Currently only dc.coverage has

+
any qualified fields  Transforms the returned xml to html  This is the default metadata view.  With icons for searching a dublin core field

+	
+	

+		String
+		
+			getQDC
+		
+					($pid $pid)
+			

+	
+			
    
+					
  • 
+				$pid
+				$pid: String			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getStream (line 479)
+	
 
+	
+	
+
returns a stream from a fedora object given a pid and dsid

+	
+	

+		void
+		
+			getStream
+		
+					( $pid,  $dsid, [ $showError = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$showError			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_all_related_pids (line 768)
+	
 
+	
+	
+
Get a tree of related pids - for the basket functionality

+	
+	

+		void
+		
+			get_all_related_pids
+		
+					( $pid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_and_do_datastream_rules (line 753)
+	
 
+	
+	
+
Look in the content model for rules to run on the specified datastream.

+	
+	

+		boolean
+		
+			get_and_do_datastream_rules
+		
+					(string $pid, string $dsid, [ $file = ''])
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$dsid			
    • 
+					
  • 
+				
+				$file			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_child_pids (line 797)
+	
 
+	
+	
+
Get children of PID - but only 2 levels deep

+	
+	

+		void
+		
+			get_child_pids
+		
+					( $pids)
+			

+	
+			
    
+					
  • 
+				
+				$pids			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_content_models_list (line 511)
+	
 
+	
+	
+	
+	

+		void
+		
+			get_content_models_list
+		
+					( $pid, [ $include_fedora_system_content_models = FALSE])
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$include_fedora_system_content_models			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_formatted_datastream_list (line 402)
+	
 
+	
+	
+
Gets a list of datastreams from an object using its pid

+
We make some assumptions here.  We have implemented a policy that  we ingest in our repository will have TN (thumbnail) datastream.  Even audio  will have a picture of a speaker or something.  This is not critical  but makes searches etc. look better if there is a TN stream.  This diplays all the streams in a collapsed fieldset at the bottom of the object page.  you can implement a content model if you would like certain streams displayed in certain ways.

+	
+	

+		String
+		
+			get_formatted_datastream_list
+		
+					($object_pid $object_pid,  $contentModels,  &$fedoraItem)
+			

+	
+			
    
+					
  • 
+				$object_pid
+				$object_pid: String			
    • 
+					
  • 
+				
+				$contentModels			
    • 
+					
  • 
+				
+				&$fedoraItem			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_parent_objects (line 688)
+	
 
+	
+	
+
Gets the parent objects that this object is related to

+	
+	

+		unknown
+		
+			get_parent_objects
+		
+					(unknown_type $pid)
+			

+	
+			
    
+					
  • 
+				unknown_type
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_parent_objects_asHTML (line 698)
+	
 
+	
+	
+	
+	

+		void
+		
+			get_parent_objects_asHTML
+		
+					( $pid)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		makeObject (line 46)
+	
 
+	
+	
+
Grabs a stream from fedora sets the mimetype and returns it. $dsID is the  datastream id.   If $forceSoap is set, the function will always buffer the datastream from fedora.  Otherwise, it will  try and use a redirect if possible.

+	
+	

+		void
+		
+			makeObject
+		
+					($pid $pid, $dsID $dsID, [ $asAttachment = FALSE], [ $label = NULL], [ $filePath = FALSE], [ $version = NULL], [ $forceSoap = TRUE])
+			

+	
+			
    
+					
  • 
+				$pid
+				$pid: String			
    • 
+					
  • 
+				$dsID
+				$dsID: String			
    • 
+					
  • 
+				
+				$asAttachment			
    • 
+					
  • 
+				
+				$label			
    • 
+					
  • 
+				
+				$filePath			
    • 
+					
  • 
+				
+				$version			
    • 
+					
  • 
+				
+				$forceSoap			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		parseContent (line 591)
+	
 
+	
+	
+
internal function  uses an xsl to parse the sparql xml returned from the ITQL query

+	
+	

+		void
+		
+			parseContent
+		
+					($content $content,  $pid,  $dsId,  $collection, [ $pageNumber = NULL])
+			

+	
+			
    
+					
  • 
+				$content
+				$content: String			
    • 
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dsId			
    • 
+					
  • 
+				
+				$collection			
    • 
+					
  • 
+				
+				$pageNumber			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/SearchClass.html b/docs/Islandora/rootdirectory/SearchClass.html
new file mode 100644
index 00000000..66573f18
--- /dev/null
+++ b/docs/Islandora/rootdirectory/SearchClass.html
@@ -0,0 +1,710 @@
+
+
+  
+		
+			
+			Docs For Class SearchClass
+			
+						
+												
+					
+		
+			
			
+
 Class SearchClass

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+		

+			Located in /SearchClass.inc (line 9)
+		

+		
+				
+		

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+												

+					 
+					static mixed
+					$SEARCH_CLASS_ADVANCED_SEARCH_NUMBER_FIELDS
+				

+																							

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																																																																																							
+				

+					 
+											void
+										applyLuceneXSLT
+											( $resultData, [ $startPage = 1], [ $xslt_file = '/xsl/results.xsl'], [ $query = NULL])
+									

+															
+				

+					 
+											void
+										applySpecifiedXSLT
+											( $resultData,  $pathToXSLT, [ $displayName = NULL])
+									

+															
+				

+					 
+											void
+										applyXSLT
+											( $resultData, [ $orderBy = 0])
+									

+															
+				

+					 
+											void
+										build_advanced_search_form
+											([ $repeat = NULL], [ $pathToSearchTerms = NULL], [ $query = NULL])
+									

+															
+				

+					 
+											void
+										build_simple_solr_form
+										()
+									

+															
+				

+					 
+											void
+										build_solr_search_form
+											([ $repeat = NULL], [ $pathToSearchTerms = NULL], [ $query = NULL])
+									

+															
+				

+					 
+											void
+										custom_search
+											( $query, [ $startPage = 1], [ $xslt = '/xsl/advanced_search_results.xsl'], [ $numberOfHistPerPage = 50])
+									

+															
+				

+					 
+											void
+										getTerms
+											( $fieldName,  $startTerm, [ $displayName = NULL])
+									

+															
+				

+					 
+											void
+										get_search_terms_array
+											([ $path = NULL], [ $file = NULL])
+									

+															
+				

+					 
+											void
+										quickSearch
+											( $type,  $query, [ $showForm = 1], [ $orderBy = 0],  &$userArray)
+									

+															
+				

+					 
+											void
+										solr_search
+											( $query, [ $startPage = 1], [ $fq = NULL], [ $dismax = NULL])
+									

+															
+				

+					 
+											void
+										theme_advanced_search_form
+											( $form, [ $repeat = NULL])
+									

+															
+				

+					 
+											void
+										theme_solr_search_form
+											( $form)
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+

+
+	

+		
+		
+			static mixed
+			$SEARCH_CLASS_ADVANCED_SEARCH_NUMBER_FIELDS
+			 =  5			(line 10)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		applyLuceneXSLT (line 310)
+	
 
+	
+	
+
apply an xslt to lucene gsearch search results

+	
+	

+		void
+		
+			applyLuceneXSLT
+		
+					( $resultData, [ $startPage = 1], [ $xslt_file = '/xsl/results.xsl'], [ $query = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$resultData			
    • 
+					
  • 
+				
+				$startPage			
    • 
+					
  • 
+				
+				$xslt_file			
    • 
+					
  • 
+				
+				$query: the query that was executed.  May want to pass this on.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		applySpecifiedXSLT (line 251)
+	
 
+	
+	
+	
+	

+		void
+		
+			applySpecifiedXSLT
+		
+					( $resultData,  $pathToXSLT, [ $displayName = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$resultData			
    • 
+					
  • 
+				
+				$pathToXSLT			
    • 
+					
  • 
+				
+				$displayName			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		applyXSLT (line 363)
+	
 
+	
+	
+	
+	

+		void
+		
+			applyXSLT
+		
+					( $resultData, [ $orderBy = 0])
+			

+	
+			
    
+					
  • 
+				
+				$resultData			
    • 
+					
  • 
+				
+				$orderBy			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		build_advanced_search_form (line 428)
+	
 
+	
+	
+	
+	

+		void
+		
+			build_advanced_search_form
+		
+					([ $repeat = NULL], [ $pathToSearchTerms = NULL], [ $query = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$repeat			
    • 
+					
  • 
+				
+				$pathToSearchTerms			
    • 
+					
  • 
+				
+				$query			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		build_simple_solr_form (line 108)
+	
 
+	
+	
+	
+	

+		void
+		
+			build_simple_solr_form
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		build_solr_search_form (line 27)
+	
 
+	
+	
+	
+	

+		void
+		
+			build_solr_search_form
+		
+					([ $repeat = NULL], [ $pathToSearchTerms = NULL], [ $query = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$repeat			
    • 
+					
  • 
+				
+				$pathToSearchTerms			
    • 
+					
  • 
+				
+				$query			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		custom_search (line 218)
+	
 
+	
+	
+	
+	

+		void
+		
+			custom_search
+		
+					( $query, [ $startPage = 1], [ $xslt = '/xsl/advanced_search_results.xsl'], [ $numberOfHistPerPage = 50])
+			

+	
+			
    
+					
  • 
+				
+				$query			
    • 
+					
  • 
+				
+				$startPage			
    • 
+					
  • 
+				
+				$xslt			
    • 
+					
  • 
+				
+				$numberOfHistPerPage			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getTerms (line 191)
+	
 
+	
+	
+	
+	

+		void
+		
+			getTerms
+		
+					( $fieldName,  $startTerm, [ $displayName = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$fieldName			
    • 
+					
  • 
+				
+				$startTerm			
    • 
+					
  • 
+				
+				$displayName			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		get_search_terms_array (line 510)
+	
 
+	
+	
+	
+	

+		void
+		
+			get_search_terms_array
+		
+					([ $path = NULL], [ $file = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$path			
    • 
+					
  • 
+				
+				$file			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		quickSearch (line 144)
+	
 
+	
+	
+	
+	

+		void
+		
+			quickSearch
+		
+					( $type,  $query, [ $showForm = 1], [ $orderBy = 0],  &$userArray)
+			

+	
+			
    
+					
  • 
+				
+				$type			
    • 
+					
  • 
+				
+				$query			
    • 
+					
  • 
+				
+				$showForm			
    • 
+					
  • 
+				
+				$orderBy			
    • 
+					
  • 
+				
+				&$userArray			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		solr_search (line 11)
+	
 
+	
+	
+	
+	

+		void
+		
+			solr_search
+		
+					( $query, [ $startPage = 1], [ $fq = NULL], [ $dismax = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$query			
    • 
+					
  • 
+				
+				$startPage			
    • 
+					
  • 
+				
+				$fq			
    • 
+					
  • 
+				
+				$dismax			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		theme_advanced_search_form (line 406)
+	
 
+	
+	
+	
+	

+		void
+		
+			theme_advanced_search_form
+		
+					( $form, [ $repeat = NULL])
+			

+	
+			
    
+					
  • 
+				
+				$form			
    • 
+					
  • 
+				
+				$repeat			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		theme_solr_search_form (line 122)
+	
 
+	
+	
+	
+	

+		void
+		
+			theme_solr_search_form
+		
+					( $form)
+			

+	
+			
    
+					
  • 
+				
+				$form			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/SecurityClass.html b/docs/Islandora/rootdirectory/SecurityClass.html
new file mode 100644
index 00000000..a77d070e
--- /dev/null
+++ b/docs/Islandora/rootdirectory/SecurityClass.html
@@ -0,0 +1,380 @@
+
+
+  
+		
+			
+			Docs For Class SecurityClass
+			
+						
+												
+					
+		
+			
			
+
 Class SecurityClass

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+		

+			Located in /SecurityClass.inc (line 16)
+		

+		
+				
+		

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+												

+					 
+					static mixed
+					$SECURITY_CLASS_SECURITY_STREAM
+				

+																							

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																							
+				

+					 
+											SecurityClass
+										SecurityClass
+										()
+									

+															
+				

+					 
+											void
+										canIngestHere
+											( $collection_pid)
+									

+															
+				

+					 
+											void
+										createPersonalPolicy
+											( $user)
+									

+															
+				

+					 
+											void
+										getAllowedUsersAndRoles
+											( $policyStream)
+									

+															
+				

+					 
+											DOMDocument
+										set_allowed_users_and_roles
+											( &$policy_stream, array $users_and_roles, string $policy_stream)
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+

+
+	

+		
+		
+			static mixed
+			$SECURITY_CLASS_SECURITY_STREAM
+			 =  'POLICY'			(line 17)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor SecurityClass (line 18)
+	
 
+	
+	
+	
+	

+		SecurityClass
+		
+			SecurityClass
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		canIngestHere (line 23)
+	
 
+	
+	
+	
+	

+		void
+		
+			canIngestHere
+		
+					( $collection_pid)
+			

+	
+			
    
+					
  • 
+				
+				$collection_pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createPersonalPolicy (line 105)
+	
 
+	
+	
+	
+	

+		void
+		
+			createPersonalPolicy
+		
+					( $user)
+			

+	
+			
    
+					
  • 
+				
+				$user			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		getAllowedUsersAndRoles (line 56)
+	
 
+	
+	
+	
+	

+		void
+		
+			getAllowedUsersAndRoles
+		
+					( $policyStream)
+			

+	
+			
    
+					
  • 
+				
+				$policyStream			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		set_allowed_users_and_roles (line 160)
+	
 
+	
+	
+
Add a list of allowed users and roles to the given policy stream and return it.

+	
+	

+		DOMDocument
+		
+			set_allowed_users_and_roles
+		
+					( &$policy_stream, array $users_and_roles, string $policy_stream)
+			

+	
+			
    
+					
  • 
+				string
+				$policy_stream			
    • 
+					
  • 
+				array
+				$users_and_roles			
    • 
+					
  • 
+				
+				&$policy_stream			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/XMLDatastream.html b/docs/Islandora/rootdirectory/XMLDatastream.html
new file mode 100644
index 00000000..3109ab20
--- /dev/null
+++ b/docs/Islandora/rootdirectory/XMLDatastream.html
@@ -0,0 +1,890 @@
+
+
+  
+		
+			
+			Docs For Class XMLDatastream
+			
+						
+												
+					
+		
+			
			
+
Abstract Class XMLDatastream

+
+
+

+	
Description

+	

+					Description |
+							Descendents
+			|											Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+	
    
+				
  • abstract: 
    • 
+			

+		

+			Located in /XMLDatastream.inc (line 9)
+		

+		
+				
+		

+	
+			

+

+
+	
+	

+		
Direct descendents

+		

+			Description |
+			Descendents
+			|												Vars (details)
+								|															Methods (details)
+							
+								

+		

+			
+				
+					
+					
+				
+								
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						CollectionPolicy
+					
+											
+										

+						 class
+						ContentModel
+					
+											
+										

+		

+	

+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+							Descendants |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																				

+					 
+					static mixed
+					$errors
+				

+																																								

+					 
+					static mixed
+					$XMLNS
+				

+																				

+					 
+					mixed
+					$dsid
+				

+																								

+					 
+					mixed
+					$forceSchema
+				

+																

+					 
+					mixed
+					$pid
+				

+																

+					 
+					mixed
+					$xml
+				

+																			

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+							Descendants |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																			
+				

+					 
+					static 						string
+										getDSIDFromIdentifier
+											(string $identifier)
+									

+																															
+				

+					 
+					static 						string
+										getPidFromIdentifier
+											(string $identifier)
+									

+															
+				

+					 
+					static 						XMLDatastream
+										loadFromFile
+											(string $filename)
+									

+																																							
+				

+					 
+					static 						boolean
+										validDsid
+											( $dsid, String $pid)
+									

+															
+				

+					 
+					static 						boolean
+										validPid
+											(String $pid)
+									

+																			
+				

+					 
+											XMLDatastream
+										__construct
+											(string $xmlStr, [string $pid = NULL], [string $dsid = NULL])
+									

+															
+				

+					 
+											void
+										convertFromOldSchema
+										()
+									

+															
+				

+					 
+											string
+										dumpXml
+										()
+									

+																							
+				

+					 
+											string[]
+										getHistory
+										()
+									

+															
+				

+					 
+											string
+										getIdentifier
+										()
+									

+																															
+				

+					 
+											boolean
+										purgeVersions
+											(string $start_date, [string $end_date = NULL])
+									

+															
+				

+					 
+											boolean
+										saveToFedora
+										()
+									

+															
+				

+					 
+											boolean
+										validate
+										()
+									

+																											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+							Descendents |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+

+
+	

+		
+		
+			static mixed
+			$errors
+			 =  NULL			(line 12)
+		
+	

+
+	
+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			static mixed
+			$XMLNS
+			 =  'http://www.islandora.ca'			(line 11)
+		
+	

+
+	
+	
+	
+		
+		
+
+

+
+
+

+
+	

+		
+		
+			mixed
+			$dsid
+						(line 18)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$forceSchema
+			 =  FALSE			(line 15)
+		
+	

+
+	
+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$pid
+						(line 17)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$xml
+			 =  NULL			(line 13)
+		
+	

+
+	
+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+							Descendents |
+															Vars (details)
+																	Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		static getDSIDFromIdentifier (line 72)
+	
 
+	
+	
+
Parses the DSID from an identifier.

+
TODO: combine this method with getPidFromIdentifier?

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static string
+		
+			getDSIDFromIdentifier
+		
+					(string $identifier)
+			

+	
+			
    
+					
  • 
+				string
+				$identifier			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static getPidFromIdentifier (line 25)
+	
 
+	
+	
+
Parses an PID from an identifier.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static string
+		
+			getPidFromIdentifier
+		
+					(string $identifier)
+			

+	
+			
    
+					
  • 
+				string
+				$identifier			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static loadFromFile (line 84)
+	
 
+	
+	
+
Constructs an XMLDatastream object from the XML file specified.

+
Returns FALSE on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static XMLDatastream
+		
+			loadFromFile
+		
+					(string $filename)
+			

+	
+			
    
+					
  • 
+				string
+				$filename			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static validDsid (line 57)
+	
 
+	
+	
+
validDsid  Validates a fedora Dsid based on the the allowed XML standard NCName.

+
The regexp is a "regular" subset of names allowed, it excludes some extended hex characters that are  technically permitted.  http://www.fedora-commons.org/confluence/display/FCR30/Fedora+Identifiers

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static boolean
+		
+			validDsid
+		
+					( $dsid, String $pid)
+			

+	
+			
    
+					
  • 
+				String
+				$pid			
    • 
+					
  • 
+				
+				$dsid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		static validPid (line 38)
+	
 
+	
+	
+
validPid  Validates a fedora PID based on the regexp provided in the fedora  3.3 documentation.

+
http://www.fedora-commons.org/confluence/display/FCR30/Fedora+Identifiers

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		static boolean
+		
+			validPid
+		
+					(String $pid)
+			

+	
+			
    
+					
  • 
+				String
+				$pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Constructor __construct (line 97)
+	
 
+	
+	
+
Constructor  NOTE: Use the static constructor methods whenever possible.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		XMLDatastream
+		
+			__construct
+		
+					(string $xmlStr, [string $pid = NULL], [string $dsid = NULL])
+			

+	
+			
    
+					
  • 
+				string
+				$xmlStr			
    • 
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$dsid			
    • 
+				

+		
+			
+			

+		
Redefined in descendants as:

+		
+	

+
+

+	
+	

+		
+		convertFromOldSchema (line 273)
+	
 
+	
+	
+
Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..

+	
    
+				
  • abstract: 
    • 
+				
  • access: protected
    • 
+			

+	
+	

+		void
+		
+			convertFromOldSchema
+		
+				()
+			

+	
+		
+			
+			

+		
Redefined in descendants as:

+		
    
+					
  • 
+				CollectionPolicy::convertFromOldSchema()
+								: Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..
+							
    • 
+					
  • 
+				ContentModel::convertFromOldSchema()
+								: Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..
+							
    • 
+				

+	

+
+

+	
+	

+		
+		dumpXml (line 131)
+	
 
+	
+	
+
Dumps the XMLDatastream as an XML String

+	
    
+				
  • return: xml
    • 
+				
  • access: public
    • 
+			

+	
+	

+		string
+		
+			dumpXml
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getHistory (line 250)
+	
 
+	
+	
+
Gets the history of the datastream from fedora.

+
Returns false on failure.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		string[]
+		
+			getHistory
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getIdentifier (line 121)
+	
 
+	
+	
+
Gets the identifier for this XMLDatastream  Returns FALSE on failure.

+
NOTE: not available if constructed directly from file.

+	
    
+				
  • return: identifier
    • 
+				
  • access: public
    • 
+			

+	
+	

+		string
+		
+			getIdentifier
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		purgeVersions (line 238)
+	
 
+	
+	
+
Purges veersions of the datastream newer than and including the start_date.  If  End date is specified, it can be used to purge a range of versions instead. Date should be in  DATE_RFC822 format

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			purgeVersions
+		
+					(string $start_date, [string $end_date = NULL])
+			

+	
+			
    
+					
  • 
+				string
+				$start_date			
    • 
+					
  • 
+				string
+				$end_date			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		saveToFedora (line 219)
+	
 
+	
+	
+
Saves the current XML datastream back to fedora.   The XML must validate.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			saveToFedora
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		validate (line 151)
+	
 
+	
+	
+
Validates the XMLDatastream against the schema location

+
defined by the xmlns:schemaLocation attribute of the root  element. If the xmlns:schemaLocation attribute does not exist,  then it is assumed to be the old schema and it attempts to convert  using the convertFromOldSchema method.
TODO:  Maybe change it so that it always validates against a known  schema.  This makes more sense because this class assumes the structure  to be known after it has been validated.

+	
    
+				
  • access: public
    • 
+			

+	
+	

+		boolean
+		
+			validate
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/_CollectionClass.inc.html b/docs/Islandora/rootdirectory/_CollectionClass.inc.html
new file mode 100644
index 00000000..986a3330
--- /dev/null
+++ b/docs/Islandora/rootdirectory/_CollectionClass.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page CollectionClass.inc
+			
+						
+												
+					
+		
+			
			
+
File/CollectionClass.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						CollectionClass
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/_CollectionPolicy.inc.html b/docs/Islandora/rootdirectory/_CollectionPolicy.inc.html
new file mode 100644
index 00000000..9163d381
--- /dev/null
+++ b/docs/Islandora/rootdirectory/_CollectionPolicy.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page CollectionPolicy.inc
+			
+						
+												
+					
+		
+			
			
+
File/CollectionPolicy.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						CollectionPolicy
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/_ConnectionHelper.inc.html b/docs/Islandora/rootdirectory/_ConnectionHelper.inc.html
new file mode 100644
index 00000000..364361a6
--- /dev/null
+++ b/docs/Islandora/rootdirectory/_ConnectionHelper.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page ConnectionHelper.inc
+			
+						
+												
+					
+		
+			
			
+
File/ConnectionHelper.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						ConnectionHelper
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/_ContentModel.inc.html b/docs/Islandora/rootdirectory/_ContentModel.inc.html
new file mode 100644
index 00000000..c3f1d937
--- /dev/null
+++ b/docs/Islandora/rootdirectory/_ContentModel.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page ContentModel.inc
+			
+						
+												
+					
+		
+			
			
+
File/ContentModel.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						ContentModel
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/_MimeClass.inc.html b/docs/Islandora/rootdirectory/_MimeClass.inc.html
new file mode 100644
index 00000000..9798228d
--- /dev/null
+++ b/docs/Islandora/rootdirectory/_MimeClass.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page MimeClass.inc
+			
+						
+												
+					
+		
+			
			
+
File/MimeClass.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						MimeClass
+					
+											This class inspired by Chris Jean's work, here:  http://chrisjean.com/2009/02/14/generating-mime-type-in-php-is-not-magic/
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/_ObjectHelper.inc.html b/docs/Islandora/rootdirectory/_ObjectHelper.inc.html
new file mode 100644
index 00000000..44217916
--- /dev/null
+++ b/docs/Islandora/rootdirectory/_ObjectHelper.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page ObjectHelper.inc
+			
+						
+												
+					
+		
+			
			
+
File/ObjectHelper.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						ObjectHelper
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/_SearchClass.inc.html b/docs/Islandora/rootdirectory/_SearchClass.inc.html
new file mode 100644
index 00000000..f4c0b237
--- /dev/null
+++ b/docs/Islandora/rootdirectory/_SearchClass.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page SearchClass.inc
+			
+						
+												
+					
+		
+			
			
+
File/SearchClass.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						SearchClass
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/_SecurityClass.inc.html b/docs/Islandora/rootdirectory/_SecurityClass.inc.html
new file mode 100644
index 00000000..0b46d0f6
--- /dev/null
+++ b/docs/Islandora/rootdirectory/_SecurityClass.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page SecurityClass.inc
+			
+						
+												
+					
+		
+			
			
+
File/SecurityClass.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						SecurityClass
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/_XMLDatastream.inc.html b/docs/Islandora/rootdirectory/_XMLDatastream.inc.html
new file mode 100644
index 00000000..aa732817
--- /dev/null
+++ b/docs/Islandora/rootdirectory/_XMLDatastream.inc.html
@@ -0,0 +1,142 @@
+
+
+  
+		
+			
+			Docs for page XMLDatastream.inc
+			
+						
+												
+					
+		
+			
			
+
File/XMLDatastream.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+	
    
+				
  • abstract: 
    • 
+			

+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						Abstract class
+						XMLDatastream
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/_fedora_repository.solutionpacks.inc.html b/docs/Islandora/rootdirectory/_fedora_repository.solutionpacks.inc.html
new file mode 100644
index 00000000..4b8a20e1
--- /dev/null
+++ b/docs/Islandora/rootdirectory/_fedora_repository.solutionpacks.inc.html
@@ -0,0 +1,210 @@
+
+
+  
+		
+			
+			Docs for page fedora_repository.solutionpacks.inc
+			
+						
+												
+					
+		
+			
			
+
File/fedora_repository.solutionpacks.inc

+
+
+

+	
Description

+	

+					Description |
+															Functions
+			

+	
	
+		
+		
+			

+

+		
+
+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+															Functions
+		

+		
	
+			
+

+	
+	

+		
+		fedora_repository_solution_packs_page (line 28)
+	
 
+
+	
+
Invokes a hook to any dependent modules asking them if their installations require  any fedora objects to be present. Modules implementing this hook should return an array  of arrays of the form:

+
array( 'pid', 'path-to-foxml-file', 'dsid', 'path-to-datastream-file', int dsversion)
where the last three options are optional. A module can either point to a simple  foxml file to install, or can specify a datastreamstream to check for, with a  path to load the datastream from if it isn't there. Optionally a version number  can be included, to enable updating of content model or collection policy streams  that may have been updated. THis is a simple whole number that should be incremented  when changed.  This value appears in as an attribute of the topmost element of the stream,  e.g.,:
<?xml version="1.0" encoding="utf-8"?> <content_model name="Collection" version="2" ...
Datastreams which don't have this element are assumed to be at version 0.

+	

+		void
+		
+			fedora_repository_solution_packs_page
+		
+				()
+			

+
+		
+	
+

+
+

+	
+	

+		
+		fedora_repository_solution_pack_form (line 53)
+	
 
+
+	
+
Check for installed objects and add a 'Update' or 'Install' button if some objects are missing.

+	

+		void
+		
+			fedora_repository_solution_pack_form
+		
+					( &$form_state,  $solution_pack_module,  $solution_pack_name, [ $objects = array()], array $solution_pack)
+			

+
+			
    
+					
  • 
+				array
+				$solution_pack			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+					
  • 
+				
+				$solution_pack_module			
    • 
+					
  • 
+				
+				$solution_pack_name			
    • 
+					
  • 
+				
+				$objects			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		fedora_repository_solution_pack_form_submit (line 161)
+	
 
+
+	
+	

+		void
+		
+			fedora_repository_solution_pack_form_submit
+		
+					( $form,  &$form_state)
+			

+
+			
    
+					
  • 
+				
+				$form			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+	
+

+		

+	

+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/_formClass.inc.html b/docs/Islandora/rootdirectory/_formClass.inc.html
new file mode 100644
index 00000000..dd8ddb2e
--- /dev/null
+++ b/docs/Islandora/rootdirectory/_formClass.inc.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs for page formClass.inc
+			
+						
+												
+					
+		
+			
			
+
File/formClass.inc

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						formClass
+					
+											
+										

+		

+	

+
+	
+	
+	
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/Islandora/rootdirectory/formClass.html b/docs/Islandora/rootdirectory/formClass.html
new file mode 100644
index 00000000..7677fcf7
--- /dev/null
+++ b/docs/Islandora/rootdirectory/formClass.html
@@ -0,0 +1,679 @@
+
+
+  
+		
+			
+			Docs For Class formClass
+			
+						
+												
+					
+		
+			
			
+
 Class formClass

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /formClass.inc (line 13)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																																																																																																															
+				

+					 
+											formClass
+										formClass
+										()
+									

+															
+				

+					 
+											type
+										canShowIngestForm
+											(type $collection_pid)
+									

+															
+				

+					 
+											void
+										can_ingest_here
+											( $collection_pid)
+									

+															
+				

+					 
+											void
+										createAddDataStreamForm
+											( $pid,  &$form_state)
+									

+															
+				

+					 
+											void
+										createAdminForm
+										()
+									

+															
+				

+					 
+											array
+										createIngestForm
+											(string $collection_pid, string $collection_label,  &$form_state, array $form_state)
+									

+															
+				

+					 
+											void
+										createMenu
+										()
+									

+															
+				

+					 
+											void
+										createMetaDataForm
+											( $pid,  $dsid,  $client,  &$form_state)
+									

+															
+				

+					 
+											string
+										createQDCEditForm
+											(string $pid, string $dsid, object $client,  &$form_state, array $form_state)
+									

+															
+				

+					 
+											array
+										createQDCIngestForm
+											(type $collection_pid, type $collection_label,  &$form_state, array $form_state)
+									

+															
+				

+					 
+											array
+										createQDCIngestFormPageOne
+											(string $collection_pid, string $collection_label,  &$form_state, array $form_state)
+									

+															
+				

+					 
+											array
+										createQDCIngestFormPageTwo
+											(string $collection_pid, string $collection_label,  &$form_state, array $form_state)
+									

+															
+				

+					 
+											void
+										createReplaceDataStreamForm
+											( $pid,  $dsId,  $dsLabel,  &$form_state)
+									

+															
+				

+					 
+											void
+										updateMetaData
+											( $form_id,  $form_values,  $client)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+																Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor formClass (line 15)
+	
 
+	
+	
+	
+	

+		formClass
+		
+			formClass
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		canShowIngestForm (line 464)
+	
 
+	
+	
+
Drupal's permissions at this point no xacml yet. xacml decisions are made by fedora

+	
+	

+		type
+		
+			canShowIngestForm
+		
+					(type $collection_pid)
+			

+	
+			
    
+					
  • 
+				type
+				$collection_pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		can_ingest_here (line 452)
+	
 
+	
+	
+	
+	

+		void
+		
+			can_ingest_here
+		
+					( $collection_pid)
+			

+	
+			
    
+					
  • 
+				
+				$collection_pid			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createAddDataStreamForm (line 616)
+	
 
+	
+	
+	
+	

+		void
+		
+			createAddDataStreamForm
+		
+					( $pid,  &$form_state)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createAdminForm (line 201)
+	
 
+	
+	
+	
+	

+		void
+		
+			createAdminForm
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		createIngestForm (line 599)
+	
 
+	
+	
+
Create a multi step form (wizard) for ingesting objects into Fedora

+	
+	

+		array
+		
+			createIngestForm
+		
+					(string $collection_pid, string $collection_label,  &$form_state, array $form_state)
+			

+	
+			
    
+					
  • 
+				string
+				$collection_pid			
    • 
+					
  • 
+				string
+				$collection_label			
    • 
+					
  • 
+				array
+				$form_state			
    • 
+					
  • 
+				array
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createMenu (line 24)
+	
 
+	
+	
+	
+	

+		void
+		
+			createMenu
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		createMetaDataForm (line 815)
+	
 
+	
+	
+
Creates a drupal form to edit either the QDC or DC datastream

+	
+	

+		void
+		
+			createMetaDataForm
+		
+					( $pid,  $dsid,  $client,  &$form_state)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dsid			
    • 
+					
  • 
+				
+				$client			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createQDCEditForm (line 732)
+	
 
+	
+	
+
Create edit form.

+	
+	

+		string
+		
+			createQDCEditForm
+		
+					(string $pid, string $dsid, object $client,  &$form_state, array $form_state)
+			

+	
+			
    
+					
  • 
+				string
+				$pid			
    • 
+					
  • 
+				string
+				$dsid			
    • 
+					
  • 
+				object
+				$client			
    • 
+					
  • 
+				array
+				$form_state			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createQDCIngestForm (line 579)
+	
 
+	
+	
+
Create the QDC Ingest Form.

+	
+	

+		array
+		
+			createQDCIngestForm
+		
+					(type $collection_pid, type $collection_label,  &$form_state, array $form_state)
+			

+	
+			
    
+					
  • 
+				type
+				$collection_pid			
    • 
+					
  • 
+				type
+				$collection_label			
    • 
+					
  • 
+				array
+				$form_state			
    • 
+					
  • 
+				array
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createQDCIngestFormPageOne (line 494)
+	
 
+	
+	
+
Creates the first page of the ingest form for editing QDC.

+	
+	

+		array
+		
+			createQDCIngestFormPageOne
+		
+					(string $collection_pid, string $collection_label,  &$form_state, array $form_state)
+			

+	
+			
    
+					
  • 
+				string
+				$collection_pid			
    • 
+					
  • 
+				string
+				$collection_label			
    • 
+					
  • 
+				array
+				$form_state			
    • 
+					
  • 
+				array
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createQDCIngestFormPageTwo (line 544)
+	
 
+	
+	
+
Create the second page of the ingest form for editing QDC

+	
+	

+		array
+		
+			createQDCIngestFormPageTwo
+		
+					(string $collection_pid, string $collection_label,  &$form_state, array $form_state)
+			

+	
+			
    
+					
  • 
+				string
+				$collection_pid			
    • 
+					
  • 
+				string
+				$collection_label			
    • 
+					
  • 
+				array
+				$form_state			
    • 
+					
  • 
+				array
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		createReplaceDataStreamForm (line 831)
+	
 
+	
+	
+
Creates a form for replacing datastream

+	
+	

+		void
+		
+			createReplaceDataStreamForm
+		
+					( $pid,  $dsId,  $dsLabel,  &$form_state)
+			

+	
+			
    
+					
  • 
+				
+				$pid			
    • 
+					
  • 
+				
+				$dsId			
    • 
+					
  • 
+				
+				$dsLabel			
    • 
+					
  • 
+				
+				&$form_state			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		updateMetaData (line 390)
+	
 
+	
+	
+	
+	

+		void
+		
+			updateMetaData
+		
+					( $form_id,  $form_values,  $client)
+			

+	
+			
    
+					
  • 
+				
+				$form_id			
    • 
+					
  • 
+				
+				$form_values			
    • 
+					
  • 
+				
+				$client			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/blank.html b/docs/blank.html
new file mode 100644
index 00000000..5362c297
--- /dev/null
+++ b/docs/blank.html
@@ -0,0 +1,13 @@
+
+
+	Islandora
+			
+			
+
+
+
Islandora

+Welcome to Islandora!

+

+This documentation was generated by phpDocumentor v1.4.3

+
+
\ No newline at end of file
diff --git a/docs/classtrees_Islandora.html b/docs/classtrees_Islandora.html
new file mode 100644
index 00000000..5cd44f94
--- /dev/null
+++ b/docs/classtrees_Islandora.html
@@ -0,0 +1,153 @@
+
+
+  
+		
+			
+			
+			
+											
+		
+						
+
+

+	
+

+
Root class CollectionClass

+
+
+
Root class ConnectionHelper

+
+
+
Root class CreateCollection

+
+
+
Root class DarwinCore

+
+
+
Root class DocumentConverter

+
+
+
Root class Dublin_Core

+
+
+
Root class Exiftool

+
+
+
Root class FedoraObject

+
+
+
Root class Fedora_Item

+
+
+
Root class Ffmpeg

+
+
+
Root class FormBuilder

+
+
+
Root class FormBuilder

+
+
+
Root class formClass

+
+
+
Root class Herbarium

+
+
+
Root class ImageManipulation

+
+
+
Root class IslandoraBook

+
+
+
Root class MimeClass

+
+
+
Root class Newspaper

+
+
+
Root class ObjectHelper

+
+
+
Root class PersonalCollectionClass

+
+
+
Root class Refworks

+
+
+
Root class RelsExt

+
+
+
Root class SearchClass

+
+
+
Root class SecurityClass

+
+
+
Root class ShowDemoStreamsInFieldSets

+
+
+
Root class ShowILivesStreamsInFieldSets

+
+
+
Root class ShowMapStreamsInFieldSets

+
+
+
Root class ShowQtStreamsInFieldSets

+
+
+
Root class ShowSlideStreamsInFieldSets

+
+
+
Root class ShowStreamsInFieldSets

+
+
+
Root class TagSet

+
+
+
Root class XMLDatastream

+
+
+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	
+
\ No newline at end of file
diff --git a/docs/elementindex.html b/docs/elementindex.html
new file mode 100644
index 00000000..6361a534
--- /dev/null
+++ b/docs/elementindex.html
@@ -0,0 +1,3911 @@
+
+
+  
+		
+			
+			
+			
+											
+		
+						
+
Full index

+
Package indexes

+
+

+

+	a
+	b
+	c
+	d
+	e
+	f
+	g
+	h
+	i
+	l
+	m
+	n
+	o
+	p
+	q
+	r
+	s
+	t
+	u
+	v
+	w
+	x
+	_
+

+
+	
+	

+		
a

+		
top

+		

+	

+	

+			

+						Variable
+			$ADD_FEDORA_STREAMS
+					

+		

+			
ObjectHelper::$ADD_FEDORA_STREAMS in ObjectHelper.inc

+					

+			

+						Variable
+			$availableDataStreamsText
+					

+		

+			
ObjectHelper::$availableDataStreamsText in ObjectHelper.inc

+					

+			

+						Method
+			addAppliesTo
+					

+		

+			
ContentModel::addAppliesTo() in ContentModel.inc

+					

+			

+						Method
+			addAuthListItem
+					

+		

+			
ContentModel::addAuthListItem() in ContentModel.inc

+							
Adds an authority list item to a form element.

+					

+			

+						Method
+			addDispMeth
+					

+		

+			
ContentModel::addDispMeth() in ContentModel.inc

+					

+			

+						Method
+			addDs
+					

+		

+			
ContentModel::addDs() in ContentModel.inc

+					

+			

+						Method
+			addElementToForm
+					

+		

+			
ContentModel::addElementToForm() in ContentModel.inc

+					

+			

+						Method
+			addForm
+					

+		

+			
ContentModel::addForm() in ContentModel.inc

+							
Adds the named form.

+					

+			

+						Method
+			addIngestFormElement
+					

+		

+			
ContentModel::addIngestFormElement() in ContentModel.inc

+							
Add an ingest form element to the model.

+					

+			

+						Method
+			addIngestMethod
+					

+		

+			
ContentModel::addIngestMethod() in ContentModel.inc

+					

+			

+						Method
+			addIngestMethodParam
+					

+		

+			
ContentModel::addIngestMethodParam() in ContentModel.inc

+					

+			

+						Method
+			addIngestRule
+					

+		

+			
ContentModel::addIngestRule() in ContentModel.inc

+					

+			

+						Method
+			addMimetype
+					

+		

+			
ContentModel::addMimetype() in ContentModel.inc

+							
Adds an allowed mimetype to the model.

+					

+			

+						Method
+			addModel
+					

+		

+			
CollectionPolicy::addModel() in CollectionPolicy.inc

+					

+			

+						Method
+			addTerm
+					

+		

+			
CollectionPolicy::addTerm() in CollectionPolicy.inc

+							
Adds a search term to the collection policy.

+					

+			

+						Method
+			add_datastream_from_file
+					

+		

+			
Fedora_Item::add_datastream_from_file() in fedora_item.inc

+					

+			

+						Method
+			add_datastream_from_string
+					

+		

+			
Fedora_Item::add_datastream_from_string() in fedora_item.inc

+					

+			

+						Method
+			add_datastream_from_url
+					

+		

+			
Fedora_Item::add_datastream_from_url() in fedora_item.inc

+					

+			

+						Method
+			add_element
+					

+		

+			
Dublin_Core::add_element() in dublin_core.inc

+					

+			

+						Method
+			add_relationship
+					

+		

+			
Fedora_Item::add_relationship() in fedora_item.inc

+							
Add a relationship string to this object's RELS-EXT.

+					

+			

+						Method
+			applyLuceneXSLT
+					

+		

+			
SearchClass::applyLuceneXSLT() in SearchClass.inc

+							
apply an xslt to lucene gsearch search results

+					

+			

+						Method
+			applySpecifiedXSLT
+					

+		

+			
SearchClass::applySpecifiedXSLT() in SearchClass.inc

+					

+			

+						Method
+			applyXSLT
+					

+		

+			
SearchClass::applyXSLT() in SearchClass.inc

+					

+			

+						Method
+			asHTML
+					

+		

+			
DarwinCore::asHTML() in DarwinCore.inc

+					

+			

+						Method
+			asXML
+					

+		

+			
DarwinCore::asXML() in DarwinCore.inc

+					

+			

+						Method
+			as_xml
+					

+		

+			
Dublin_Core::as_xml() in dublin_core.inc

+							
Serialize this object to XML and return it.

+					

+			

+						Constant
+			ATOMZip_11
+					

+		

+			
ATOMZip_11 in fedora_export.inc

+					

+			

+						Constant
+			ATOM_11
+					

+		

+			
ATOM_11 in fedora_export.inc

+					

+		

+	
+	

+		
b

+		
top

+		

+	

+	

+			

+						Function
+			book_add_pages_form
+					

+		

+			
book_add_pages_form() in book.inc

+					

+			

+						Function
+			book_add_pages_form_submit
+					

+		

+			
book_add_pages_form_submit() in book.inc

+					

+			

+						Function
+			book_add_pages_form_validate
+					

+		

+			
book_add_pages_form_validate() in book.inc

+					

+			

+						Method
+			buildAddPagesForm
+					

+		

+			
IslandoraBook::buildAddPagesForm() in book.inc

+					

+			

+						Method
+			buildDrupalForm
+					

+		

+			
DarwinCore::buildDrupalForm() in DarwinCore.inc

+					

+			

+						Method
+			buildDrupalForm
+					

+		

+			
Newspaper::buildDrupalForm() in Newspaper.inc

+					

+			

+						Method
+			buildDrupalForm
+					

+		

+			
Herbarium::buildDrupalForm() in herbarium.inc

+					

+			

+						Method
+			buildDrupalForm
+					

+		

+			
IslandoraBook::buildDrupalForm() in book.inc

+					

+			

+						Method
+			buildEditMetadataForm
+					

+		

+			
ModsFormBuilder::buildEditMetadataForm() in ModsFormBuilder.inc

+					

+			

+						Method
+			buildEditMetadataForm
+					

+		

+			
IslandoraBook::buildEditMetadataForm() in book.inc

+					

+			

+						Method
+			buildEditMetadataForm
+					

+		

+			
ContentModel::buildEditMetadataForm() in ContentModel.inc

+							
Builds an edit metadata form using the method specified in the <edit_metadata_method> element

+					

+			

+						Method
+			buildEditMetadataForm
+					

+		

+			
Herbarium::buildEditMetadataForm() in herbarium.inc

+					

+			

+						Method
+			buildForm
+					

+		

+			
Refworks::buildForm() in Refworks.inc

+					

+			

+						Method
+			buildIngestForm
+					

+		

+			
ContentModel::buildIngestForm() in ContentModel.inc

+							
Builds an ingest form using the method specified in  <form_builder_method> element of <ingest_form>  Returns FALSE on failure.

+					

+			

+						Method
+			buildQDCForm
+					

+		

+			
FormBuilder::buildQDCForm() in Flv.inc

+					

+			

+						Method
+			build_advanced_search_form
+					

+		

+			
SearchClass::build_advanced_search_form() in SearchClass.inc

+					

+			

+						Method
+			build_ingest_form
+					

+		

+			
CollectionClass::build_ingest_form() in CollectionClass.inc

+							
grabs a xml form definition from a content model and builds

+					

+			

+						Method
+			build_simple_solr_form
+					

+		

+			
SearchClass::build_simple_solr_form() in SearchClass.inc

+					

+			

+						Method
+			build_solr_search_form
+					

+		

+			
SearchClass::build_solr_search_form() in SearchClass.inc

+					

+			

+						Page
+			book.inc
+					

+		

+			
book.inc in book.inc

+					

+		

+	
+	

+		
c

+		
top

+		

+	

+	

+			

+						Variable
+			$cm
+					

+		

+			
ModsFormBuilder::$cm in ModsFormBuilder.inc

+					

+			

+						Variable
+			$collectionObject
+					

+		

+			
CollectionClass::$collectionObject in CollectionClass.inc

+					

+			

+						Variable
+			$COLLECTION_CLASS_COLLECTION_POLICY_STREAM
+					

+		

+			
CollectionClass::$COLLECTION_CLASS_COLLECTION_POLICY_STREAM in CollectionClass.inc

+					

+			

+						Variable
+			$COLLECTION_CLASS_COLLECTION_VIEW_STREAM
+					

+		

+			
CollectionClass::$COLLECTION_CLASS_COLLECTION_VIEW_STREAM in CollectionClass.inc

+					

+			

+						Method
+			callMethods
+					

+		

+			
CollectionClass::callMethods() in CollectionClass.inc

+							
calls the methods defined in the content model rules .xml file stored in a Fedora object

+					

+			

+						Method
+			canIngestHere
+					

+		

+			
SecurityClass::canIngestHere() in SecurityClass.inc

+					

+			

+						Method
+			canShowIngestForm
+					

+		

+			
formClass::canShowIngestForm() in formClass.inc

+							
Drupal's permissions at this point no xacml yet. xacml decisions are made by fedora

+					

+			

+						Method
+			can_ingest_here
+					

+		

+			
formClass::can_ingest_here() in formClass.inc

+					

+			

+						Class
+			CollectionClass
+					

+		

+			
CollectionClass in CollectionClass.inc

+					

+			

+						Page
+			CollectionClass.inc
+					

+		

+			
CollectionClass.inc in CollectionClass.inc

+					

+			

+						Method
+			CollectionFormBuilder
+					

+		

+			
CollectionFormBuilder::CollectionFormBuilder() in CollectionFormBuilder.inc

+					

+			

+						Class
+			CollectionFormBuilder
+					

+		

+			
CollectionFormBuilder in CollectionFormBuilder.inc

+					

+			

+						Class
+			CollectionPolicy
+					

+		

+			
CollectionPolicy in CollectionPolicy.inc

+					

+			

+						Page
+			CollectionPolicy.inc
+					

+		

+			
CollectionPolicy.inc in CollectionPolicy.inc

+					

+			

+						Method
+			ConnectionHelper
+					

+		

+			
ConnectionHelper::ConnectionHelper() in ConnectionHelper.inc

+					

+			

+						Class
+			ConnectionHelper
+					

+		

+			
ConnectionHelper in ConnectionHelper.inc

+					

+			

+						Page
+			ConnectionHelper.inc
+					

+		

+			
ConnectionHelper.inc in ConnectionHelper.inc

+					

+			

+						Class
+			ContentModel
+					

+		

+			
ContentModel in ContentModel.inc

+					

+			

+						Page
+			ContentModel.inc
+					

+		

+			
ContentModel.inc in ContentModel.inc

+					

+			

+						Method
+			convert
+					

+		

+			
DocumentConverter::convert() in DocumentConverter.inc

+					

+			

+						Method
+			convertFromOldSchema
+					

+		

+			
XMLDatastream::convertFromOldSchema() in XMLDatastream.inc

+							
Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..

+					

+			

+						Method
+			convertFromOldSchema
+					

+		

+			
CollectionPolicy::convertFromOldSchema() in CollectionPolicy.inc

+							
Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..

+					

+			

+						Method
+			convertFromOldSchema
+					

+		

+			
ContentModel::convertFromOldSchema() in ContentModel.inc

+							
Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..

+					

+			

+						Method
+			createAddDataStreamForm
+					

+		

+			
formClass::createAddDataStreamForm() in formClass.inc

+					

+			

+						Method
+			createAdminForm
+					

+		

+			
formClass::createAdminForm() in formClass.inc

+					

+			

+						Method
+			createChildPolicyStream
+					

+		

+			
PersonalCollectionClass::createChildPolicyStream() in PersonalCollectionClass.inc

+					

+			

+						Method
+			createCollection
+					

+		

+			
PersonalCollectionClass::createCollection() in PersonalCollectionClass.inc

+					

+			

+						Class
+			CreateCollection
+					

+		

+			
CreateCollection in CreateCollection.inc

+					

+			

+						Method
+			CreateCollection
+					

+		

+			
CreateCollection::CreateCollection() in CreateCollection.inc

+					

+			

+						Method
+			createCollectionPolicy
+					

+		

+			
ModsFormBuilder::createCollectionPolicy() in ModsFormBuilder.inc

+					

+			

+						Method
+			createCollectionPolicyStream
+					

+		

+			
PersonalCollectionClass::createCollectionPolicyStream() in PersonalCollectionClass.inc

+					

+			

+						Method
+			createDCStream
+					

+		

+			
PersonalCollectionClass::createDCStream() in PersonalCollectionClass.inc

+					

+			

+						Method
+			createExtraFieldsets
+					

+		

+			
ObjectHelper::createExtraFieldsets() in ObjectHelper.inc

+							
gets a list of datastreams and related function that we should use to show datastreams in their own fieldsets

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
Refworks::createFedoraDataStreams() in Refworks.inc

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
CollectionFormBuilder::createFedoraDataStreams() in CollectionFormBuilder.inc

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
FlvFormBuilder::createFedoraDataStreams() in FlvFormBuilder.inc

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
FormBuilder::createFedoraDataStreams() in Flv.inc

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
QtFormBuilder::createFedoraDataStreams() in QtFormBuilder.php

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
DemoFormBuilder::createFedoraDataStreams() in DemoFormBuilder.inc

+					

+			

+						Method
+			createIngestForm
+					

+		

+			
formClass::createIngestForm() in formClass.inc

+							
Create a multi step form (wizard) for ingesting objects into Fedora

+					

+			

+						Method
+			createJP2
+					

+		

+			
ImageManipulation::createJP2() in ImageManipulation.inc

+					

+			

+						Method
+			createMenu
+					

+		

+			
formClass::createMenu() in formClass.inc

+					

+			

+						Method
+			createMetaDataForm
+					

+		

+			
formClass::createMetaDataForm() in formClass.inc

+							
Creates a drupal form to edit either the QDC or DC datastream

+					

+			

+						Method
+			createModsStream
+					

+		

+			
ModsFormBuilder::createModsStream() in ModsFormBuilder.inc

+					

+			

+						Method
+			createPersonalPolicy
+					

+		

+			
SecurityClass::createPersonalPolicy() in SecurityClass.inc

+					

+			

+						Method
+			createPNG
+					

+		

+			
ImageManipulation::createPNG() in ImageManipulation.inc

+					

+			

+						Method
+			createPolicyStream
+					

+		

+			
PersonalCollectionClass::createPolicyStream() in PersonalCollectionClass.inc

+					

+			

+						Method
+			createPreview
+					

+		

+			
ImageManipulation::createPreview() in ImageManipulation.inc

+					

+			

+						Method
+			createQDCEditForm
+					

+		

+			
formClass::createQDCEditForm() in formClass.inc

+							
Create edit form.

+					

+			

+						Method
+			createQDCIngestForm
+					

+		

+			
formClass::createQDCIngestForm() in formClass.inc

+							
Create the QDC Ingest Form.

+					

+			

+						Method
+			createQDCIngestFormPageOne
+					

+		

+			
formClass::createQDCIngestFormPageOne() in formClass.inc

+							
Creates the first page of the ingest form for editing QDC.

+					

+			

+						Method
+			createQDCIngestFormPageTwo
+					

+		

+			
formClass::createQDCIngestFormPageTwo() in formClass.inc

+							
Create the second page of the ingest form for editing QDC

+					

+			

+						Method
+			createQDCStream
+					

+		

+			
FormBuilder::createQDCStream() in Flv.inc

+					

+			

+						Method
+			createQDCStream
+					

+		

+			
Refworks::createQDCStream() in Refworks.inc

+					

+			

+						Method
+			createRelationShips
+					

+		

+			
Refworks::createRelationShips() in Refworks.inc

+							
Creates the RELS-EXT for the foxml

+					

+			

+						Method
+			createRelationShips
+					

+		

+			
FormBuilder::createRelationShips() in Flv.inc

+							
creates the RELS-EXT for the foxml

+					

+			

+						Method
+			createReplaceDataStreamForm
+					

+		

+			
formClass::createReplaceDataStreamForm() in formClass.inc

+							
Creates a form for replacing datastream

+					

+			

+						Method
+			createRomeoDataStream
+					

+		

+			
Refworks::createRomeoDataStream() in Refworks.inc

+					

+			

+						Method
+			createStandardFedoraStuff
+					

+		

+			
FormBuilder::createStandardFedoraStuff() in Flv.inc

+							
creates the standard foxml properties

+					

+			

+						Method
+			createStandardFedoraStuff
+					

+		

+			
PersonalCollectionClass::createStandardFedoraStuff() in PersonalCollectionClass.inc

+					

+			

+						Method
+			createStandardFedoraStuff
+					

+		

+			
Refworks::createStandardFedoraStuff() in Refworks.inc

+							
Creates the standard foxml properties

+					

+			

+						Method
+			createThumbnail
+					

+		

+			
ImageManipulation::createThumbnail() in ImageManipulation.inc

+					

+			

+						Method
+			createThumbnailFromPDF
+					

+		

+			
ImageManipulation::createThumbnailFromPDF() in ImageManipulation.inc

+					

+			

+						Method
+			createUserCollection
+					

+		

+			
CollectionClass::createUserCollection() in CollectionClass.inc

+					

+			

+						Method
+			createWorkflowStream
+					

+		

+			
ModsFormBuilder::createWorkflowStream() in ModsFormBuilder.inc

+					

+			

+						Method
+			create_dc_from_dict
+					

+		

+			
Dublin_Core::create_dc_from_dict() in dublin_core.inc

+					

+			

+						Method
+			create_link_for_ds
+					

+		

+			
ObjectHelper::create_link_for_ds() in ObjectHelper.inc

+							
internal function

+					

+			

+						Method
+			create_object_FOXML
+					

+		

+			
Fedora_Item::create_object_FOXML() in fedora_item.inc

+							
Creates the minimal FOXML for a new Fedora object, which is then passed to  ingest_from_FOXML to be added to the repository.

+					

+			

+						Method
+			create_security_policies
+					

+		

+			
Refworks::create_security_policies() in Refworks.inc

+							
Read the list of Users from the U1 field and Roles from the U2 field and add elements  to the security policy record for this item, then add the record as the security policy datastream.

+					

+			

+						Method
+			custom_search
+					

+		

+			
SearchClass::custom_search() in SearchClass.inc

+					

+			

+						Page
+			CollectionFormBuilder.inc
+					

+		

+			
CollectionFormBuilder.inc in CollectionFormBuilder.inc

+					

+			

+						Page
+			CreateCollection.inc
+					

+		

+			
CreateCollection.inc in CreateCollection.inc

+					

+		

+	
+	

+		
d

+		
top

+		

+	

+	

+			

+						Variable
+			$darwinCoreXML
+					

+		

+			
DarwinCore::$darwinCoreXML in DarwinCore.inc

+					

+			

+						Variable
+			$datastreams
+					

+		

+			
Fedora_Item::$datastreams in fedora_item.inc

+					

+			

+						Variable
+			$dc
+					

+		

+			
Dublin_Core::$dc in dublin_core.inc

+					

+			

+						Variable
+			$DEFAULT_DSID
+					

+		

+			
CollectionPolicy::$DEFAULT_DSID in CollectionPolicy.inc

+					

+			

+						Variable
+			$DEFAULT_DSID
+					

+		

+			
ContentModel::$DEFAULT_DSID in ContentModel.inc

+					

+			

+						Variable
+			$DISPLAY_ALWAYS
+					

+		

+			
ObjectHelper::$DISPLAY_ALWAYS in ObjectHelper.inc

+					

+			

+						Variable
+			$DISPLAY_NEVER
+					

+		

+			
ObjectHelper::$DISPLAY_NEVER in ObjectHelper.inc

+					

+			

+						Variable
+			$DISPLAY_NO_MODEL_OUTPUT
+					

+		

+			
ObjectHelper::$DISPLAY_NO_MODEL_OUTPUT in ObjectHelper.inc

+					

+			

+						Variable
+			$dsid
+					

+		

+			
XMLDatastream::$dsid in XMLDatastream.inc

+					

+			

+						Variable
+			$dwcFields
+					

+		

+			
DarwinCore::$dwcFields in DarwinCore.inc

+					

+			

+						Page
+			dublin_core.inc
+					

+		

+			
dublin_core.inc in dublin_core.inc

+					

+			

+						Class
+			DarwinCore
+					

+		

+			
DarwinCore in DarwinCore.inc

+					

+			

+						Method
+			decAuthListItem
+					

+		

+			
ContentModel::decAuthListItem() in ContentModel.inc

+							
Decrements an authority list item from a form element in the list of elements.

+					

+			

+						Method
+			decFormElement
+					

+		

+			
ContentModel::decFormElement() in ContentModel.inc

+					

+			

+						Method
+			decIngestFormElement
+					

+		

+			
ContentModel::decIngestFormElement() in ContentModel.inc

+							
Decrements an ingest form element in the list of elements.

+					

+			

+						Method
+			DemoFormBuilder
+					

+		

+			
DemoFormBuilder::DemoFormBuilder() in DemoFormBuilder.inc

+					

+			

+						Class
+			DemoFormBuilder
+					

+		

+			
DemoFormBuilder in DemoFormBuilder.inc

+					

+			

+						Method
+			displayExtraFieldset
+					

+		

+			
ContentModel::displayExtraFieldset() in ContentModel.inc

+							
Calls all defined display methods for the ContentModel.

+					

+			

+						Method
+			displayInFieldset
+					

+		

+			
ContentModel::displayInFieldset() in ContentModel.inc

+					

+			

+						Method
+			displayMetadata
+					

+		

+			
Exiftool::displayMetadata() in Exiftool.inc

+					

+			

+						Class
+			DocumentConverter
+					

+		

+			
DocumentConverter in DocumentConverter.inc

+							
This class implements document (doc, odt, pdf, etc.) conversion for a generic  multi-format document collection.

+					

+			

+						Function
+			do_curl
+					

+		

+			
do_curl() in fedora_utils.inc

+					

+			

+						Method
+			Dublin_Core
+					

+		

+			
Dublin_Core::Dublin_Core() in dublin_core.inc

+							
Constructs a Dublin_Core object from a Fedora_Item object and populates  the $dc array.

+					

+			

+						Class
+			Dublin_Core
+					

+		

+			
Dublin_Core in dublin_core.inc

+					

+			

+						Method
+			dumpXml
+					

+		

+			
XMLDatastream::dumpXml() in XMLDatastream.inc

+							
Dumps the XMLDatastream as an XML String

+					

+			

+						Page
+			DarwinCore.inc
+					

+		

+			
DarwinCore.inc in DarwinCore.inc

+					

+			

+						Page
+			DemoFormBuilder.inc
+					

+		

+			
DemoFormBuilder.inc in DemoFormBuilder.inc

+					

+			

+						Page
+			DocumentConverter.inc
+					

+		

+			
DocumentConverter.inc in DocumentConverter.inc

+					

+		

+	
+	

+		
e

+		
top

+		

+	

+	

+			

+						Variable
+			$EDIT_FEDORA_METADATA
+					

+		

+			
ObjectHelper::$EDIT_FEDORA_METADATA in ObjectHelper.inc

+					

+			

+						Variable
+			$EDIT_TAGS_DATASTREAM
+					

+		

+			
ObjectHelper::$EDIT_TAGS_DATASTREAM in ObjectHelper.inc

+					

+			

+						Variable
+			$errors
+					

+		

+			
XMLDatastream::$errors in XMLDatastream.inc

+					

+			

+						Method
+			editForm
+					

+		

+			
ContentModel::editForm() in ContentModel.inc

+							
Edits a form element with attribute name='$name' from the 'forms' element.

+					

+			

+						Method
+			editFormElement
+					

+		

+			
ContentModel::editFormElement() in ContentModel.inc

+					

+			

+						Method
+			editIngestFormAttributes
+					

+		

+			
ContentModel::editIngestFormAttributes() in ContentModel.inc

+					

+			

+						Method
+			editIngestFormBuilderMethod
+					

+		

+			
ContentModel::editIngestFormBuilderMethod() in ContentModel.inc

+					

+			

+						Method
+			editIngestFormElement
+					

+		

+			
ContentModel::editIngestFormElement() in ContentModel.inc

+							
Edits the ingest form element specified.

+					

+			

+						Method
+			enableDownload
+					

+		

+			
ShowQtStreamsInFieldSets::enableDownload() in qt_viewer.inc

+					

+			

+						Method
+			execAddDatastreamMethods
+					

+		

+			
ContentModel::execAddDatastreamMethods() in ContentModel.inc

+							
Executes the add datastream method for the specified datastream on the specified file.

+					

+			

+						Method
+			execFormHandler
+					

+		

+			
ContentModel::execFormHandler() in ContentModel.inc

+							
Executes the form handler from the <form_builder_method> element of <ingest_form>.

+					

+			

+						Method
+			execIngestRules
+					

+		

+			
ContentModel::execIngestRules() in ContentModel.inc

+							
Executes the ingest rules that apply to the specified file/mimetype.

+					

+			

+						Class
+			Exiftool
+					

+		

+			
Exiftool in Exiftool.inc

+					

+			

+						Method
+			exists
+					

+		

+			
Fedora_Item::exists() in fedora_item.inc

+					

+			

+						Method
+			export_as_foxml
+					

+		

+			
Fedora_Item::export_as_foxml() in fedora_item.inc

+					

+			

+						Function
+			export_collection
+					

+		

+			
export_collection() in fedora_collection.inc

+							
Exports a fedora collection object and all of its children in a format  that will let you import them into another repository.

+					

+			

+						Function
+			export_foxml_for_pid
+					

+		

+			
export_foxml_for_pid() in fedora_export.inc

+					

+			

+						Function
+			export_objects_for_pid
+					

+		

+			
export_objects_for_pid() in fedora_export.inc

+					

+			

+						Function
+			export_to_export_area
+					

+		

+			
export_to_export_area() in fedora_export.inc

+							
Function to to export all objects assocoiated with a given pid to the export area

+					

+			

+						Method
+			extractMetadata
+					

+		

+			
Exiftool::extractMetadata() in Exiftool.inc

+					

+			

+						Method
+			extract_thumbnail
+					

+		

+			
Ffmpeg::extract_thumbnail() in Ffmpeg.inc

+					

+			

+						Page
+			Exiftool.inc
+					

+		

+			
Exiftool.inc in Exiftool.inc

+					

+		

+	
+	

+		
f

+		
top

+		

+	

+	

+			

+						Variable
+			$forceSchema
+					

+		

+			
XMLDatastream::$forceSchema in XMLDatastream.inc

+					

+			

+						Page
+			fedora_collection.inc
+					

+		

+			
fedora_collection.inc in fedora_collection.inc

+					

+			

+						Page
+			fedora_export.inc
+					

+		

+			
fedora_export.inc in fedora_export.inc

+					

+			

+						Page
+			fedora_item.inc
+					

+		

+			
fedora_item.inc in fedora_item.inc

+					

+			

+						Page
+			fedora_utils.inc
+					

+		

+			
fedora_utils.inc in fedora_utils.inc

+					

+			

+						Method
+			fedoraObject
+					

+		

+			
ShowQtStreamsInFieldSets::fedoraObject() in qt_viewer.inc

+					

+			

+						Class
+			FedoraObject
+					

+		

+			
FedoraObject in fedoraObject.inc

+					

+			

+						Function
+			fedora_attach_admin
+					

+		

+			
fedora_attach_admin() in fedora_attach.admin.inc

+							
Form builder.  Configure Redmine parameters.

+					

+			

+						Function
+			fedora_available
+					

+		

+			
fedora_available() in fedora_utils.inc

+					

+			

+						Class
+			Fedora_Item
+					

+		

+			
Fedora_Item in fedora_item.inc

+					

+			

+						Method
+			fedora_item_exists
+					

+		

+			
Fedora_Item::fedora_item_exists() in fedora_item.inc

+					

+			

+						Constant
+			FEDORA_MODEL_URI
+					

+		

+			
FEDORA_MODEL_URI in fedora_item.inc

+					

+			

+						Page
+			fedora_repository.solutionpacks.inc
+					

+		

+			
fedora_repository.solutionpacks.inc in fedora_repository.solutionpacks.inc

+					

+			

+						Method
+			fedora_repository_access
+					

+		

+			
ObjectHelper::fedora_repository_access() in ObjectHelper.inc

+					

+			

+						Function
+			fedora_repository_image_tagging_form
+					

+		

+			
fedora_repository_image_tagging_form() in tagging_form.inc

+					

+			

+						Function
+			fedora_repository_image_tagging_form_submit
+					

+		

+			
fedora_repository_image_tagging_form_submit() in tagging_form.inc

+					

+			

+						Function
+			fedora_repository_solution_packs_page
+					

+		

+			
fedora_repository_solution_packs_page() in fedora_repository.solutionpacks.inc

+							
Invokes a hook to any dependent modules asking them if their installations require  any fedora objects to be present. Modules implementing this hook should return an array  of arrays of the form:

+					

+			

+						Function
+			fedora_repository_solution_pack_form
+					

+		

+			
fedora_repository_solution_pack_form() in fedora_repository.solutionpacks.inc

+							
Check for installed objects and add a 'Update' or 'Install' button if some objects are missing.

+					

+			

+						Function
+			fedora_repository_solution_pack_form_submit
+					

+		

+			
fedora_repository_solution_pack_form_submit() in fedora_repository.solutionpacks.inc

+					

+			

+						Method
+			Ffmpeg
+					

+		

+			
Ffmpeg::Ffmpeg() in Ffmpeg.inc

+					

+			

+						Class
+			Ffmpeg
+					

+		

+			
Ffmpeg in Ffmpeg.inc

+					

+			

+						Method
+			find_objects_by_pattern
+					

+		

+			
Fedora_Item::find_objects_by_pattern() in fedora_item.inc

+							
Does a search using the "query" format followed by the Fedora REST APi.

+					

+			

+						Function
+			fixDsid
+					

+		

+			
fixDsid() in fedora_utils.inc

+					

+			

+						Function
+			fix_encoding
+					

+		

+			
fix_encoding() in fedora_utils.inc

+							
Returns a UTF-8-encoded transcripiton of the string given in $in_str.

+					

+			

+						Method
+			FlvFormBuilder
+					

+		

+			
FlvFormBuilder::FlvFormBuilder() in FlvFormBuilder.inc

+					

+			

+						Class
+			FlvFormBuilder
+					

+		

+			
FlvFormBuilder in FlvFormBuilder.inc

+					

+			

+						Method
+			FormBuilder
+					

+		

+			
FormBuilder::FormBuilder() in Flv.inc

+					

+			

+						Class
+			FormBuilder
+					

+		

+			
FormBuilder in Flv.inc

+					

+			

+						Method
+			formClass
+					

+		

+			
formClass::formClass() in formClass.inc

+					

+			

+						Class
+			formClass
+					

+		

+			
formClass in formClass.inc

+					

+			

+						Page
+			formClass.inc
+					

+		

+			
formClass.inc in formClass.inc

+					

+			

+						Constant
+			FOXML_10
+					

+		

+			
FOXML_10 in fedora_export.inc

+					

+			

+						Constant
+			FOXML_11
+					

+		

+			
FOXML_11 in fedora_export.inc

+					

+			

+						Page
+			fedoraObject.inc
+					

+		

+			
fedoraObject.inc in fedoraObject.inc

+					

+			

+						Page
+			fedora_attach.admin.inc
+					

+		

+			
fedora_attach.admin.inc in fedora_attach.admin.inc

+					

+			

+						Page
+			Ffmpeg.inc
+					

+		

+			
Ffmpeg.inc in Ffmpeg.inc

+					

+			

+						Page
+			Flv.inc
+					

+		

+			
Flv.inc in Flv.inc

+					

+			

+						Page
+			FlvFormBuilder.inc
+					

+		

+			
FlvFormBuilder.inc in FlvFormBuilder.inc

+					

+			

+						Page
+			FormBuilder.inc
+					

+		

+			
FormBuilder.inc in FormBuilder.inc

+					

+		

+	
+	

+		
g

+		
top

+		

+	

+	

+			

+						Method
+			getAddDsMethod
+					

+		

+			
ContentModel::getAddDsMethod() in ContentModel.inc

+					

+			

+						Method
+			getAllowedMimeTypes
+					

+		

+			
CollectionClass::getAllowedMimeTypes() in CollectionClass.inc

+					

+			

+						Method
+			getAllowedUsersAndRoles
+					

+		

+			
SecurityClass::getAllowedUsersAndRoles() in SecurityClass.inc

+					

+			

+						Method
+			getAndDoRules
+					

+		

+			
CollectionClass::getAndDoRules() in CollectionClass.inc

+							
Grabs the rules from the content model stream

+					

+			

+						Method
+			getBreadcrumbs
+					

+		

+			
ObjectHelper::getBreadcrumbs() in ObjectHelper.inc

+							
Builds an array of drupal links for use in breadcrumbs.

+					

+			

+						Method
+			getCollectionInfo
+					

+		

+			
ObjectHelper::getCollectionInfo() in ObjectHelper.inc

+					

+			

+						Method
+			getCollectionPolicyStream
+					

+		

+			
CollectionClass::getCollectionPolicyStream() in CollectionClass.inc

+					

+			

+						Method
+			getCollectionViewStream
+					

+		

+			
CollectionClass::getCollectionViewStream() in CollectionClass.inc

+					

+			

+						Method
+			getContentModels
+					

+		

+			
CollectionPolicy::getContentModels() in CollectionPolicy.inc

+							
Gets a list of ContentModel objects supported by this collection.

+					

+			

+						Method
+			getContentModels
+					

+		

+			
CollectionClass::getContentModels() in CollectionClass.inc

+							
gets a list of content models from a collection policy

+					

+			

+						Method
+			getDatastreamInfo
+					

+		

+			
ObjectHelper::getDatastreamInfo() in ObjectHelper.inc

+					

+			

+						Method
+			getDefaultDSID
+					

+		

+			
CollectionPolicy::getDefaultDSID() in CollectionPolicy.inc

+							
Gets the default DSID to use for ContentModel datastreams.

+					

+			

+						Method
+			getDefaultDSID
+					

+		

+			
ContentModel::getDefaultDSID() in ContentModel.inc

+							
Gets the default DSID to use for ContentModel datastreams.

+					

+			

+						Method
+			getDisplayMethods
+					

+		

+			
ContentModel::getDisplayMethods() in ContentModel.inc

+					

+			

+						Method
+			getDSIDFromIdentifier
+					

+		

+			
XMLDatastream::getDSIDFromIdentifier() in XMLDatastream.inc

+							
Parses the DSID from an identifier.

+					

+			

+						Method
+			getEditFormNames
+					

+		

+			
ContentModel::getEditFormNames() in ContentModel.inc

+					

+			

+						Method
+			getEditMetadataMethod
+					

+		

+			
ContentModel::getEditMetadataMethod() in ContentModel.inc

+							
Gets an associative array describing the edit metadata method.

+					

+			

+						Method
+			getForm
+					

+		

+			
ContentModel::getForm() in ContentModel.inc

+							
Find the form element with name $name.

+					

+			

+						Method
+			getFormattedDC
+					

+		

+			
ObjectHelper::getFormattedDC() in ObjectHelper.inc

+					

+			

+						Method
+			getFormHandler
+					

+		

+			
CollectionClass::getFormHandler() in CollectionClass.inc

+							
gets the form handler file, class and method and returns them in an array

+					

+			

+						Method
+			getFormNames
+					

+		

+			
ContentModel::getFormNames() in ContentModel.inc

+					

+			

+						Method
+			getHistory
+					

+		

+			
XMLDatastream::getHistory() in XMLDatastream.inc

+							
Gets the history of the datastream from fedora.

+					

+			

+						Method
+			getIdentifier
+					

+		

+			
XMLDatastream::getIdentifier() in XMLDatastream.inc

+							
Gets the identifier for this XMLDatastream  Returns FALSE on failure.

+					

+			

+						Method
+			getIngestFormAttributes
+					

+		

+			
ContentModel::getIngestFormAttributes() in ContentModel.inc

+					

+			

+						Method
+			getIngestFormBuilderMethod
+					

+		

+			
ContentModel::getIngestFormBuilderMethod() in ContentModel.inc

+					

+			

+						Method
+			getIngestFormElementParams
+					

+		

+			
ContentModel::getIngestFormElementParams() in ContentModel.inc

+							
Gets a list of all parameters that belong to the specified ingest form element.

+					

+			

+						Method
+			getIngestFormElements
+					

+		

+			
ContentModel::getIngestFormElements() in ContentModel.inc

+							
Gets an array of form elements to use in the ingest form.  The results of this array are passed  to the specified ingest form builder.  The form builder can optionally not use the elements as defined  in the form builder if more complex forms or behaviour is required.

+					

+			

+						Method
+			getIngestFormNames
+					

+		

+			
ContentModel::getIngestFormNames() in ContentModel.inc

+					

+			

+						Method
+			getIngestInterface
+					

+		

+			
CollectionClass::getIngestInterface() in CollectionClass.inc

+					

+			

+						Method
+			getIngestRule
+					

+		

+			
ContentModel::getIngestRule() in ContentModel.inc

+					

+			

+						Method
+			getIngestRules
+					

+		

+			
ContentModel::getIngestRules() in ContentModel.inc

+					

+			

+						Method
+			getMediaDatastreamInfo
+					

+		

+			
ShowQtStreamsInFieldSets::getMediaDatastreamInfo() in qt_viewer.inc

+					

+			

+						Method
+			getMimeType
+					

+		

+			
ObjectHelper::getMimeType() in ObjectHelper.inc

+							
returns the mime type

+					

+			

+						Method
+			getMimetypes
+					

+		

+			
ContentModel::getMimetypes() in ContentModel.inc

+							
Gets a list of valid mimetypes that can apply to this model.

+					

+			

+						Method
+			getName
+					

+		

+			
ContentModel::getName() in ContentModel.inc

+							
Gets the name of the ContentModel  Returns false on failure.

+					

+			

+						Method
+			getName
+					

+		

+			
CollectionPolicy::getName() in CollectionPolicy.inc

+					

+			

+						Method
+			getNextPid
+					

+		

+			
CollectionClass::getNextPid() in CollectionClass.inc

+							
using the collection policies pid namespace get a new pid by calling fedora' get next pid and appending it to the namespace  $pid is the $pid of the content model  $dsid is the datastream id of the content model.

+					

+			

+						Method
+			getNextPid
+					

+		

+			
CollectionPolicy::getNextPid() in CollectionPolicy.inc

+							
Gets the next available PID for the  content model specified by the DSID  parameter.

+					

+			

+						Method
+			getObject
+					

+		

+			
ObjectHelper::getObject() in ObjectHelper.inc

+							
Returns XML description of the object (export).

+					

+			

+						Method
+			getPidFromIdentifier
+					

+		

+			
XMLDatastream::getPidFromIdentifier() in XMLDatastream.inc

+							
Parses an PID from an identifier.

+					

+			

+						Method
+			getPidNameSpace
+					

+		

+			
CollectionClass::getPidNameSpace() in CollectionClass.inc

+					

+			

+						Method
+			getPosterFrameDatastreamInfo
+					

+		

+			
ShowQtStreamsInFieldSets::getPosterFrameDatastreamInfo() in qt_viewer.inc

+					

+			

+						Method
+			getQDC
+					

+		

+			
ObjectHelper::getQDC() in ObjectHelper.inc

+							
Queries fedora for what we call the qualified dublin core.  Currently only dc.coverage has

+					

+			

+						Method
+			getRelatedItems
+					

+		

+			
CollectionClass::getRelatedItems() in CollectionClass.inc

+							
Gets objects related to this item.  It will query the object for a Query stream and use that as a itql query

+					

+			

+						Method
+			getRelatedObjects
+					

+		

+			
CollectionClass::getRelatedObjects() in CollectionClass.inc

+					

+			

+						Method
+			getRelationship
+					

+		

+			
CollectionPolicy::getRelationship() in CollectionPolicy.inc

+							
Gets the name of the relationship to use  for members of this collection.

+					

+			

+						Method
+			getRelationshipElement
+					

+		

+			
CollectionClass::getRelationshipElement() in CollectionClass.inc

+					

+			

+						Method
+			getSearchTerms
+					

+		

+			
CollectionPolicy::getSearchTerms() in CollectionPolicy.inc

+							
Gets a list of search terms from the Collection Policy.  If asArray is set  it will return an associative array with the value, field name, and the default value.

+					

+			

+						Method
+			getServices
+					

+		

+			
ContentModel::getServices() in ContentModel.inc

+							
Gets a list of service deployments that this model has.

+					

+			

+						Method
+			getSoapClient
+					

+		

+			
ConnectionHelper::getSoapClient() in ConnectionHelper.inc

+					

+			

+						Method
+			getStagingArea
+					

+		

+			
CollectionPolicy::getStagingArea() in CollectionPolicy.inc

+							
Gets the path to the staging area to use for this  collection. By default recurses to the parent collection  if the staging area is undefined

+					

+			

+						Method
+			getStream
+					

+		

+			
CollectionClass::getStream() in CollectionClass.inc

+					

+			

+						Method
+			getStream
+					

+		

+			
ObjectHelper::getStream() in ObjectHelper.inc

+							
returns a stream from a fedora object given a pid and dsid

+					

+			

+						Method
+			getTerms
+					

+		

+			
SearchClass::getTerms() in SearchClass.inc

+					

+			

+						Method
+			getType
+					

+		

+			
MimeClass::getType() in MimeClass.inc

+							
function: getType  description: An alias to get_mimetype,  for backwards-compatibility with our old mimetype class.

+					

+			

+						Method
+			getXslContent
+					

+		

+			
CollectionClass::getXslContent() in CollectionClass.inc

+							
Queries a collection object for an xslt to format how the  collection of objects is displayed.

+					

+			

+						Method
+			get_all_related_pids
+					

+		

+			
ObjectHelper::get_all_related_pids() in ObjectHelper.inc

+							
Get a tree of related pids - for the basket functionality

+					

+			

+						Method
+			get_and_do_datastream_rules
+					

+		

+			
ObjectHelper::get_and_do_datastream_rules() in ObjectHelper.inc

+							
Look in the content model for rules to run on the specified datastream.

+					

+			

+						Method
+			get_child_pids
+					

+		

+			
ObjectHelper::get_child_pids() in ObjectHelper.inc

+							
Get children of PID - but only 2 levels deep

+					

+			

+						Method
+			get_content_models_list
+					

+		

+			
ObjectHelper::get_content_models_list() in ObjectHelper.inc

+					

+			

+						Method
+			get_datastream
+					

+		

+			
Fedora_Item::get_datastream() in fedora_item.inc

+					

+			

+						Method
+			get_datastreams_list_as_array
+					

+		

+			
Fedora_Item::get_datastreams_list_as_array() in fedora_item.inc

+							
Returns an associative array of this object's datastreams. Results look like this:

+					

+			

+						Method
+			get_datastreams_list_as_SimpleXML
+					

+		

+			
Fedora_Item::get_datastreams_list_as_SimpleXML() in fedora_item.inc

+							
Retrieves and returns a SimpleXML list of this item's datastreams, and stores them  as an instance variable for caching purposes.

+					

+			

+						Method
+			get_datastream_dissemination
+					

+		

+			
Fedora_Item::get_datastream_dissemination() in fedora_item.inc

+					

+			

+						Method
+			get_datastream_history
+					

+		

+			
Fedora_Item::get_datastream_history() in fedora_item.inc

+					

+			

+						Method
+			get_datastream_info
+					

+		

+			
Fedora_Item::get_datastream_info() in fedora_item.inc

+							
*  DatastreamControlGroup controlGroup - String restricted to the values of "X", "M", "R", or "E" (InlineXML,Managed Content,Redirect, or External Referenced).

+					

+			

+						Method
+			get_dissemination
+					

+		

+			
Fedora_Item::get_dissemination() in fedora_item.inc

+					

+			

+						Method
+			get_extension
+					

+		

+			
MimeClass::get_extension() in MimeClass.inc

+							
function: get_extension

+					

+			

+						Function
+			get_file_extension
+					

+		

+			
get_file_extension() in fedora_export.inc

+					

+			

+						Method
+			get_formatted_datastream_list
+					

+		

+			
ObjectHelper::get_formatted_datastream_list() in ObjectHelper.inc

+							
Gets a list of datastreams from an object using its pid

+					

+			

+						Method
+			get_mimetype
+					

+		

+			
MimeClass::get_mimetype() in MimeClass.inc

+							
function: get_mimetype

+					

+			

+						Method
+			get_mimetype_of_datastream
+					

+		

+			
Fedora_Item::get_mimetype_of_datastream() in fedora_item.inc

+							
Returns a MIME type string for the given Datastream ID.

+					

+			

+						Method
+			get_next_PID_in_namespace
+					

+		

+			
Fedora_Item::get_next_PID_in_namespace() in fedora_item.inc

+					

+			

+						Method
+			get_parent_objects
+					

+		

+			
ObjectHelper::get_parent_objects() in ObjectHelper.inc

+							
Gets the parent objects that this object is related to

+					

+			

+						Method
+			get_parent_objects_asHTML
+					

+		

+			
ObjectHelper::get_parent_objects_asHTML() in ObjectHelper.inc

+					

+			

+						Function
+			get_random_image
+					

+		

+			
get_random_image() in image_rotator_tagger_block.inc

+					

+			

+						Function
+			get_related_items_as_array
+					

+		

+			
get_related_items_as_array() in fedora_collection.inc

+					

+			

+						Function
+			get_related_items_as_xml
+					

+		

+			
get_related_items_as_xml() in fedora_collection.inc

+							
Returns an array of pids that match the query contained in teh collection  object's QUERY datastream or in the suppled $query parameter.

+					

+			

+						Method
+			get_relationships
+					

+		

+			
Fedora_Item::get_relationships() in fedora_item.inc

+							
Currently the Fedora API call getRelationships is reporting an uncaught  exception so we will parse the RELS-EXT ourselves and simulate the  documented behaviour.

+					

+			

+						Method
+			get_search_terms_array
+					

+		

+			
SearchClass::get_search_terms_array() in SearchClass.inc

+					

+		

+	
+	

+		
h

+		
top

+		

+	

+	

+			

+						Method
+			handleEditMetadataForm
+					

+		

+			
Herbarium::handleEditMetadataForm() in herbarium.inc

+					

+			

+						Method
+			handleEditMetadataForm
+					

+		

+			
ContentModel::handleEditMetadataForm() in ContentModel.inc

+							
Handles the edit metadata form using the handler specified in the <edit_metadata_method> element  Returns FALSE on failure.

+					

+			

+						Method
+			handleEditMetadataForm
+					

+		

+			
ModsFormBuilder::handleEditMetadataForm() in ModsFormBuilder.inc

+					

+			

+						Method
+			handleEditMetadataForm
+					

+		

+			
IslandoraBook::handleEditMetadataForm() in book.inc

+					

+			

+						Method
+			handleForm
+					

+		

+			
Refworks::handleForm() in Refworks.inc

+					

+			

+						Method
+			handleForm
+					

+		

+			
DarwinCore::handleForm() in DarwinCore.inc

+					

+			

+						Method
+			handleIngestForm
+					

+		

+			
IslandoraBook::handleIngestForm() in book.inc

+					

+			

+						Method
+			handleIngestForm
+					

+		

+			
Herbarium::handleIngestForm() in herbarium.inc

+					

+			

+						Method
+			handleIngestForm
+					

+		

+			
Newspaper::handleIngestForm() in Newspaper.inc

+					

+			

+						Method
+			handleModsForm
+					

+		

+			
ModsFormBuilder::handleModsForm() in ModsFormBuilder.inc

+					

+			

+						Method
+			handleQDCForm
+					

+		

+			
FormBuilder::handleQDCForm() in Flv.inc

+					

+			

+						Class
+			Herbarium
+					

+		

+			
Herbarium in herbarium.inc

+					

+			

+						Function
+			hook_imagebutton_process
+					

+		

+			
hook_imagebutton_process() in tagging_form.inc

+					

+			

+						Page
+			herbarium.inc
+					

+		

+			
herbarium.inc in herbarium.inc

+					

+		

+	
+	

+		
i

+		
top

+		

+	

+	

+			

+						Variable
+			$INGEST_FEDORA_OBJECTS
+					

+		

+			
ObjectHelper::$INGEST_FEDORA_OBJECTS in ObjectHelper.inc

+					

+			

+						Variable
+			$item
+					

+		

+			
TagSet::$item in tagging.inc

+					

+			

+						Variable
+			$item
+					

+		

+			
ModsFormBuilder::$item in ModsFormBuilder.inc

+					

+			

+						Page
+			image_rotator_tagger_block.inc
+					

+		

+			
image_rotator_tagger_block.inc in image_rotator_tagger_block.inc

+					

+			

+						Function
+			ilives_add_single_page_object
+					

+		

+			
ilives_add_single_page_object() in book.inc

+					

+			

+						Function
+			ilives_create_page_objects
+					

+		

+			
ilives_create_page_objects() in book.inc

+							
Create a page object for each element in $image_list as a child object of $pid

+					

+			

+						Method
+			ImageManipulation
+					

+		

+			
ImageManipulation::ImageManipulation() in ImageManipulation.inc

+					

+			

+						Class
+			ImageManipulation
+					

+		

+			
ImageManipulation in ImageManipulation.inc

+					

+			

+						Method
+			import_from_xml_string
+					

+		

+			
Dublin_Core::import_from_xml_string() in dublin_core.inc

+							
Creates a new instance of the class by parsing dc_xml

+					

+			

+						Method
+			incAuthListItem
+					

+		

+			
ContentModel::incAuthListItem() in ContentModel.inc

+							
Increments (or decrements) an authority list item from a form element in the list of elements.

+					

+			

+						Method
+			incFormElement
+					

+		

+			
ContentModel::incFormElement() in ContentModel.inc

+					

+			

+						Method
+			incIngestFormElement
+					

+		

+			
ContentModel::incIngestFormElement() in ContentModel.inc

+							
Increments (or decrements) ingest form element in the list of elements.

+					

+			

+						Method
+			ingestBlankModel
+					

+		

+			
ContentModel::ingestBlankModel() in ContentModel.inc

+							
Ingests a minimum Content Model to the specified pid/dsid.

+					

+			

+						Method
+			ingestBlankPolicy
+					

+		

+			
CollectionPolicy::ingestBlankPolicy() in CollectionPolicy.inc

+							
Ingests a new minimum  Collection Policy datastream to the specified  PID with the DSID specified.  Initializes the policy with the specified values.

+					

+			

+						Method
+			ingestCollectionPolicy
+					

+		

+			
CreateCollection::ingestCollectionPolicy() in CreateCollection.inc

+					

+			

+						Method
+			ingestFromCollection
+					

+		

+			
CollectionPolicy::ingestFromCollection() in CollectionPolicy.inc

+							
Ingests a new Collection Policy datastream to the specified  PID with the DSID specified.  Clones the collection policy from the  source collection pid. Returns false on failure.

+					

+			

+						Method
+			ingestFromFile
+					

+		

+			
ContentModel::ingestFromFile() in ContentModel.inc

+							
Ingests a Content Model from a file to the specified pid/dsid .

+					

+			

+						Method
+			ingestFromFile
+					

+		

+			
CollectionPolicy::ingestFromFile() in CollectionPolicy.inc

+							
Ingests a new Collection Policy datastream to the specified  PID with the DSID specified.  The file should be a valid collection  policy XML.  Returns false on failure.

+					

+			

+						Method
+			ingestFromModel
+					

+		

+			
ContentModel::ingestFromModel() in ContentModel.inc

+							
Ingests a Content Model from an existing model to the specified pid/dsid .

+					

+			

+						Method
+			ingest_from_FOXML
+					

+		

+			
Fedora_Item::ingest_from_FOXML() in fedora_item.inc

+					

+			

+						Method
+			ingest_from_FOXML_file
+					

+		

+			
Fedora_Item::ingest_from_FOXML_file() in fedora_item.inc

+					

+			

+						Method
+			ingest_from_FOXML_files_in_directory
+					

+		

+			
Fedora_Item::ingest_from_FOXML_files_in_directory() in fedora_item.inc

+					

+			

+						Method
+			ingest_new_item
+					

+		

+			
Fedora_Item::ingest_new_item() in fedora_item.inc

+					

+			

+						Class
+			IslandoraBook
+					

+		

+			
IslandoraBook in book.inc

+					

+			

+						Page
+			ImageManipulation.inc
+					

+		

+			
ImageManipulation.inc in ImageManipulation.inc

+					

+		

+	
+	

+		
l

+		
top

+		

+	

+	

+			

+						Method
+			listDatastreams
+					

+		

+			
ContentModel::listDatastreams() in ContentModel.inc

+							
Gets a list of datastreams from the ContentModel  (not including the QDC ds if it is listed).

+					

+			

+						Method
+			load
+					

+		

+			
TagSet::load() in tagging.inc

+					

+			

+						Method
+			loadFromCollection
+					

+		

+			
CollectionPolicy::loadFromCollection() in CollectionPolicy.inc

+							
Constructs a new CollectionPolicy object from the specified  collection PID.  If preFetch is disabled, then Islandora will not get the datastream until needed.

+					

+			

+						Method
+			loadFromFile
+					

+		

+			
XMLDatastream::loadFromFile() in XMLDatastream.inc

+							
Constructs an XMLDatastream object from the XML file specified.

+					

+			

+						Method
+			loadFromModel
+					

+		

+			
ContentModel::loadFromModel() in ContentModel.inc

+							
Constructs a ContentModel object from the PID of the model in Fedora.

+					

+			

+						Method
+			loadFromObject
+					

+		

+			
ContentModel::loadFromObject() in ContentModel.inc

+							
Constructs a ContentModel object from a Fedora item  by getting the first content model from the hasModel relationship.

+					

+			

+						Function
+			log_line
+					

+		

+			
log_line() in fedora_export.inc

+					

+		

+	
+	

+		
m

+		
top

+		

+	

+	

+			

+						Variable
+			$MODS_NS
+					

+		

+			
ModsFormBuilder::$MODS_NS in ModsFormBuilder.inc

+					

+			

+						Method
+			makeObject
+					

+		

+			
ObjectHelper::makeObject() in ObjectHelper.inc

+							
Grabs a stream from fedora sets the mimetype and returns it. $dsID is the  datastream id.   If $forceSoap is set, the function will always buffer the datastream from fedora.  Otherwise, it will  try and use a redirect if possible.

+					

+			

+						Method
+			manipulateImage
+					

+		

+			
ImageManipulation::manipulateImage() in ImageManipulation.inc

+					

+			

+						Constant
+			METS_10
+					

+		

+			
METS_10 in fedora_export.inc

+					

+			

+						Constant
+			METS_11
+					

+		

+			
METS_11 in fedora_export.inc

+					

+			

+						Class
+			MimeClass
+					

+		

+			
MimeClass in MimeClass.inc

+							
This class inspired by Chris Jean's work, here:  http://chrisjean.com/2009/02/14/generating-mime-type-in-php-is-not-magic/

+					

+			

+						Page
+			MimeClass.inc
+					

+		

+			
MimeClass.inc in MimeClass.inc

+					

+			

+						Method
+			modified
+					

+		

+			
RelsExt::modified() in rels-ext.inc

+					

+			

+						Method
+			modify_datastream_by_reference
+					

+		

+			
Fedora_Item::modify_datastream_by_reference() in fedora_item.inc

+					

+			

+						Method
+			modify_datastream_by_value
+					

+		

+			
Fedora_Item::modify_datastream_by_value() in fedora_item.inc

+					

+			

+						Method
+			modify_object
+					

+		

+			
Fedora_Item::modify_object() in fedora_item.inc

+					

+			

+						Class
+			ModsFormBuilder
+					

+		

+			
ModsFormBuilder in ModsFormBuilder.inc

+					

+			

+						Method
+			modsFromForm
+					

+		

+			
ModsFormBuilder::modsFromForm() in ModsFormBuilder.inc

+					

+			

+						Page
+			map_viewer.inc
+					

+		

+			
map_viewer.inc in map_viewer.inc

+					

+			

+						Page
+			ModsFormBuilder.inc
+					

+		

+			
ModsFormBuilder.inc in ModsFormBuilder.inc

+					

+		

+	
+	

+		
n

+		
top

+		

+	

+	

+			

+						Variable
+			$name
+					

+		

+			
ContentModel::$name in ContentModel.inc

+					

+			

+						Class
+			Newspaper
+					

+		

+			
Newspaper in Newspaper.inc

+					

+			

+						Page
+			Newspaper.inc
+					

+		

+			
Newspaper.inc in Newspaper.inc

+					

+		

+	
+	

+		
o

+		
top

+		

+	

+	

+			

+						Variable
+			$objectProfile
+					

+		

+			
Fedora_Item::$objectProfile in fedora_item.inc

+					

+			

+						Variable
+			$OBJECT_HELPER_VIEW_FEDORA
+					

+		

+			
ObjectHelper::$OBJECT_HELPER_VIEW_FEDORA in ObjectHelper.inc

+					

+			

+						Variable
+			$owner
+					

+		

+			
Dublin_Core::$owner in dublin_core.inc

+					

+			

+						Method
+			ObjectHelper
+					

+		

+			
ObjectHelper::ObjectHelper() in ObjectHelper.inc

+					

+			

+						Class
+			ObjectHelper
+					

+		

+			
ObjectHelper in ObjectHelper.inc

+					

+			

+						Page
+			ObjectHelper.inc
+					

+		

+			
ObjectHelper.inc in ObjectHelper.inc

+					

+		

+	
+	

+		
p

+		
top

+		

+	

+	

+			

+						Variable
+			$pid
+					

+		

+			
XMLDatastream::$pid in XMLDatastream.inc

+					

+			

+						Variable
+			$pid
+					

+		

+			
Fedora_Item::$pid in fedora_item.inc

+					

+			

+						Variable
+			$pid
+					

+		

+			
ModsFormBuilder::$pid in ModsFormBuilder.inc

+					

+			

+						Variable
+			$pid_namespace
+					

+		

+			
ContentModel::$pid_namespace in ContentModel.inc

+					

+			

+						Variable
+			$PURGE_FEDORA_OBJECTSANDSTREAMS
+					

+		

+			
ObjectHelper::$PURGE_FEDORA_OBJECTSANDSTREAMS in ObjectHelper.inc

+					

+			

+						Method
+			parseContent
+					

+		

+			
ObjectHelper::parseContent() in ObjectHelper.inc

+							
internal function  uses an xsl to parse the sparql xml returned from the ITQL query

+					

+			

+						Method
+			parse_refworks_item
+					

+		

+			
Refworks::parse_refworks_item() in Refworks.inc

+							
Read the input file and generate a list of Reference items.

+					

+			

+						Method
+			PersonalCollectionClass
+					

+		

+			
PersonalCollectionClass::PersonalCollectionClass() in PersonalCollectionClass.inc

+					

+			

+						Class
+			PersonalCollectionClass
+					

+		

+			
PersonalCollectionClass in PersonalCollectionClass.inc

+					

+			

+						Page
+			PersonalCollectionClass.inc
+					

+		

+			
PersonalCollectionClass.inc in PersonalCollectionClass.inc

+					

+			

+						Method
+			purge
+					

+		

+			
Fedora_Item::purge() in fedora_item.inc

+							
Removes this object form the repository.

+					

+			

+						Method
+			purgeVersions
+					

+		

+			
XMLDatastream::purgeVersions() in XMLDatastream.inc

+							
Purges veersions of the datastream newer than and including the start_date.  If  End date is specified, it can be used to purge a range of versions instead. Date should be in  DATE_RFC822 format

+					

+			

+						Method
+			purge_datastream
+					

+		

+			
Fedora_Item::purge_datastream() in fedora_item.inc

+					

+			

+						Method
+			purge_relationship
+					

+		

+			
Fedora_Item::purge_relationship() in fedora_item.inc

+							
Removes the given relationship from the item's RELS-EXT and re-saves it.

+					

+		

+	
+	

+		
q

+		
top

+		

+	

+	

+			

+						Page
+			QtFormBuilder.php
+					

+		

+			
QtFormBuilder.php in QtFormBuilder.php

+					

+			

+						Page
+			qt_viewer.inc
+					

+		

+			
qt_viewer.inc in qt_viewer.inc

+					

+			

+						Method
+			QtFormBuilder
+					

+		

+			
QtFormBuilder::QtFormBuilder() in QtFormBuilder.php

+					

+			

+						Class
+			QtFormBuilder
+					

+		

+			
QtFormBuilder in QtFormBuilder.php

+					

+			

+						Method
+			quickSearch
+					

+		

+			
SearchClass::quickSearch() in SearchClass.inc

+					

+		

+	
+	

+		
r

+		
top

+		

+	

+	

+			

+						Variable
+			$relsExtArray
+					

+		

+			
RelsExt::$relsExtArray in rels-ext.inc

+					

+			

+						Page
+			rels-ext.inc
+					

+		

+			
rels-ext.inc in rels-ext.inc

+					

+			

+						Page
+			Refworks.inc
+					

+		

+			
Refworks.inc in Refworks.inc

+					

+			

+						Class
+			Refworks
+					

+		

+			
Refworks in Refworks.inc

+					

+			

+						Method
+			Refworks
+					

+		

+			
Refworks::Refworks() in Refworks.inc

+					

+			

+						Class
+			RelsExt
+					

+		

+			
RelsExt in rels-ext.inc

+							
Description of relsext

+					

+			

+						Method
+			RelsExt
+					

+		

+			
RelsExt::RelsExt() in rels-ext.inc

+							
Constructor that builds itself by retrieving the RELS-EXT stream from  the repository for the given Fedora_Item.

+					

+			

+						Constant
+			RELS_EXT_URI
+					

+		

+			
RELS_EXT_URI in fedora_item.inc

+					

+			

+						Method
+			removeAppliesTo
+					

+		

+			
ContentModel::removeAppliesTo() in ContentModel.inc

+					

+			

+						Method
+			removeAuthListItem
+					

+		

+			
ContentModel::removeAuthListItem() in ContentModel.inc

+							
Removes an authority list item from a form element.

+					

+			

+						Method
+			removeDispMeth
+					

+		

+			
ContentModel::removeDispMeth() in ContentModel.inc

+					

+			

+						Method
+			removeDs
+					

+		

+			
ContentModel::removeDs() in ContentModel.inc

+					

+			

+						Method
+			removeEditMetadataMethod
+					

+		

+			
ContentModel::removeEditMetadataMethod() in ContentModel.inc

+							
Removes the edit data method from the Content Model.

+					

+			

+						Method
+			removeForm
+					

+		

+			
ContentModel::removeForm() in ContentModel.inc

+							
Removes the named form.

+					

+			

+						Method
+			removeIngestFormElement
+					

+		

+			
ContentModel::removeIngestFormElement() in ContentModel.inc

+							
Removes an ingest form element from the list of ingest form elements.

+					

+			

+						Method
+			removeIngestMethod
+					

+		

+			
ContentModel::removeIngestMethod() in ContentModel.inc

+					

+			

+						Method
+			removeIngestMethodParam
+					

+		

+			
ContentModel::removeIngestMethodParam() in ContentModel.inc

+					

+			

+						Method
+			removeIngestRule
+					

+		

+			
ContentModel::removeIngestRule() in ContentModel.inc

+					

+			

+						Method
+			removeMimetype
+					

+		

+			
ContentModel::removeMimetype() in ContentModel.inc

+							
Removes an allowed mimetype from the model.

+					

+			

+						Method
+			removeModel
+					

+		

+			
CollectionPolicy::removeModel() in CollectionPolicy.inc

+							
Removes the specified content model from the collection policy.  This will only  prevent future ingests of the removed model to the collection.  $cm should be  a valid ContentModel object.  Returns false on failure or when the CM was not found in  the collection policy.

+					

+			

+						Method
+			removeTerm
+					

+		

+			
CollectionPolicy::removeTerm() in CollectionPolicy.inc

+							
Removes the search term specified by the field parameter from the collection policy.

+					

+			

+						Method
+			renderCollection
+					

+		

+			
CollectionClass::renderCollection() in CollectionClass.inc

+					

+		

+	
+	

+		
s

+		
top

+		

+	

+	

+			

+						Variable
+			$SCHEMA_URI
+					

+		

+			
CollectionPolicy::$SCHEMA_URI in CollectionPolicy.inc

+					

+			

+						Variable
+			$SCHEMA_URI
+					

+		

+			
ContentModel::$SCHEMA_URI in ContentModel.inc

+					

+			

+						Variable
+			$SEARCH_CLASS_ADVANCED_SEARCH_NUMBER_FIELDS
+					

+		

+			
SearchClass::$SEARCH_CLASS_ADVANCED_SEARCH_NUMBER_FIELDS in SearchClass.inc

+					

+			

+						Variable
+			$SECURITY_CLASS_SECURITY_STREAM
+					

+		

+			
SecurityClass::$SECURITY_CLASS_SECURITY_STREAM in SecurityClass.inc

+					

+			

+						Page
+			ShowDemoStreamsInFieldSets.inc
+					

+		

+			
ShowDemoStreamsInFieldSets.inc in ShowDemoStreamsInFieldSets.inc

+					

+			

+						Page
+			ShowStreamsInFieldSets.inc
+					

+		

+			
ShowStreamsInFieldSets.inc in ShowStreamsInFieldSets.inc

+					

+			

+						Page
+			slide_viewer.inc
+					

+		

+			
slide_viewer.inc in slide_viewer.inc

+					

+			

+						Method
+			save
+					

+		

+			
RelsExt::save() in rels-ext.inc

+							
Save the current state of the RELS-EXT array out to the repository item  as a datastream.

+					

+			

+						Method
+			save
+					

+		

+			
Dublin_Core::save() in dublin_core.inc

+					

+			

+						Method
+			save
+					

+		

+			
TagSet::save() in tagging.inc

+							
Saves an associative array of tags to a datastream.

+					

+			

+						Method
+			saveToFedora
+					

+		

+			
XMLDatastream::saveToFedora() in XMLDatastream.inc

+							
Saves the current XML datastream back to fedora.   The XML must validate.

+					

+			

+						Method
+			save_relationships
+					

+		

+			
Fedora_Item::save_relationships() in fedora_item.inc

+							
Creates a RELS-EXT XML stream from the supplied array and saves it to  the item on the server.

+					

+			

+						Class
+			SearchClass
+					

+		

+			
SearchClass in SearchClass.inc

+					

+			

+						Page
+			SearchClass.inc
+					

+		

+			
SearchClass.inc in SearchClass.inc

+					

+			

+						Class
+			SecurityClass
+					

+		

+			
SecurityClass in SecurityClass.inc

+					

+			

+						Method
+			SecurityClass
+					

+		

+			
SecurityClass::SecurityClass() in SecurityClass.inc

+					

+			

+						Page
+			SecurityClass.inc
+					

+		

+			
SecurityClass.inc in SecurityClass.inc

+					

+			

+						Method
+			setDefaultDispMeth
+					

+		

+			
ContentModel::setDefaultDispMeth() in ContentModel.inc

+					

+			

+						Method
+			setDefaultTerm
+					

+		

+			
CollectionPolicy::setDefaultTerm() in CollectionPolicy.inc

+					

+			

+						Method
+			setDisplayInFieldset
+					

+		

+			
ContentModel::setDisplayInFieldset() in ContentModel.inc

+					

+			

+						Method
+			setIngestFormElementParam
+					

+		

+			
ContentModel::setIngestFormElementParam() in ContentModel.inc

+							
Sets a parameter of an ingest form element.  If the value of the element is FALSE the parameter  will be removed entirely (if you want to store false as a value, then send the String "false").

+					

+			

+						Method
+			setRelationship
+					

+		

+			
CollectionPolicy::setRelationship() in CollectionPolicy.inc

+							
Sets the name of the relationship to use  for members of this collection.

+					

+			

+						Method
+			setStagingArea
+					

+		

+			
CollectionPolicy::setStagingArea() in CollectionPolicy.inc

+							
Sets the path to the staging area to use for this  collection. If specified path is blank (or false) it will  remove the staging are path element from the collection policy.

+					

+			

+						Method
+			set_allowed_users_and_roles
+					

+		

+			
SecurityClass::set_allowed_users_and_roles() in SecurityClass.inc

+							
Add a list of allowed users and roles to the given policy stream and return it.

+					

+			

+						Method
+			set_element
+					

+		

+			
Dublin_Core::set_element() in dublin_core.inc

+							
Replace the given DC element with the values in $values

+					

+			

+						Method
+			showArtInventoryTN
+					

+		

+			
ShowStreamsInFieldSets::showArtInventoryTN() in ShowStreamsInFieldSets.inc

+					

+			

+						Class
+			ShowDemoStreamsInFieldSets
+					

+		

+			
ShowDemoStreamsInFieldSets in ShowDemoStreamsInFieldSets.inc

+					

+			

+						Method
+			ShowDemoStreamsInFieldSets
+					

+		

+			
ShowDemoStreamsInFieldSets::ShowDemoStreamsInFieldSets() in ShowDemoStreamsInFieldSets.inc

+					

+			

+						Method
+			showFieldSets
+					

+		

+			
Newspaper::showFieldSets() in Newspaper.inc

+					

+			

+						Method
+			showFieldSets
+					

+		

+			
Herbarium::showFieldSets() in herbarium.inc

+					

+			

+						Method
+			showFieldSets
+					

+		

+			
FedoraObject::showFieldSets() in fedoraObject.inc

+					

+			

+						Method
+			showFieldSets
+					

+		

+			
IslandoraBook::showFieldSets() in book.inc

+					

+			

+						Method
+			showFieldSets
+					

+		

+			
CollectionClass::showFieldSets() in CollectionClass.inc

+					

+			

+						Method
+			showFlv
+					

+		

+			
ShowStreamsInFieldSets::showFlv() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			ShowILivesStreamsInFieldSets
+					

+		

+			
ShowILivesStreamsInFieldSets::ShowILivesStreamsInFieldSets() in image_rotator_tagger_block.inc

+					

+			

+						Class
+			ShowILivesStreamsInFieldSets
+					

+		

+			
ShowILivesStreamsInFieldSets in image_rotator_tagger_block.inc

+					

+			

+						Method
+			showJP2
+					

+		

+			
ShowStreamsInFieldSets::showJP2() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			showJPG
+					

+		

+			
ShowILivesStreamsInFieldSets::showJPG() in image_rotator_tagger_block.inc

+					

+			

+						Method
+			showJPG
+					

+		

+			
ShowMapStreamsInFieldSets::showJPG() in map_viewer.inc

+					

+			

+						Method
+			showJPG
+					

+		

+			
ShowSlideStreamsInFieldSets::showJPG() in slide_viewer.inc

+					

+			

+						Class
+			ShowMapStreamsInFieldSets
+					

+		

+			
ShowMapStreamsInFieldSets in map_viewer.inc

+					

+			

+						Method
+			ShowMapStreamsInFieldSets
+					

+		

+			
ShowMapStreamsInFieldSets::ShowMapStreamsInFieldSets() in map_viewer.inc

+					

+			

+						Method
+			showMediumSize
+					

+		

+			
ShowDemoStreamsInFieldSets::showMediumSize() in ShowDemoStreamsInFieldSets.inc

+					

+			

+						Method
+			showOBJLink
+					

+		

+			
ShowStreamsInFieldSets::showOBJLink() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			showPageFieldSets
+					

+		

+			
Newspaper::showPageFieldSets() in Newspaper.inc

+					

+			

+						Method
+			showPDFPreview
+					

+		

+			
ShowStreamsInFieldSets::showPDFPreview() in ShowStreamsInFieldSets.inc

+							
Embed Google Docs' PDF viewer into the page.

+					

+			

+						Method
+			showQdc
+					

+		

+			
ShowStreamsInFieldSets::showQdc() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			showQt
+					

+		

+			
ShowQtStreamsInFieldSets::showQt() in qt_viewer.inc

+					

+			

+						Method
+			ShowQtStreamsInFieldSets
+					

+		

+			
ShowQtStreamsInFieldSets::ShowQtStreamsInFieldSets() in qt_viewer.inc

+					

+			

+						Class
+			ShowQtStreamsInFieldSets
+					

+		

+			
ShowQtStreamsInFieldSets in qt_viewer.inc

+					

+			

+						Method
+			showRefworks
+					

+		

+			
ShowStreamsInFieldSets::showRefworks() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			showRomeo
+					

+		

+			
ShowStreamsInFieldSets::showRomeo() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			ShowSlideStreamsInFieldSets
+					

+		

+			
ShowSlideStreamsInFieldSets::ShowSlideStreamsInFieldSets() in slide_viewer.inc

+					

+			

+						Class
+			ShowSlideStreamsInFieldSets
+					

+		

+			
ShowSlideStreamsInFieldSets in slide_viewer.inc

+					

+			

+						Class
+			ShowStreamsInFieldSets
+					

+		

+			
ShowStreamsInFieldSets in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			ShowStreamsInFieldSets
+					

+		

+			
ShowStreamsInFieldSets::ShowStreamsInFieldSets() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			showTN
+					

+		

+			
ShowStreamsInFieldSets::showTN() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			soap_call
+					

+		

+			
Fedora_Item::soap_call() in fedora_item.inc

+					

+			

+						Method
+			solr_search
+					

+		

+			
SearchClass::solr_search() in SearchClass.inc

+					

+			

+						Function
+			str_getcsv
+					

+		

+			
str_getcsv() in fedora_utils.inc

+					

+		

+	
+	

+		
t

+		
top

+		

+	

+	

+			

+						Variable
+			$tags
+					

+		

+			
TagSet::$tags in tagging.inc

+					

+			

+						Variable
+			$tagsDSID
+					

+		

+			
TagSet::$tagsDSID in tagging.inc

+					

+			

+						Page
+			tagging.inc
+					

+		

+			
tagging.inc in tagging.inc

+					

+			

+						Page
+			tagging_form.inc
+					

+		

+			
tagging_form.inc in tagging_form.inc

+					

+			

+						Method
+			TagSet
+					

+		

+			
TagSet::TagSet() in tagging.inc

+					

+			

+						Class
+			TagSet
+					

+		

+			
TagSet in tagging.inc

+							
Description of tagging

+					

+			

+						Method
+			technicalMetadata
+					

+		

+			
ShowQtStreamsInFieldSets::technicalMetadata() in qt_viewer.inc

+					

+			

+						Method
+			theme_advanced_search_form
+					

+		

+			
SearchClass::theme_advanced_search_form() in SearchClass.inc

+					

+			

+						Method
+			theme_solr_search_form
+					

+		

+			
SearchClass::theme_solr_search_form() in SearchClass.inc

+					

+			

+						Function
+			transform_mods_to_dc
+					

+		

+			
transform_mods_to_dc() in book.inc

+					

+		

+	
+	

+		
u

+		
top

+		

+	

+	

+			

+						Method
+			updateEditMetadataMethod
+					

+		

+			
ContentModel::updateEditMetadataMethod() in ContentModel.inc

+							
Update the Edit Metadata Method defined in the Content Model

+					

+			

+						Method
+			updateMetaData
+					

+		

+			
formClass::updateMetaData() in formClass.inc

+					

+			

+						Method
+			url
+					

+		

+			
Fedora_Item::url() in fedora_item.inc

+					

+		

+	
+	

+		
v

+		
top

+		

+	

+	

+			

+						Variable
+			$VIEW_DETAILED_CONTENT_LIST
+					

+		

+			
ObjectHelper::$VIEW_DETAILED_CONTENT_LIST in ObjectHelper.inc

+					

+			

+						Variable
+			$vocabulary
+					

+		

+			
DarwinCore::$vocabulary in DarwinCore.inc

+					

+			

+						Method
+			validate
+					

+		

+			
XMLDatastream::validate() in XMLDatastream.inc

+							
Validates the XMLDatastream against the schema location

+					

+			

+						Method
+			validDsid
+					

+		

+			
XMLDatastream::validDsid() in XMLDatastream.inc

+							
validDsid  Validates a fedora Dsid based on the the allowed XML standard NCName.

+					

+			

+						Function
+			validDsid
+					

+		

+			
validDsid() in fedora_utils.inc

+					

+			

+						Method
+			validPid
+					

+		

+			
XMLDatastream::validPid() in XMLDatastream.inc

+							
validPid  Validates a fedora PID based on the regexp provided in the fedora  3.3 documentation.

+					

+			

+						Function
+			validPid
+					

+		

+			
validPid() in fedora_utils.inc

+					

+		

+	
+	

+		
w

+		
top

+		

+	

+	

+			

+						Method
+			warnIfMisconfigured
+					

+		

+			
ObjectHelper::warnIfMisconfigured() in ObjectHelper.inc

+					

+		

+	
+	

+		
x

+		
top

+		

+	

+	

+			

+						Variable
+			$xml
+					

+		

+			
XMLDatastream::$xml in XMLDatastream.inc

+					

+			

+						Variable
+			$XMLNS
+					

+		

+			
XMLDatastream::$XMLNS in XMLDatastream.inc

+					

+			

+						Class
+			XMLDatastream
+					

+		

+			
XMLDatastream in XMLDatastream.inc

+					

+			

+						Page
+			XMLDatastream.inc
+					

+		

+			
XMLDatastream.inc in XMLDatastream.inc

+					

+		

+	
+	

+		
_

+		
top

+		

+	

+	

+			

+						Function
+			_fedora_image_rotator_tagger_block_content
+					

+		

+			
_fedora_image_rotator_tagger_block_content() in image_rotator_tagger_block.inc

+					

+			

+						Method
+			_fixURL
+					

+		

+			
ConnectionHelper::_fixURL() in ConnectionHelper.inc

+					

+			

+						Function
+			_show_subject_tags
+					

+		

+			
_show_subject_tags() in tagging_form.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
Herbarium::__construct() in herbarium.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
MimeClass::__construct() in MimeClass.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
Newspaper::__construct() in Newspaper.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
XMLDatastream::__construct() in XMLDatastream.inc

+							
Constructor  NOTE: Use the static constructor methods whenever possible.

+					

+			

+						Method
+			__construct
+					

+		

+			
Fedora_Item::__construct() in fedora_item.inc

+							
Create an object to represent an item in the Fedora repository.

+					

+			

+						Method
+			__construct
+					

+		

+			
ModsFormBuilder::__construct() in ModsFormBuilder.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
FedoraObject::__construct() in fedoraObject.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
CollectionPolicy::__construct() in CollectionPolicy.inc

+							
Constructor  NOTE: Use the static constructor methods whenever possible.

+					

+			

+						Method
+			__construct
+					

+		

+			
CollectionClass::__construct() in CollectionClass.inc

+							
Creates a collection object. Optionally can associate it with a single collection with parameter $pid.

+					

+			

+						Method
+			__construct
+					

+		

+			
ContentModel::__construct() in ContentModel.inc

+							
Constructor  NOTE: Use the static constructor methods whenever possible.

+					

+			

+						Method
+			__construct
+					

+		

+			
DarwinCore::__construct() in DarwinCore.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
Exiftool::__construct() in Exiftool.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
DocumentConverter::__construct() in DocumentConverter.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
IslandoraBook::__construct() in book.inc

+					

+		

+
+

+	a
+	b
+	c
+	d
+	e
+	f
+	g
+	h
+	i
+	l
+	m
+	n
+	o
+	p
+	q
+	r
+	s
+	t
+	u
+	v
+	w
+	x
+	_
+
	
+
\ No newline at end of file
diff --git a/docs/elementindex_Islandora.html b/docs/elementindex_Islandora.html
new file mode 100644
index 00000000..42b07eb3
--- /dev/null
+++ b/docs/elementindex_Islandora.html
@@ -0,0 +1,3908 @@
+
+
+  
+		
+			
+			
+			
+											
+		
+						
+
[Islandora] element index

+All elements
+

+

+	a
+	b
+	c
+	d
+	e
+	f
+	g
+	h
+	i
+	l
+	m
+	n
+	o
+	p
+	q
+	r
+	s
+	t
+	u
+	v
+	w
+	x
+	_
+

+
+	
+	

+		
_

+		
top

+		

+	

+	

+			

+						Function
+			_fedora_image_rotator_tagger_block_content
+					

+		

+			
_fedora_image_rotator_tagger_block_content() in image_rotator_tagger_block.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
Newspaper::__construct() in Newspaper.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
IslandoraBook::__construct() in book.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
Fedora_Item::__construct() in fedora_item.inc

+							
Create an object to represent an item in the Fedora repository.

+					

+			

+						Function
+			_show_subject_tags
+					

+		

+			
_show_subject_tags() in tagging_form.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
ModsFormBuilder::__construct() in ModsFormBuilder.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
Herbarium::__construct() in herbarium.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
FedoraObject::__construct() in fedoraObject.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
DocumentConverter::__construct() in DocumentConverter.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
Exiftool::__construct() in Exiftool.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
DarwinCore::__construct() in DarwinCore.inc

+					

+			

+						Method
+			_fixURL
+					

+		

+			
ConnectionHelper::_fixURL() in ConnectionHelper.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
XMLDatastream::__construct() in XMLDatastream.inc

+							
Constructor  NOTE: Use the static constructor methods whenever possible.

+					

+			

+						Method
+			__construct
+					

+		

+			
MimeClass::__construct() in MimeClass.inc

+					

+			

+						Method
+			__construct
+					

+		

+			
ContentModel::__construct() in ContentModel.inc

+							
Constructor  NOTE: Use the static constructor methods whenever possible.

+					

+			

+						Method
+			__construct
+					

+		

+			
CollectionClass::__construct() in CollectionClass.inc

+							
Creates a collection object. Optionally can associate it with a single collection with parameter $pid.

+					

+			

+						Method
+			__construct
+					

+		

+			
CollectionPolicy::__construct() in CollectionPolicy.inc

+							
Constructor  NOTE: Use the static constructor methods whenever possible.

+					

+		

+	
+	

+		
a

+		
top

+		

+	

+	

+			

+						Method
+			add_datastream_from_file
+					

+		

+			
Fedora_Item::add_datastream_from_file() in fedora_item.inc

+					

+			

+						Method
+			add_datastream_from_string
+					

+		

+			
Fedora_Item::add_datastream_from_string() in fedora_item.inc

+					

+			

+						Method
+			add_datastream_from_url
+					

+		

+			
Fedora_Item::add_datastream_from_url() in fedora_item.inc

+					

+			

+						Method
+			add_element
+					

+		

+			
Dublin_Core::add_element() in dublin_core.inc

+					

+			

+						Method
+			add_relationship
+					

+		

+			
Fedora_Item::add_relationship() in fedora_item.inc

+							
Add a relationship string to this object's RELS-EXT.

+					

+			

+						Method
+			as_xml
+					

+		

+			
Dublin_Core::as_xml() in dublin_core.inc

+							
Serialize this object to XML and return it.

+					

+			

+						Constant
+			ATOMZip_11
+					

+		

+			
ATOMZip_11 in fedora_export.inc

+					

+			

+						Constant
+			ATOM_11
+					

+		

+			
ATOM_11 in fedora_export.inc

+					

+			

+						Method
+			asHTML
+					

+		

+			
DarwinCore::asHTML() in DarwinCore.inc

+					

+			

+						Method
+			asXML
+					

+		

+			
DarwinCore::asXML() in DarwinCore.inc

+					

+			

+						Variable
+			$ADD_FEDORA_STREAMS
+					

+		

+			
ObjectHelper::$ADD_FEDORA_STREAMS in ObjectHelper.inc

+					

+			

+						Variable
+			$availableDataStreamsText
+					

+		

+			
ObjectHelper::$availableDataStreamsText in ObjectHelper.inc

+					

+			

+						Method
+			addAppliesTo
+					

+		

+			
ContentModel::addAppliesTo() in ContentModel.inc

+					

+			

+						Method
+			addAuthListItem
+					

+		

+			
ContentModel::addAuthListItem() in ContentModel.inc

+							
Adds an authority list item to a form element.

+					

+			

+						Method
+			addDispMeth
+					

+		

+			
ContentModel::addDispMeth() in ContentModel.inc

+					

+			

+						Method
+			addDs
+					

+		

+			
ContentModel::addDs() in ContentModel.inc

+					

+			

+						Method
+			addElementToForm
+					

+		

+			
ContentModel::addElementToForm() in ContentModel.inc

+					

+			

+						Method
+			addForm
+					

+		

+			
ContentModel::addForm() in ContentModel.inc

+							
Adds the named form.

+					

+			

+						Method
+			addIngestFormElement
+					

+		

+			
ContentModel::addIngestFormElement() in ContentModel.inc

+							
Add an ingest form element to the model.

+					

+			

+						Method
+			addIngestMethod
+					

+		

+			
ContentModel::addIngestMethod() in ContentModel.inc

+					

+			

+						Method
+			addIngestMethodParam
+					

+		

+			
ContentModel::addIngestMethodParam() in ContentModel.inc

+					

+			

+						Method
+			addIngestRule
+					

+		

+			
ContentModel::addIngestRule() in ContentModel.inc

+					

+			

+						Method
+			addMimetype
+					

+		

+			
ContentModel::addMimetype() in ContentModel.inc

+							
Adds an allowed mimetype to the model.

+					

+			

+						Method
+			addModel
+					

+		

+			
CollectionPolicy::addModel() in CollectionPolicy.inc

+					

+			

+						Method
+			addTerm
+					

+		

+			
CollectionPolicy::addTerm() in CollectionPolicy.inc

+							
Adds a search term to the collection policy.

+					

+			

+						Method
+			applyLuceneXSLT
+					

+		

+			
SearchClass::applyLuceneXSLT() in SearchClass.inc

+							
apply an xslt to lucene gsearch search results

+					

+			

+						Method
+			applySpecifiedXSLT
+					

+		

+			
SearchClass::applySpecifiedXSLT() in SearchClass.inc

+					

+			

+						Method
+			applyXSLT
+					

+		

+			
SearchClass::applyXSLT() in SearchClass.inc

+					

+		

+	
+	

+		
b

+		
top

+		

+	

+	

+			

+						Function
+			book_add_pages_form
+					

+		

+			
book_add_pages_form() in book.inc

+					

+			

+						Function
+			book_add_pages_form_submit
+					

+		

+			
book_add_pages_form_submit() in book.inc

+					

+			

+						Function
+			book_add_pages_form_validate
+					

+		

+			
book_add_pages_form_validate() in book.inc

+					

+			

+						Method
+			buildAddPagesForm
+					

+		

+			
IslandoraBook::buildAddPagesForm() in book.inc

+					

+			

+						Method
+			buildDrupalForm
+					

+		

+			
Newspaper::buildDrupalForm() in Newspaper.inc

+					

+			

+						Method
+			buildDrupalForm
+					

+		

+			
IslandoraBook::buildDrupalForm() in book.inc

+					

+			

+						Method
+			buildEditMetadataForm
+					

+		

+			
IslandoraBook::buildEditMetadataForm() in book.inc

+					

+			

+						Page
+			book.inc
+					

+		

+			
book.inc in book.inc

+					

+			

+						Method
+			buildDrupalForm
+					

+		

+			
DarwinCore::buildDrupalForm() in DarwinCore.inc

+					

+			

+						Method
+			buildDrupalForm
+					

+		

+			
Herbarium::buildDrupalForm() in herbarium.inc

+					

+			

+						Method
+			buildEditMetadataForm
+					

+		

+			
ModsFormBuilder::buildEditMetadataForm() in ModsFormBuilder.inc

+					

+			

+						Method
+			buildEditMetadataForm
+					

+		

+			
Herbarium::buildEditMetadataForm() in herbarium.inc

+					

+			

+						Method
+			buildForm
+					

+		

+			
Refworks::buildForm() in Refworks.inc

+					

+			

+						Method
+			buildQDCForm
+					

+		

+			
FormBuilder::buildQDCForm() in Flv.inc

+					

+			

+						Method
+			buildEditMetadataForm
+					

+		

+			
ContentModel::buildEditMetadataForm() in ContentModel.inc

+							
Builds an edit metadata form using the method specified in the <edit_metadata_method> element

+					

+			

+						Method
+			buildIngestForm
+					

+		

+			
ContentModel::buildIngestForm() in ContentModel.inc

+							
Builds an ingest form using the method specified in  <form_builder_method> element of <ingest_form>  Returns FALSE on failure.

+					

+			

+						Method
+			build_advanced_search_form
+					

+		

+			
SearchClass::build_advanced_search_form() in SearchClass.inc

+					

+			

+						Method
+			build_ingest_form
+					

+		

+			
CollectionClass::build_ingest_form() in CollectionClass.inc

+							
grabs a xml form definition from a content model and builds

+					

+			

+						Method
+			build_simple_solr_form
+					

+		

+			
SearchClass::build_simple_solr_form() in SearchClass.inc

+					

+			

+						Method
+			build_solr_search_form
+					

+		

+			
SearchClass::build_solr_search_form() in SearchClass.inc

+					

+		

+	
+	

+		
c

+		
top

+		

+	

+	

+			

+						Method
+			create_dc_from_dict
+					

+		

+			
Dublin_Core::create_dc_from_dict() in dublin_core.inc

+					

+			

+						Method
+			create_object_FOXML
+					

+		

+			
Fedora_Item::create_object_FOXML() in fedora_item.inc

+							
Creates the minimal FOXML for a new Fedora object, which is then passed to  ingest_from_FOXML to be added to the repository.

+					

+			

+						Variable
+			$cm
+					

+		

+			
ModsFormBuilder::$cm in ModsFormBuilder.inc

+					

+			

+						Method
+			CollectionFormBuilder
+					

+		

+			
CollectionFormBuilder::CollectionFormBuilder() in CollectionFormBuilder.inc

+					

+			

+						Class
+			CollectionFormBuilder
+					

+		

+			
CollectionFormBuilder in CollectionFormBuilder.inc

+					

+			

+						Method
+			convert
+					

+		

+			
DocumentConverter::convert() in DocumentConverter.inc

+					

+			

+						Method
+			createChildPolicyStream
+					

+		

+			
PersonalCollectionClass::createChildPolicyStream() in PersonalCollectionClass.inc

+					

+			

+						Method
+			createCollection
+					

+		

+			
PersonalCollectionClass::createCollection() in PersonalCollectionClass.inc

+					

+			

+						Method
+			CreateCollection
+					

+		

+			
CreateCollection::CreateCollection() in CreateCollection.inc

+					

+			

+						Class
+			CreateCollection
+					

+		

+			
CreateCollection in CreateCollection.inc

+					

+			

+						Method
+			createCollectionPolicy
+					

+		

+			
ModsFormBuilder::createCollectionPolicy() in ModsFormBuilder.inc

+					

+			

+						Method
+			createCollectionPolicyStream
+					

+		

+			
PersonalCollectionClass::createCollectionPolicyStream() in PersonalCollectionClass.inc

+					

+			

+						Method
+			createDCStream
+					

+		

+			
PersonalCollectionClass::createDCStream() in PersonalCollectionClass.inc

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
CollectionFormBuilder::createFedoraDataStreams() in CollectionFormBuilder.inc

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
DemoFormBuilder::createFedoraDataStreams() in DemoFormBuilder.inc

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
Refworks::createFedoraDataStreams() in Refworks.inc

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
FlvFormBuilder::createFedoraDataStreams() in FlvFormBuilder.inc

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
FormBuilder::createFedoraDataStreams() in Flv.inc

+					

+			

+						Method
+			createFedoraDataStreams
+					

+		

+			
QtFormBuilder::createFedoraDataStreams() in QtFormBuilder.php

+					

+			

+						Method
+			createJP2
+					

+		

+			
ImageManipulation::createJP2() in ImageManipulation.inc

+					

+			

+						Method
+			createModsStream
+					

+		

+			
ModsFormBuilder::createModsStream() in ModsFormBuilder.inc

+					

+			

+						Method
+			createPNG
+					

+		

+			
ImageManipulation::createPNG() in ImageManipulation.inc

+					

+			

+						Method
+			createPolicyStream
+					

+		

+			
PersonalCollectionClass::createPolicyStream() in PersonalCollectionClass.inc

+					

+			

+						Method
+			createPreview
+					

+		

+			
ImageManipulation::createPreview() in ImageManipulation.inc

+					

+			

+						Method
+			createQDCStream
+					

+		

+			
FormBuilder::createQDCStream() in Flv.inc

+					

+			

+						Method
+			createQDCStream
+					

+		

+			
Refworks::createQDCStream() in Refworks.inc

+					

+			

+						Method
+			createRelationShips
+					

+		

+			
FormBuilder::createRelationShips() in Flv.inc

+							
creates the RELS-EXT for the foxml

+					

+			

+						Method
+			createRelationShips
+					

+		

+			
Refworks::createRelationShips() in Refworks.inc

+							
Creates the RELS-EXT for the foxml

+					

+			

+						Method
+			createRomeoDataStream
+					

+		

+			
Refworks::createRomeoDataStream() in Refworks.inc

+					

+			

+						Method
+			createStandardFedoraStuff
+					

+		

+			
Refworks::createStandardFedoraStuff() in Refworks.inc

+							
Creates the standard foxml properties

+					

+			

+						Method
+			createStandardFedoraStuff
+					

+		

+			
FormBuilder::createStandardFedoraStuff() in Flv.inc

+							
creates the standard foxml properties

+					

+			

+						Method
+			createStandardFedoraStuff
+					

+		

+			
PersonalCollectionClass::createStandardFedoraStuff() in PersonalCollectionClass.inc

+					

+			

+						Method
+			createThumbnail
+					

+		

+			
ImageManipulation::createThumbnail() in ImageManipulation.inc

+					

+			

+						Method
+			createThumbnailFromPDF
+					

+		

+			
ImageManipulation::createThumbnailFromPDF() in ImageManipulation.inc

+					

+			

+						Method
+			createWorkflowStream
+					

+		

+			
ModsFormBuilder::createWorkflowStream() in ModsFormBuilder.inc

+					

+			

+						Method
+			create_security_policies
+					

+		

+			
Refworks::create_security_policies() in Refworks.inc

+							
Read the list of Users from the U1 field and Roles from the U2 field and add elements  to the security policy record for this item, then add the record as the security policy datastream.

+					

+			

+						Page
+			CollectionFormBuilder.inc
+					

+		

+			
CollectionFormBuilder.inc in CollectionFormBuilder.inc

+					

+			

+						Page
+			CreateCollection.inc
+					

+		

+			
CreateCollection.inc in CreateCollection.inc

+					

+			

+						Variable
+			$collectionObject
+					

+		

+			
CollectionClass::$collectionObject in CollectionClass.inc

+					

+			

+						Variable
+			$COLLECTION_CLASS_COLLECTION_POLICY_STREAM
+					

+		

+			
CollectionClass::$COLLECTION_CLASS_COLLECTION_POLICY_STREAM in CollectionClass.inc

+					

+			

+						Variable
+			$COLLECTION_CLASS_COLLECTION_VIEW_STREAM
+					

+		

+			
CollectionClass::$COLLECTION_CLASS_COLLECTION_VIEW_STREAM in CollectionClass.inc

+					

+			

+						Method
+			callMethods
+					

+		

+			
CollectionClass::callMethods() in CollectionClass.inc

+							
calls the methods defined in the content model rules .xml file stored in a Fedora object

+					

+			

+						Method
+			canIngestHere
+					

+		

+			
SecurityClass::canIngestHere() in SecurityClass.inc

+					

+			

+						Method
+			canShowIngestForm
+					

+		

+			
formClass::canShowIngestForm() in formClass.inc

+							
Drupal's permissions at this point no xacml yet. xacml decisions are made by fedora

+					

+			

+						Method
+			can_ingest_here
+					

+		

+			
formClass::can_ingest_here() in formClass.inc

+					

+			

+						Class
+			CollectionClass
+					

+		

+			
CollectionClass in CollectionClass.inc

+					

+			

+						Page
+			CollectionClass.inc
+					

+		

+			
CollectionClass.inc in CollectionClass.inc

+					

+			

+						Class
+			CollectionPolicy
+					

+		

+			
CollectionPolicy in CollectionPolicy.inc

+					

+			

+						Page
+			CollectionPolicy.inc
+					

+		

+			
CollectionPolicy.inc in CollectionPolicy.inc

+					

+			

+						Method
+			ConnectionHelper
+					

+		

+			
ConnectionHelper::ConnectionHelper() in ConnectionHelper.inc

+					

+			

+						Class
+			ConnectionHelper
+					

+		

+			
ConnectionHelper in ConnectionHelper.inc

+					

+			

+						Page
+			ConnectionHelper.inc
+					

+		

+			
ConnectionHelper.inc in ConnectionHelper.inc

+					

+			

+						Class
+			ContentModel
+					

+		

+			
ContentModel in ContentModel.inc

+					

+			

+						Page
+			ContentModel.inc
+					

+		

+			
ContentModel.inc in ContentModel.inc

+					

+			

+						Method
+			convertFromOldSchema
+					

+		

+			
XMLDatastream::convertFromOldSchema() in XMLDatastream.inc

+							
Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..

+					

+			

+						Method
+			convertFromOldSchema
+					

+		

+			
ContentModel::convertFromOldSchema() in ContentModel.inc

+							
Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..

+					

+			

+						Method
+			convertFromOldSchema
+					

+		

+			
CollectionPolicy::convertFromOldSchema() in CollectionPolicy.inc

+							
Attempts to convert from the old XML schema to the new by  traversing the XML DOM and building a new DOM.  When done  $this->xml is replaced by the newly created DOM..

+					

+			

+						Method
+			createAddDataStreamForm
+					

+		

+			
formClass::createAddDataStreamForm() in formClass.inc

+					

+			

+						Method
+			createAdminForm
+					

+		

+			
formClass::createAdminForm() in formClass.inc

+					

+			

+						Method
+			createExtraFieldsets
+					

+		

+			
ObjectHelper::createExtraFieldsets() in ObjectHelper.inc

+							
gets a list of datastreams and related function that we should use to show datastreams in their own fieldsets

+					

+			

+						Method
+			createIngestForm
+					

+		

+			
formClass::createIngestForm() in formClass.inc

+							
Create a multi step form (wizard) for ingesting objects into Fedora

+					

+			

+						Method
+			createMenu
+					

+		

+			
formClass::createMenu() in formClass.inc

+					

+			

+						Method
+			createMetaDataForm
+					

+		

+			
formClass::createMetaDataForm() in formClass.inc

+							
Creates a drupal form to edit either the QDC or DC datastream

+					

+			

+						Method
+			createPersonalPolicy
+					

+		

+			
SecurityClass::createPersonalPolicy() in SecurityClass.inc

+					

+			

+						Method
+			createQDCEditForm
+					

+		

+			
formClass::createQDCEditForm() in formClass.inc

+							
Create edit form.

+					

+			

+						Method
+			createQDCIngestForm
+					

+		

+			
formClass::createQDCIngestForm() in formClass.inc

+							
Create the QDC Ingest Form.

+					

+			

+						Method
+			createQDCIngestFormPageOne
+					

+		

+			
formClass::createQDCIngestFormPageOne() in formClass.inc

+							
Creates the first page of the ingest form for editing QDC.

+					

+			

+						Method
+			createQDCIngestFormPageTwo
+					

+		

+			
formClass::createQDCIngestFormPageTwo() in formClass.inc

+							
Create the second page of the ingest form for editing QDC

+					

+			

+						Method
+			createReplaceDataStreamForm
+					

+		

+			
formClass::createReplaceDataStreamForm() in formClass.inc

+							
Creates a form for replacing datastream

+					

+			

+						Method
+			createUserCollection
+					

+		

+			
CollectionClass::createUserCollection() in CollectionClass.inc

+					

+			

+						Method
+			create_link_for_ds
+					

+		

+			
ObjectHelper::create_link_for_ds() in ObjectHelper.inc

+							
internal function

+					

+			

+						Method
+			custom_search
+					

+		

+			
SearchClass::custom_search() in SearchClass.inc

+					

+		

+	
+	

+		
d

+		
top

+		

+	

+	

+			

+						Variable
+			$datastreams
+					

+		

+			
Fedora_Item::$datastreams in fedora_item.inc

+					

+			

+						Variable
+			$dc
+					

+		

+			
Dublin_Core::$dc in dublin_core.inc

+					

+			

+						Page
+			dublin_core.inc
+					

+		

+			
dublin_core.inc in dublin_core.inc

+					

+			

+						Function
+			do_curl
+					

+		

+			
do_curl() in fedora_utils.inc

+					

+			

+						Method
+			Dublin_Core
+					

+		

+			
Dublin_Core::Dublin_Core() in dublin_core.inc

+							
Constructs a Dublin_Core object from a Fedora_Item object and populates  the $dc array.

+					

+			

+						Class
+			Dublin_Core
+					

+		

+			
Dublin_Core in dublin_core.inc

+					

+			

+						Variable
+			$darwinCoreXML
+					

+		

+			
DarwinCore::$darwinCoreXML in DarwinCore.inc

+					

+			

+						Variable
+			$dwcFields
+					

+		

+			
DarwinCore::$dwcFields in DarwinCore.inc

+					

+			

+						Class
+			DarwinCore
+					

+		

+			
DarwinCore in DarwinCore.inc

+					

+			

+						Method
+			DemoFormBuilder
+					

+		

+			
DemoFormBuilder::DemoFormBuilder() in DemoFormBuilder.inc

+					

+			

+						Class
+			DemoFormBuilder
+					

+		

+			
DemoFormBuilder in DemoFormBuilder.inc

+					

+			

+						Method
+			displayMetadata
+					

+		

+			
Exiftool::displayMetadata() in Exiftool.inc

+					

+			

+						Class
+			DocumentConverter
+					

+		

+			
DocumentConverter in DocumentConverter.inc

+							
This class implements document (doc, odt, pdf, etc.) conversion for a generic  multi-format document collection.

+					

+			

+						Page
+			DarwinCore.inc
+					

+		

+			
DarwinCore.inc in DarwinCore.inc

+					

+			

+						Page
+			DemoFormBuilder.inc
+					

+		

+			
DemoFormBuilder.inc in DemoFormBuilder.inc

+					

+			

+						Page
+			DocumentConverter.inc
+					

+		

+			
DocumentConverter.inc in DocumentConverter.inc

+					

+			

+						Variable
+			$DEFAULT_DSID
+					

+		

+			
CollectionPolicy::$DEFAULT_DSID in CollectionPolicy.inc

+					

+			

+						Variable
+			$DEFAULT_DSID
+					

+		

+			
ContentModel::$DEFAULT_DSID in ContentModel.inc

+					

+			

+						Variable
+			$DISPLAY_ALWAYS
+					

+		

+			
ObjectHelper::$DISPLAY_ALWAYS in ObjectHelper.inc

+					

+			

+						Variable
+			$DISPLAY_NEVER
+					

+		

+			
ObjectHelper::$DISPLAY_NEVER in ObjectHelper.inc

+					

+			

+						Variable
+			$DISPLAY_NO_MODEL_OUTPUT
+					

+		

+			
ObjectHelper::$DISPLAY_NO_MODEL_OUTPUT in ObjectHelper.inc

+					

+			

+						Variable
+			$dsid
+					

+		

+			
XMLDatastream::$dsid in XMLDatastream.inc

+					

+			

+						Method
+			decAuthListItem
+					

+		

+			
ContentModel::decAuthListItem() in ContentModel.inc

+							
Decrements an authority list item from a form element in the list of elements.

+					

+			

+						Method
+			decFormElement
+					

+		

+			
ContentModel::decFormElement() in ContentModel.inc

+					

+			

+						Method
+			decIngestFormElement
+					

+		

+			
ContentModel::decIngestFormElement() in ContentModel.inc

+							
Decrements an ingest form element in the list of elements.

+					

+			

+						Method
+			displayExtraFieldset
+					

+		

+			
ContentModel::displayExtraFieldset() in ContentModel.inc

+							
Calls all defined display methods for the ContentModel.

+					

+			

+						Method
+			displayInFieldset
+					

+		

+			
ContentModel::displayInFieldset() in ContentModel.inc

+					

+			

+						Method
+			dumpXml
+					

+		

+			
XMLDatastream::dumpXml() in XMLDatastream.inc

+							
Dumps the XMLDatastream as an XML String

+					

+		

+	
+	

+		
e

+		
top

+		

+	

+	

+			

+						Method
+			exists
+					

+		

+			
Fedora_Item::exists() in fedora_item.inc

+					

+			

+						Method
+			export_as_foxml
+					

+		

+			
Fedora_Item::export_as_foxml() in fedora_item.inc

+					

+			

+						Function
+			export_collection
+					

+		

+			
export_collection() in fedora_collection.inc

+							
Exports a fedora collection object and all of its children in a format  that will let you import them into another repository.

+					

+			

+						Function
+			export_foxml_for_pid
+					

+		

+			
export_foxml_for_pid() in fedora_export.inc

+					

+			

+						Function
+			export_objects_for_pid
+					

+		

+			
export_objects_for_pid() in fedora_export.inc

+					

+			

+						Function
+			export_to_export_area
+					

+		

+			
export_to_export_area() in fedora_export.inc

+							
Function to to export all objects assocoiated with a given pid to the export area

+					

+			

+						Method
+			enableDownload
+					

+		

+			
ShowQtStreamsInFieldSets::enableDownload() in qt_viewer.inc

+					

+			

+						Class
+			Exiftool
+					

+		

+			
Exiftool in Exiftool.inc

+					

+			

+						Method
+			extractMetadata
+					

+		

+			
Exiftool::extractMetadata() in Exiftool.inc

+					

+			

+						Method
+			extract_thumbnail
+					

+		

+			
Ffmpeg::extract_thumbnail() in Ffmpeg.inc

+					

+			

+						Page
+			Exiftool.inc
+					

+		

+			
Exiftool.inc in Exiftool.inc

+					

+			

+						Variable
+			$EDIT_FEDORA_METADATA
+					

+		

+			
ObjectHelper::$EDIT_FEDORA_METADATA in ObjectHelper.inc

+					

+			

+						Variable
+			$EDIT_TAGS_DATASTREAM
+					

+		

+			
ObjectHelper::$EDIT_TAGS_DATASTREAM in ObjectHelper.inc

+					

+			

+						Variable
+			$errors
+					

+		

+			
XMLDatastream::$errors in XMLDatastream.inc

+					

+			

+						Method
+			editForm
+					

+		

+			
ContentModel::editForm() in ContentModel.inc

+							
Edits a form element with attribute name='$name' from the 'forms' element.

+					

+			

+						Method
+			editFormElement
+					

+		

+			
ContentModel::editFormElement() in ContentModel.inc

+					

+			

+						Method
+			editIngestFormAttributes
+					

+		

+			
ContentModel::editIngestFormAttributes() in ContentModel.inc

+					

+			

+						Method
+			editIngestFormBuilderMethod
+					

+		

+			
ContentModel::editIngestFormBuilderMethod() in ContentModel.inc

+					

+			

+						Method
+			editIngestFormElement
+					

+		

+			
ContentModel::editIngestFormElement() in ContentModel.inc

+							
Edits the ingest form element specified.

+					

+			

+						Method
+			execAddDatastreamMethods
+					

+		

+			
ContentModel::execAddDatastreamMethods() in ContentModel.inc

+							
Executes the add datastream method for the specified datastream on the specified file.

+					

+			

+						Method
+			execFormHandler
+					

+		

+			
ContentModel::execFormHandler() in ContentModel.inc

+							
Executes the form handler from the <form_builder_method> element of <ingest_form>.

+					

+			

+						Method
+			execIngestRules
+					

+		

+			
ContentModel::execIngestRules() in ContentModel.inc

+							
Executes the ingest rules that apply to the specified file/mimetype.

+					

+		

+	
+	

+		
f

+		
top

+		

+	

+	

+			

+						Function
+			fedora_attach_admin
+					

+		

+			
fedora_attach_admin() in fedora_attach.admin.inc

+							
Form builder.  Configure Redmine parameters.

+					

+			

+						Page
+			fedora_attach.admin.inc
+					

+		

+			
fedora_attach.admin.inc in fedora_attach.admin.inc

+					

+			

+						Page
+			fedora_collection.inc
+					

+		

+			
fedora_collection.inc in fedora_collection.inc

+					

+			

+						Page
+			fedora_export.inc
+					

+		

+			
fedora_export.inc in fedora_export.inc

+					

+			

+						Page
+			fedora_item.inc
+					

+		

+			
fedora_item.inc in fedora_item.inc

+					

+			

+						Page
+			fedora_utils.inc
+					

+		

+			
fedora_utils.inc in fedora_utils.inc

+					

+			

+						Function
+			fedora_available
+					

+		

+			
fedora_available() in fedora_utils.inc

+					

+			

+						Class
+			Fedora_Item
+					

+		

+			
Fedora_Item in fedora_item.inc

+					

+			

+						Method
+			fedora_item_exists
+					

+		

+			
Fedora_Item::fedora_item_exists() in fedora_item.inc

+					

+			

+						Constant
+			FEDORA_MODEL_URI
+					

+		

+			
FEDORA_MODEL_URI in fedora_item.inc

+					

+			

+						Method
+			find_objects_by_pattern
+					

+		

+			
Fedora_Item::find_objects_by_pattern() in fedora_item.inc

+							
Does a search using the "query" format followed by the Fedora REST APi.

+					

+			

+						Function
+			fixDsid
+					

+		

+			
fixDsid() in fedora_utils.inc

+					

+			

+						Function
+			fix_encoding
+					

+		

+			
fix_encoding() in fedora_utils.inc

+							
Returns a UTF-8-encoded transcripiton of the string given in $in_str.

+					

+			

+						Constant
+			FOXML_10
+					

+		

+			
FOXML_10 in fedora_export.inc

+					

+			

+						Constant
+			FOXML_11
+					

+		

+			
FOXML_11 in fedora_export.inc

+					

+			

+						Method
+			fedoraObject
+					

+		

+			
ShowQtStreamsInFieldSets::fedoraObject() in qt_viewer.inc

+					

+			

+						Class
+			FedoraObject
+					

+		

+			
FedoraObject in fedoraObject.inc

+					

+			

+						Function
+			fedora_repository_image_tagging_form
+					

+		

+			
fedora_repository_image_tagging_form() in tagging_form.inc

+					

+			

+						Function
+			fedora_repository_image_tagging_form_submit
+					

+		

+			
fedora_repository_image_tagging_form_submit() in tagging_form.inc

+					

+			

+						Class
+			Ffmpeg
+					

+		

+			
Ffmpeg in Ffmpeg.inc

+					

+			

+						Method
+			Ffmpeg
+					

+		

+			
Ffmpeg::Ffmpeg() in Ffmpeg.inc

+					

+			

+						Method
+			FlvFormBuilder
+					

+		

+			
FlvFormBuilder::FlvFormBuilder() in FlvFormBuilder.inc

+					

+			

+						Class
+			FlvFormBuilder
+					

+		

+			
FlvFormBuilder in FlvFormBuilder.inc

+					

+			

+						Method
+			FormBuilder
+					

+		

+			
FormBuilder::FormBuilder() in Flv.inc

+					

+			

+						Class
+			FormBuilder
+					

+		

+			
FormBuilder in Flv.inc

+					

+			

+						Page
+			fedoraObject.inc
+					

+		

+			
fedoraObject.inc in fedoraObject.inc

+					

+			

+						Page
+			Ffmpeg.inc
+					

+		

+			
Ffmpeg.inc in Ffmpeg.inc

+					

+			

+						Page
+			Flv.inc
+					

+		

+			
Flv.inc in Flv.inc

+					

+			

+						Page
+			FlvFormBuilder.inc
+					

+		

+			
FlvFormBuilder.inc in FlvFormBuilder.inc

+					

+			

+						Page
+			FormBuilder.inc
+					

+		

+			
FormBuilder.inc in FormBuilder.inc

+					

+			

+						Variable
+			$forceSchema
+					

+		

+			
XMLDatastream::$forceSchema in XMLDatastream.inc

+					

+			

+						Page
+			fedora_repository.solutionpacks.inc
+					

+		

+			
fedora_repository.solutionpacks.inc in fedora_repository.solutionpacks.inc

+					

+			

+						Method
+			fedora_repository_access
+					

+		

+			
ObjectHelper::fedora_repository_access() in ObjectHelper.inc

+					

+			

+						Function
+			fedora_repository_solution_packs_page
+					

+		

+			
fedora_repository_solution_packs_page() in fedora_repository.solutionpacks.inc

+							
Invokes a hook to any dependent modules asking them if their installations require  any fedora objects to be present. Modules implementing this hook should return an array  of arrays of the form:

+					

+			

+						Function
+			fedora_repository_solution_pack_form
+					

+		

+			
fedora_repository_solution_pack_form() in fedora_repository.solutionpacks.inc

+							
Check for installed objects and add a 'Update' or 'Install' button if some objects are missing.

+					

+			

+						Function
+			fedora_repository_solution_pack_form_submit
+					

+		

+			
fedora_repository_solution_pack_form_submit() in fedora_repository.solutionpacks.inc

+					

+			

+						Class
+			formClass
+					

+		

+			
formClass in formClass.inc

+					

+			

+						Method
+			formClass
+					

+		

+			
formClass::formClass() in formClass.inc

+					

+			

+						Page
+			formClass.inc
+					

+		

+			
formClass.inc in formClass.inc

+					

+		

+	
+	

+		
g

+		
top

+		

+	

+	

+			

+						Function
+			get_random_image
+					

+		

+			
get_random_image() in image_rotator_tagger_block.inc

+					

+			

+						Method
+			get_datastream
+					

+		

+			
Fedora_Item::get_datastream() in fedora_item.inc

+					

+			

+						Method
+			get_datastreams_list_as_array
+					

+		

+			
Fedora_Item::get_datastreams_list_as_array() in fedora_item.inc

+							
Returns an associative array of this object's datastreams. Results look like this:

+					

+			

+						Method
+			get_datastreams_list_as_SimpleXML
+					

+		

+			
Fedora_Item::get_datastreams_list_as_SimpleXML() in fedora_item.inc

+							
Retrieves and returns a SimpleXML list of this item's datastreams, and stores them  as an instance variable for caching purposes.

+					

+			

+						Method
+			get_datastream_dissemination
+					

+		

+			
Fedora_Item::get_datastream_dissemination() in fedora_item.inc

+					

+			

+						Method
+			get_datastream_history
+					

+		

+			
Fedora_Item::get_datastream_history() in fedora_item.inc

+					

+			

+						Method
+			get_datastream_info
+					

+		

+			
Fedora_Item::get_datastream_info() in fedora_item.inc

+							
*  DatastreamControlGroup controlGroup - String restricted to the values of "X", "M", "R", or "E" (InlineXML,Managed Content,Redirect, or External Referenced).

+					

+			

+						Method
+			get_dissemination
+					

+		

+			
Fedora_Item::get_dissemination() in fedora_item.inc

+					

+			

+						Function
+			get_file_extension
+					

+		

+			
get_file_extension() in fedora_export.inc

+					

+			

+						Method
+			get_mimetype_of_datastream
+					

+		

+			
Fedora_Item::get_mimetype_of_datastream() in fedora_item.inc

+							
Returns a MIME type string for the given Datastream ID.

+					

+			

+						Method
+			get_next_PID_in_namespace
+					

+		

+			
Fedora_Item::get_next_PID_in_namespace() in fedora_item.inc

+					

+			

+						Function
+			get_related_items_as_array
+					

+		

+			
get_related_items_as_array() in fedora_collection.inc

+					

+			

+						Function
+			get_related_items_as_xml
+					

+		

+			
get_related_items_as_xml() in fedora_collection.inc

+							
Returns an array of pids that match the query contained in teh collection  object's QUERY datastream or in the suppled $query parameter.

+					

+			

+						Method
+			get_relationships
+					

+		

+			
Fedora_Item::get_relationships() in fedora_item.inc

+							
Currently the Fedora API call getRelationships is reporting an uncaught  exception so we will parse the RELS-EXT ourselves and simulate the  documented behaviour.

+					

+			

+						Method
+			getMediaDatastreamInfo
+					

+		

+			
ShowQtStreamsInFieldSets::getMediaDatastreamInfo() in qt_viewer.inc

+					

+			

+						Method
+			getPosterFrameDatastreamInfo
+					

+		

+			
ShowQtStreamsInFieldSets::getPosterFrameDatastreamInfo() in qt_viewer.inc

+					

+			

+						Method
+			getAddDsMethod
+					

+		

+			
ContentModel::getAddDsMethod() in ContentModel.inc

+					

+			

+						Method
+			getAllowedMimeTypes
+					

+		

+			
CollectionClass::getAllowedMimeTypes() in CollectionClass.inc

+					

+			

+						Method
+			getAllowedUsersAndRoles
+					

+		

+			
SecurityClass::getAllowedUsersAndRoles() in SecurityClass.inc

+					

+			

+						Method
+			getAndDoRules
+					

+		

+			
CollectionClass::getAndDoRules() in CollectionClass.inc

+							
Grabs the rules from the content model stream

+					

+			

+						Method
+			getBreadcrumbs
+					

+		

+			
ObjectHelper::getBreadcrumbs() in ObjectHelper.inc

+							
Builds an array of drupal links for use in breadcrumbs.

+					

+			

+						Method
+			getCollectionInfo
+					

+		

+			
ObjectHelper::getCollectionInfo() in ObjectHelper.inc

+					

+			

+						Method
+			getCollectionPolicyStream
+					

+		

+			
CollectionClass::getCollectionPolicyStream() in CollectionClass.inc

+					

+			

+						Method
+			getCollectionViewStream
+					

+		

+			
CollectionClass::getCollectionViewStream() in CollectionClass.inc

+					

+			

+						Method
+			getContentModels
+					

+		

+			
CollectionPolicy::getContentModels() in CollectionPolicy.inc

+							
Gets a list of ContentModel objects supported by this collection.

+					

+			

+						Method
+			getContentModels
+					

+		

+			
CollectionClass::getContentModels() in CollectionClass.inc

+							
gets a list of content models from a collection policy

+					

+			

+						Method
+			getDatastreamInfo
+					

+		

+			
ObjectHelper::getDatastreamInfo() in ObjectHelper.inc

+					

+			

+						Method
+			getDefaultDSID
+					

+		

+			
ContentModel::getDefaultDSID() in ContentModel.inc

+							
Gets the default DSID to use for ContentModel datastreams.

+					

+			

+						Method
+			getDefaultDSID
+					

+		

+			
CollectionPolicy::getDefaultDSID() in CollectionPolicy.inc

+							
Gets the default DSID to use for ContentModel datastreams.

+					

+			

+						Method
+			getDisplayMethods
+					

+		

+			
ContentModel::getDisplayMethods() in ContentModel.inc

+					

+			

+						Method
+			getDSIDFromIdentifier
+					

+		

+			
XMLDatastream::getDSIDFromIdentifier() in XMLDatastream.inc

+							
Parses the DSID from an identifier.

+					

+			

+						Method
+			getEditFormNames
+					

+		

+			
ContentModel::getEditFormNames() in ContentModel.inc

+					

+			

+						Method
+			getEditMetadataMethod
+					

+		

+			
ContentModel::getEditMetadataMethod() in ContentModel.inc

+							
Gets an associative array describing the edit metadata method.

+					

+			

+						Method
+			getForm
+					

+		

+			
ContentModel::getForm() in ContentModel.inc

+							
Find the form element with name $name.

+					

+			

+						Method
+			getFormattedDC
+					

+		

+			
ObjectHelper::getFormattedDC() in ObjectHelper.inc

+					

+			

+						Method
+			getFormHandler
+					

+		

+			
CollectionClass::getFormHandler() in CollectionClass.inc

+							
gets the form handler file, class and method and returns them in an array

+					

+			

+						Method
+			getFormNames
+					

+		

+			
ContentModel::getFormNames() in ContentModel.inc

+					

+			

+						Method
+			getHistory
+					

+		

+			
XMLDatastream::getHistory() in XMLDatastream.inc

+							
Gets the history of the datastream from fedora.

+					

+			

+						Method
+			getIdentifier
+					

+		

+			
XMLDatastream::getIdentifier() in XMLDatastream.inc

+							
Gets the identifier for this XMLDatastream  Returns FALSE on failure.

+					

+			

+						Method
+			getIngestFormAttributes
+					

+		

+			
ContentModel::getIngestFormAttributes() in ContentModel.inc

+					

+			

+						Method
+			getIngestFormBuilderMethod
+					

+		

+			
ContentModel::getIngestFormBuilderMethod() in ContentModel.inc

+					

+			

+						Method
+			getIngestFormElementParams
+					

+		

+			
ContentModel::getIngestFormElementParams() in ContentModel.inc

+							
Gets a list of all parameters that belong to the specified ingest form element.

+					

+			

+						Method
+			getIngestFormElements
+					

+		

+			
ContentModel::getIngestFormElements() in ContentModel.inc

+							
Gets an array of form elements to use in the ingest form.  The results of this array are passed  to the specified ingest form builder.  The form builder can optionally not use the elements as defined  in the form builder if more complex forms or behaviour is required.

+					

+			

+						Method
+			getIngestFormNames
+					

+		

+			
ContentModel::getIngestFormNames() in ContentModel.inc

+					

+			

+						Method
+			getIngestInterface
+					

+		

+			
CollectionClass::getIngestInterface() in CollectionClass.inc

+					

+			

+						Method
+			getIngestRule
+					

+		

+			
ContentModel::getIngestRule() in ContentModel.inc

+					

+			

+						Method
+			getIngestRules
+					

+		

+			
ContentModel::getIngestRules() in ContentModel.inc

+					

+			

+						Method
+			getMimeType
+					

+		

+			
ObjectHelper::getMimeType() in ObjectHelper.inc

+							
returns the mime type

+					

+			

+						Method
+			getMimetypes
+					

+		

+			
ContentModel::getMimetypes() in ContentModel.inc

+							
Gets a list of valid mimetypes that can apply to this model.

+					

+			

+						Method
+			getName
+					

+		

+			
ContentModel::getName() in ContentModel.inc

+							
Gets the name of the ContentModel  Returns false on failure.

+					

+			

+						Method
+			getName
+					

+		

+			
CollectionPolicy::getName() in CollectionPolicy.inc

+					

+			

+						Method
+			getNextPid
+					

+		

+			
CollectionPolicy::getNextPid() in CollectionPolicy.inc

+							
Gets the next available PID for the  content model specified by the DSID  parameter.

+					

+			

+						Method
+			getNextPid
+					

+		

+			
CollectionClass::getNextPid() in CollectionClass.inc

+							
using the collection policies pid namespace get a new pid by calling fedora' get next pid and appending it to the namespace  $pid is the $pid of the content model  $dsid is the datastream id of the content model.

+					

+			

+						Method
+			getObject
+					

+		

+			
ObjectHelper::getObject() in ObjectHelper.inc

+							
Returns XML description of the object (export).

+					

+			

+						Method
+			getPidFromIdentifier
+					

+		

+			
XMLDatastream::getPidFromIdentifier() in XMLDatastream.inc

+							
Parses an PID from an identifier.

+					

+			

+						Method
+			getPidNameSpace
+					

+		

+			
CollectionClass::getPidNameSpace() in CollectionClass.inc

+					

+			

+						Method
+			getQDC
+					

+		

+			
ObjectHelper::getQDC() in ObjectHelper.inc

+							
Queries fedora for what we call the qualified dublin core.  Currently only dc.coverage has

+					

+			

+						Method
+			getRelatedItems
+					

+		

+			
CollectionClass::getRelatedItems() in CollectionClass.inc

+							
Gets objects related to this item.  It will query the object for a Query stream and use that as a itql query

+					

+			

+						Method
+			getRelatedObjects
+					

+		

+			
CollectionClass::getRelatedObjects() in CollectionClass.inc

+					

+			

+						Method
+			getRelationship
+					

+		

+			
CollectionPolicy::getRelationship() in CollectionPolicy.inc

+							
Gets the name of the relationship to use  for members of this collection.

+					

+			

+						Method
+			getRelationshipElement
+					

+		

+			
CollectionClass::getRelationshipElement() in CollectionClass.inc

+					

+			

+						Method
+			getSearchTerms
+					

+		

+			
CollectionPolicy::getSearchTerms() in CollectionPolicy.inc

+							
Gets a list of search terms from the Collection Policy.  If asArray is set  it will return an associative array with the value, field name, and the default value.

+					

+			

+						Method
+			getServices
+					

+		

+			
ContentModel::getServices() in ContentModel.inc

+							
Gets a list of service deployments that this model has.

+					

+			

+						Method
+			getSoapClient
+					

+		

+			
ConnectionHelper::getSoapClient() in ConnectionHelper.inc

+					

+			

+						Method
+			getStagingArea
+					

+		

+			
CollectionPolicy::getStagingArea() in CollectionPolicy.inc

+							
Gets the path to the staging area to use for this  collection. By default recurses to the parent collection  if the staging area is undefined

+					

+			

+						Method
+			getStream
+					

+		

+			
ObjectHelper::getStream() in ObjectHelper.inc

+							
returns a stream from a fedora object given a pid and dsid

+					

+			

+						Method
+			getStream
+					

+		

+			
CollectionClass::getStream() in CollectionClass.inc

+					

+			

+						Method
+			getTerms
+					

+		

+			
SearchClass::getTerms() in SearchClass.inc

+					

+			

+						Method
+			getType
+					

+		

+			
MimeClass::getType() in MimeClass.inc

+							
function: getType  description: An alias to get_mimetype,  for backwards-compatibility with our old mimetype class.

+					

+			

+						Method
+			getXslContent
+					

+		

+			
CollectionClass::getXslContent() in CollectionClass.inc

+							
Queries a collection object for an xslt to format how the  collection of objects is displayed.

+					

+			

+						Method
+			get_all_related_pids
+					

+		

+			
ObjectHelper::get_all_related_pids() in ObjectHelper.inc

+							
Get a tree of related pids - for the basket functionality

+					

+			

+						Method
+			get_and_do_datastream_rules
+					

+		

+			
ObjectHelper::get_and_do_datastream_rules() in ObjectHelper.inc

+							
Look in the content model for rules to run on the specified datastream.

+					

+			

+						Method
+			get_child_pids
+					

+		

+			
ObjectHelper::get_child_pids() in ObjectHelper.inc

+							
Get children of PID - but only 2 levels deep

+					

+			

+						Method
+			get_content_models_list
+					

+		

+			
ObjectHelper::get_content_models_list() in ObjectHelper.inc

+					

+			

+						Method
+			get_extension
+					

+		

+			
MimeClass::get_extension() in MimeClass.inc

+							
function: get_extension

+					

+			

+						Method
+			get_formatted_datastream_list
+					

+		

+			
ObjectHelper::get_formatted_datastream_list() in ObjectHelper.inc

+							
Gets a list of datastreams from an object using its pid

+					

+			

+						Method
+			get_mimetype
+					

+		

+			
MimeClass::get_mimetype() in MimeClass.inc

+							
function: get_mimetype

+					

+			

+						Method
+			get_parent_objects
+					

+		

+			
ObjectHelper::get_parent_objects() in ObjectHelper.inc

+							
Gets the parent objects that this object is related to

+					

+			

+						Method
+			get_parent_objects_asHTML
+					

+		

+			
ObjectHelper::get_parent_objects_asHTML() in ObjectHelper.inc

+					

+			

+						Method
+			get_search_terms_array
+					

+		

+			
SearchClass::get_search_terms_array() in SearchClass.inc

+					

+		

+	
+	

+		
h

+		
top

+		

+	

+	

+			

+						Method
+			handleEditMetadataForm
+					

+		

+			
IslandoraBook::handleEditMetadataForm() in book.inc

+					

+			

+						Method
+			handleIngestForm
+					

+		

+			
Newspaper::handleIngestForm() in Newspaper.inc

+					

+			

+						Method
+			handleIngestForm
+					

+		

+			
IslandoraBook::handleIngestForm() in book.inc

+					

+			

+						Method
+			handleEditMetadataForm
+					

+		

+			
ModsFormBuilder::handleEditMetadataForm() in ModsFormBuilder.inc

+					

+			

+						Method
+			handleEditMetadataForm
+					

+		

+			
Herbarium::handleEditMetadataForm() in herbarium.inc

+					

+			

+						Method
+			handleForm
+					

+		

+			
Refworks::handleForm() in Refworks.inc

+					

+			

+						Method
+			handleForm
+					

+		

+			
DarwinCore::handleForm() in DarwinCore.inc

+					

+			

+						Method
+			handleIngestForm
+					

+		

+			
Herbarium::handleIngestForm() in herbarium.inc

+					

+			

+						Method
+			handleModsForm
+					

+		

+			
ModsFormBuilder::handleModsForm() in ModsFormBuilder.inc

+					

+			

+						Method
+			handleQDCForm
+					

+		

+			
FormBuilder::handleQDCForm() in Flv.inc

+					

+			

+						Class
+			Herbarium
+					

+		

+			
Herbarium in herbarium.inc

+					

+			

+						Function
+			hook_imagebutton_process
+					

+		

+			
hook_imagebutton_process() in tagging_form.inc

+					

+			

+						Page
+			herbarium.inc
+					

+		

+			
herbarium.inc in herbarium.inc

+					

+			

+						Method
+			handleEditMetadataForm
+					

+		

+			
ContentModel::handleEditMetadataForm() in ContentModel.inc

+							
Handles the edit metadata form using the handler specified in the <edit_metadata_method> element  Returns FALSE on failure.

+					

+		

+	
+	

+		
i

+		
top

+		

+	

+	

+			

+						Page
+			image_rotator_tagger_block.inc
+					

+		

+			
image_rotator_tagger_block.inc in image_rotator_tagger_block.inc

+					

+			

+						Function
+			ilives_add_single_page_object
+					

+		

+			
ilives_add_single_page_object() in book.inc

+					

+			

+						Function
+			ilives_create_page_objects
+					

+		

+			
ilives_create_page_objects() in book.inc

+							
Create a page object for each element in $image_list as a child object of $pid

+					

+			

+						Class
+			IslandoraBook
+					

+		

+			
IslandoraBook in book.inc

+					

+			

+						Variable
+			$item
+					

+		

+			
TagSet::$item in tagging.inc

+					

+			

+						Method
+			import_from_xml_string
+					

+		

+			
Dublin_Core::import_from_xml_string() in dublin_core.inc

+							
Creates a new instance of the class by parsing dc_xml

+					

+			

+						Method
+			ingest_from_FOXML
+					

+		

+			
Fedora_Item::ingest_from_FOXML() in fedora_item.inc

+					

+			

+						Method
+			ingest_from_FOXML_file
+					

+		

+			
Fedora_Item::ingest_from_FOXML_file() in fedora_item.inc

+					

+			

+						Method
+			ingest_from_FOXML_files_in_directory
+					

+		

+			
Fedora_Item::ingest_from_FOXML_files_in_directory() in fedora_item.inc

+					

+			

+						Method
+			ingest_new_item
+					

+		

+			
Fedora_Item::ingest_new_item() in fedora_item.inc

+					

+			

+						Variable
+			$item
+					

+		

+			
ModsFormBuilder::$item in ModsFormBuilder.inc

+					

+			

+						Method
+			ImageManipulation
+					

+		

+			
ImageManipulation::ImageManipulation() in ImageManipulation.inc

+					

+			

+						Class
+			ImageManipulation
+					

+		

+			
ImageManipulation in ImageManipulation.inc

+					

+			

+						Method
+			ingestCollectionPolicy
+					

+		

+			
CreateCollection::ingestCollectionPolicy() in CreateCollection.inc

+					

+			

+						Page
+			ImageManipulation.inc
+					

+		

+			
ImageManipulation.inc in ImageManipulation.inc

+					

+			

+						Variable
+			$INGEST_FEDORA_OBJECTS
+					

+		

+			
ObjectHelper::$INGEST_FEDORA_OBJECTS in ObjectHelper.inc

+					

+			

+						Method
+			incAuthListItem
+					

+		

+			
ContentModel::incAuthListItem() in ContentModel.inc

+							
Increments (or decrements) an authority list item from a form element in the list of elements.

+					

+			

+						Method
+			incFormElement
+					

+		

+			
ContentModel::incFormElement() in ContentModel.inc

+					

+			

+						Method
+			incIngestFormElement
+					

+		

+			
ContentModel::incIngestFormElement() in ContentModel.inc

+							
Increments (or decrements) ingest form element in the list of elements.

+					

+			

+						Method
+			ingestBlankModel
+					

+		

+			
ContentModel::ingestBlankModel() in ContentModel.inc

+							
Ingests a minimum Content Model to the specified pid/dsid.

+					

+			

+						Method
+			ingestBlankPolicy
+					

+		

+			
CollectionPolicy::ingestBlankPolicy() in CollectionPolicy.inc

+							
Ingests a new minimum  Collection Policy datastream to the specified  PID with the DSID specified.  Initializes the policy with the specified values.

+					

+			

+						Method
+			ingestFromCollection
+					

+		

+			
CollectionPolicy::ingestFromCollection() in CollectionPolicy.inc

+							
Ingests a new Collection Policy datastream to the specified  PID with the DSID specified.  Clones the collection policy from the  source collection pid. Returns false on failure.

+					

+			

+						Method
+			ingestFromFile
+					

+		

+			
ContentModel::ingestFromFile() in ContentModel.inc

+							
Ingests a Content Model from a file to the specified pid/dsid .

+					

+			

+						Method
+			ingestFromFile
+					

+		

+			
CollectionPolicy::ingestFromFile() in CollectionPolicy.inc

+							
Ingests a new Collection Policy datastream to the specified  PID with the DSID specified.  The file should be a valid collection  policy XML.  Returns false on failure.

+					

+			

+						Method
+			ingestFromModel
+					

+		

+			
ContentModel::ingestFromModel() in ContentModel.inc

+							
Ingests a Content Model from an existing model to the specified pid/dsid .

+					

+		

+	
+	

+		
l

+		
top

+		

+	

+	

+			

+						Method
+			load
+					

+		

+			
TagSet::load() in tagging.inc

+					

+			

+						Function
+			log_line
+					

+		

+			
log_line() in fedora_export.inc

+					

+			

+						Method
+			listDatastreams
+					

+		

+			
ContentModel::listDatastreams() in ContentModel.inc

+							
Gets a list of datastreams from the ContentModel  (not including the QDC ds if it is listed).

+					

+			

+						Method
+			loadFromCollection
+					

+		

+			
CollectionPolicy::loadFromCollection() in CollectionPolicy.inc

+							
Constructs a new CollectionPolicy object from the specified  collection PID.  If preFetch is disabled, then Islandora will not get the datastream until needed.

+					

+			

+						Method
+			loadFromFile
+					

+		

+			
XMLDatastream::loadFromFile() in XMLDatastream.inc

+							
Constructs an XMLDatastream object from the XML file specified.

+					

+			

+						Method
+			loadFromModel
+					

+		

+			
ContentModel::loadFromModel() in ContentModel.inc

+							
Constructs a ContentModel object from the PID of the model in Fedora.

+					

+			

+						Method
+			loadFromObject
+					

+		

+			
ContentModel::loadFromObject() in ContentModel.inc

+							
Constructs a ContentModel object from a Fedora item  by getting the first content model from the hasModel relationship.

+					

+		

+	
+	

+		
m

+		
top

+		

+	

+	

+			

+						Constant
+			METS_10
+					

+		

+			
METS_10 in fedora_export.inc

+					

+			

+						Constant
+			METS_11
+					

+		

+			
METS_11 in fedora_export.inc

+					

+			

+						Method
+			modified
+					

+		

+			
RelsExt::modified() in rels-ext.inc

+					

+			

+						Method
+			modify_datastream_by_reference
+					

+		

+			
Fedora_Item::modify_datastream_by_reference() in fedora_item.inc

+					

+			

+						Method
+			modify_datastream_by_value
+					

+		

+			
Fedora_Item::modify_datastream_by_value() in fedora_item.inc

+					

+			

+						Method
+			modify_object
+					

+		

+			
Fedora_Item::modify_object() in fedora_item.inc

+					

+			

+						Variable
+			$MODS_NS
+					

+		

+			
ModsFormBuilder::$MODS_NS in ModsFormBuilder.inc

+					

+			

+						Method
+			manipulateImage
+					

+		

+			
ImageManipulation::manipulateImage() in ImageManipulation.inc

+					

+			

+						Class
+			ModsFormBuilder
+					

+		

+			
ModsFormBuilder in ModsFormBuilder.inc

+					

+			

+						Method
+			modsFromForm
+					

+		

+			
ModsFormBuilder::modsFromForm() in ModsFormBuilder.inc

+					

+			

+						Page
+			map_viewer.inc
+					

+		

+			
map_viewer.inc in map_viewer.inc

+					

+			

+						Page
+			ModsFormBuilder.inc
+					

+		

+			
ModsFormBuilder.inc in ModsFormBuilder.inc

+					

+			

+						Method
+			makeObject
+					

+		

+			
ObjectHelper::makeObject() in ObjectHelper.inc

+							
Grabs a stream from fedora sets the mimetype and returns it. $dsID is the  datastream id.   If $forceSoap is set, the function will always buffer the datastream from fedora.  Otherwise, it will  try and use a redirect if possible.

+					

+			

+						Class
+			MimeClass
+					

+		

+			
MimeClass in MimeClass.inc

+							
This class inspired by Chris Jean's work, here:  http://chrisjean.com/2009/02/14/generating-mime-type-in-php-is-not-magic/

+					

+			

+						Page
+			MimeClass.inc
+					

+		

+			
MimeClass.inc in MimeClass.inc

+					

+		

+	
+	

+		
n

+		
top

+		

+	

+	

+			

+						Class
+			Newspaper
+					

+		

+			
Newspaper in Newspaper.inc

+					

+			

+						Page
+			Newspaper.inc
+					

+		

+			
Newspaper.inc in Newspaper.inc

+					

+			

+						Variable
+			$name
+					

+		

+			
ContentModel::$name in ContentModel.inc

+					

+		

+	
+	

+		
o

+		
top

+		

+	

+	

+			

+						Variable
+			$objectProfile
+					

+		

+			
Fedora_Item::$objectProfile in fedora_item.inc

+					

+			

+						Variable
+			$owner
+					

+		

+			
Dublin_Core::$owner in dublin_core.inc

+					

+			

+						Variable
+			$OBJECT_HELPER_VIEW_FEDORA
+					

+		

+			
ObjectHelper::$OBJECT_HELPER_VIEW_FEDORA in ObjectHelper.inc

+					

+			

+						Method
+			ObjectHelper
+					

+		

+			
ObjectHelper::ObjectHelper() in ObjectHelper.inc

+					

+			

+						Class
+			ObjectHelper
+					

+		

+			
ObjectHelper in ObjectHelper.inc

+					

+			

+						Page
+			ObjectHelper.inc
+					

+		

+			
ObjectHelper.inc in ObjectHelper.inc

+					

+		

+	
+	

+		
p

+		
top

+		

+	

+	

+			

+						Variable
+			$pid
+					

+		

+			
Fedora_Item::$pid in fedora_item.inc

+					

+			

+						Method
+			purge
+					

+		

+			
Fedora_Item::purge() in fedora_item.inc

+							
Removes this object form the repository.

+					

+			

+						Method
+			purge_datastream
+					

+		

+			
Fedora_Item::purge_datastream() in fedora_item.inc

+					

+			

+						Method
+			purge_relationship
+					

+		

+			
Fedora_Item::purge_relationship() in fedora_item.inc

+							
Removes the given relationship from the item's RELS-EXT and re-saves it.

+					

+			

+						Variable
+			$pid
+					

+		

+			
ModsFormBuilder::$pid in ModsFormBuilder.inc

+					

+			

+						Method
+			parse_refworks_item
+					

+		

+			
Refworks::parse_refworks_item() in Refworks.inc

+							
Read the input file and generate a list of Reference items.

+					

+			

+						Method
+			PersonalCollectionClass
+					

+		

+			
PersonalCollectionClass::PersonalCollectionClass() in PersonalCollectionClass.inc

+					

+			

+						Class
+			PersonalCollectionClass
+					

+		

+			
PersonalCollectionClass in PersonalCollectionClass.inc

+					

+			

+						Page
+			PersonalCollectionClass.inc
+					

+		

+			
PersonalCollectionClass.inc in PersonalCollectionClass.inc

+					

+			

+						Variable
+			$pid
+					

+		

+			
XMLDatastream::$pid in XMLDatastream.inc

+					

+			

+						Variable
+			$pid_namespace
+					

+		

+			
ContentModel::$pid_namespace in ContentModel.inc

+					

+			

+						Variable
+			$PURGE_FEDORA_OBJECTSANDSTREAMS
+					

+		

+			
ObjectHelper::$PURGE_FEDORA_OBJECTSANDSTREAMS in ObjectHelper.inc

+					

+			

+						Method
+			parseContent
+					

+		

+			
ObjectHelper::parseContent() in ObjectHelper.inc

+							
internal function  uses an xsl to parse the sparql xml returned from the ITQL query

+					

+			

+						Method
+			purgeVersions
+					

+		

+			
XMLDatastream::purgeVersions() in XMLDatastream.inc

+							
Purges veersions of the datastream newer than and including the start_date.  If  End date is specified, it can be used to purge a range of versions instead. Date should be in  DATE_RFC822 format

+					

+		

+	
+	

+		
q

+		
top

+		

+	

+	

+			

+						Page
+			QtFormBuilder.php
+					

+		

+			
QtFormBuilder.php in QtFormBuilder.php

+					

+			

+						Page
+			qt_viewer.inc
+					

+		

+			
qt_viewer.inc in qt_viewer.inc

+					

+			

+						Class
+			QtFormBuilder
+					

+		

+			
QtFormBuilder in QtFormBuilder.php

+					

+			

+						Method
+			QtFormBuilder
+					

+		

+			
QtFormBuilder::QtFormBuilder() in QtFormBuilder.php

+					

+			

+						Method
+			quickSearch
+					

+		

+			
SearchClass::quickSearch() in SearchClass.inc

+					

+		

+	
+	

+		
r

+		
top

+		

+	

+	

+			

+						Variable
+			$relsExtArray
+					

+		

+			
RelsExt::$relsExtArray in rels-ext.inc

+					

+			

+						Page
+			rels-ext.inc
+					

+		

+			
rels-ext.inc in rels-ext.inc

+					

+			

+						Method
+			RelsExt
+					

+		

+			
RelsExt::RelsExt() in rels-ext.inc

+							
Constructor that builds itself by retrieving the RELS-EXT stream from  the repository for the given Fedora_Item.

+					

+			

+						Class
+			RelsExt
+					

+		

+			
RelsExt in rels-ext.inc

+							
Description of relsext

+					

+			

+						Constant
+			RELS_EXT_URI
+					

+		

+			
RELS_EXT_URI in fedora_item.inc

+					

+			

+						Page
+			Refworks.inc
+					

+		

+			
Refworks.inc in Refworks.inc

+					

+			

+						Method
+			Refworks
+					

+		

+			
Refworks::Refworks() in Refworks.inc

+					

+			

+						Class
+			Refworks
+					

+		

+			
Refworks in Refworks.inc

+					

+			

+						Method
+			removeAppliesTo
+					

+		

+			
ContentModel::removeAppliesTo() in ContentModel.inc

+					

+			

+						Method
+			removeAuthListItem
+					

+		

+			
ContentModel::removeAuthListItem() in ContentModel.inc

+							
Removes an authority list item from a form element.

+					

+			

+						Method
+			removeDispMeth
+					

+		

+			
ContentModel::removeDispMeth() in ContentModel.inc

+					

+			

+						Method
+			removeDs
+					

+		

+			
ContentModel::removeDs() in ContentModel.inc

+					

+			

+						Method
+			removeEditMetadataMethod
+					

+		

+			
ContentModel::removeEditMetadataMethod() in ContentModel.inc

+							
Removes the edit data method from the Content Model.

+					

+			

+						Method
+			removeForm
+					

+		

+			
ContentModel::removeForm() in ContentModel.inc

+							
Removes the named form.

+					

+			

+						Method
+			removeIngestFormElement
+					

+		

+			
ContentModel::removeIngestFormElement() in ContentModel.inc

+							
Removes an ingest form element from the list of ingest form elements.

+					

+			

+						Method
+			removeIngestMethod
+					

+		

+			
ContentModel::removeIngestMethod() in ContentModel.inc

+					

+			

+						Method
+			removeIngestMethodParam
+					

+		

+			
ContentModel::removeIngestMethodParam() in ContentModel.inc

+					

+			

+						Method
+			removeIngestRule
+					

+		

+			
ContentModel::removeIngestRule() in ContentModel.inc

+					

+			

+						Method
+			removeMimetype
+					

+		

+			
ContentModel::removeMimetype() in ContentModel.inc

+							
Removes an allowed mimetype from the model.

+					

+			

+						Method
+			removeModel
+					

+		

+			
CollectionPolicy::removeModel() in CollectionPolicy.inc

+							
Removes the specified content model from the collection policy.  This will only  prevent future ingests of the removed model to the collection.  $cm should be  a valid ContentModel object.  Returns false on failure or when the CM was not found in  the collection policy.

+					

+			

+						Method
+			removeTerm
+					

+		

+			
CollectionPolicy::removeTerm() in CollectionPolicy.inc

+							
Removes the search term specified by the field parameter from the collection policy.

+					

+			

+						Method
+			renderCollection
+					

+		

+			
CollectionClass::renderCollection() in CollectionClass.inc

+					

+		

+	
+	

+		
s

+		
top

+		

+	

+	

+			

+						Method
+			showFieldSets
+					

+		

+			
Newspaper::showFieldSets() in Newspaper.inc

+					

+			

+						Method
+			showFieldSets
+					

+		

+			
IslandoraBook::showFieldSets() in book.inc

+					

+			

+						Method
+			ShowILivesStreamsInFieldSets
+					

+		

+			
ShowILivesStreamsInFieldSets::ShowILivesStreamsInFieldSets() in image_rotator_tagger_block.inc

+					

+			

+						Class
+			ShowILivesStreamsInFieldSets
+					

+		

+			
ShowILivesStreamsInFieldSets in image_rotator_tagger_block.inc

+					

+			

+						Method
+			showJPG
+					

+		

+			
ShowILivesStreamsInFieldSets::showJPG() in image_rotator_tagger_block.inc

+					

+			

+						Method
+			showPageFieldSets
+					

+		

+			
Newspaper::showPageFieldSets() in Newspaper.inc

+					

+			

+						Method
+			save
+					

+		

+			
RelsExt::save() in rels-ext.inc

+							
Save the current state of the RELS-EXT array out to the repository item  as a datastream.

+					

+			

+						Method
+			save
+					

+		

+			
TagSet::save() in tagging.inc

+							
Saves an associative array of tags to a datastream.

+					

+			

+						Method
+			save
+					

+		

+			
Dublin_Core::save() in dublin_core.inc

+					

+			

+						Method
+			save_relationships
+					

+		

+			
Fedora_Item::save_relationships() in fedora_item.inc

+							
Creates a RELS-EXT XML stream from the supplied array and saves it to  the item on the server.

+					

+			

+						Method
+			set_element
+					

+		

+			
Dublin_Core::set_element() in dublin_core.inc

+							
Replace the given DC element with the values in $values

+					

+			

+						Method
+			soap_call
+					

+		

+			
Fedora_Item::soap_call() in fedora_item.inc

+					

+			

+						Function
+			str_getcsv
+					

+		

+			
str_getcsv() in fedora_utils.inc

+					

+			

+						Page
+			ShowDemoStreamsInFieldSets.inc
+					

+		

+			
ShowDemoStreamsInFieldSets.inc in ShowDemoStreamsInFieldSets.inc

+					

+			

+						Page
+			ShowStreamsInFieldSets.inc
+					

+		

+			
ShowStreamsInFieldSets.inc in ShowStreamsInFieldSets.inc

+					

+			

+						Page
+			slide_viewer.inc
+					

+		

+			
slide_viewer.inc in slide_viewer.inc

+					

+			

+						Method
+			showArtInventoryTN
+					

+		

+			
ShowStreamsInFieldSets::showArtInventoryTN() in ShowStreamsInFieldSets.inc

+					

+			

+						Class
+			ShowDemoStreamsInFieldSets
+					

+		

+			
ShowDemoStreamsInFieldSets in ShowDemoStreamsInFieldSets.inc

+					

+			

+						Method
+			ShowDemoStreamsInFieldSets
+					

+		

+			
ShowDemoStreamsInFieldSets::ShowDemoStreamsInFieldSets() in ShowDemoStreamsInFieldSets.inc

+					

+			

+						Method
+			showFieldSets
+					

+		

+			
Herbarium::showFieldSets() in herbarium.inc

+					

+			

+						Method
+			showFieldSets
+					

+		

+			
FedoraObject::showFieldSets() in fedoraObject.inc

+					

+			

+						Method
+			showFlv
+					

+		

+			
ShowStreamsInFieldSets::showFlv() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			showJP2
+					

+		

+			
ShowStreamsInFieldSets::showJP2() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			showJPG
+					

+		

+			
ShowMapStreamsInFieldSets::showJPG() in map_viewer.inc

+					

+			

+						Method
+			showJPG
+					

+		

+			
ShowSlideStreamsInFieldSets::showJPG() in slide_viewer.inc

+					

+			

+						Class
+			ShowMapStreamsInFieldSets
+					

+		

+			
ShowMapStreamsInFieldSets in map_viewer.inc

+					

+			

+						Method
+			ShowMapStreamsInFieldSets
+					

+		

+			
ShowMapStreamsInFieldSets::ShowMapStreamsInFieldSets() in map_viewer.inc

+					

+			

+						Method
+			showMediumSize
+					

+		

+			
ShowDemoStreamsInFieldSets::showMediumSize() in ShowDemoStreamsInFieldSets.inc

+					

+			

+						Method
+			showOBJLink
+					

+		

+			
ShowStreamsInFieldSets::showOBJLink() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			showPDFPreview
+					

+		

+			
ShowStreamsInFieldSets::showPDFPreview() in ShowStreamsInFieldSets.inc

+							
Embed Google Docs' PDF viewer into the page.

+					

+			

+						Method
+			showQdc
+					

+		

+			
ShowStreamsInFieldSets::showQdc() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			showQt
+					

+		

+			
ShowQtStreamsInFieldSets::showQt() in qt_viewer.inc

+					

+			

+						Class
+			ShowQtStreamsInFieldSets
+					

+		

+			
ShowQtStreamsInFieldSets in qt_viewer.inc

+					

+			

+						Method
+			ShowQtStreamsInFieldSets
+					

+		

+			
ShowQtStreamsInFieldSets::ShowQtStreamsInFieldSets() in qt_viewer.inc

+					

+			

+						Method
+			showRefworks
+					

+		

+			
ShowStreamsInFieldSets::showRefworks() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			showRomeo
+					

+		

+			
ShowStreamsInFieldSets::showRomeo() in ShowStreamsInFieldSets.inc

+					

+			

+						Class
+			ShowSlideStreamsInFieldSets
+					

+		

+			
ShowSlideStreamsInFieldSets in slide_viewer.inc

+					

+			

+						Method
+			ShowSlideStreamsInFieldSets
+					

+		

+			
ShowSlideStreamsInFieldSets::ShowSlideStreamsInFieldSets() in slide_viewer.inc

+					

+			

+						Class
+			ShowStreamsInFieldSets
+					

+		

+			
ShowStreamsInFieldSets in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			ShowStreamsInFieldSets
+					

+		

+			
ShowStreamsInFieldSets::ShowStreamsInFieldSets() in ShowStreamsInFieldSets.inc

+					

+			

+						Method
+			showTN
+					

+		

+			
ShowStreamsInFieldSets::showTN() in ShowStreamsInFieldSets.inc

+					

+			

+						Variable
+			$SCHEMA_URI
+					

+		

+			
ContentModel::$SCHEMA_URI in ContentModel.inc

+					

+			

+						Variable
+			$SCHEMA_URI
+					

+		

+			
CollectionPolicy::$SCHEMA_URI in CollectionPolicy.inc

+					

+			

+						Variable
+			$SEARCH_CLASS_ADVANCED_SEARCH_NUMBER_FIELDS
+					

+		

+			
SearchClass::$SEARCH_CLASS_ADVANCED_SEARCH_NUMBER_FIELDS in SearchClass.inc

+					

+			

+						Variable
+			$SECURITY_CLASS_SECURITY_STREAM
+					

+		

+			
SecurityClass::$SECURITY_CLASS_SECURITY_STREAM in SecurityClass.inc

+					

+			

+						Method
+			saveToFedora
+					

+		

+			
XMLDatastream::saveToFedora() in XMLDatastream.inc

+							
Saves the current XML datastream back to fedora.   The XML must validate.

+					

+			

+						Class
+			SearchClass
+					

+		

+			
SearchClass in SearchClass.inc

+					

+			

+						Page
+			SearchClass.inc
+					

+		

+			
SearchClass.inc in SearchClass.inc

+					

+			

+						Method
+			SecurityClass
+					

+		

+			
SecurityClass::SecurityClass() in SecurityClass.inc

+					

+			

+						Class
+			SecurityClass
+					

+		

+			
SecurityClass in SecurityClass.inc

+					

+			

+						Page
+			SecurityClass.inc
+					

+		

+			
SecurityClass.inc in SecurityClass.inc

+					

+			

+						Method
+			setDefaultDispMeth
+					

+		

+			
ContentModel::setDefaultDispMeth() in ContentModel.inc

+					

+			

+						Method
+			setDefaultTerm
+					

+		

+			
CollectionPolicy::setDefaultTerm() in CollectionPolicy.inc

+					

+			

+						Method
+			setDisplayInFieldset
+					

+		

+			
ContentModel::setDisplayInFieldset() in ContentModel.inc

+					

+			

+						Method
+			setIngestFormElementParam
+					

+		

+			
ContentModel::setIngestFormElementParam() in ContentModel.inc

+							
Sets a parameter of an ingest form element.  If the value of the element is FALSE the parameter  will be removed entirely (if you want to store false as a value, then send the String "false").

+					

+			

+						Method
+			setRelationship
+					

+		

+			
CollectionPolicy::setRelationship() in CollectionPolicy.inc

+							
Sets the name of the relationship to use  for members of this collection.

+					

+			

+						Method
+			setStagingArea
+					

+		

+			
CollectionPolicy::setStagingArea() in CollectionPolicy.inc

+							
Sets the path to the staging area to use for this  collection. If specified path is blank (or false) it will  remove the staging are path element from the collection policy.

+					

+			

+						Method
+			set_allowed_users_and_roles
+					

+		

+			
SecurityClass::set_allowed_users_and_roles() in SecurityClass.inc

+							
Add a list of allowed users and roles to the given policy stream and return it.

+					

+			

+						Method
+			showFieldSets
+					

+		

+			
CollectionClass::showFieldSets() in CollectionClass.inc

+					

+			

+						Method
+			solr_search
+					

+		

+			
SearchClass::solr_search() in SearchClass.inc

+					

+		

+	
+	

+		
t

+		
top

+		

+	

+	

+			

+						Function
+			transform_mods_to_dc
+					

+		

+			
transform_mods_to_dc() in book.inc

+					

+			

+						Variable
+			$tags
+					

+		

+			
TagSet::$tags in tagging.inc

+					

+			

+						Variable
+			$tagsDSID
+					

+		

+			
TagSet::$tagsDSID in tagging.inc

+					

+			

+						Page
+			tagging.inc
+					

+		

+			
tagging.inc in tagging.inc

+					

+			

+						Method
+			TagSet
+					

+		

+			
TagSet::TagSet() in tagging.inc

+					

+			

+						Class
+			TagSet
+					

+		

+			
TagSet in tagging.inc

+							
Description of tagging

+					

+			

+						Page
+			tagging_form.inc
+					

+		

+			
tagging_form.inc in tagging_form.inc

+					

+			

+						Method
+			technicalMetadata
+					

+		

+			
ShowQtStreamsInFieldSets::technicalMetadata() in qt_viewer.inc

+					

+			

+						Method
+			theme_advanced_search_form
+					

+		

+			
SearchClass::theme_advanced_search_form() in SearchClass.inc

+					

+			

+						Method
+			theme_solr_search_form
+					

+		

+			
SearchClass::theme_solr_search_form() in SearchClass.inc

+					

+		

+	
+	

+		
u

+		
top

+		

+	

+	

+			

+						Method
+			url
+					

+		

+			
Fedora_Item::url() in fedora_item.inc

+					

+			

+						Method
+			updateEditMetadataMethod
+					

+		

+			
ContentModel::updateEditMetadataMethod() in ContentModel.inc

+							
Update the Edit Metadata Method defined in the Content Model

+					

+			

+						Method
+			updateMetaData
+					

+		

+			
formClass::updateMetaData() in formClass.inc

+					

+		

+	
+	

+		
v

+		
top

+		

+	

+	

+			

+						Function
+			validDsid
+					

+		

+			
validDsid() in fedora_utils.inc

+					

+			

+						Function
+			validPid
+					

+		

+			
validPid() in fedora_utils.inc

+					

+			

+						Variable
+			$vocabulary
+					

+		

+			
DarwinCore::$vocabulary in DarwinCore.inc

+					

+			

+						Variable
+			$VIEW_DETAILED_CONTENT_LIST
+					

+		

+			
ObjectHelper::$VIEW_DETAILED_CONTENT_LIST in ObjectHelper.inc

+					

+			

+						Method
+			validate
+					

+		

+			
XMLDatastream::validate() in XMLDatastream.inc

+							
Validates the XMLDatastream against the schema location

+					

+			

+						Method
+			validDsid
+					

+		

+			
XMLDatastream::validDsid() in XMLDatastream.inc

+							
validDsid  Validates a fedora Dsid based on the the allowed XML standard NCName.

+					

+			

+						Method
+			validPid
+					

+		

+			
XMLDatastream::validPid() in XMLDatastream.inc

+							
validPid  Validates a fedora PID based on the regexp provided in the fedora  3.3 documentation.

+					

+		

+	
+	

+		
w

+		
top

+		

+	

+	

+			

+						Method
+			warnIfMisconfigured
+					

+		

+			
ObjectHelper::warnIfMisconfigured() in ObjectHelper.inc

+					

+		

+	
+	

+		
x

+		
top

+		

+	

+	

+			

+						Variable
+			$xml
+					

+		

+			
XMLDatastream::$xml in XMLDatastream.inc

+					

+			

+						Variable
+			$XMLNS
+					

+		

+			
XMLDatastream::$XMLNS in XMLDatastream.inc

+					

+			

+						Class
+			XMLDatastream
+					

+		

+			
XMLDatastream in XMLDatastream.inc

+					

+			

+						Page
+			XMLDatastream.inc
+					

+		

+			
XMLDatastream.inc in XMLDatastream.inc

+					

+		

+
+

+	a
+	b
+	c
+	d
+	e
+	f
+	g
+	h
+	i
+	l
+	m
+	n
+	o
+	p
+	q
+	r
+	s
+	t
+	u
+	v
+	w
+	x
+	_
+
	
+
\ No newline at end of file
diff --git a/docs/errors.html b/docs/errors.html
new file mode 100644
index 00000000..53a38a05
--- /dev/null
+++ b/docs/errors.html
@@ -0,0 +1,149 @@
+
+
+  
+		
+			
+			phpDocumentor Parser Errors and Warnings
+			
+											
+		
+						Post-parsing

+CollectionClass.inc

+CollectionFormBuilder.inc

+CollectionPolicy.inc

+ConnectionHelper.inc

+ContentModel.inc

+CreateCollection.inc

+DarwinCore.inc

+DemoFormBuilder.inc

+DocumentConverter.inc

+dublin_core.inc

+Exiftool.inc

+fedora_attach.admin.inc

+fedora_export.inc

+fedora_item.inc

+fedora_utils.inc

+formClass.inc

+image_rotator_tagger_block.inc

+MimeClass.inc

+Newspaper.inc

+ObjectHelper.inc

+rels-ext.inc

+tagging.inc

+tagging_form.inc

+
+
Post-parsing

+
Warnings:


+Warning - 
+duplicate class element "FormBuilder" in file /Users/benwoodhead/Development/islandora/plugins/FormBuilder.inc will be ignored.
+Use an @ignore tag on the original if you want this case to be documented.

+
+
book.inc

+
Warnings:


+Warning on line 4 - no @package tag was used in a DocBlock for class IslandoraBook

+Warning on line 333 - File "/Users/benwoodhead/Development/islandora/ilives/book.inc" has no page-level DocBlock, use @package in the first DocBlock to create one

+
+
CollectionClass.inc

+
Warnings:


+Warning on line 17 - DocBlock would be page-level, but precedes class "CollectionClass", use another DocBlock to document the file

+
+
CollectionFormBuilder.inc

+
Warnings:


+Warning on line 16 - DocBlock would be page-level, but precedes class "CollectionFormBuilder", use another DocBlock to document the file

+
+
CollectionPolicy.inc

+
Warnings:


+Warning on line 10 - DocBlock would be page-level, but precedes class "CollectionPolicy", use another DocBlock to document the file

+
+
ConnectionHelper.inc

+
Warnings:


+Warning on line 16 - DocBlock would be page-level, but precedes class "ConnectionHelper", use another DocBlock to document the file

+
+
ContentModel.inc

+
Warnings:


+Warning on line 10 - DocBlock would be page-level, but precedes class "ContentModel", use another DocBlock to document the file

+
+
CreateCollection.inc

+
Warnings:


+Warning on line 14 - DocBlock would be page-level, but precedes class "CreateCollection", use another DocBlock to document the file

+
+
DarwinCore.inc

+
Warnings:


+Warning on line 8 - DocBlock would be page-level, but precedes class "DarwinCore", use another DocBlock to document the file

+
+
DemoFormBuilder.inc

+
Warnings:


+Warning on line 17 - DocBlock would be page-level, but precedes class "DemoFormBuilder", use another DocBlock to document the file

+
+
DocumentConverter.inc

+
Warnings:


+Warning on line 15 - no @package tag was used in a DocBlock for class DocumentConverter

+
+
dublin_core.inc

+
Warnings:


+Warning on line 14 - DocBlock would be page-level, but precedes class "Dublin_Core", use another DocBlock to document the file

+
+
Exiftool.inc

+
Warnings:


+Warning on line 15 - DocBlock would be page-level, but precedes class "Exiftool", use another DocBlock to document the file

+
+
fedora_attach.admin.inc

+
Warnings:


+Warning on line 14 - Unknown tag "@file" used

+Warning on line 15 - Unknown tag "@ingroup" used

+Warning on line 15 - no @package tag was used in a DocBlock for file /Users/benwoodhead/Development/islandora/plugins/fedora_attach/fedora_attach.admin.inc

+
+
fedora_export.inc

+
Warnings:


+Warning on line 9 - Page-level DocBlock precedes "define FOXML_10", use another DocBlock to document the source element

+
+
fedora_item.inc

+
Warnings:


+Warning on line 9 - Page-level DocBlock precedes "define RELS_EXT_URI", use another DocBlock to document the source element

+Warning on line 12 - no @package tag was used in a DocBlock for class Fedora_Item

+
+
fedora_utils.inc

+
Warnings:


+Warning on line 23 - Page-level DocBlock precedes "function str_getcsv", use another DocBlock to document the source element

+
+
formClass.inc

+
Warnings:


+Warning on line 12 - DocBlock would be page-level, but precedes class "formClass", use another DocBlock to document the file

+
+
image_rotator_tagger_block.inc

+
Warnings:


+Warning on line 87 - no @package tag was used in a DocBlock for class ShowILivesStreamsInFieldSets

+Warning on line 106 - File "/Users/benwoodhead/Development/islandora/ilives/image_rotator_tagger_block.inc" has no page-level DocBlock, use @package in the first DocBlock to create one

+
+
MimeClass.inc

+
Warnings:


+Warning on line 28 - no @package tag was used in a DocBlock for class MimeClass

+
+
Newspaper.inc

+
Warnings:


+Warning on line 4 - no @package tag was used in a DocBlock for class Newspaper

+Warning on line 175 - File "/Users/benwoodhead/Development/islandora/plugins/islandora_newspaper/Newspaper.inc" has no page-level DocBlock, use @package in the first DocBlock to create one

+
+
ObjectHelper.inc

+
Warnings:


+Warning on line 14 - DocBlock would be page-level, but precedes class "ObjectHelper", use another DocBlock to document the file

+
+
rels-ext.inc

+
Warnings:


+Warning on line 18 - no @package tag was used in a DocBlock for class RelsExt

+
+
tagging.inc

+
Warnings:


+Warning on line 17 - no @package tag was used in a DocBlock for class TagSet

+
+
tagging_form.inc

+
Warnings:


+Warning on line 28 - Page-level DocBlock precedes "function _show_subject_tags", use another DocBlock to document the source element

+
Errors:


+Error on line 28 - DocBlock has multiple @package tags, illegal. ignoring additional tag "@package Islandora"

+Error on line 28 - "function" _show_subject_tags's DocBlock has @subpackage tags, illegal. ignoring tag "@subpackage plugins"

+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:55 -0300 by phpDocumentor 1.4.3
+	

+	
+
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 00000000..83a39704
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,24 @@
+
+
+   
+
+	
+  Islandora
+  
+
+
+
+	
+	
+		
+		
+	
+	
+		<H2>Frame Alert</H2>
+		<P>This document is designed to be viewed using the frames feature.
+		If you see this message, you are using a non-frame-capable web client.</P>
+	
+
+
\ No newline at end of file
diff --git a/docs/li_Islandora.html b/docs/li_Islandora.html
new file mode 100644
index 00000000..edc1aedb
--- /dev/null
+++ b/docs/li_Islandora.html
@@ -0,0 +1,683 @@
+
+
+  
+		
+			
+			
+			
+						
+									
+									
+					
+		
+						
Islandora

+

+
+

+

+	Generated by 
+	phpDocumentor 1.4.3
+

+
+
\ No newline at end of file
diff --git a/docs/media/banner.css b/docs/media/banner.css
new file mode 100644
index 00000000..19a383c3
--- /dev/null
+++ b/docs/media/banner.css
@@ -0,0 +1,32 @@
+body 
+{ 
+	background-color: #EEEEEE; 
+	margin: 0px; 
+	padding: 0px;
+}
+
+/* Banner (top bar) classes */
+
+.banner {  }
+
+.banner-menu 
+{ 
+	clear: both;
+	padding: .5em;
+	border-top: 2px solid #AAAAAA;	
+}
+
+.banner-title 
+{ 
+	text-align: right; 
+	font-size: 20pt; 
+	font-weight: bold; 
+	margin: .2em;
+}
+
+.package-selector 
+{ 
+	background-color: #DDDDDD; 
+	border: 1px solid #AAAAAA; 
+	color: #000090;
+}
diff --git a/docs/media/images/AbstractClass.png b/docs/media/images/AbstractClass.png
new file mode 100644
index 0000000000000000000000000000000000000000..afa9d1d9261500c57ec37cff1de8cf43b31dbf25
GIT binary patch
literal 620
zcmeAS@N?(olHy`uVBq!ia0vp^0wB!63?wyl`GbKJbFq_W2nPqp?T7vkfZSaHJ|V9E
z|NjRvPcK>oB;jC!uy7wgKahK+w)SFm^_jG^eUXv70s?k;dvAAg+Gb<3&cI-?g2GG&
zh8_lnGzNx)iHU~;0{$Bt?{jhjD)_IizRSYmznt6_Lqnj-|B{khH8nS=tN#}e_{zt(
zR#EXk2ggfJ&eakUK)aWTi~nF?_`tyMoPps!1H*L&hBwx{7GaqsHK2b=zCZk2F6c8jl1JVN5*@+%rr7PI}^11C*oaK4^xC05VCJK_3<
zud|-<{@_}WT(>@P3->I)OHK!WY*;^8{ZU{D!{pbT`vks!nK+ee*>;`t+%u+Jea(8o
vR5x-}=mldp!DT+b`?hi(nsMPiM;)`hf`a|hX9_^KGcb6%`njxgN@xNA_;dCz

literal 0
HcmV?d00001

diff --git a/docs/media/images/AbstractClass_logo.png b/docs/media/images/AbstractClass_logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..8f65c390e37b548578390c0bdbe4a4bc469c4d19
GIT binary patch
literal 1232
zcmb`F`%jZ+6vq#W@U{$S1TZXV4viCPx3q`=k`4L
zo1#BJx0H}AAicqQU>vV%^^<9m|tWsIx<8LP>5;)!-8{5Ba8xawKa^8)JAwolYrP3xG
ze;gi;N)W-psLCUuuq7;v;PILTf-XM)dx3ypvzvl~UU4|4;9xV4hpH34zB3F)V?aO$
zn|+nbCFt}9e}9{g&n%sOWyOknOy(?=N>C`M!zl`-mcbw}tb)O4@%Ek}kw)FzM%>+P
z&dw7gQYD>^Hi$-;0kAkbTLCIOJjMZr0D1sUQ>kWvt0dArfEIuTfD>f$DGaLt_zu7T
zPzaEN77pxLob%;x2CG}`xIIwL@5%qsVT}twSp0*)++a!sc%Q?K
z`N@jCeTp+nwyR|s`Xqf{xt8ToY?#m#I3M+++}?TZyynf|!6(h%ZXB5YwRD&DpE->+
zQa?!d&ipfd^zwzIKtBJ~qLA$Mj4wHSb~mtdtP52mbBN=vTM#>mfmycxM}yu)6Bg^4@lw*?MFu3*Llv~
zTq;{9ldCeY*UL|oCB+&|W}C3XvTUffR~(q#WAaNg-nYFVl1oFwjfcGkWO1Lan7mWj
zTHAk$B{{PsrhD+|_&Dv{Dq|lMERc7*{?yjm*&4fucG~As73P}JZF+xm+H<2#y7rxG
zW9=q?%ZBwC`JJPAZS{(h+4A?WNris0W9rS3rW|*EzKH2={VP|ERZ$+~<|y91p2^}Q
nm5>e}t(H)$%7m@A#{7td(X}C*54y81qwfI{akQvb7@z$w+j=f(

literal 0
HcmV?d00001

diff --git a/docs/media/images/AbstractMethod.png b/docs/media/images/AbstractMethod.png
new file mode 100644
index 0000000000000000000000000000000000000000..605ccbe58e04d8f1462227f08369ef6d8e5d4fe0
GIT binary patch
literal 696
zcmV;p0!RIcP){TiMy!!e(Yf-7_V#G2iUr
zLy?{{R5VTt!-qRXx-)@b&OX;WKp!2|aT>;Q#=c
z001J6D>1||Q0X(T002sRN{?O-R{#J232;bRa{vGf5&!@T5&_cPe*6Fc02XvbSad^j
zWnpw_Z*Cw|X>DZyFf=bPGA}SQ*^*j90000WbVXQnQ*UN;cVTj608L?Ia&K*AWNBd_
zMrm?ocW-iQb0AGvyOAm+0002PNklfMHT-Bv8QIEs=+ZPf$A`E>2c0)H#Sj$PWnk1p@>G(zLXgfTkY(YJ2o$Mf2{EX7&_@CL4Lsu
zf=WupE-s;IY31eR9Y|p2?lbS+y#t0XRlwut?cae`au#?*7Bet#3xP1>rMq>1fPxAo
zt`Q}{`DrEPiAAXlzKO|2`MIennTZN+nMJAP`9;~q3ceA$Cu*qx)rx`CIv1rTmSpDV
zDTHL^rZO0q=o=X68yMf56y*d|@zK-8F{EOS?)lqMO%4*R4`(`@EDFELx7ssVZORd|
zq%5HzwQYvlS2%cGPXFHD@~{05-~Gi~FPw_9ndsyAvUly>(4LD`8%wTUDBXMa-M%{6
zPZCGZ>%ZQD?T}l&!`s7tUKsOr`-?Wu<;}Q-LQ_10v>q37%ry4uIK**v&qDxa`a*R3vrciLZ8L}yD)
oC>0QH(U@~sMxOVvCC6j?c~N@r8XNCh0zJ>*>FVdQ&MBb@0EQ=S+yDRo

literal 0
HcmV?d00001

diff --git a/docs/media/images/AbstractPrivateClass_logo.png b/docs/media/images/AbstractPrivateClass_logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..4e68f570dcb38ee67756ce2231bb5c38e77cce71
GIT binary patch
literal 1615
zcmd5)X;Twc6n!ia!lFSW4Jkrc1`LPY$1sj(#lRGf?-K4OF)W1MOFm{
z#7YHOM1d45sY*y?RaT*Ff-H@QqJv;$S_hSqKJ6F#4|-7%db^6N%JBAT-(9*4o%q
znVVM{8z&gwu}%jHt3R3eeo)zwv3Rdtk>
zHkX%IR8+_c3#BLl`T3*C$>o`ujcI8r9xppPdr&AWJ9+Y=SiH#R_r%1&N)#a>
zLp)xoP^jW?x*{TSg~HD8@MMu_J|N&;P>>Mv3@w(yNtt`_4MTNcqLq}
z%GI^Y$LAr10vpK)47}svp&}CHWHOh_eLy0K*z8s^S%t^Hv9+Bb5@VQ58Hse=#f8OU
z!IlG<%q?^C0ynn}bMx!Y&f#=AmrftS
zz{0{8=0u^Owi_rERBYA2Al=^ngo6W*NbJU9H<8F%9BxBfdvV7O=!jBFYZ-~mv9x@x
zsR@ORv9^X@%xG!71fbr~a2|np3MB<#5&&q>5CDxxWG?{FDLDW|y1G&TngOW$U}y!L
z4IC~XfGhw62!t2_EEWrG`q&@}0J;|r4?^#yB9<>37+4Ughj_fi#GHz2*JLti8^rv7
zu=W9PsQxe5o@p5i8$iZ+2Ey)icfJp`vH6pmki>~-0U~xRPm~y%5D9!j!xLhUM@H~N
zaUT4H$i&!$Xd%ugKz7d73jRgE|LdL*87kt(3UD0$@kl^$b|5%85QsCyT&R@#EjpFV
zNxB$0{_dMGCPphR1jGN@&Te?$F)~u1_bJ2p$i%={-+*sD-;Or!G|aRk{(Pj}Kd}0H
zUF|6ogUq)Y;t|lhxz(~t`eQ_RUoq1-eLFT?AP8E>XkA)fHggqi^htaeb*$=!t4&v9
zqXdHJ6|UE%Zb#CMmiE)kj0RV6b=%tA)%tp^#^=wTC2c+JUMy1oOuKh7@94hZJCoCG
zXxaS2yJN@J#J33U`c+%lKU?M&7D~KdDwWEKxzE31HT2^+xj+0k>P|X8pxN^#{*0l;
zJtxPg-}2sdI`*|*oC&-#etYRjR+M_H)cIG6TS0l{{gE&BmCtq~sCpA%t$SPejT1KZ
zhgY7Xi)In=GWoXzL>tiaEgkbHwlbdGz1?uS;}g9r9hTrqerW-%FO1@shEpP|okxi=
zPM5cWANffS>kbM9sa+||;ebojEN0yA9yek&f^IImjYjiE#g2W+w}g5r{lcI0tMbXg
zn)g@NIfMqbGFiEQJ-TD7%ey9VJ;gYDC9Ao8C1ZwKf{tkXg^MxlZFwOFr^!}`w~YQU
zd1uJz%3r<80}oBt)q-)m&*Rf}D)wh9&K|(^9IVw$da;MNxX>Y)R&c|pBRwc!j(BVG
z1gV@=8A+_ZCz$E2gI1@w{L*m@r+H)9vC7|V^Qd`Hj&)~W1WkS8@5e~OE~BI%6gwn=
zr*W1_Ms>6Hs`1daQJXsTMk+A3=fdt{i_4foPsd6$>Q%`uT3s3z34l|D0EF>7@e!`_b&3NDRW2J
ly0$Y=SuS5{3YHYFR9bNnjKnZ6dJUX%K&SaqC6tg;{{UJF@sa=l

literal 0
HcmV?d00001

diff --git a/docs/media/images/AbstractPrivateMethod.png b/docs/media/images/AbstractPrivateMethod.png
new file mode 100644
index 0000000000000000000000000000000000000000..41cc9f021734b6f99a723a687827190f2ae645e2
GIT binary patch
literal 874
zcmeAS@N?(olHy`uVBq!ia0vp^0wB!63?wyl`GbKJbFq_W2nPqp?T7vk7#J8+1AIbU
z|Ns9Flwsj#1(FdZp_~dll^g2aJA$}1LE7U51%YJBiZnqBFdculhYlSI
zePQDH(Aed!@#@v9{V!U0T+*|>Vq|mPaK+-qHfL>(<z;@U}mwJ#*$v?ZZY|dku|t
z>TYOnx7uW^y4kR+tIJ@Wf$1uBpzT)k?NpbUwl>yHs;P72AM0gsJN85x|f1nsNASyQ)C^V
z5(o6cX?uI1gPQ_$zUt}*MFj!9qne@NAL##8Sy?4sMa%1B#506*U(#MpQkI2X<
zc`N_t;!<)|IwT?j3`C$$JEf(8o_)r^aG!xeU0r=914Ae{#Jqy9S^>kcyd=mkm_blU
z$=KK>G&D3VtsLmpnX6WvIdc~R-hlxyN~jN}hd;CiI)SsmBeIx*fm;ZK886+f`vVjd
zD{+k|aV|AI6tkVJh3R1!8b9vC_gtf
zB{NaMEwd=KJijQrSiv`9_e3ofpxV=(E{-7;bCLzbgr`rKFk#BGq?87R>nEOk>FJpx
zR5!!H#V1TpU<$_pmPbOx#d~EhvfQbWT_nhq+3L!8?pK_VPC(<7l;G
z*2$BHZrL7j2|sUR5%A_P)N-TQ+}Y|GrRdK
zV81Pn)+>0zGnMUCiP|Spqc&^AG^y;y-0mPhgGJ5$HDs$bXTdY0@m-PJEq%`?TdG9A
z`7w;w(EZ*psMAWc}ikt!qr000(rMObu0a%Ew3
zX>V>IRB3Hx05CK!FfuPNGue__LI3~&s7XXYRCt_C%4rvYKmdi|(V{3Sky0s2sVw0{
z3ns_0{QqBM)L8Df_c<4+W|ZRbuE?ptT;0z>z23f%IS}<{hVT1%ezB)pU1LBR7z?!4
zdf1$>0)?RM<32r|FI3$jzfkuMegO9fmRSW?+;gd{A6?vpl~i!EaT78927Y{aY)A+t
zD;|Uj0{6%|rRRA`LWdbZAQrk%Pf@@U0ViwJZw&^h9P>Z*1$ZnRgm9bKlmGw#07*qo
IM6N<$g0d3*MgRZ+

literal 0
HcmV?d00001

diff --git a/docs/media/images/Class_logo.png b/docs/media/images/Class_logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..6f223c479a6c6fefab504deb84ab824d2e744713
GIT binary patch
literal 1600
zcmd5*`!|$%9DdQB9VXJcrO7tT6s8%5m)$T$<9->p85y@dE{&RXZA?TG%_2nB{k}w+
z>>y&K8JEf>)@4JEu#A%^x8$DGyKmbsyZ^yH=X@^b^L>8!JkR-jlN{|WrKJu_0RSLv
zZDr;RS2P?)5fX5&yJ6f47l|;kH4TA4Ow2fl06^Tq(T-*gK@j``L!Zj}+HeO}zBX0;
zizS_}vsy(-{E4`_@#vbdi+5fGm5%u5_tDdPtzuhX8qOmN&M4C`MSV{xS#?0cPBr16I(qS$$iDTJrh_s?O!p#8Hcm?#qi{w{Bl~rNTh%>k
zux{n)ub}uDC~68~PeK9XP|o0n-x!qAyY4;;IgdbbU2Fb*kj)U}I`FAP@Yeb{ME(1wR2$S
zCnkTzwDp5^%MQJH%Za}Qw(J@Sb}rN|#d2rO_**uOn}$u>PW5Z&eqR6^w@vF-EowJR
z?ytf7pRC>Vy0c(Xy#ZElT5*>`i$x}PS71@3%2n|0Ix}zDrR23?#T;0%YIu7FmT6El
z2Nu24DVZbXi)=HebP7bUa4>sWJ4d9GHAl=E1#c}<6Gn-tBHfgEozyY>%|Y;&c|yW4
zku#~q8L_(3kLUF3#=OE^@6x?8LyQ_DL=9+0x1A2}#zl7MT$&`ZUJ%&*xUeUhY#|}I
zSN$R%Hj~6`#Raq+3+8G3+=%z@#4@=!KOxb#LH%4E&aW2hTXDiu02{99&efzpfNj@w
zsn?)ZV`*i_sYO_)-;O(09;Z}d95XSL46I%8F`F_qo10kk0*qOr$PC`va_ndpbYvy|{2GJehB@IiF4o$aZ>K{XIGb8+#H_!n;6$gipr{DZ!g
z{{X(k{~?NKvs$nq$xth|FaSV)_a(%J{)*XyhiJArolOn#XGi$37y!k`j};QcILGus
zTQFISh!9pl7@9&C{EEZET*WV3Qx?OA%?t@f)0jaFfT*WU)YT?}FEiZ9@ONZdo1LLu
zF7opRBrE~}wa)fRZUyglRb^$GxSn2Pg91AFWDunfuj18GhDIRNFt3KCaO!XG6XR&1
z28*aehm}!<>IiA_!AaB^KQ(Cz%0e>k6#30Eu?
zFVRRBHaEw|$2T?#1h?9*(e0eWnYQm1Hr1B!cKi1WHPMl!yyD`-M9a|7P&O+nm`UBf
zx#`hy(nM;f-efI&Ys=m~Cg$M5y1IM!ni-dtGv`C5w7MQkIj2kLO^;6v4}(M!NmW%J
zqg~58a-sbR!Ac6xD=uAAR*p0`XIvs=o+nJC@!AI@u?L*fb6sg?her$|Pd^gJMy6kX
zyY5=9aetfR0c3@|$s=BsOcoC~V2u4xFqbA7rlWwKMHLuT_IuR@E0N<;1(y5jqdklr
zA18PT(&hJAnw&ypeXE(*jBty~<~W1~;xeKKN4`lJ4URwYtcit4vd9TpEPUi`Ko+~!
znxf<=Hu;%f(yED6tR88cY6$)$k_sYx5+paB)@w47v$fpK_KbB9<-0uWWx$V$Y(nJvu4LwpP~GnArV?p7r+FCdX3sF>*+w
zM8ps6Vm(S|1s-pS4xBiFG!w(f$;lxV0eSz9%%(EsBY==fcwRHDvGW
Fe*-2SG_e2x

literal 0
HcmV?d00001

diff --git a/docs/media/images/Constant.png b/docs/media/images/Constant.png
new file mode 100644
index 0000000000000000000000000000000000000000..a9c6f28b3591824c0732239096324984401092e5
GIT binary patch
literal 752
zcmVOeFFcbb@qHow`d0Y;LfV5s^(xaR!&Cux=r_h
zK>yEkwuWTri~;WM?zB!GySux2ODz7(wV9cj|EC>kUsw2=N7!5`|NsB+nG)o;ng6pi
z?6#AtQ5D^iW&g!kh=_>Y-QAyDGK@(hpKnk5)xQ6t5&Et%|AnnE%s?=+VL4bRGY=KmW3S?UXD3%7ojB4yZ&Sl06&8RVDFrLHC>x|F0|m!)5=D
zWMNxY|E`aEUP|_}Os8!{fqZ!Ru{!;~Pu+z8ja4uIq=V{$Q2oE5_n8Xrj{yJCdF-7Z
z_OC#eKOFz28iqL-|EnYarde7~M!IDR)?gv_vy8A<63$a7|GS6&yh+s0%m2(~=8gyd
zoe2K4Iq#eo+=dGO)q%E8AK!Z)?wTmWSRMbM5&y4||I~k!LLndTsj>h7010qNS#tmY
z3h)2`3h)6!tTdPa001C#MObuGZ)S9NVRB^vO<`klZ*65{X<;BnX>w(EZ*psMAWc}i
zkt!qr000(rMObu0a%Ew3X>V>IRB3Hx05CK!FfuPNGue__LI3~&=1D|BRCt_YkcI#b
zK`4U(M2Pz6Icht~3ql2S@>nhM`5YqHd=mvh0y@s|8GK1fN}j>Ix{QKA0Y9^hBqh%T
z(^Rc&DK|!G1|1(GJ`i8dK0M7tpHq-QLoYCi2h10jNsn_^VK8(|g2;!4`U}LlFfznw
zDp-HqkjkAq?C=KG<_Aoa(CHB9TlWKE$_z
ijGSU(oWd#~?*ag}r7qqQ?+~c~0000;SsO~ttNgt@c?ITUy+H?~F1$qJv5
zrj%inz4BS|lBY2XpN7wU95Cg+N6)R&S-Wy3tx4&gXH|B=yx^o^#sQu9?QQ>K8~%sZ
z{0}Jm@7e#puI6oK)~nE@m)?oj|A$=pANt%j?acp}v%f-5{aU(vY0a7Rz}r@CC;s>y
z_~w2^f9i&*uDiZCoO5v6`rY`9vHRwCT`RgWmp`jpSqZe)c-0rXl`kw;yt7~a!fK~g
z=)5OIi*oZ8r2!qIu*ouQW?EwBb;IdTOs3w|UZw3aUl-^?yPlho&DXT%Y3a3H_piCa
zH_y(z`J!&~1--@#`u#SZWfuag168_I91G66);c&DuZkdK$q?W#UzIB6L*!=K%vvBTz%$TUpUjQPxsc+FV-7
zR7zY|e1`Pi6Tt84q|K9b~#>w5dpFQc%z_t$REF)G#$AI3{PO
zi`#}?{&3@lPKQ}}C9A8dZ}IjAKfWk!a7giqTGl_Y+%GXPku##9bLwQK<5PFJZ+-_fA85GosxS7-Us$eq7dr0=(3bNhOU@OqP3*jGIQ@yq)Vq6&7M{#q
z477Sr{(QThn~}}e&ZN!sueoC0eDO%k^aC-opNFK(Oq=OhcEPdW>{HKZz2YNN!Y4j;
z3AV^N{LRk&iIdY~8yo$^9eXUQx0}^%F{pl^sd+`+YMoB)e`)Cta&kM>a@MPsK9Ml&
z)7M|AkoTXLcaDa}VO>_
z%)r1c1j3A$?$-SQ3W}AuMwB=gr6!hS=I1GdWag$a7?|iA80i}r-<%ZX1XQ5_QW2b=
zR#Ki=l*-_nm|T>fo0^iDsNj}alvYxA!qX>A
zNlIy8vJMV5*3M3^SKHChH*MR#g{~aNJ_mfmqwk-%q}ar&_F&=i{FJ=+5=XdFicd7L
z@bKuq?cMu$iKN7hJ&QyoB>wp5$i&=np1gX8$i&uZ%B&^(gI6I0}
zGUVzNQK6O$8{S
zC}qw=9fKWQ#zRcqIUjNk==S15ts}q2y)L~lP}(>_ogbmaoJrJ0AgwbXi6JhpDPFKT
z9$x~a$ENK7000SaNLh0L01EH`01EH{Laa2H0000WbVXQnQ*UN;cVTj608L?Ia&K*A
zWNBd_Mrm?ocW-iQb0AGvyOAm+0000MbVXQnLvm$dbZKvHAXI5>WdJZVFEBDMFf-Yb
zT0#H-0HH}lK~#90W8iRC=0FAv99%)3!YBe-))JP&C<2Chw%iuNNCHkg-d5alQo;xU
z8CL}X4_hHdm;k$sti6G8pr((nFjT%dS9ocX$5n$N$)Tp@>xCyk+k0?wOgH`Q@&JYcT)s
zdE3HL%*@Q>)vf*e_W$H#w30>t^on|8F81N2s;a8ZvP6i8i1*uE-QC^)@Pqg0b?wn(
z|JsUdXkPpC*^GEfs*66hqd1H2uT%f=o&W#;+=l<-g2$mxWdJZVFEBDMFf-YbT0#H-
z0Od(UK~#90V{n52MNTM#0YtFI1j@(B2XI0KbfYa?T|L!(nVh{iK>~u&X4;-2GBUh+
zO#b|wKmqRrZ4q7|2-S~r3FdcW5R3`;1aU+4g;eeQ#5oya13hJAO+rKM?S)kNjI5;@
zxP3%G@<6_jL6VUZKZ6*X3`AZi%uqr{fsw(ANe{{o(+mk>VPxPm*V5M)0)jA)NMTb+
zeg-!Ib2&Lxsjy^C=6G9UE@=igP7RJkK126N2W6fJNk&ef)1_7Xj9k=&ZABS?e6Z)F
u#ckM?93xmje28y3`Ng@o#2KYQ-UR?_sW14`Hh}s70000AMyVi9{#UaQ0r%7Fss&l*vy)E6e!K$>FVdQ&MBb@0CA5htN;K2

literal 0
HcmV?d00001

diff --git a/docs/media/images/Index.png b/docs/media/images/Index.png
new file mode 100644
index 0000000000000000000000000000000000000000..6558ec393a6e0b35fb7776a52b4ca9c10da0d5c3
GIT binary patch
literal 584
zcmV-O0=NB%P)sGc1s$KlTB|5tUFl&jIZ$KRg6;GCqm5-wl6(B`4Q;1)J+i=@-=`2U5V
zz0~Rd#@X$9lDq;jjf$eZgrL)or^gjMgq*e3yWRhls?|-6=3oE-010qNS#tmY3h)2`
z3h)6!tTdPa001C#MObuGZ)S9NVRB^vO<`klZ*65{X<;BnX>w(EZ*psMAWc}ikt!qr
z000(rMObu0a%Ew3X>V>IRB3Hx05CK!FfuPNGue__LI3~&s!2paRCt^{$?Fn1@%ouFXELYW(Fj^6Z(U`)_51(-|7XseY25!>(WA}p^8eefzIoSOHBLL@
zu5c=u23
zg#EgG*R(4R8Bcv1+IdSoXt7!L5tEf~j@@~uVBhR|_Md6WYSZ+C#*073PQ0UAdtN0gNKbwkHzugYdUHQk=cz1X!nX~(+V
z_vf=O_Fb>Npdzh8PLU=1Pe4dSL)YuZgf>gNH%uxGi_eHC{A4Kd*st(Y%3;N2oyz=}
znqKw`%X@Y1uQTv0S!*U^fJH$hN@BTe&;g&?!xjVTG>^jPxS@?+*er933
sa(UjQ<*PC{8=_;sg?l=%aQ~mEp5P)i@yk~|9Z;Bfy85}Sb4q9e05`Dm_y7O^

literal 0
HcmV?d00001

diff --git a/docs/media/images/Interface_logo.png b/docs/media/images/Interface_logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..6f223c479a6c6fefab504deb84ab824d2e744713
GIT binary patch
literal 1600
zcmd5*`!|$%9DdQB9VXJcrO7tT6s8%5m)$T$<9->p85y@dE{&RXZA?TG%_2nB{k}w+
z>>y&K8JEf>)@4JEu#A%^x8$DGyKmbsyZ^yH=X@^b^L>8!JkR-jlN{|WrKJu_0RSLv
zZDr;RS2P?)5fX5&yJ6f47l|;kH4TA4Ow2fl06^Tq(T-*gK@j``L!Zj}+HeO}zBX0;
zizS_}vsy(-{E4`_@#vbdi+5fGm5%u5_tDdPtzuhX8qOmN&M4C`MSV{xS#?0cPBr16I(qS$$iDTJrh_s?O!p#8Hcm?#qi{w{Bl~rNTh%>k
zux{n)ub}uDC~68~PeK9XP|o0n-x!qAyY4;;IgdbbU2Fb*kj)U}I`FAP@Yeb{ME(1wR2$S
zCnkTzwDp5^%MQJH%Za}Qw(J@Sb}rN|#d2rO_**uOn}$u>PW5Z&eqR6^w@vF-EowJR
z?ytf7pRC>Vy0c(Xy#ZElT5*>`i$x}PS71@3%2n|0Ix}zDrR23?#T;0%YIu7FmT6El
z2Nu24DVZbXi)=HebP7bUa4>sWJ4d9GHAl=E1#c}<6Gn-tBHfgEozyY>%|Y;&c|yW4
zku#~q8L_(3kLUF3#=OE^@6x?8LyQ_DL=9+0x1A2}#zl7MT$&`ZUJ%&*xUeUhY#|}I
zSN$R%Hj~6`#Raq+3+8G3+=%z@#4@=!KOxb#LH%4E&aW2hTXDiu02{99&efzpfNj@w
zsn?)ZV`*i_sYO_)-;O(09;Z}d95XSL46I%8F`F_qo10kk0*qOr$PC`va_ndpbYvy|{2GJehB@IiF4o$aZ>K{XIGb8+#H_!n;6$gipr{DZ!g
z{{X(k{~?NKvs$nq$xth|FaSV)_a(%J{)*XyhiJArolOn#XGi$37y!k`j};QcILGus
zTQFISh!9pl7@9&C{EEZET*WV3Qx?OA%?t@f)0jaFfT*WU)YT?}FEiZ9@ONZdo1LLu
zF7opRBrE~}wa)fRZUyglRb^$GxSn2Pg91AFWDunfuj18GhDIRNFt3KCaO!XG6XR&1
z28*aehm}!<>IiA_!AaB^KQ(Cz%0e>k6#30Eu?
zFVRRBHaEw|$2T?#1h?9*(e0eWnYQm1Hr1B!cKi1WHPMl!yyD`-M9a|7P&O+nm`UBf
zx#`hy(nM;f-efI&Ys=m~Cg$M5y1IM!ni-dtGv`C5w7MQkIj2kLO^;6v4}(M!NmW%J
zqg~58a-sbR!Ac6xD=uAAR*p0`XIvs=o+nJC@!AI@u?L*fb6sg?her$|Pd^gJMy6kX
zyY5=9aetfR0c3@|$s=BsOcoC~V2u4xFqbA7rlWwKMHLuT_IuR@E0N<;1(y5jqdklr
zA18PT(&hJAnw&ypeXE(*jBty~<~W1~;xeKKN4`lJ4URwYtcit4vd9TpEPUi`Ko+~!
znxf<=Hu;%f(yED6tR88cY6$)$k_sYx5+paB)@w47v$fpK_KbB9<-0uWWx$V$Y(nJvu4LwpP~GnArV?p7r+FCdX3sF>*+w
zM8ps6Vm(S|1s-pS4xBiFG!w(f$;lxV0eSz9%%(EsBY==fcwRHDvGW
Fe*-2SG_e2x

literal 0
HcmV?d00001

diff --git a/docs/media/images/L.png b/docs/media/images/L.png
new file mode 100644
index 0000000000000000000000000000000000000000..eb334edaeac52e2f473ffd92a49b025fb6148ec3
GIT binary patch
literal 153
zcmeAS@N?(olHy`uVBq!ia0vp^!ayv*$P6UUaa~gcQtTz3zOL*Scz79Am98pQqyvRG
z3p^r=85p=efH0%e8j~47LAC&&5ZCE_)&Kwh7Y~}?0Tf{>3Gxg6&+v4+fftY`;pyTS
tQgJK!NBsYWhyUvpj=8p5Ib^(%U@*zon(m*SoDEdN;OXk;vd$@?2>{+EE2IDb

literal 0
HcmV?d00001

diff --git a/docs/media/images/Lminus.png b/docs/media/images/Lminus.png
new file mode 100644
index 0000000000000000000000000000000000000000..f7c43c0aa3bebb499e86eb744b1e47b9a9445ba7
GIT binary patch
literal 219
zcmeAS@N?(olHy`uVBq!ia0vp^!ayv*!VDzYUPT51DfSXiUsv`EJiLsmQh${X`~(Vd
z7I;J!Gca&{0AWU_H6}BFf(8LTA+A9B|NsBf`>KHqVn8Lk#c`lIrjj7P;QtIyw;Ol?
zc?O;?jv*Ddk_A|pTm=*lC~zFVdQ&MBb@0OtiQr2qf`

literal 0
HcmV?d00001

diff --git a/docs/media/images/Lplus.png b/docs/media/images/Lplus.png
new file mode 100644
index 0000000000000000000000000000000000000000..848ec2fc3bbaab6345864c303684ff8a86559cfb
GIT binary patch
literal 224
zcmeAS@N?(olHy`uVBq!ia0vp^!ayv*!VDzYUPT51DfSXiUsv`EJiLtR`ZJfMMF533
z3p^r=85p=efH0%e8j~47L4yFF5LY1m|NsB#ebqn)F`$y&;y6$pQ%R6t@PCG<+YP*c
zJX22>$B>F!$pS1)t^$e&6gZd#)XV}^6#`leL>0XheB5$;*x1}$U0qr4a0#d>%paztiFSddoE
z=FO+Zs9v~B@b&OYf=WY?JVJfcJk32QO)AOb$urFVKXE`Ry)jqsH71)XJB8YEt>{GE
zGvwvuGqv|cy!A6?%sp|-T8&j?o?bnP-A{*1r^4t+dqpBkBPV|V>IRB3Hx05CK!FfuPNGue__LI3~&
zAaq4obW?9;ba!ELWdKcKV{&h8Wn^h#AVz6&Wp{6KYjYq?Si6xbBme*ayGcYrRCt_Y
z&;kMn2M1Xdeh6R)4Ab%Sw6|x9hYPq^SqVCeF?quTBwVb*o#mC81mFUy;m%?#?D`xC
z0cWuYe|IAv4`YZxESp$_l#sZsh-s)UL?ALUMqSb?I@nP<)JGU7U}h%a#vI_K=%}q7
zq~RmZ$N<)8;N{4}qYx4zCu$87;NdY>VCC|)P=g6*o7-s0FmMCSfC?zsMKS0(@xufx
vP5c-vI3ex;lft~dN-&p#Ny9iND4!ny)Wjn48}#yJ00000NkvXXu0mjf>`)kw

literal 0
HcmV?d00001

diff --git a/docs/media/images/Page.png b/docs/media/images/Page.png
new file mode 100644
index 0000000000000000000000000000000000000000..ffe7986ee2e78f7079d6de1a13ef29bff125f7a8
GIT binary patch
literal 592
zcmV-W0wTQkb(FJYg{r&I=J@>oPidBsr@_|i|DM0#0xyTVySs>p
zi0u&l@7S9O=i(&oFz-*}d|5-wk#ve_0k
zZi}ST)an1e-~WcE$O18qgrL(EJcN#?$DzRBm8#XK#^imQz1B}9Gynhq32;bRa{vGe
z@Bjb`@Bu=sG?)MY03dWlSaefwW^{L9a%BKbVPkS{ZDnL>VIW3na%FdKa%*!SO<22;
zDkJ~^02XvbSad^jWnpw_Z*Cw|X>DZyFf=bPGA}SQ*^*j900025Nkl8X^a6$`;}MU&lC(fZYGN)*U*T&WTYe`t|6?P&^gvL>{}6e8nl
zLI{`JKlCFG|LqoMkSE{iD56H;IN0Sraje`6bqbr=>+Ac4L(v&iSUtNMDLgY2KvhT^
eCV+sH1<((?kR=WgbuC-~0000)GO-L0AERF6v)dP%qbhFs5=j^@`6F?l_(@;?;SYFPR0
zI9jbQwZey3=y8ba9+c^JAk$@k`bNJ*XM8mL<6q0r!V+YD551g+rvHRYW=KB^jl71Q
zyjUEXf%<=gv{N57&;Ray_CaNWG~<7$j7xBl@^MHtX718|yz^v1Gcq;sXrgWOL-%8|
zeAujcX!zyfo16VFq#9G>J(EnWtL=RyR-0NB6V)oy
zRmEie9Z=A1gd35_HMMe(FE?E78WVI3@nv91+wgViUAV!rpFqJ)Wl_to!seceCS_?;
zZ;4o$E4k0B*A>>Q@@^>L31o}zmDNbO)e5c<%)AP+E5P*1yXjXRr0_e>m1)_fP3L*4
zq>@`n#eK};ri8-Yv`eDs;=aU7t-G*r(;{fc=?O5OKSe$`R3j_d*nP9?x%J(%fQEH%67mU3Hek2mE8BI_V-TD<8{d?o6-ef!PG`p%c&+4{j^aUgcH
zPg_HSd3If0jjtfvXN7{Bm9@0`
z{!FFF(*y6@p7PEXiOALIn)UNaUZG?FMfe@usLHF4iAJOOeEx9SoR_ols++f6a=J|s
z5ggQNwU#-2UgKh&U;x$U?l6kKlg`fF$Kh~T&%}(*P&e;MzM$e1iDYH5)s7SzdNQ)O
zW|LFc9?jNAIaVEr_>4^{Y;|6Zw5lrHumeb(iS9?J(ExtAVJMHD8w=kA5FA7#v<61y
F{sZ~k(bNC{

literal 0
HcmV?d00001

diff --git a/docs/media/images/PrivateClass.png b/docs/media/images/PrivateClass.png
new file mode 100644
index 0000000000000000000000000000000000000000..470e6d5684f29e52abb36ee6036a4d0b717f92e4
GIT binary patch
literal 790
zcmV+x1L^#UP)WmEhNm^6>N2zOCt|Fuvb2MPgIr%?-{0R%gxJKy#3oLoEQio1TB$RW
z>}rOS@9*z3X3RRU*Z=?jNYVd(pWkzHbE2lGGqCn7nbbf>Stx6=M8@%WtGpvWd{9$d
zW@ctxl-^f`)gwrPNl|4eO^Yjd!Y3yuC{eAu(Bd|2#VxYmFkYoDiPgf`>UMyN)z#HS
z%>A{^=P{-CPSgKgi`geqs99WJM7{YbYtFRD+-aQPBu9}dn9Ep?+$&_jF0SJ+!SP*W
zX)~JcM@?QQa<)}jTP=IfF8)Ib00009a7bBm000XT000XT0n*)m`~Uy|Aaq4obW?9;
zba!ELWdKcKV{&h8Wn^h#AVz6&Wp{6KYjYq?Si6xbBme*a7IZ~ebVG7wVRUJ4ZXi@?
zZDjy3G%qkRFEBINl3GFl008buL_t(|oMUj)Q(}VxtyFm#HwHbAypTdL(6@<=mvd%N
zQkP73cXv}CPB4cExH8Hr
zR9dNMl-WZB*f~Ua3V1C`?H#MY0*R^toKm_>URD+2h7KTs7*P=&Pi7Gj&r(CfOje+P
zFt?7JoTp{7PL{MZM8L#S&O(+`PDicC$POfs3ly+qPy-6^M{5QG1%xD+<>aCiZ7tPU
z^H~Lf0(?n|mdsYno>sEH;pIUBhYhhT*-1^kj&-m>@4F3035e9
Ui&^Ep{Qv*}07*qoM6N<$f)e~=1ONa4

literal 0
HcmV?d00001

diff --git a/docs/media/images/PrivateClass_logo.png b/docs/media/images/PrivateClass_logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..590e00640baeca2f541347cc1c5067c255030bba
GIT binary patch
literal 1836
zcmdT^`&Sa!7N)T^!|2#(lU~J2d<$xV*reb%if{uGAB2xcCr~6EBoS~N3`R%8oA1Z9
zjI?x2^HGvbVw2{xv>MSY!8DVxe2kTOO|w!{=Jd;~yVm^+?p|x3z1KPWoOQnaedlBa
z1?)G}hv`Eg5JNJFKm!r}(V==^BvfbjfuJYElj%?>bo^=HBn0wFeULw$sMG1d%HLKu
zxBzkwfr3JzfTUsI<@w&3l8(u&mT`$j!bTAk>Lj{8{G)6;Xhe<^xY#~9JI
zx3?b|Ud!owO;hVQDqYy%2IZmdeCu=a(B{wGi%O+3M75INIh1s3f~0znAN+9Y`W*B2
zYFSHH*zMJT-gTef-zyY~$j*1CuC)_;*9A8gz*V^|uYx-Nq_)2&cB}^f_O_;`#Wz=Dmm0WGd_5vmZPn;Z@Y$?s-xl010-LVn-j7_WpUmV?gQ
z#@BnsDCw;D-Mk{e0y63*g(>ik5-}JIM`rWR*c|KVbAjP(z>W_i1`*!8_i(%|;{uGC
z=1*tRXf#K<;z00WJ9@QwgxE5?z#+KKmR3oohFArc09Du>_{D}=45RaiWSTAcoE0S(
z@N0$7w#FA*`D6m3Ej=?Wu_-VQ{;qw(T^K2l4WQn_MPTm22Kq5Uga8S_V6a;oN&P@u
zQzBZxL5Q(6h7b}0@Ff42os>5;w6y`Ds8kaR|6@St|4;V1Z*vQP`#GOQZH!5*#rSH(*E!w%R>-W{9c69(j2#gn5S*Pqeeq^v
zzkL7CbksY8FY>ZH_y6!U8jYr2bRG(APR1>F*_YGqtw{Yg0`Hk*&pV0b&!3yS)ld!|
zn-f5urNP6I+p~<`D6nDn7fewiT>32o*H`kl6t(#{?$F=*N%E5432(0YCHDnRmtM{%F+ZC$WQDv++M6`c7mUI8vfQsyf=ACU$>$DI+n##uKp{O$Xh-}+|U_|mnTX|Q;*F+<{u+T@*V3jZ|K
z&~S*U?dR?=dYp2%b8#zklwvgU3(HA5ZJ*GQU#Pd#ydxV9O*j5)xBk^zxanB&!TRJbl+-sIOMSY7+S!-!q6vOvO6U|hJ<$tucw(e2>IopzU
zf2Q#2*c**a=_FsApXeEHs+lu9>UQWW!OhK72-@dJnVPY@2A%?hObj3>@XYkT0K34m
Aj{pDw

literal 0
HcmV?d00001

diff --git a/docs/media/images/PrivateMethod.png b/docs/media/images/PrivateMethod.png
new file mode 100644
index 0000000000000000000000000000000000000000..d01f2b314b973da7318cdb98a71a326f383e5864
GIT binary patch
literal 918
zcmeAS@N?(olHy`uVBq!ia0vp^0wB!63?wyl`GbKJbFq_W2nPqp?T7vk7#J8E0(?ST
z|NsBrx}lMUpA{(2slZdYq28zK9FXna5yY)2U{iVAD08bu#A0RNsVOVc1TDmPHTipb
zdQ55!GnYS0Uh*_%;nVQBj{~OMck8;@+}kAODC6$#?$PP#(BP7mmKGHirRd(Fy|8-qYX6HC
z9+&iNuNW;|w!-GTq4$nAHfL?^c7FHT`aNmOeB(356Bn%kIv{R`xBWrwnKNf)W>PYjD}zLwkAT3uZo(G~1G(Z;{#vR6}oNlA%PpSD}U
zF^_6j=PGB;3=*#Y$WwN}P*Q6H7Al^Atid
zb5j`%O!N(m^bL$}PKt5@s!#x_2+mI{DNig)W$;Z*F3QhMP037DaLX)8Ezd8?E>`f3
z*ga881*rD2r;B4q#hhdTK`}8wQQ_$c$qh{j*4F9e`#W^>b~G%TwQJr~Z#{D#1vl?l
z|LazJX0WSGSg|%ebAsU9Bi!N!<-8wzw);;`Y~fl`b(`(zvrGw95l%-IFCTC1&!2ls
zzwGV0^wWWiW15+nU*5!-t};9e3k&TQp8P2%
zX10&@>Zv(AJSVl5iLPpE{gyxy^(5I^
sFWFixmIS`k36rN!*Izp!t?eTtSH52M{Yh~%f!<^AboFyt=akR{02;ETy8r+H

literal 0
HcmV?d00001

diff --git a/docs/media/images/PrivateVariable.png b/docs/media/images/PrivateVariable.png
new file mode 100644
index 0000000000000000000000000000000000000000..d76b21d4e9e8656a68989f007945ab14507ae23c
GIT binary patch
literal 772
zcmV+f1N;1mP)%f|KD9dx9b1xbjG4eNtEH2jam85a{u&(X=GITZxLbNk_B|L=MK=xa7(sn)kg@8o`zfK1-9S*@a5ux7
zfmfd7&Z|n=(z?t5000SaNLh0L01EH`01EH{Laa2H0000WbVXQnQ*UN;cVTj608L?I
za&K*AWNBd_Mrm?ocW-iQb0AGvyOAm+0000MbVXQnLvm$dbZKvHAXI5>WdJZVFEBDM
zFf-YbT0#H-0Od(UK~#90W8e{Sh>wpK_v7H<0s#g#e~U6rcWa$YHYh)|I4&;C+*d}O
z2f|lomMalTR8dirW#a+!op`m(q>74+J*{+kKztWlvm~$d^mHFbLpC7aKvFO=TL8$-
z(9YH4VPIntQ#1*-Nlnd2bB@(uW8hJbF68FUi^)(>aJDaCV_;(~R6mrqkrNJ-9N
zW6+HbC{^VT@L*JM&I(uJVNf@UHVOzZ($7!fbQ1-dZx^5&WvUzCEm6)Q&B_DjGcf1|
zBm@>j=z`qG8lcY2t!~7v&IWNmtEDgym~unB%LM?}VJts-{;Z7v0000paztiFSddoE
z=FO+Zs9v~B@b&OYf=WY?JVJfcJk32QO)AOb$urFVKXE`Ry)jqsH71)XJB8YEt>{GE
zGvwvuGqv|cy!A6?%sp|-T8&j?o?bnP-A{*1r^4t+dqpBkBPV|V>IRB3Hx05CK!FfuPNGue__LI3~&
zAaq4obW?9;ba!ELWdKcKV{&h8Wn^h#AVz6&Wp{6KYjYq?Si6xbBme*ayGcYrRCt_Y
z&;kMn2M1Xdeh6R)4Ab%Sw6|x9hYPq^SqVCeF?quTBwVb*o#mC81mFUy;m%?#?D`xC
z0cWuYe|IAv4`YZxESp$_l#sZsh-s)UL?ALUMqSb?I@nP<)JGU7U}h%a#vI_K=%}q7
zq~RmZ$N<)8;N{4}qYx4zCu$87;NdY>VCC|)P=g6*o7-s0FmMCSfC?zsMKS0(@xufx
vP5c-vI3ex;lft~dN-&p#Ny9iND4!ny)Wjn48}#yJ00000NkvXXu0mjf>`)kw

literal 0
HcmV?d00001

diff --git a/docs/media/images/StaticVariable.png b/docs/media/images/StaticVariable.png
new file mode 100644
index 0000000000000000000000000000000000000000..8e820193cf930c4147eba542a1b50626933d1f42
GIT binary patch
literal 688
zcmV;h0#E&kP)ugtEVnh;=iW%reFK|K(=fyleQ_jJUz6HFV9ct*geON>7>N>(GgmfJ|kL+1=gU
z^~Y`c%U_K>y!eySuyp^oG^8
zOJ%3#Pt*VAzglvk(fQzS|Kx&gliM$y+%{plJI?=wq~ZVfjLxV|_|0oEwD7g7kJ`IY
z``=&x-kSgDYyawSp@vA;vQq!uhw#*m-@tNLp5*`PleCyn|MHYq)&I_`O8L%mFH&Tq
z00009a7bBm000W`000W`0Ya=am;e9(Aaq4obW?9;ba!ELWdKcKV{&h8Wn^h#AVz6&
zWp{6KYjYq?Si6xbBme*a7IZ~ebVG7wVRUJ4ZXi@?ZDjy3G%qkRFEBINl3GFl007WQ
zL_t(|oMT{NQ!(J+;Bd9(Wn%#W1{OIVrx+F&;*6wS&87O>I`iFMG>&~Wn?kpl^s3aTqPC~9aZgzBhqu>l3V
zEJEUe@?l}Z!7lo83@mJN_9niTy1Jpl!gdkiKmisO)({&oUzpiX1}q>a${hye3fnpI
z39x|#*m&f1fLvyFNkfn=ASHU{Ea4lA_OTmCm4hW!rK?49w
W#UB-s5zQI^0000H>
zJR*x37`Q%wFr(8NlNmrkwg8_H*Xe!L|Ns9N51QZs6k#d}@(cdY@N~O@7mz3J>Eakt
raVz;p{QriB|LYZwxwcz9n9R-~pRXx?mgVYJpb`d8S3j3^P6#nkpi;(?AirP+hi5m^fE-m%
z7srr_TgeFwOpI(f46|1#2yiGY`Di?KiU>FVdQ
I&MBb@06e2A@c;k-

literal 0
HcmV?d00001

diff --git a/docs/media/images/Tplus.png b/docs/media/images/Tplus.png
new file mode 100644
index 0000000000000000000000000000000000000000..2c8d8f4fd38259b2ef70fc63fad505fb0a0f55a4
GIT binary patch
literal 222
zcmeAS@N?(olHy`uVBq!ia0vp^!ayv*!VDzYUPT51DfSXiUsv`EJiLtRLI=-jc>;wv
z3p^r=85p=efH0%e8j~47L4yFF5LY1m|NsB#ebqn)F`$y&;y6$pQ%R6t@PCG<+YP*c
zJY!E6$B>F!$pS1)t^$e&6gZd#)XV}^6#`leL>0XheB5$;*x1}$U0qr4a0#d>%86hy4NT6+w`tp00i_>zopr0L}p{>Hq)$

literal 0
HcmV?d00001

diff --git a/docs/media/images/Variable.png b/docs/media/images/Variable.png
new file mode 100644
index 0000000000000000000000000000000000000000..8e820193cf930c4147eba542a1b50626933d1f42
GIT binary patch
literal 688
zcmV;h0#E&kP)ugtEVnh;=iW%reFK|K(=fyleQ_jJUz6HFV9ct*geON>7>N>(GgmfJ|kL+1=gU
z^~Y`c%U_K>y!eySuyp^oG^8
zOJ%3#Pt*VAzglvk(fQzS|Kx&gliM$y+%{plJI?=wq~ZVfjLxV|_|0oEwD7g7kJ`IY
z``=&x-kSgDYyawSp@vA;vQq!uhw#*m-@tNLp5*`PleCyn|MHYq)&I_`O8L%mFH&Tq
z00009a7bBm000W`000W`0Ya=am;e9(Aaq4obW?9;ba!ELWdKcKV{&h8Wn^h#AVz6&
zWp{6KYjYq?Si6xbBme*a7IZ~ebVG7wVRUJ4ZXi@?ZDjy3G%qkRFEBINl3GFl007WQ
zL_t(|oMT{NQ!(J+;Bd9(Wn%#W1{OIVrx+F&;*6wS&87O>I`iFMG>&~Wn?kpl^s3aTqPC~9aZgzBhqu>l3V
zEJEUe@?l}Z!7lo83@mJN_9niTy1Jpl!gdkiKmisO)({&oUzpiX1}q>a${hye3fnpI
z39x|#*m&f1fLvyFNkfn=ASHU{Ea4lA_OTmCm4hW!rK?49w
W#UB-s5zQI^0000(x0NIF%{nuT>i_6Z|J+03z&LVrQvdj0nPvbd
zPMvIEmeZ?!4s&x#
z#i%Uo#W*vP>T-Bh-n}vA&qc6+7`mT2TL1t632;bRa{vGe@Bjb`@Bu=sG?)MY03dWl
zSaefwW^{L9a%BKbVPkS{ZDnL>VIW3na%FdKa%*!SO<22;DkJ~^02XvbSad^jWnpw_
zZ*Cw|X>DZyFf=bPGA}SQ*^*j90002ANklU5Ub
z)J&2>v72qTTu7E`nx@t2xdQKkZtdZYg4lY+yP)e911YGU#WzGE3Im~vZA6xzk`9>4
zNL8_RMr5ZhnC39*aq{=8RR=h(7tdcVhw%9H0)imQWkC?GbCM*z2n^6y_rKc*n=K%t
TSg55|Cs*qzIWRJ6ld^s^>bP0l+XkKHvAUX

literal 0
HcmV?d00001

diff --git a/docs/media/images/file.png b/docs/media/images/file.png
new file mode 100644
index 0000000000000000000000000000000000000000..0bb2427f8afe94b50835b0a6fb2f7fc4b6624bb9
GIT binary patch
literal 462
zcmeAS@N?(olHy`uVBq!ia0vp^{6H+o!2~3GGZMc6DV-A6h!W?b)Wnj^{5*w_%-mFl
zkkV8IBTEIZ#5@Hf0|O%FdgViBVQqh^b}u-UUD*
z&H|6fVg?4j!ywFfJby(BP>?0v(btiIVPik{pF~y$21Zp+7srr_TgiX^|F>tp*udH$
zEiL_V#ftUo-3uDh%uP)G{Qt|SZB_7q!9$E~2FI`q8Re^|Ns4w54;**JyG{r3reJX3bz{Zf3vmrZqg`n}6P+S5*tz>i^H*
z#2~u%W)Z8#mr%xxhMwd+SvmjaL%%Odb!ew<(5(2Ban^6jjOpAT8-5&KS>(Rw-29d%
zNdZfFap?uEMT+k<(v+DOT$Z%I^ZS1lw?N{?lj=*DIus0-A5UO#>EQ|b(2vWFmuh=~9H|IVo^qIey?Dz1hsy_{P4Pvu|$000SaNLh0L01EH`01EH{Laa2H0000W
zbVXQnQ*UN;cVTj608L?Ia&K*AWNBd_Mrm?ocW-iQb0AGvyOAm+0000MbVXQnLvm$d
zbZKvHAXI5>WdJZVFEBDMFf-YbT0#H-0F6mRK~#90WyotAfiM_=;n!)RO))lyYKg9G
zDu)jI|9{59Wq7{b4-9^S|1r5?yt?|k_gEL_vSjsQJ~o|}aLiJr)OMPgdUXK!BBdrI
ziX117J(mLBNUinDT$y2+3p0|WwfAs4W|lcJ!*ci>ABPQvf>`e66oz{@WlRWx5Nh&6
i1*3pkRRDgc|J5D1CKP}NM>^*K0000|Jy16

literal 0
HcmV?d00001

diff --git a/docs/media/images/function_folder.png b/docs/media/images/function_folder.png
new file mode 100644
index 0000000000000000000000000000000000000000..8b3d6e3b12902fd6de044496082464dbc7639d42
GIT binary patch
literal 605
zcmV-j0;2tiP)|{;@VQH
zutK?#8|2oVPNX5otuVc-H2>T~`qMo_z!(4RRPW0<*~LTu^jkBj5P!Tt|K&_$wm39v
z5ILL=BqI
z!r&0NoVJJLDxgp-+TMLq>XzlVuBikpI}FsMP+>!akcx{yaKxWv;lIWQI-(jqRCU$Q00000NkvXXu0mjfHW&%O

literal 0
HcmV?d00001

diff --git a/docs/media/images/minus.gif b/docs/media/images/minus.gif
new file mode 100644
index 0000000000000000000000000000000000000000..f502662bccc750fa7163df74d83beb34041d8509
GIT binary patch
literal 54
zcmZ?wbhEHb>%!0InVFe0X3Tk++2-cv|NsBJy}eg}(|db+t*x!g)adv3
z_j7Y|rn=z0$>ZMM-tX`4KW@&Ajg7^{#b#z^wY9a6sobTdrOeFC+TiVjgM-%A*0aLm
zTwGj+qT6qh*h+WM*WK!7W@ee0nXJF&WQx{%o7>so?BwU}l&#?3;^@xa?}MP(t-ap6
zEIdd6000SaNLh0L01m?d01m?e$8V@)0000MbVXQnLvm$dbZKvHAXI5>WdJZVFEKJN
zFf-)xbMgQH03dWlSaefwW^{L9a%BKbVPkS{ZDnL>VIW3na%FdKa%*!SO<22;DkJ~^
z0ZK_kK~#90g_GNIgCGzd~1b@PXAis>##hF-Lcwks_T5{Gt1=G+~a%dFwQCnQZU3J+k?=iHfkBIVqw%X0=b%mMM4MWsfC|3Za
zJLI<3MRLMm2C;EFN?uzwL|DX3a6V)!kcPBr
r4(}qx0<9ZuvwaL3$t_-E{1p8KSMoIIFM}#&00000NkvXXu0mjfmFG8p

literal 0
HcmV?d00001

diff --git a/docs/media/images/next_button_disabled.png b/docs/media/images/next_button_disabled.png
new file mode 100644
index 0000000000000000000000000000000000000000..4a11780fc0ec50dd27cdb6a52f863c511e32b61a
GIT binary patch
literal 543
zcmV+)0^t3LP)D
z03dWlSaefwW^{L9a%BKbVPkS{ZDnL>VIW3na%FdKa%*!SO<22;DkJ~^02XvbSad^j
zWnpw_Z*Cw|X>DZyFf=bQGA}SQTlLsPeLfOt#LNVQ}_yWVA&J!XM&=yzgAag0bSrwNq7QKuW}AeCmE|^Nojv;1W49t(
zJ^R_7npd}q|9AEYBEEOSPL(b=(wtUnF~5x!^#c9rjMvp>dVHd>fI6h^x!+-x^4?w{
zA}`WpEJtxdM>gE74H3rQb1zDxCZhMp#IYTl92jdPHrzr4kKJTmn+Eji>=$zWWK{du
hHd63A_=WQ``UAH88gT1vi|haZ002ovPDHLkV1oT`@4^58

literal 0
HcmV?d00001

diff --git a/docs/media/images/package.png b/docs/media/images/package.png
new file mode 100644
index 0000000000000000000000000000000000000000..b04cf566d4ac41fa95f87664cf65325cc51e8a64
GIT binary patch
literal 668
zcmV;N0%QG&P)t@djQ|x-^8(p
z?4%BxbRnvSIo8(J;;cKFW&rs3_^P0a=H}+Wz`&@4HsP26zocrIZ4l3l0QR&iRXPBo
zdnn+jGIdY@nPvdLr+C=OsEk?wl583Es}SUx0Hl8}w3Siws0*g0p<_e<_q#u(c^k{N
zhsBHlt8)OYia^7{zq@__-VIW3na%FdKa%*!SO<22;DkJ~^02XvbSad^jWnpw_
zZ*Cw|X>DZyFf=bPGA}SQ*^*j90002jNklc}6)3g8(
z2ru$H580mZyrWAbSccU12f~7K5mUsGBX6FN7o9)y4In#v$>W9q0000@uL8oa~j{sfyu2e|KUjW+DCy{0JN1+^UXT2cmT$oA=$Mq|M6Jhn+c_M3;+0E
zbx;8R*gvs`8movsnPvdrmjLt9Kjg6{xsNKVeGbg7FZ<$8{qAY-)kDUkCzNLg*TZiA
z)ja?7TfLMa+qE&-lK}C{I^?=9yq74~zG|$36Zh6a^rZm*+(ZBWW~z4x;hqqmcOiRJ
z0IiEc|K?4LUIG8;Po#Y-wvr&V>IRB3Hx05CK!FfuPNGue__LI3~&Aaq4obW?9;ba!ELWdKcKV{&h8
zWn^h#AVz6&Wp{6KYjYq?Si6xbBme*aqDe$SRCt_K&07n
zYC8yeE(c9}CP^I;-Xj?!ixGY5~lHzpft}vlT9I`brT10000%q?FnVFe0X3Vv2q^)rKP2vv)}0J@jq_P*4*ihjg4kzX1%?=#l^*vtlzDzt>WeD%*@Qz*49dQ&}@*_
zgM)*ny5P~$Sz@EU>hb
z00009a7bBm000id000id0mpBsWB>pF7IZ~ebVG7wVRUJ4ZXi@?ZDjy3G%qnSFEBIY
z@^kV4001C#MObuGZ)S9NVRB^vO<`klZ*65{X<;BnX>w(EZ*psMAWc}ikt!qr00BTr
zL_t(|oOP4!R>L3+K%uvC@aN(<}}S|
z_cY8cJz7aQY#zo&M2jq~x36itf~8liMJ`!c@Asvy$I6;i&)Dnru()HiB+edazpMKd
zEoJN8-)<(BGm@V>Kss~sJD&cma7A&3Rf
z-i?ioW@cust*yny#e;)`TwGjcW@ee0nN!N#@Bjb+32;bRa{vGi!vFvd!vV){sAK>D
z03dWlSaefwW^{L9a%BKbVPkS{ZDnL>VIW3na%FdKa%*!SO<22;DkJ~^02XvbSad^j
zWnpw_Z*Cw|X>DZyFf=bQGA}SQx
z*6k)+-YhrkG_XnH4KgoalbW`Y#C%zLMG(A8#WIe0Sdy)s;aR#>iI`s&ukbi9->Bn;
zl^kv0>?j`lHcTk$X~oOxj`mj&)#BNTkGP5zKdfml{jyB_s;gQ~-J%yw(;cg&WqD+e
z@4Tv&%scxQ+Swu0bZj8*=8QhlX_YI61C}V0RhrpeSIKn$X;_d%y$~5a%u?9ODEgSKg~J500000NkvXXu0mjffsXN<

literal 0
HcmV?d00001

diff --git a/docs/media/images/private_class_logo.png b/docs/media/images/private_class_logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..590e00640baeca2f541347cc1c5067c255030bba
GIT binary patch
literal 1836
zcmdT^`&Sa!7N)T^!|2#(lU~J2d<$xV*reb%if{uGAB2xcCr~6EBoS~N3`R%8oA1Z9
zjI?x2^HGvbVw2{xv>MSY!8DVxe2kTOO|w!{=Jd;~yVm^+?p|x3z1KPWoOQnaedlBa
z1?)G}hv`Eg5JNJFKm!r}(V==^BvfbjfuJYElj%?>bo^=HBn0wFeULw$sMG1d%HLKu
zxBzkwfr3JzfTUsI<@w&3l8(u&mT`$j!bTAk>Lj{8{G)6;Xhe<^xY#~9JI
zx3?b|Ud!owO;hVQDqYy%2IZmdeCu=a(B{wGi%O+3M75INIh1s3f~0znAN+9Y`W*B2
zYFSHH*zMJT-gTef-zyY~$j*1CuC)_;*9A8gz*V^|uYx-Nq_)2&cB}^f_O_;`#Wz=Dmm0WGd_5vmZPn;Z@Y$?s-xl010-LVn-j7_WpUmV?gQ
z#@BnsDCw;D-Mk{e0y63*g(>ik5-}JIM`rWR*c|KVbAjP(z>W_i1`*!8_i(%|;{uGC
z=1*tRXf#K<;z00WJ9@QwgxE5?z#+KKmR3oohFArc09Du>_{D}=45RaiWSTAcoE0S(
z@N0$7w#FA*`D6m3Ej=?Wu_-VQ{;qw(T^K2l4WQn_MPTm22Kq5Uga8S_V6a;oN&P@u
zQzBZxL5Q(6h7b}0@Ff42os>5;w6y`Ds8kaR|6@St|4;V1Z*vQP`#GOQZH!5*#rSH(*E!w%R>-W{9c69(j2#gn5S*Pqeeq^v
zzkL7CbksY8FY>ZH_y6!U8jYr2bRG(APR1>F*_YGqtw{Yg0`Hk*&pV0b&!3yS)ld!|
zn-f5urNP6I+p~<`D6nDn7fewiT>32o*H`kl6t(#{?$F=*N%E5432(0YCHDnRmtM{%F+ZC$WQDv++M6`c7mUI8vfQsyf=ACU$>$DI+n##uKp{O$Xh-}+|U_|mnTX|Q;*F+<{u+T@*V3jZ|K
z&~S*U?dR?=dYp2%b8#zklwvgU3(HA5ZJ*GQU#Pd#ydxV9O*j5)xBk^zxanB&!TRJbl+-sIOMSY7+S!-!q6vOvO6U|hJ<$tucw(e2>IopzU
zf2Q#2*c**a=_FsApXeEHs+lu9>UQWW!OhK72-@dJnVPY@2A%?hObj3>@XYkT0K34m
Aj{pDw

literal 0
HcmV?d00001

diff --git a/docs/media/images/tutorial.png b/docs/media/images/tutorial.png
new file mode 100644
index 0000000000000000000000000000000000000000..bc19737521daf3fdf8ba84693a6c1db275587a5c
GIT binary patch
literal 431
zcmeAS@N?(olHy`uVBq!ia0vp^0wB!63?wyl`GbKJbFq_W2nPqp?T7vkfZXr^pAgre
zprHL{KJDGRx2LCv!T8Mo|NkA*ZeG25wYa$W-Me?omMzQgdGzervomMTq@|^;S+i#5
z%$Y4ME$=`5xp(j0`I}#l9z7Zv8M$@qR-kNkbv01-`}gk!y^mPGos9)r!CBxDS#iRWF{)OWfrBD=NDxcEBHq2o~We)
zR4WEj>s*wYSdy8arx22vo62BdqHkafM2UK~>Od6>JzX3_D(1wVzsPr3frB+*)nX0d
z)r+?ozWcww_=ZWek(`gs#BPRvqA|;NeJ*kO*ruqfcq}a9c#C3L?KpBF@G1}eAg_>
R{R!w;22WQ%mvv4FO#oMzwKo6&

literal 0
HcmV?d00001

diff --git a/docs/media/images/tutorial_folder.png b/docs/media/images/tutorial_folder.png
new file mode 100644
index 0000000000000000000000000000000000000000..2a468b2a06fa3424ba94773373637d424f91f7e0
GIT binary patch
literal 572
zcmV-C0>k}@P)>~W@cuiqoe=KGyn8k-rnBK%*_ATKmXxKdU|^Q=uf|NmyHcL<7#inXPLp`VEqaE{#o000SaNLh0L01FZT01FZU
z(%pXi0000MbVXQnLvm$dbZKvHAXI5>WdJZVFEBDMFf-YbT0#H-03dWlSaefwW^{L9
za%BKbVPkS{ZDnL>VIW3na%FdKa%*!SO<22;DkJ~^0HH}lK~#90Rm|HGfj|I&;Z-?S
zTE~>lvDmU9)2vA$a-s45?_+lx7yird;s>}vSUUa%B5*H?0lB_-jxz$}S+Eu>Tci^}
zf*_zRSBAc7nwO;j`bo#VVd?HJ70@Hv7$8pt&R;?fo08O0cTlDBo5&$
zS2)D&L_ip-Xv-c3iad`)mSr0V%M{(b3i`Z5_cW1MYXWTY*ZT`cP91=4{NC>X0000<
KMNUMnLSTaQ$PWMj

literal 0
HcmV?d00001

diff --git a/docs/media/images/up_button.png b/docs/media/images/up_button.png
new file mode 100644
index 0000000000000000000000000000000000000000..ff36c59356d1d67cf8c4d12cef7b5aff7bf4dbc1
GIT binary patch
literal 668
zcmV;N0%QG&P)%Pk4nVFe0X3Tq=+TY{p|NsA1fYZIby?c9mt*x!i*Xj57
z_j7Y|p0wcB-0AP{?>}zNjg5_FW@fduwWXz{lda&z#l@+-;@;%(Zjsl_%*=y>gJX);
zOLx%L*4A8HT!y3E-rnA{#N%dWW|^6pp||AZ=k2Gu;O6G$tG?unrQUFp*;j$nOL)=N
z-H!7B000SaNLh0L01m?d01m?e$8V@)0000WbVXQnQ*UN;cVTj608L?Ia&K*AWNBd_
zMrm?ocW-iQb0AGvyOAm+0000MbVXQnLvm$dbZKvHAXI5>WdJZVFEKJNFf-)xbMgQH
z0aZyvK~#90eUl4s!XOZUanyCl+N~BSZdg%F=FV*U|Nm|WGzj(aC4Hp#g}ZVbsUwYZ
z&Rzjil!QBIZEnCM*G;mFfhMO*Sgs&ijd4EZ4F>=mqdHh2`yC0Klf6aD**dot!!VqZ
z1kM^tYtrbhSZY~S)mve)l_6jX>4Z|XyI6o$PsyzG!CTd_u;_}+68;72Gqbc*E#XaG
z{1KHkUhfaBA749OLuPS0vpzyLTx|WwI-s@b{QWyw?8=I(yrMOhmdva(hL@P@CDfl=
z3@+A)(FIx?d>#r*+a&qgfBjDR2CScBhYVBOmN=QV;cFbnb7;T&7X-qIrqsl*m$}d$CKcW835(Ow@m?{E
zuz;N49J94VK$=2) {
+		this.childNodes[this.childNodes.length -2]._last = false;
+	}
+	while (root.parentNode) { root = root.parentNode; }
+	if (root.rendered) {
+		if (this.childNodes.length >= 2) {
+			document.getElementById(this.childNodes[this.childNodes.length -2].id + '-plus').src = ((this.childNodes[this.childNodes.length -2].folder)?webFXTreeConfig.tMinusIcon:webFXTreeConfig.tIcon);
+			if (this.childNodes[this.childNodes.length -2].folder) {
+				this.childNodes[this.childNodes.length -2].plusIcon = webFXTreeConfig.tPlusIcon;
+				this.childNodes[this.childNodes.length -2].minusIcon = webFXTreeConfig.tMinusIcon;
+			}
+			this.childNodes[this.childNodes.length -2]._last = false;
+		}
+		this._last = true;
+		var foo = this;
+		while (foo.parentNode) {
+			for (var i = 0; i < foo.parentNode.childNodes.length; i++) {
+				if (foo.id == foo.parentNode.childNodes[i].id) { break; }
+			}
+			if (++i == foo.parentNode.childNodes.length) { foo.parentNode._last = true; }
+			else { foo.parentNode._last = false; }
+			foo = foo.parentNode;
+		}
+		document.getElementById(this.id + '-cont').insertAdjacentHTML("beforeEnd", node.toString());
+		if ((!this.folder) && (!this.openIcon)) {
+			this.icon = webFXTreeConfig.folderIcon;
+			this.openIcon = webFXTreeConfig.openFolderIcon;
+		}
+		this.folder = true;
+		this.indent();
+		this.expand();
+	}
+	return node;
+}
+
+WebFXTreeAbstractNode.prototype.toggle = function() {
+	if (this.folder) {
+		if (this.open) { this.collapse(); }
+		else { this.expand(); }
+	}
+}
+
+WebFXTreeAbstractNode.prototype.select = function() {
+	document.getElementById(this.id + '-anchor').focus();
+}
+
+WebFXTreeAbstractNode.prototype.focus = function() {
+	webFXTreeHandler.selected = this;
+	if ((this.openIcon) && (webFXTreeHandler.behavior != 'classic')) { document.getElementById(this.id + '-icon').src = this.openIcon; }
+	document.getElementById(this.id + '-anchor').style.backgroundColor = 'highlight';
+	document.getElementById(this.id + '-anchor').style.color = 'highlighttext';
+	document.getElementById(this.id + '-anchor').focus();
+}
+
+WebFXTreeAbstractNode.prototype.blur = function() {
+	if ((this.openIcon) && (webFXTreeHandler.behavior != 'classic')) { document.getElementById(this.id + '-icon').src = this.icon; }
+	document.getElementById(this.id + '-anchor').style.backgroundColor = 'transparent';
+	document.getElementById(this.id + '-anchor').style.color = 'menutext';
+}
+
+WebFXTreeAbstractNode.prototype.doExpand = function() {
+	if (webFXTreeHandler.behavior == 'classic') { document.getElementById(this.id + '-icon').src = this.openIcon; }
+	if (this.childNodes.length) {  document.getElementById(this.id + '-cont').style.display = 'block'; }
+	this.open = true;
+	webFXTreeHandler.cookies.setCookie(this.id.substr(18,this.id.length - 18), '1');
+}
+
+WebFXTreeAbstractNode.prototype.doCollapse = function() {
+	if (webFXTreeHandler.behavior == 'classic') { document.getElementById(this.id + '-icon').src = this.icon; }
+	if (this.childNodes.length) { document.getElementById(this.id + '-cont').style.display = 'none'; }
+	this.open = false;
+	webFXTreeHandler.cookies.setCookie(this.id.substr(18,this.id.length - 18), '0');
+}
+
+WebFXTreeAbstractNode.prototype.expandAll = function() {
+	this.expandChildren();
+	if ((this.folder) && (!this.open)) { this.expand(); }
+}
+
+WebFXTreeAbstractNode.prototype.expandChildren = function() {
+	for (var i = 0; i < this.childNodes.length; i++) {
+		this.childNodes[i].expandAll();
+} }
+
+WebFXTreeAbstractNode.prototype.collapseAll = function() {
+	if ((this.folder) && (this.open)) { this.collapse(); }
+	this.collapseChildren();
+}
+
+WebFXTreeAbstractNode.prototype.collapseChildren = function() {
+	for (var i = 0; i < this.childNodes.length; i++) {
+		this.childNodes[i].collapseAll();
+} }
+
+WebFXTreeAbstractNode.prototype.indent = function(lvl, del, last, level) {
+	/*
+	 * Since we only want to modify items one level below ourself,
+	 * and since the rightmost indentation position is occupied by
+	 * the plus icon we set this to -2
+	 */
+	if (lvl == null) { lvl = -2; }
+	var state = 0;
+	for (var i = this.childNodes.length - 1; i >= 0 ; i--) {
+		state = this.childNodes[i].indent(lvl + 1, del, last, level);
+		if (state) { return; }
+	}
+	if (del) {
+		if (level >= this._level) {
+			if (this.folder) {
+				document.getElementById(this.id + '-plus').src = (this.open)?webFXTreeConfig.lMinusIcon:webFXTreeConfig.lPlusIcon;
+				this.plusIcon = webFXTreeConfig.lPlusIcon;
+				this.minusIcon = webFXTreeConfig.lMinusIcon;
+			}
+			else { document.getElementById(this.id + '-plus').src = webFXTreeConfig.lIcon; }
+			return 1;
+		}
+	}
+	var foo = document.getElementById(this.id + '-indent-' + lvl);
+	if (foo) {
+		if ((del) && (last)) { foo._last = true; }
+		if (foo._last) { foo.src =  webFXTreeConfig.blankIcon; }
+		else { foo.src =  webFXTreeConfig.iIcon; }
+	}
+	return 0;
+}
+
+/*
+ * WebFXTree class
+ */
+
+function WebFXTree(sText, sAction, sBehavior, sIcon, sOpenIcon) {
+	this.base = WebFXTreeAbstractNode;
+	this.base(sText, sAction);
+	this.icon      = sIcon || webFXTreeConfig.rootIcon;
+	this.openIcon  = sOpenIcon || webFXTreeConfig.openRootIcon;
+	/* Defaults to open */
+	this.open      = (webFXTreeHandler.cookies.getCookie(this.id.substr(18,this.id.length - 18)) == '0')?false:true;
+	this.folder    = true;
+	this.rendered  = false;
+	if (!webFXTreeHandler.behavior) {  webFXTreeHandler.behavior = sBehavior || webFXTreeConfig.defaultBehavior; }
+	this.targetWindow = 'right';
+}
+
+WebFXTree.prototype = new WebFXTreeAbstractNode;
+
+WebFXTree.prototype.setBehavior = function (sBehavior) {
+	webFXTreeHandler.behavior =  sBehavior;
+};
+
+WebFXTree.prototype.getBehavior = function (sBehavior) {
+	return webFXTreeHandler.behavior;
+};
+
+WebFXTree.prototype.getSelected = function() {
+	if (webFXTreeHandler.selected) { return webFXTreeHandler.selected; }
+	else { return null; }
+}
+
+WebFXTree.prototype.remove = function() { }
+
+WebFXTree.prototype.expand = function() {
+	this.doExpand();
+}
+
+WebFXTree.prototype.collapse = function() {
+	this.focus();
+	this.doCollapse();
+}
+
+WebFXTree.prototype.getFirst = function() {
+	return null;
+}
+
+WebFXTree.prototype.getLast = function() {
+	return null;
+}
+
+WebFXTree.prototype.getNextSibling = function() {
+	return null;
+}
+
+WebFXTree.prototype.getPreviousSibling = function() {
+	return null;
+}
+
+WebFXTree.prototype.keydown = function(key) {
+	if (key == 39) { this.expand(); return false; }
+	if (key == 37) { this.collapse(); return false; }
+	if ((key == 40) && (this.open)) { this.childNodes[0].select(); return false; }
+	return true;
+}
+
+WebFXTree.prototype.toString = function() {
+	var str = "
";
+	str += "" + this.text + "
";
+	str += "
";
+	for (var i = 0; i < this.childNodes.length; i++) {
+		str += this.childNodes[i].toString(i, this.childNodes.length);
+	}
+	str += "
";
+	this.rendered = true;
+	return str;
+};
+
+/*
+ * WebFXTreeItem class
+ */
+
+function WebFXTreeItem(sText, sAction, eParent, sIcon, sOpenIcon) {
+	this.base = WebFXTreeAbstractNode;
+	this.base(sText, sAction);
+	/* Defaults to close */
+	this.open = (webFXTreeHandler.cookies.getCookie(this.id.substr(18,this.id.length - 18)) == '1')?true:false;
+	if (eParent) { eParent.add(this); }
+	if (sIcon) { this.icon = sIcon; }
+	if (sOpenIcon) { this.openIcon = sOpenIcon; }
+}
+
+WebFXTreeItem.prototype = new WebFXTreeAbstractNode;
+
+WebFXTreeItem.prototype.remove = function() {
+	var parentNode = this.parentNode;
+	var prevSibling = this.getPreviousSibling(true);
+	var nextSibling = this.getNextSibling(true);
+	var folder = this.parentNode.folder;
+	var last = ((nextSibling) && (nextSibling.parentNode) && (nextSibling.parentNode.id == parentNode.id))?false:true;
+	this.getPreviousSibling().focus();
+	this._remove();
+	if (parentNode.childNodes.length == 0) {
+		parentNode.folder = false;
+		parentNode.open = false;
+	}
+	if (last) {
+		if (parentNode.id == prevSibling.id) {
+			document.getElementById(parentNode.id + '-icon').src = webFXTreeConfig.fileIcon;
+		}
+		else { }
+	}
+	if ((!prevSibling.parentNode) || (prevSibling.parentNode != parentNode)) {
+		parentNode.indent(null, true, last, this._level);
+	}
+	if (document.getElementById(prevSibling.id + '-plus')) {
+		if (nextSibling) {
+			if ((parentNode == prevSibling) && (parentNode.getNextSibling))  { document.getElementById(prevSibling.id + '-plus').src = webFXTreeConfig.tIcon; }
+			else if (nextSibling.parentNode != prevSibling) { document.getElementById(prevSibling.id + '-plus').src = webFXTreeConfig.lIcon; }
+		}
+		else { document.getElementById(prevSibling.id + '-plus').src = webFXTreeConfig.lIcon; }
+	}
+}
+
+WebFXTreeItem.prototype._remove = function() {
+	for (var i = this.childNodes.length - 1; i >= 0; i--) {
+		this.childNodes[i]._remove();
+ 	}
+	for (var i = 0; i < this.parentNode.childNodes.length; i++) {
+		if (this.id == this.parentNode.childNodes[i].id) {
+			for (var j = i; j < this.parentNode.childNodes.length; j++) {
+				this.parentNode.childNodes[i] = this.parentNode.childNodes[i+1]
+			}
+			this.parentNode.childNodes.length = this.parentNode.childNodes.length - 1;
+			if (i + 1 == this.parentNode.childNodes.length) { this.parentNode._last = true; }
+		}
+	}
+	webFXTreeHandler.all[this.id] = null;
+	if (document.getElementById(this.id)) {
+		document.getElementById(this.id).innerHTML = "";
+		document.getElementById(this.id).removeNode();
+	}
+}
+
+WebFXTreeItem.prototype.expand = function() {
+	this.doExpand();
+	document.getElementById(this.id + '-plus').src = this.minusIcon;
+}
+
+WebFXTreeItem.prototype.collapse = function() {
+	this.focus();
+	this.doCollapse();
+	document.getElementById(this.id + '-plus').src = this.plusIcon;
+}
+
+WebFXTreeItem.prototype.getFirst = function() {
+	return this.childNodes[0];
+}
+
+WebFXTreeItem.prototype.getLast = function() {
+	if (this.childNodes[this.childNodes.length - 1].open) { return this.childNodes[this.childNodes.length - 1].getLast(); }
+	else { return this.childNodes[this.childNodes.length - 1]; }
+}
+
+WebFXTreeItem.prototype.getNextSibling = function() {
+	for (var i = 0; i < this.parentNode.childNodes.length; i++) {
+		if (this == this.parentNode.childNodes[i]) { break; }
+	}
+	if (++i == this.parentNode.childNodes.length) { return this.parentNode.getNextSibling(); }
+	else { return this.parentNode.childNodes[i]; }
+}
+
+WebFXTreeItem.prototype.getPreviousSibling = function(b) {
+	for (var i = 0; i < this.parentNode.childNodes.length; i++) {
+		if (this == this.parentNode.childNodes[i]) { break; }
+	}
+	if (i == 0) { return this.parentNode; }
+	else {
+		if ((this.parentNode.childNodes[--i].open) || (b && this.parentNode.childNodes[i].folder)) { return this.parentNode.childNodes[i].getLast(); }
+		else { return this.parentNode.childNodes[i]; }
+} }
+
+WebFXTreeItem.prototype.keydown = function(key) {
+	if ((key == 39) && (this.folder)) {
+		if (!this.open) { this.expand(); return false; }
+		else { this.getFirst().select(); return false; }
+	}
+	else if (key == 37) {
+		if (this.open) { this.collapse(); return false; }
+		else { this.parentNode.select(); return false; }
+	}
+	else if (key == 40) {
+		if (this.open) { this.getFirst().select(); return false; }
+		else {
+			var sib = this.getNextSibling();
+			if (sib) { sib.select(); return false; }
+	} }
+	else if (key == 38) { this.getPreviousSibling().select(); return false; }
+	return true;
+}
+
+WebFXTreeItem.prototype.toString = function (nItem, nItemCount) {
+	var foo = this.parentNode;
+	var indent = '';
+	if (nItem + 1 == nItemCount) { this.parentNode._last = true; }
+	var i = 0;
+	while (foo.parentNode) {
+		foo = foo.parentNode;
+		indent = "" + indent;
+		i++;
+	}
+	this._level = i;
+	if (this.childNodes.length) { this.folder = 1; }
+	else { this.open = false; }
+	if ((this.folder) || (webFXTreeHandler.behavior != 'classic')) {
+		if (!this.icon) { this.icon = webFXTreeConfig.folderIcon; }
+		if (!this.openIcon) { this.openIcon = webFXTreeConfig.openFolderIcon; }
+	}
+	else if (!this.icon) { this.icon = webFXTreeConfig.fileIcon; }
+	var label = this.text;
+	label = label.replace('<', '<');
+	label = label.replace('>', '>');
+	var str = "
";
+	str += indent;
+	str += ""
+	str += "" + label + "
";
+	str += "
";
+	for (var i = 0; i < this.childNodes.length; i++) {
+		str += this.childNodes[i].toString(i,this.childNodes.length);
+	}
+	str += "
";
+	this.plusIcon = ((this.parentNode._last)?webFXTreeConfig.lPlusIcon:webFXTreeConfig.tPlusIcon);
+	this.minusIcon = ((this.parentNode._last)?webFXTreeConfig.lMinusIcon:webFXTreeConfig.tMinusIcon);
+	return str;
+}
\ No newline at end of file
diff --git a/docs/media/stylesheet.css b/docs/media/stylesheet.css
new file mode 100644
index 00000000..5b025a93
--- /dev/null
+++ b/docs/media/stylesheet.css
@@ -0,0 +1,181 @@
+a { color: #000090; text-decoration: none; }
+a:hover, a:active, a:focus { color: highlighttext; background-color: highlight; text-decoration: none; }
+
+body { background : #FFFFFF; }
+body, table { font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 10pt; }
+
+a img { border: 0px; }
+
+/* Page layout/boxes */
+
+.info-box {  }
+.info-box-title { margin: 1em 0em 0em 0em; font-weight: normal; font-size: 14pt; color: #999999; border-bottom: 2px solid #999999; }
+.info-box-body { border: 1px solid #999999; padding: .5em; }
+.nav-bar { font-size: 8pt; white-space: nowrap; text-align: right; padding: .2em; margin: 0em 0em 1em 0em; }
+
+.oddrow { background-color: #F8F8F8; border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}
+.evenrow { border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}
+
+.page-body { max-width: 800px; margin: auto; }
+.tree { }
+
+/* Index formatting classes */
+
+.index-item-body { margin-top: .5em; margin-bottom: .5em}
+.index-item-description { margin-top: .25em }
+.index-item-details { font-weight: normal; font-style: italic; font-size: 8pt }
+.index-letter-section { background-color: #EEEEEE; border: 1px dotted #999999; padding: .5em; margin-bottom: 1em}
+.index-letter-title { font-size: 12pt; font-weight: bold }
+.index-letter-menu { text-align: center; margin: 1em }
+.index-letter { font-size: 12pt }
+
+/* Docbook classes */
+
+.description {}
+.short-description { font-weight: bold; color: #666666; }
+.tags {	padding-left: 0em; margin-left: 3em; color: #666666; list-style-type: square; }
+.parameters {	padding-left: 0em; margin-left: 3em; color: #014fbe; list-style-type: square; }
+.redefinitions { font-size: 8pt; padding-left: 0em; margin-left: 2em; }
+.package { font-weight: bold; }
+.package-title { font-weight: bold; font-size: 14pt; border-bottom: 1px solid black }
+.sub-package { font-weight: bold; }
+.tutorial { border-width: thin; border-color: #0066ff; }
+.tutorial-nav-box { width: 100%; border: 1px solid #999999; background-color: #F8F8F8; }
+
+/* Generic formatting */
+
+.field { font-weight: bold; }
+.detail { font-size: 8pt; }
+.notes { font-style: italic; font-size: 8pt; }
+.separator { background-color: #999999; height: 2px; }
+.warning {  color: #FF6600; }
+.disabled { font-style: italic; color: #999999; }
+
+/* Code elements */
+
+.line-number {  }
+
+.class-table { width: 100%; }
+.class-table-header { border-bottom: 1px dotted #666666; text-align: left}
+.class-name { color: #0000AA; font-weight: bold; }
+
+.method-summary { color: #009000; padding-left: 1em; font-size: 8pt; }
+.method-header { }
+.method-definition { margin-bottom: .2em }
+.method-title { color: #009000; font-weight: bold; }
+.method-name { font-weight: bold; }
+.method-signature { font-size: 85%; color: #666666; margin: .5em 0em }
+.method-result { font-style: italic; }
+
+.var-summary { padding-left: 1em; font-size: 8pt; }
+.var-header { }
+.var-title { color: #014fbe; margin-bottom: .3em }
+.var-type { font-style: italic; }
+.var-name { font-weight: bold; }
+.var-default {}
+.var-description { font-weight: normal; color: #000000; }
+
+.include-title { color: #014fbe;}
+.include-type { font-style: italic; }
+.include-name { font-weight: bold; }
+
+.const-title { color: #FF6600; }
+.const-name { font-weight: bold; }
+
+/* Syntax highlighting */
+
+.src-code { font-family: 'Courier New', Courier, monospace; font-weight: normal; }
+.src-line { font-family: 'Courier New', Courier, monospace; font-weight: normal; }
+
+.src-code a:link { padding: 1px; text-decoration: underline; color: #0000DD; }
+.src-code a:visited { text-decoration: underline; color: #0000DD; }
+.src-code a:active { background-color: #FFFF66; color: #008000; }
+.src-code a:hover { background-color: #FFFF66; text-decoration: overline underline; color: #008000; }
+
+.src-comm { color: #666666; }
+.src-id { color: #FF6600; font-style: italic; }
+.src-inc { color: #0000AA; font-weight: bold; }
+.src-key { color: #0000AA; font-weight: bold; }
+.src-num { color: #CC0000; }
+.src-str { color: #CC0000; }
+.src-sym { }
+.src-var { }
+
+.src-php { font-weight: bold; }
+
+.src-doc { color: #666666; }
+.src-doc-close-template { color: #666666 }
+.src-doc-coretag { color: #008000; }
+.src-doc-inlinetag {}
+.src-doc-internal {}
+.src-doc-tag { color: #0080CC; }
+.src-doc-template { color: #666666 }
+.src-doc-type { font-style: italic; color: #444444 }
+.src-doc-var { color: #444444 }
+
+.tute-tag { color: #009999 }
+.tute-attribute-name { color: #0000FF }
+.tute-attribute-value { color: #0099FF }
+.tute-entity { font-weight: bold; }
+.tute-comment { font-style: italic }
+.tute-inline-tag { color: #636311; font-weight: bold }
+
+/* tutorial */
+
+.authors {  }
+.author { font-style: italic; font-weight: bold }
+.author-blurb { margin: .5em 0em .5em 2em; font-size: 85%; font-weight: normal; font-style: normal }
+.example { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; }
+.listing { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; white-space: nowrap; }
+.release-info { font-size: 85%; font-style: italic; margin: 1em 0em }
+.ref-title-box {  }
+.ref-title {  }
+.ref-purpose { font-style: italic; color: #666666 }
+.ref-synopsis {  }
+.title { font-weight: bold; border-bottom: 1px solid #999999; color: #999999;  }
+.cmd-synopsis { margin: 1em 0em }
+.cmd-title { font-weight: bold }
+.toc { margin-left: 2em; padding-left: 0em }
+
+/*------------------------------------------------------------------------------
+    webfx-tree
+------------------------------------------------------------------------------*/
+
+.webfx-tree-container {
+	margin: 0px;
+	padding: 0px;
+	white-space: nowrap;
+	font: icon;
+}
+
+.webfx-tree-item {
+	padding: 0px;
+	margin: 0px;
+	color: black;
+	white-space: nowrap;
+	font: icon;
+}
+
+.webfx-tree-item a {
+	margin-left: 3px;
+	padding: 1px 2px 1px 2px;
+	color: black;
+	text-decoration: none;
+}
+
+.webfx-tree-item a:hover, .webfx-tree-item a:active { 
+	color: highlighttext; 
+	background: highlight; 
+	text-decoration: none 
+}
+
+.webfx-tree-item img {
+	vertical-align: middle;
+	border: 0px;
+}
+
+.webfx-tree-icon {
+	width: 16px;
+	height: 16px;
+}
+
diff --git a/docs/packages.html b/docs/packages.html
new file mode 100644
index 00000000..b329df47
--- /dev/null
+++ b/docs/packages.html
@@ -0,0 +1,32 @@
+
+
+  
+		
+			
+			
+			
+			
+			
+		
+		
+			
+		
+	
\ No newline at end of file
diff --git a/docs/ric_README.html b/docs/ric_README.html
new file mode 100644
index 00000000..b52d86e3
--- /dev/null
+++ b/docs/ric_README.html
@@ -0,0 +1,30 @@
+
+
+  
+		
+			
+			
+			
+											
+		
+						
README

+
+Islandora Fedora Repository Module
+
+For installation and customization instructions please see the documentation and the DuraSpace Wiki: 
+
+https://wiki.duraspace.org/display/ISLANDORA/Islandora
+
+Specifically the Islandora Guide:
+
+https://wiki.duraspace.org/display/ISLANDORA/Islandora+Guide
+
+All bugs, feature requests and improvement suggestions are tracked at the DuraSpace JIRA:
+
+https://jira.duraspace.org/browse/ISLANDORA
+

+	

+		Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by phpDocumentor 1.4.3
+	

+	
+
\ No newline at end of file
diff --git a/fedora_repository.solutionpacks.inc b/fedora_repository.solutionpacks.inc
index ad49ce86..32e76be4 100644
--- a/fedora_repository.solutionpacks.inc
+++ b/fedora_repository.solutionpacks.inc
@@ -1,5 +1,10 @@