Class: CodeGen_PECL_Element_Stream

Source Location: /CodeGen_PECL-1.1.3/PECL/Element/Stream.php

Class Overview

CodeGen_Element
   |
   --CodeGen_PECL_Element
      |
      --CodeGen_PECL_Element_Stream

Class for managing PHP stream wrappers

Author(s):

Hartmut Holzgraefe <hartmut at php.net>

Version:

Release: @package_version@

Copyright:

2005-2008 Hartmut Holzgraefe

Variables

Methods

Inherited Variables

Inherited Methods

Class: CodeGen_PECL_Element

CodeGen_PECL_Element::isKeyword(): Checks whether a string is a reserved name
CodeGen_PECL_Element::isType(): Checks whether a string is a valid PHP type name and returns the official name

Class Details

[line 38]
Class for managing PHP stream wrappers

Author: Hartmut Holzgraefe <hartmut@php.net>
Version: Release: @package_version@
Copyright: 2005-2008 Hartmut Holzgraefe
Link: http://pear.php.net/package/CodeGen
License: PHP License 3.0

[ Top ]

Class Variables

$codeBlocks = array()

[line 127]

code blocks for various handlers

Access: protected

Type:

array

[ Top ]

$description = ""

[line 103]

DocBook XML snippet that describes the resource for the manual

Access: protected

Type:

string

[ Top ]

$name = "unknown"

[line 47]

Stream type name

Access: protected

Type:

string

[ Top ]

$summary = ""

[line 80]

DocBook XML snippet that describes the resource for the manual

Access: protected

Type:

string

[ Top ]

Method Detail

addCode [line 135]

void addCode(
string
$role, string
$code)

add code for a handler

Parameters:

string	`$role`	—	handler role
string	`$code`	—	C code snippet

[ Top ]

cCode [line 171]

string cCode(
object extension
$extension)

Generate C code for resource destructor callback

Return: C code snippet
Access: public

Parameters:

object extension $extension —

[ Top ]

docEntry [line 234]

string docEntry(
string
$base)

Generate documentation for this resource

Return: DocBook XML code snippet
Access: public

Parameters:

string $base — id basename for extension

[ Top ]

getName [line 68]

void getName(
)

[ Top ]

hCode [line 220]

string hCode(
)

Generate covenience macros for resource access

Return: C code snippet
Access: public

[ Top ]

minitCode [line 158]

string minitCode(
)

Generate resource registration code for MINIT()

Return: C code snippet
Access: public

[ Top ]

setDescription [line 112]

bool setDescription(
string
$text)

Set method for destructor snippet

Return: true on success
Access: public

Parameters:

string $text — C code snippet

[ Top ]

setName [line 56]

bool setName(
string
$name)

Set method for name

Return: true on success
Access: public

Parameters:

string $name — name

[ Top ]

setSummary [line 89]

bool setSummary(
string
$text)

Set method for destructor snippet

Return: true on success
Access: public

Parameters:

string $text — C code snippet

[ Top ]