PHP 클래스 Doctrine\OXM\Mapping\Driver\AbstractFileDriver

부터: 2.0
저자: Richard Fullmer ([email protected])
상속: implements Doctrine\OXM\Mapping\Driver\Driver
파일 보기 프로젝트 열기: doctrine/oxm

보호된 프로퍼티들

프로퍼티 타입 설명
$fileExtension string The file extension of mapping documents.
$paths array The paths where to look for mapping files.

공개 메소드들

메소드 설명
__construct ( string | array $paths ) Initializes a new FileDriver that looks in the given path(s) for mapping documents and operates in the specified operating mode.
addPaths ( array $paths ) Append lookup paths to metadata driver.
getAllClassNames ( ) : array Gets the names of all mapped classes known to this driver.
getElement ( $className ) : array Get the element of schema meta data for the class from the mapping file.
getFileExtension ( ) : void Get the file extension used to look for mapping files under
getPaths ( ) : array Retrieve the defined metadata lookup paths.
isTransient ( string $className ) : boolean Whether the class with the specified name should have its metadata loaded.
setFileExtension ( string $fileExtension ) : void Set the file extension used to look for mapping files under

보호된 메소드들

메소드 설명
findMappingFile ( $className ) : string Finds the mapping file for the class with the given name by searching through the configured paths.
loadMappingFile ( string $file ) : array Loads a mapping file with the given name and returns a map from class/entity names to their corresponding elements.

메소드 상세

__construct() 공개 메소드

Initializes a new FileDriver that looks in the given path(s) for mapping documents and operates in the specified operating mode.
public __construct ( string | array $paths )
$paths string | array One or multiple paths where mapping documents can be found.

addPaths() 공개 메소드

Append lookup paths to metadata driver.
public addPaths ( array $paths )
$paths array

findMappingFile() 보호된 메소드

Finds the mapping file for the class with the given name by searching through the configured paths.
protected findMappingFile ( $className ) : string
$className
리턴 string The (absolute) file name.

getAllClassNames() 공개 메소드

Gets the names of all mapped classes known to this driver.
public getAllClassNames ( ) : array
리턴 array The names of all mapped classes known to this driver.

getElement() 공개 메소드

This will lazily load the mapping file if it is not loaded yet
public getElement ( $className ) : array
리턴 array $element The element of schema meta data

getFileExtension() 공개 메소드

Get the file extension used to look for mapping files under
public getFileExtension ( ) : void
리턴 void

getPaths() 공개 메소드

Retrieve the defined metadata lookup paths.
public getPaths ( ) : array
리턴 array

isTransient() 공개 메소드

This is only the case if it is either mapped as an Entity or a MappedSuperclass.
public isTransient ( string $className ) : boolean
$className string
리턴 boolean

loadMappingFile() 추상적인 보호된 메소드

Loads a mapping file with the given name and returns a map from class/entity names to their corresponding elements.
abstract protected loadMappingFile ( string $file ) : array
$file string The mapping file to load.
리턴 array

setFileExtension() 공개 메소드

Set the file extension used to look for mapping files under
public setFileExtension ( string $fileExtension ) : void
$fileExtension string The file extension to set
리턴 void

프로퍼티 상세

$fileExtension 보호되어 있는 프로퍼티

The file extension of mapping documents.
protected string $fileExtension
리턴 string

$paths 보호되어 있는 프로퍼티

The paths where to look for mapping files.
protected array $paths
리턴 array