File_Therion_Formatters
[ class tree: File_Therion_Formatters ] [ index: File_Therion_Formatters ] [ all elements ]
Packages:
File_Therion
File_Therion_DataTypes
File_Therion_Formatters
File_Therion_Readers
File_Therion_Writers


Classes:
File_Therion_BasicFormatter
File_Therion
   File_Therion_AddLineNumberFormatter
Files:
BasicFormatter.php
FormatterInterface.php

Class: File_Therion_Formatter

Source Location: /File_Therion-0.4.1/File/Therion/Formatters/FormatterInterface.php

Class Overview




Interface defines formatter plugins used by therion file objects.




Author(s):






          
          


Copyright:


    
  
  • 2016 Benedikt Hallinger
    • 








Methods
















Inherited Variables





Inherited Methods














Class Details



[line 32]

Interface defines formatter plugins used by therion file objects.
Formatters can be used to influence the writing of therion file data.  They are attached to a File_Therion instance to carry out formatting stuff.
Formatters are exprectet to be able to work independently, so you also may  get lines unformatted as copy (see File_Therion->toLines()) and  feed them in your formatter by hand.









[ Top ]








Method Detail



	
	
format   [line 43]

	

    

    

		array format(
array
$lines)
    

    


	
		Format lines.
This method is automatically invoked by File_Therion->getLines() to  transparently (re-)format the lines returned to the caller.


    

  • Return: formatted line objects
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $lines  
        — 
        File_Therion_Lines to format
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 15:09:45 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.