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


Classes:
CodeGen_PECL_Command
CodeGen_PECL_Dependency_Extension
CodeGen_PECL_Dependency_With
CodeGen_PECL_Element
CodeGen_PECL_Element_Class
CodeGen_PECL_Element_ClassConstant
CodeGen_PECL_Element_Constant
CodeGen_PECL_Element_Global
CodeGen_PECL_Element_Ini
CodeGen_PECL_Element_Interface
CodeGen_PECL_Element_Logo
CodeGen_PECL_Element_Method
CodeGen_PECL_Element_Property
CodeGen_PECL_Element_Resource
CodeGen_PECL_Element_Stream
CodeGen_PECL_ExtensionParser
CodeGen_PECL_Maintainer
CodeGen_PECL_Release
Files:
Class.php
ClassConstant.php
Command.php
Constant.php
Element.php
Extension.php
ExtensionParser.php
Global.php
Ini.php
Interface.php
Logo.php
Maintainer.php
Method.php
Property.php
Release.php
Resource.php
Stream.php
With.php

Class: CodeGen_PECL_Element_Resource

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

Class Overview

CodeGen_Element
   |
   --CodeGen_PECL_Element
      |
      --CodeGen_PECL_Element_Resource

Class for managing PHP internal resource types


Author(s):

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 internal resource types


[ Top ]

Class Variables

$alloc =  true

[line 119]

Whether the resource memory is allocated and freed by the extension itself
  • Access: protected

Type:   bool


[ Top ]

$description =  ""

[line 178]

DocBook XML snippet that describes the resource for the manual
  • Access: protected

Type:   string


[ Top ]

$destruct =  ""

[line 153]

Code snippet to be added to the resource destructor callback
  • Access: protected

Type:   string


[ Top ]

$name =  "unknown"

[line 47]

Resource type name
  • Access: protected

Type:   string


[ Top ]

$payload =  "void"

[line 85]

Type of the payload that the resource data pointer points to
  • Access: protected

Type:   string


[ Top ]


Method Detail

cCode   [line 250]

string cCode( object extension $extension)

Generate C code for resource destructor callback
  • Return: C code snippet
  • Access: public

Parameters:

object extension   $extension   — 

[ Top ]

cCodeFooter   [line 238]

string cCodeFooter( string $name)

Generate C code footer block for resources
  • Return: C code
  • Access: public

Parameters:

string   $name   —  Extension name

[ Top ]

cCodeHeader   [line 226]

string cCodeHeader( string $name)

Generate C code header block for resources
  • Return: C code
  • Access: public

Parameters:

string   $name   —  Extension name

[ Top ]

configm4   [line 316]

string configm4( $extension_name)

Generate config.m4 to check for payload type
  • Return: autoconf code snippet
  • Access: public

Parameters:

   $extension_name   — 

[ Top ]

docEntry   [line 342]

string docEntry( string $base)

Generate documentation for this resource
  • Return: DocBook XML code snippet
  • Access: public

Parameters:

string   $base   —  id basename for extension

[ Top ]

getAlloc   [line 141]

bool getAlloc( )

Get mehod for alloc
  • Access: public

[ Top ]

getName   [line 73]

string getName( )

Get method for name
  • Access: public

[ Top ]

getPayload   [line 107]

string getPayload( )

Get method for payload type
  • Access: public

[ Top ]

hCode   [line 290]

string hCode( )

Generate covenience macros for resource access
  • Return: C code snippet
  • Access: public

[ Top ]

minitCode   [line 203]

string minitCode( )

Generate resource registration code for MINIT()
  • Return: C code snippet
  • Access: public

[ Top ]

setAlloc   [line 128]

bool setAlloc( bool $text)

Set method for alloc
  • Return: true on success
  • Access: public

Parameters:

bool   $text   —  allocate memory?

[ Top ]

setDescription   [line 187]

bool setDescription( string $text)

Set method for destructor snippet
  • Return: true on success
  • Access: public

Parameters:

string   $text   —  C code snippet

[ Top ]

setDestruct   [line 162]

bool setDestruct( 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 ]

setPayload   [line 94]

bool setPayload( string $type)

Set method for payload type
  • Return: true on success
  • Access: public

Parameters:

string   $type   —  type name

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:39:10 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.