Class CollectionContent

(line 2148)

Description




	Located in File: /lib/collection.inc.php





CollectionContent Object Definition











Class Variables


Summary:



    Collection
    $Collection




    integer
    $CollectionID




    integer
    $ContainerNumber




    ContainerType
    $ContainerType




    integer
    $ContainerTypeID




    integer
    $ContainsContent




    CollectionContent[]
    $Content




    string
    $Date




    DLContent[]
    $DLContent




    integer
    $ID




    CollectionContent
    $Parent




    integer
    $ParentID




    string
    $Scope




    string
    $Title




    UserField[]
    $UserFields









 $Collection =  NULL (line 2900)
 


Data type : Collection



    
		
  • access: - public
    • 
	








 $CollectionID =  0 (line 2872)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $ContainerNumber =  0 (line 2878)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $ContainerType =  NULL (line 2909)
 


Data type : ContainerType



    
		
  • access: - public
    • 
	








 $ContainerTypeID =  0 (line 2875)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $ContainsContent =  0 (line 2893)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $Content = array() (line 2903)
 


Data type : CollectionContent[]



    
		
  • access: - public
    • 
	








 $Date =  NULL (line 2884)
 


Data type : string



    
		
  • access: - public
    • 
	








 $DLContent = array() (line 2917)
 


Data type : DLContent[]



    
		
  • access: - public
    • 
	








 $ID =  0 (line 2869)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $Parent =  NULL (line 2906)
 


Data type : CollectionContent



    
		
  • access: - public
    • 
	








 $ParentID =  0 (line 2890)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $Scope =  NULL (line 2887)
 


Data type : string



    
		
  • access: - public
    • 
	








 $Title =  NULL (line 2881)
 


Data type : string



    
		
  • access: - public
    • 
	








 $UserFields = array() (line 2912)
 


Data type : UserField[]



    
		
  • access: - public
    • 
	










Class Constants


Summary:









Method Detail


Summary:



    

            CollectionContent
        CollectionContent
        ([integer|array $ID_or_Row = NULL])
        

    

            boolean
        dbDelete
        ()
        

    

            boolean
        dbLoad
        ()
        

    

            boolean
        dbLoadContent
        ()
        

    

            boolean
        dbLoadDLContent
        ()
        

    

            boolean
        dbLoadUserFields
        ()
        

    

            boolean
        dbStore
        ()
        

    

            string
        toString
        ([ $MakeIntoLink = LINK_NONE], [ $ConcatinateContainerType = true], [ $ConcatinateContainerNumber = true], [ $ConcatinateParentContainerType = false], [ $ConcatinateParentContainerNumber = false], [ $Delimiter = ", "], boolean $ConcatinateContainerType[optional], boolean $ConcatinateContainerNumber[optional])
        

    

            string
        __toString
        ()
        











 Constructor CollectionContent (line 2164)
 
 

CollectionContent CollectionContent(
[integer|array
$ID_or_Row = NULL])


	

CollectionContent Constructor


If ID is passed as an argument,  no data will be loaded until  dbLoad is called.
If a table row is passed as an argument,  the array will be parsed, and object  variables will be assigned.

		
Parameters

	
    
			
  • integer|array $ID_or_Row: Content ID or array containing row from tblCol_Content
    • 
		

		
	
Info

	
    
		






 Method dbDelete (line 2198)
 
 

boolean dbDelete(
)


	

Deletes CollectionContent from the database

		
	
Info

	
    
		






 Method dbLoad (line 2317)
 
 

boolean dbLoad(
)


	

Loads CollectionContent from the database

		
	
Info

	
    
		






 Method dbLoadContent (line 2377)
 
 

boolean dbLoadContent(
)


	

Loads User-Defined Fields for CollectionContent from the database

		
	
Info

	
    
		






 Method dbLoadDLContent (line 2427)
 
 

boolean dbLoadDLContent(
)


	

Loads Digital Library Content for CollectionContent instance

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbLoadUserFields (line 2469)
 
 

boolean dbLoadUserFields(
)


	

Loads User-Defined Fields for CollectionContent from the database

		
	
Info

	
    
		






 Method dbStore (line 2524)
 
 

boolean dbStore(
)


	

Stores CollectionContent to the database

		
	
Info

	
    
		






 Method toString (line 2749)
 
 

string toString(
[
$MakeIntoLink = LINK_NONE], [
$ConcatinateContainerType = true], [
$ConcatinateContainerNumber = true], [
$ConcatinateParentContainerType = false], [
$ConcatinateParentContainerNumber = false], [
$Delimiter = ", "], boolean
$ConcatinateContainerType[optional], boolean
$ConcatinateContainerNumber[optional])


	

Generates a formatted string of the CollectionContent object

		
Parameters

	
    
			
  • boolean $ConcatinateContainerType[optional]: 
    • 
			
  • boolean $ConcatinateContainerNumber[optional]: 
    • 
			
  •  $MakeIntoLink: 
    • 
			
  •  $ConcatinateContainerType: 
    • 
			
  •  $ConcatinateContainerNumber: 
    • 
			
  •  $ConcatinateParentContainerType: 
    • 
			
  •  $ConcatinateParentContainerNumber: 
    • 
			
  •  $Delimiter: 
    • 
		

		
	
Info

	
    
			
  • todo - Custom Formatting
    • 
		






 Method __toString (line 2859)
 
 

string __toString(
)


	
		
	
Info

	







Inherited Variables





Inherited Class Variable Summary


	




Inherited Methods





Inherited Method Summary


	




	

		

		Documentation generated on Wed, 10 Jan 2007 15:37:26 -0600 by phpDocumentor 1.3.1