Programmer's Reference Guide

Zend_CodeGenerator リファレンス

抽象クラスとインターフェース

Zend_CodeGenerator_Abstract

すべての CodeGenerator クラスが継承する基底のクラスは、必要な最小限の機能性を提供します。そのAPIは下記の通りです。:

abstract class Zend_CodeGenerator_Abstract
{
    final public function __construct(Array $options = array())
    public function setOptions(Array $options)
    public function setSourceContent($sourceContent)
    public function getSourceContent()
    protected function _init()
    protected function _prepare()
    abstract public function generate();
    final public function __toString()
}

コンストラクタは最初に _init() を呼び出します。（それは、具体的に拡張するクラスを実装するために空のままにされます）それから setOptions() に $options パラメータを渡し、最後に _prepare() を呼び出します。（again, クラスの拡張によって実装されます。）

Zend Framework のほとんどのクラスのように、 setOptions() ではクラスの既存のセッターへのオプション・キーを比較して、見つかったら、メソッドに値を渡します。

__toString() は最後に指定され、 generate() の代わりをします。

setSourceContent() 及び getSourceContent() はデフォルト・コンテンツを生成されたコードに設定するか、一旦すべての生成作業が完了した前述のコンテンツと入れ替えることを目的とします。

Zend_CodeGenerator_Php_Abstract

Zend_CodeGenerator_Php_Abstract は Zend_CodeGenerator_Abstract を拡張し、生成されたコンテンツの前に現れなければならないインデントの量だけでなく、コンテンツが変わったかどうか追跡するための若干のプロパティも加えます。その API は下記の通りです。:

abstract class Zend_CodeGenerator_Php_Abstract
    extends Zend_CodeGenerator_Abstract
{
    public function setSourceDirty($isSourceDirty = true)
    public function isSourceDirty()
    public function setIndentation($indentation)
    public function getIndentation()
}

Zend_CodeGenerator_Php_Member_Abstract

Zend_CodeGenerator_Php_Member_Abstract はクラスのメンバー - プロパティとメソッド - を生成するための基底クラスで、可視性を確立するためのアクセッサとミューテータを提供します; メンバーやメンバー名が abstract 、 static または final のいずれにせよ。その API は下記の通りです。:

abstract class Zend_CodeGenerator_Php_Member_Abstract
    extends Zend_CodeGenerator_Php_Abstract
{
    public function setAbstract($isAbstract)
    public function isAbstract()
    public function setStatic($isStatic)
    public function isStatic()
    public function setVisibility($visibility)
    public function getVisibility()
    public function setName($name)
    public function getName()
}

CodeGenerator クラスを確立

Zend_CodeGenerator_Php_Body

Zend_CodeGenerator_Php_Body は、ファイルの中に含む任意の手続き的なコードを生成することを目的とします。そのように、単にコンテンツをオブジェクトに設定し、 generate() を実施すると、それはそのコンテンツを返します。

そのクラスの API は下記の通りです。:

class Zend_CodeGenerator_Php_Body extends Zend_CodeGenerator_Php_Abstract
{
    public function setContent($content)
    public function getContent()
    public function generate()
}

Zend_CodeGenerator_Php_Class

Zend_CodeGenerator_Php_Class は、 PHP クラスを生成することを目的とします。基本的機能では PHP クラスそのものを生成し、また、任意で関連した PHP DocBlockも生成します。クラスは他のクラスを実装するかもしれませんし、継承するかもしれません。またはabstractと指定されるかもしれません。他のコード・ジェネレーター・クラスを利用して、クラスの定数やプロパティ、メソッドを付与することもできます。

その API は下記の通りです。:

class Zend_CodeGenerator_Php_Class extends Zend_CodeGenerator_Php_Abstract
{
    public static function fromReflection(
        Zend_Reflection_Class $reflectionClass
    )
    public function setDocblock(Zend_CodeGenerator_Php_Docblock $docblock)
    public function getDocblock()
    public function setName($name)
    public function getName()
    public function setAbstract($isAbstract)
    public function isAbstract()
    public function setExtendedClass($extendedClass)
    public function getExtendedClass()
    public function setImplementedInterfaces(Array $implementedInterfaces)
    public function getImplementedInterfaces()
    public function setProperties(Array $properties)
    public function setProperty($property)
    public function getProperties()
    public function getProperty($propertyName)
    public function setMethods(Array $methods)
    public function setMethod($method)
    public function getMethods()
    public function getMethod($methodName)
    public function hasMethod($methodName)
    public function isSourceDirty()
    public function generate()
}

