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


Classes:
CodeGen_Command
CodeGen_Element
CodeGen_Extension
CodeGen_ExtensionParser
CodeGen_License
CodeGen_License_BSD
CodeGen_License_LGPL
CodeGen_License_PHP
CodeGen_Maintainer
CodeGen_Release
CodeGen_Tools_Code
CodeGen_Tools_FileReplacer
CodeGen_Tools_Getopt
CodeGen_Tools_Indent
CodeGen_Tools_Outbuf
CodeGen_Tools_Platform
CodeGen_Tools_Tokenizer
CodeGen_XmlParser
Files:
BSD.php
Code.php
Command.php
Element.php
Extension.php
ExtensionParser.php
FileReplacer.php
Getopt.php
Indent.php
LGPL.php
License.php
Maintainer.php
Outbuf.php
PHP.php
Platform.php
Release.php
Tokenizer.php
XmlParser.php

Class: CodeGen_Element

Source Location: /CodeGen-1.0.0rc1/CodeGen/Element.php

Class Overview




Abstract base class for all code elements




Author(s):






        
          
              

Version:


    
  
  • Release: @package_version@
    • 




Copyright:


    
  
  • 2005 Hartmut Holzgraefe
    • 








Methods
















Inherited Variables





Inherited Methods














Class Details



[line 33]

Abstract base class for all code elements









[ Top ]








Method Detail



	
	
cCode   [line 73]

	

    

    

		string cCode(
string
$name)
    

    


	
		Generate C code for element


    

  • Return: C code
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        Extension name
      

        

    


        
[ Top ]

  

  
  
	
	
cCodeEditorSettings   [line 119]

	

    

    

		string cCodeEditorSettings(
)
    

    


	
		Generate Editor settings block for C source files


    

  • Return: Editor settings comment block
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
cCodeFooter   [line 97]

	

    

    

		string cCodeFooter(
string
$name)
    

    


	
		Generate C code footer block for all elements of this class


    

  • Return: C code
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        Extension name
      

        

    


        
[ Top ]

  

  
  
	
	
cCodeHeader   [line 85]

	

    

    

		string cCodeHeader(
string
$name)
    

    


	
		Generate C code header block for all elements of this class


    

  • Return: C code
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        Extension name
      

        

    


        
[ Top ]

  

  
  
	
	
docEditorSettings   [line 168]

	

    

    

		string docEditorSettings(
[int
$level = 3])
    

    


	
		Generate Editor settings block for documentation files


    

  • Return: Editor settings comment block
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $level  
        — 
        Directory nesting depth of target file (default: 3)
      

        

    


        
[ Top ]

  

  
  
	
	
docEntry   [line 132]

	

    

    

		string docEntry(
string
$extension)
    

    


	
		Generate documentation code for element


    

  • Return: documentation content
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $extension  
        — 
        id basename for extension
      

        

    


        
[ Top ]

  

  
  
	
	
docFooter   [line 156]

	

    

    

		string docFooter(
string
$name)
    

    


	
		Generate documentation footer block for all elements of this class


    

  • Return: documentation fragment
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        Extension name
      

        

    


        
[ Top ]

  

  
  
	
	
docHeader   [line 144]

	

    

    

		string docHeader(
string
$name)
    

    


	
		Generate documentation header block for all elements of this class


    

  • Return: documentation fragment
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        Extension name
      

        

    


        
[ Top ]

  

  
  
	
	
hCode   [line 108]

	

    

    

		string hCode(
)
    

    


	
		Generate C include file definitions for element


    

  • Return: C header code
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
isKeyword   [line 43]

	

    

    

		bool isKeyword(
string
$name)
    

    


	
		Checks whether a string is a reserved name


    

  • Return: true if reserved
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        name
      

        

    


        
[ Top ]

  

  
  
	
	
isName   [line 57]

	

    

    

		bool isName(
string
$name)
    

    


	
		Checks whether a string is a valid C name


    

  • Return: true for valid names, false otherwise
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        The name to check
      

        

    


        
[ Top ]

  

  
  



        

		    

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