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

Class: CodeGen_Dependency_Header

Source Location: /CodeGen-1.0.7/CodeGen/Dependency/Header.php

Class Overview

CodeGen_Element
   |
   --CodeGen_Dependency_Header

Class representing a header file dependency


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2005-2008 Hartmut Holzgraefe

Variables

Methods


Inherited Variables

Inherited Methods

Class: CodeGen_Element

CodeGen_Element::addIfCondition()
ifCondition adder
CodeGen_Element::cCode()
Generate C code for element
CodeGen_Element::cCodeFooter()
Generate C code footer block for all elements of this class
CodeGen_Element::cCodeHeader()
Generate C code header block for all elements of this class
CodeGen_Element::docEntry()
Generate documentation code for element
CodeGen_Element::docFooter()
Generate documentation footer block for all elements of this class
CodeGen_Element::docHeader()
Generate documentation header block for all elements of this class
CodeGen_Element::getIfCondition()
ifCondition getter
CodeGen_Element::getName()
Name getter
CodeGen_Element::hCode()
Generate C include file definitions for element
CodeGen_Element::ifConditionEnd()
Conditional compilation end
CodeGen_Element::ifConditionStart()
Conditional compilation start
CodeGen_Element::isKeyword()
Checks whether a string is a reserved name
CodeGen_Element::isName()
Checks whether a string is a valid C name
CodeGen_Element::setDescription()
Description setter
CodeGen_Element::setIfCondition()
ifCondition setter
CodeGen_Element::setName()
Name setter
CodeGen_Element::setSummary()
Summary setter

Class Details

[line 38]
Class representing a header file dependency


[ Top ]


Class Variables

$name =

[line 46]

Header file name
  • Access: protected

Type:   string
Overrides:   Array


[ Top ]

$path =  "include"

[line 60]

search path relative to install prefix
  • Access: protected

Type:   string


[ Top ]

$prepend =  false

[line 53]

Include this file ahead of PHP headers?
  • Access: protected

Type:   bool


[ Top ]



Method Detail

__construct (Constructor)   [line 67]

CodeGen_Dependency_Header __construct( string $name)

Constructor

Parameters:

string   $name     header file name

[ Top ]

getName   [line 78]

string getName( )

name getter

Overrides CodeGen_Element::getName() (Name getter)
[ Top ]

getPath   [line 108]

string getPath( )

search path getter

[ Top ]

hCode   [line 119]

string hCode( [bool $prepend = false])

return header file code snippet

Overrides CodeGen_Element::hCode() (Generate C include file definitions for element)

Parameters:

bool   $prepend     

[ Top ]

setPath   [line 98]

void setPath( string $path)

search path setter

Parameters:

string   $path     

[ Top ]

setPrepend   [line 88]

void setPrepend( bool $prepend)

prepend flag setter

Parameters:

bool   $prepend     

[ Top ]


Documentation generated on Mon, 27 Sep 2010 12:00:06 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.