setProperty() メソッドは、 Zend_CodeGenerator_Php_Property インスタンスを生成するために用いられるかもしれない情報の配列、またはただ単に Zend_CodeGenerator_Php_Property インスタンス、を受け入れます。同様に setMethod() は、 Zend_CodeGenerator_Php_Method インスタンスを生成するための、情報の配列またはそのクラスの具体化したインスタンスを受け入れます。

setDocBlock() が Zend_CodeGenerator_Php_DocBlock のインスタンスを期待することも注意してください。

Zend_CodeGenerator_Php_Docblock

Zend_CodeGenerator_Php_Docblock は、すべての標準的な docblock 機能を含む任意の PHP docblock を生成することで使用できます: 短い、または長い説明や注釈タグ。

注釈タグは setTag() や setTags() メソッドを用いてセットされるかもしれません; これらは Zend_CodeGenerator_Php_Docblock_Tag コンストラクタに渡されるかもしれないタグを記述している配列、またはそのクラスのインスタンスどちらもそれぞれ take

その API は下記の通りです。:

class Zend_CodeGenerator_Php_Docblock extends Zend_CodeGenerator_Php_Abstract
{
    public static function fromReflection(
        Zend_Reflection_Docblock $reflectionDocblock
    )
    public function setShortDescription($shortDescription)
    public function getShortDescription()
    public function setLongDescription($longDescription)
    public function getLongDescription()
    public function setTags(Array $tags)
    public function setTag($tag)
    public function getTags()
    public function generate()
}

Zend_CodeGenerator_Php_Docblock_Tag

Zend_CodeGenerator_Php_Docblock_Tag は、 PHP docblock に含む任意の注釈タグを作成することを目的とします。タグは、名前（＠記号にすぐ続く部分）と説明（タグ名に続いているすべて）を含むことになっています。

そのクラスの API は下記の通りです。:

class Zend_CodeGenerator_Php_Docblock_Tag
    extends Zend_CodeGenerator_Php_Abstract
{
    public static function fromReflection(
        Zend_Reflection_Docblock_Tag $reflectionTag
    )
    public function setName($name)
    public function getName()
    public function setDescription($description)
    public function getDescription()
    public function generate()
}

Zend_CodeGenerator_Php_DocBlock_Tag_Param

Zend_CodeGenerator_Php_DocBlock_Tag_Param は Zend_CodeGenerator_Php_DocBlock_Tag の分化したバージョンで、メソッド・パラメータを表します。そこで、タグ名は( "param" )として知られています、しかし、この注釈タグを構成するパラメータ名とデータ型を生成するために、追加の情報が必要とされます。

そのクラスの API は下記の通りです。:

class Zend_CodeGenerator_Php_Docblock_Tag_Param
    extends Zend_CodeGenerator_Php_Docblock_Tag
{
    public static function fromReflection(
        Zend_Reflection_Docblock_Tag $reflectionTagParam
    )
    public function setDatatype($datatype)
    public function getDatatype()
    public function setParamName($paramName)
    public function getParamName()
    public function generate()
}

Zend_CodeGenerator_Php_DocBlock_Tag_Return

param docblock tag variant のように、 Zend_CodeGenerator_Php_Docblock_Tab_Return はメソッドの戻り値を表すための注釈 tag variantです。この場合、注釈タグ名は( "return" )として知られていますが、戻す型を必要とします。

そのクラスの API は下記の通りです。:

class Zend_CodeGenerator_Php_Docblock_Tag_Param
    extends Zend_CodeGenerator_Php_Docblock_Tag
{
    public static function fromReflection(
        Zend_Reflection_Docblock_Tag $reflectionTagReturn
    )
    public function setDatatype($datatype)
    public function getDatatype()
    public function generate()
}

Zend_CodeGenerator_Php_File

Zend_CodeGenerator_Php_File は、 PHP コードを含むファイルの完全なコンテンツを生成することに使われます。ファイル・レベルの docblock と同様に必要に応じて、ファイルはクラスまたは任意の PHP コードを含むかもしれません。

クラスをファイルに加えるとき、 Zend_CodeGenerator_Php_Class コンストラクタに渡す情報の配列か、そのクラスのインスタンスのどちらかを渡す必要があります。同様に docblock で、 Zend_CodeGenerator_Php_Docblock コンストラクタが消費する情報、またはクラスのインスタンスを渡す必要があります。

そのクラスの API は下記の通りです。:

