Class Trees Index phpDocumentor Project Page

Class OLEwriter

(line 41)



	Located in File: Program_Root/OLEwriter.php





Class for creating OLE streams for Excel Spreadsheets








Class Variable Summary




		
	

		
			
$_biffsize

			

			
 Size of the data to be written to the OLE stream 

			
 Default Value: -><- 

				
	

		
	

		
			
$_big_blocks

			

			
 Number of big blocks in the OLE stream 

			
 Default Value: -><- 

				
	

		
	

		
			
$_booksize

			

			
 Real data size to be written to the OLE stream 

			
 Default Value: -><- 

				
	

		
	

		
			
$_fileclosed

			

			
 Variable for preventing closing two times 

			
 Default Value: -><- 

				
	

		
	

		
			
$_filehandle

			

			
 Filehandle for the OLE stream 

			
 Default Value: -><- 

				
	

		
	

		
			
$_list_blocks

			

			
 Number of list blocks in the OLE stream 

			
 Default Value: -><- 

				
	

		
	

		
			
$_OLEfilename

			

			
 Filename for the OLE stream 

			
 Default Value: -><- 

				
	

		
	

		
			
$_root_start

			

			
 Number of big blocks in the OLE stream 

			
 Default Value: -><- 

				
	

		
	

		
			
$_tmp_filename

			

			
 Name of the temporal file in case OLE stream goes to stdout 

			
 Default Value: -><- 

				
	

	







Inherited Class Variable Summary




	






Method Summary




		
	

		void
			
close (  )

			

			
 Write root entry, big block list and close the filehandle. 

		

	

		
	

		void
			
constructor OLEwriter ( $OLEfilename )

			

			
 Class for creating an OLEwriter 

		

	

		
	

		integer
			
set_size ( $biffsize )

			

			
 Set the size of the data to be written to the OLE stream. 

		

	

		
	

		void
			
write ( $data )

			

			
 Write BIFF data to OLE file. 

		

	

		
	

		void
			
write_header (  )

			

			
 Write OLE header block. 

		

	

		
	

		void
			
_calculate_sizes (  )

			

			
 Calculate various sizes needed for the OLE stream 

		

	

		
	

		void
			
_initialize (  )

			

			
 Check for a valid filename and store the filehandle. 

		

	

		
	

		void
			
_write_big_block_depot (  )

			

			
 Write big block depot. 

		

	

		
	

		void
			
_write_padding (  )

			

			
 Pad the end of the file 

		

	

		
	

		void
			
_write_property_storage (  )

			

			
 Write property storage. TODO: add summary sheets 

		

	

	




Inherited Method Summary




	







Method Detail


close (line 208)


void
close (  )


Write root entry, big block list and close the filehandle.


This routine is used to explicitly close the open filehandle without  having to wait for DESTROY.




	
Function Info:

		
See - Workbook::store_OLE_file()

		
Access - public

	

	
[ Top ]




OLEwriter (line 103)


void
constructor OLEwriter ( $OLEfilename )


Class for creating an OLEwriter





	
Function Info:

	

	
[ Top ]




set_size (line 161)


integer
set_size ( $biffsize )


Set the size of the data to be written to the OLE stream.


The maximun size comes from this:    $big_blocks = (109 depot block x (128 -1 marker word)                  - (1 x end words)) = 13842    $maxsize    = $big_blocks * 512 bytes = 7087104




	
Function Info:

		
Return - 1 for success

		
See - Workbook::store_OLE_file()

		
Access - public

	

	
[ Top ]




write (line 235)


void
write ( $data )


Write BIFF data to OLE file.





	
Function Info:

	

	
[ Top ]




write_header (line 244)


void
write_header (  )


Write OLE header block.





	
Function Info:

	

	
[ Top ]




_calculate_sizes (line 185)


void
_calculate_sizes (  )


Calculate various sizes needed for the OLE stream





	
Function Info:

	

	
[ Top ]




_initialize (line 123)


void
_initialize (  )


Check for a valid filename and store the filehandle.


Filehandle "-" writes to STDOUT




	
Function Info:

	

	
[ Top ]




_write_big_block_depot (line 289)


void
_write_big_block_depot (  )


Write big block depot.





	
Function Info:

	

	
[ Top ]




_write_padding (line 396)


void
_write_padding (  )


Pad the end of the file





	
Function Info:

	

	
[ Top ]




_write_property_storage (line 319)


void
_write_property_storage (  )


Write property storage. TODO: add summary sheets





	
Function Info:

	

	
[ Top ]









Variable Detail



$_biffsize
(line 72)

Data type: integer
Size of the data to be written to the OLE stream






$_big_blocks
(line 84)

Data type: integer
Number of big blocks in the OLE stream






$_booksize
(line 78)

Data type: integer
Real data size to be written to the OLE stream






$_fileclosed
(line 66)

Data type: integer
Variable for preventing closing two times






$_filehandle
(line 54)

Data type: resource
Filehandle for the OLE stream






$_list_blocks
(line 90)

Data type: integer
Number of list blocks in the OLE stream






$_OLEfilename
(line 48)

Data type: string
Filename for the OLE stream






$_root_start
(line 96)

Data type: integer
Number of big blocks in the OLE stream






$_tmp_filename
(line 60)

Data type: string
Name of the temporal file in case OLE stream goes to stdout







	

		

		Documention generated on Wed, 30 Apr 2003 11:14:31 -0400 by phpDocumentor 1.2.0