PHP Класс Doctrine\OXM\Mapping\Driver\AbstractFileDriver

С версии: 2.0
Автор: Richard Fullmer ([email protected])
Наследование: implements Doctrine\OXM\Mapping\Driver\Driver
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$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