PHP Class Doctrine\ODM\MongoDB\Tools\DocumentGenerator

[php] $classes = $dm->getClassMetadataInfoFactory()->getAllMetadata(); $generator = new \Doctrine\ODM\MongoDB\Tools\DocumentGenerator(); $generator->setGenerateAnnotations(true); $generator->setGenerateStubMethods(true); $generator->setRegenerateDocumentIfExists(false); $generator->setUpdateDocumentIfExists(true); $generator->generate($classes, '/path/to/generate/documents');
Since: 1.0
Show file Open project: doctrine/mongodb-odm Class Usage Examples

Public Methods

Method Description
generate ( array $metadatas, string $outputDirectory ) : void Generate and write document classes for the given array of ClassMetadataInfo instances
generateDocumentClass ( ClassMetadataInfo $metadata ) : string Generate a PHP5 Doctrine 2 document class from the given ClassMetadataInfo instance
generateUpdatedDocumentClass ( ClassMetadataInfo $metadata, string $path ) : string Generate the updated code for the given ClassMetadataInfo and document at path
setBackupExisting ( boolean $bool ) Sets a value indicating whether existing documents will be backed up.
setClassToExtend ( string $classToExtend ) : void Set the name of the class the generated classes should extend from
setExtension ( string $extension ) : void Set the extension to use when writing php files to disk
setGenerateAnnotations ( boolean $bool ) : void Set whether or not to generate annotations for the document
setGenerateStubMethods ( boolean $bool ) : void Set whether or not to generate stub methods for the document
setNumSpaces ( integer $numSpaces ) : void Set the number of spaces the exported class should have
setRegenerateDocumentIfExists ( boolean $bool ) : void Set whether or not to regenerate the document if it exists
setUpdateDocumentIfExists ( boolean $bool ) : void Set whether or not to try and update the document if it already exists
writeDocumentClass ( ClassMetadataInfo $metadata, string $outputDirectory ) : void Generated and write document class to disk for the given ClassMetadataInfo instance

Protected Methods

Method Description
getTraits ( ClassMetadataInfo $metadata ) : array
isAssociationNullable ( array $fieldMapping ) : boolean

Private Methods

Method Description
extendsClass ( )
generateAssociationMappingPropertyDocBlock ( array $fieldMapping )
generateChangeTrackingPolicyAnnotation ( ClassMetadataInfo $metadata )
generateDefaultDiscriminatorValueAnnotation ( ClassMetadataInfo $metadata )
generateDiscriminatorFieldAnnotation ( ClassMetadataInfo $metadata )
generateDiscriminatorMapAnnotation ( ClassMetadataInfo $metadata )
generateDocumentAssociationMappingProperties ( ClassMetadataInfo $metadata )
generateDocumentBody ( ClassMetadataInfo $metadata )
generateDocumentClassName ( ClassMetadataInfo $metadata )
generateDocumentConstructor ( ClassMetadataInfo $metadata )
generateDocumentDocBlock ( ClassMetadataInfo $metadata )
generateDocumentFieldMappingProperties ( ClassMetadataInfo $metadata )
generateDocumentImports ( )
generateDocumentLifecycleCallbackMethods ( ClassMetadataInfo $metadata )
generateDocumentNamespace ( ClassMetadataInfo $metadata )
generateDocumentStubMethod ( ClassMetadataInfo $metadata, $type, $fieldName, $typeHint = null, $defaultValue = null )
generateDocumentStubMethods ( ClassMetadataInfo $metadata )
generateFieldMappingPropertyDocBlock ( array $fieldMapping, ClassMetadataInfo $metadata )
generateInheritanceAnnotation ( ClassMetadataInfo $metadata )
generateLifecycleCallbackMethod ( $name, $methodName, ClassMetadataInfo $metadata )
getChangeTrackingPolicyString ( $policy )
getClassName ( ClassMetadataInfo $metadata )
getClassToExtend ( )
getClassToExtendName ( )
getIdGeneratorTypeString ( $type )
getInheritanceTypeString ( $type )
getNamespace ( ClassMetadataInfo $metadata )
hasMethod ( $method, ClassMetadataInfo $metadata )
hasNamespace ( ClassMetadataInfo $metadata )
hasProperty ( $property, ClassMetadataInfo $metadata )
parseTokensInDocumentFile ( string $path )
prefixCodeWithSpaces ( $code, $num = 1 )

Method Details

generate() public method

Generate and write document classes for the given array of ClassMetadataInfo instances
public generate ( array $metadatas, string $outputDirectory ) : void
$metadatas array
$outputDirectory string
return void

generateDocumentClass() public method

Generate a PHP5 Doctrine 2 document class from the given ClassMetadataInfo instance
public generateDocumentClass ( ClassMetadataInfo $metadata ) : string
$metadata Doctrine\ODM\MongoDB\Mapping\ClassMetadataInfo
return string $code

generateUpdatedDocumentClass() public method

Generate the updated code for the given ClassMetadataInfo and document at path
public generateUpdatedDocumentClass ( ClassMetadataInfo $metadata, string $path ) : string
$metadata Doctrine\ODM\MongoDB\Mapping\ClassMetadataInfo
$path string
return string $code;

getTraits() protected method

protected getTraits ( ClassMetadataInfo $metadata ) : array
$metadata Doctrine\ODM\MongoDB\Mapping\ClassMetadataInfo
return array

isAssociationNullable() protected method

protected isAssociationNullable ( array $fieldMapping ) : boolean
$fieldMapping array
return boolean

setBackupExisting() public method

Sets a value indicating whether existing documents will be backed up.
public setBackupExisting ( boolean $bool )
$bool boolean True to backup existing document, false to overwrite.

setClassToExtend() public method

Set the name of the class the generated classes should extend from
public setClassToExtend ( string $classToExtend ) : void
$classToExtend string Class name.
return void

setExtension() public method

Set the extension to use when writing php files to disk
public setExtension ( string $extension ) : void
$extension string
return void

setGenerateAnnotations() public method

Set whether or not to generate annotations for the document
public setGenerateAnnotations ( boolean $bool ) : void
$bool boolean
return void

setGenerateStubMethods() public method

Set whether or not to generate stub methods for the document
public setGenerateStubMethods ( boolean $bool ) : void
$bool boolean
return void

setNumSpaces() public method

Set the number of spaces the exported class should have
public setNumSpaces ( integer $numSpaces ) : void
$numSpaces integer
return void

setRegenerateDocumentIfExists() public method

Set whether or not to regenerate the document if it exists
public setRegenerateDocumentIfExists ( boolean $bool ) : void
$bool boolean
return void

setUpdateDocumentIfExists() public method

Set whether or not to try and update the document if it already exists
public setUpdateDocumentIfExists ( boolean $bool ) : void
$bool boolean
return void

writeDocumentClass() public method

Generated and write document class to disk for the given ClassMetadataInfo instance
public writeDocumentClass ( ClassMetadataInfo $metadata, string $outputDirectory ) : void
$metadata Doctrine\ODM\MongoDB\Mapping\ClassMetadataInfo
$outputDirectory string
return void