Console_CommandLine
[ class tree: Console_CommandLine ] [ index: Console_CommandLine ] [ all elements ]
Packages:
Console_CommandLine


Classes:
Console_CommandLine
Console_CommandLine_Action
Console_CommandLine_Action_Callback
Console_CommandLine_Action_Counter
Console_CommandLine_Action_Help
Console_CommandLine_Action_Password
Console_CommandLine_Action_StoreArray
Console_CommandLine_Action_StoreFalse
Console_CommandLine_Action_StoreFloat
Console_CommandLine_Action_StoreInt
Console_CommandLine_Action_StoreString
Console_CommandLine_Action_StoreTrue
Console_CommandLine_Action_Version
Console_CommandLine_Argument
Console_CommandLine_Command
Console_CommandLine_Element
Console_CommandLine_Exception
Console_CommandLine_MessageProvider_Default
Console_CommandLine_Option
Console_CommandLine_Outputter_Default
Console_CommandLine_Renderer_Default
Console_CommandLine_Result
Console_CommandLine_XmlParser
Files:
Action.php
Argument.php
Callback.php
Command.php
CommandLine.php
Counter.php
Default.php
Default.php
Default.php
Element.php
ex1.php
ex2.php
Exception.php
Help.php
MessageProvider.php
Option.php
Outputter.php
Password.php
Renderer.php
Result.php
StoreArray.php
StoreFalse.php
StoreFloat.php
StoreInt.php
StoreString.php
StoreTrue.php
Version.php
XmlParser.php

Class: Console_CommandLine_Renderer

Source Location: /Console_CommandLine-1.0.0RC3/CommandLine/Renderer.php

Class Overview




Renderers common interface, all renderers must implement this interface.




Author(s):






        
          
              

Version:


    
  
  • Release: 1.0.0RC3
    • 




Copyright:


    
  
  • 2007 David JEAN LOUIS
    • 








Methods
















Inherited Variables





Inherited Methods














Class Details



[line 36]

Renderers common interface, all renderers must implement this interface.









[ Top ]








Method Detail



	
	
__construct (Constructor)   [line 47]

	

    

    

		Console_CommandLine_Renderer __construct(
object
$parser)
    

    


	
		Constructor.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        object  
        $parser  
        — 
        a Console_CommandLine instance
      

        

    


        
[ Top ]

  

  
  
	
	
error   [line 71]

	

    

    

		string error(
string
$error)
    

    


	
		Return a formatted error message


    

  • Return: the error string
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $error  
        — 
        the error message to format
      

        

    


        
[ Top ]

  

  
  
	
	
usage   [line 58]

	

    

    

		string usage(
)
    

    


	
		Return the full usage message.


    

  • Return: the usage message
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
version   [line 82]

	

    

    

		string version(
)
    

    


	
		Return the program version string.


    

  • Return: the version string
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  



        

		    

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