class Zend_CodeGenerator_Php_File extends Zend_CodeGenerator_Php_Abstract
{
    public static function fromReflectedFilePath(
        $filePath,
        $usePreviousCodeGeneratorIfItExists = true,
        $includeIfNotAlreadyIncluded = true)
    public static function fromReflection(Zend_Reflection_File $reflectionFile)
    public function setDocblock(Zend_CodeGenerator_Php_Docblock $docblock)
    public function getDocblock()
    public function setRequiredFiles($requiredFiles)
    public function getRequiredFiles()
    public function setClasses(Array $classes)
    public function getClass($name = null)
    public function setClass($class)
    public function setFilename($filename)
    public function getFilename()
    public function getClasses()
    public function setBody($body)
    public function getBody()
    public function isSourceDirty()
    public function generate()
}

Zend_CodeGenerator_Php_Member_Container

Zend_CodeGenerator_Php_Member_Container は、 Zend_CodeGenerator_Php_Class によって、内部的にクラスのメンバー - プロパティやメソッドなど - の経過を追う目的に使われます。

そのクラスの API は下記の通りです。:

class Zend_CodeGenerator_Php_Member_Container extends ArrayObject
{
    public function __construct($type = self::TYPE_PROPERTY)
}

Zend_CodeGenerator_Php_Method

Zend_CodeGenerator_Php_Method は、クラス・メソッドを記述して、メソッドのためにコードと docblock を生成できます。その親クラス、 Zend_CodeGenerator_Php_Member_Abstract の通りに、 static 、 abstract または final としての可視性と状態が指示されるかもしれません。最後に、メソッドのパラメータと戻り値は、指定されるかもしれません。

パラメータは setParameter() または setParameters() を用いて設定されるかもしれません。それぞれの場合、パラメータは Zend_CodeGenerator_Php_Parameter コンストラクタに渡す情報の配列か、またはそのクラスのインスタンスでなければいけません。

そのクラスの API は下記の通りです。:

class Zend_CodeGenerator_Php_Method
    extends Zend_CodeGenerator_Php_Member_Abstract
{
    public static function fromReflection(
        Zend_Reflection_Method $reflectionMethod
    )
    public function setDocblock(Zend_CodeGenerator_Php_Docblock $docblock)
    public function getDocblock()
    public function setFinal($isFinal)
    public function setParameters(Array $parameters)
    public function setParameter($parameter)
    public function getParameters()
    public function setBody($body)
    public function getBody()
    public function generate()
}

Zend_CodeGenerator_Php_Parameter

Zend_CodeGenerator_Php_Parameter は、メソッドのパラメータを指定することに使われるかもしれません。各々のパラメータは、位置やデフォルト値、データ型を持つかもしれません; パラメータ名は必須です。位置がもし明確でなければ、それらがメソッドで記載された順序が使われます。

そのクラスの API は下記の通りです。:

class Zend_CodeGenerator_Php_Parameter extends Zend_CodeGenerator_Php_Abstract
{
    public static function fromReflection(
        Zend_Reflection_Parameter $reflectionParameter
    )
    public function setType($type)
    public function getType()
    public function setName($name)
    public function getName()
    public function setDefaultValue($defaultValue)
    public function getDefaultValue()
    public function setPosition($position)
    public function getPosition()
    public function getPassedByReference()
    public function setPassedByReference($passedByReference)
    public function generate()
}

既定値として NULL 、ブーリアンまたは配列を設定しようとすると、いくつかの問題が起きるかもしれません。このために、バリューホルダー・オブジェクト Zend_CodeGenerator_Php_ParameterDefaultValue を利用できます。例えば:

$parameter = new Zend_CodeGenerator_Php_Parameter();
$parameter->setDefaultValue(
    new Zend_CodeGenerator_Php_Parameter_DefaultValue("null")
);
$parameter->setDefaultValue(
    new Zend_CodeGenerator_Php_Parameter_DefaultValue("array('foo', 'bar')")
);

内部的には setDefaultValue() も PHP で表現できない値をバリューホルダーに変換します。

Zend_CodeGenerator_Php_Property

Zend_CodeGenerator_Php_Property はクラスのプロパティを記述します。それは定数か変数であるかもしれません。どちらの場合も、プロパティには関連するデフォルト値をオプションで持つかもしれません。さらに、親クラス（ Zend_CodeGenerator_Php_Member_Abstract ）を通じて変数のプロパティの可視性が設定されるかもしれません。

そのクラスの API は下記の通りです。:

class Zend_CodeGenerator_Php_Property
    extends Zend_CodeGenerator_Php_Member_Abstract
{
    public static function fromReflection(
        Zend_Reflection_Property $reflectionProperty
    )
    public function setConst($const)
    public function isConst()
    public function setDefaultValue($defaultValue)
    public function getDefaultValue()
    public function generate()
}