VirtualEnumerationsTransformer class - Documentation for Pelzini

Info Page:

Page options:

class VirtualEnumerationsTransformer

This transformer converts constants that start with the same name into an enumeration of that name.

So if a file has the following constants:
  APP_VERSION
  ITEM_TYPE_APPLE
  ITEM_TYPE_ORANGE

The APPLE and ORANGE constants will become a part of the virtual enumeration ITEM_TYPE.

File: /processor/virtual_enumerations_transformer.php
Namespace: processor
Extends: Transformer
Available since:

Authors

Josh

Functions

Name	Visibility	Description
__construct	public
createVirtualEnum	private	Creates an enum
numSimilarChars	private	Returns the number of chars in $a that are the same as the chars in $b
processConstants	private	Processes constants for a specified file
transform	public	Transforms the data model before outputting.

public __construct

void $VirtualEnumerationsTransformer->__construct ( );

This function does not have a description

private createVirtualEnum

unknown $VirtualEnumerationsTransformer->createVirtualEnum ( mixed $name );

Creates an enum

private numSimilarChars

unknown $VirtualEnumerationsTransformer->numSimilarChars ( mixed $a , mixed $b );

Returns the number of chars in $a that are the same as the chars in $b

private processConstants

void $VirtualEnumerationsTransformer->processConstants ( ParserFile $file );

Processes constants for a specified file

public transform

array $VirtualEnumerationsTransformer->transform ( array &$parser_model );

Transforms the data model before outputting.

This transformer converts constants that start with the same name into an enumeration of that name.

Pelzini

Search documentation