AbstractFileDriver
public abstract class AbstractFileDriver
www.doctrine-project.com| Field Summary | |
|---|---|
| protected string | The file extension of mapping documents. |
| protected array | The paths where to look for mapping files. |
| Constructor Summary | |
|---|---|
AbstractFileDriver(string|array paths) Initializes a new FileDriver that looks in the given path(s) for mapping documents and operates in the specified operating mode. |
|
| Method Summary | |
|---|---|
| void | addPaths(array paths) Append lookup paths to metadata driver. |
| array | Gets the names of all mapped classes known to this driver. |
| array | getElement(mixed className) Get the element of schema meta data for the class from the mapping file. |
| void | Get the file extension used to look for mapping files under |
| array | getPaths() Retrieve the defined metadata lookup paths. |
| boolean | isTransient(string className) Whether the class with the specified name should have its metadata loaded. |
| void | setFileExtension(string fileExtension) Set the file extension used to look for mapping files under |
protected string $_fileExtension
The file extension of mapping documents.
protected array $_paths = array()
The paths where to look for mapping files.
public AbstractFileDriver(string|array paths)
Initializes a new FileDriver that looks in the given path(s) for mapping documents and operates in the specified operating mode.
public void addPaths(array paths)
Append lookup paths to metadata driver.
public array getAllClassNames()
Gets the names of all mapped classes known to this driver.
public array getElement(mixed className)
Get the element of schema meta data for the class from the mapping file. This will lazily load the mapping file if it is not loaded yet
public void getFileExtension()
Get the file extension used to look for mapping files under
public array getPaths()
Retrieve the defined metadata lookup paths.
public boolean isTransient(string className)
Whether the class with the specified name should have its metadata loaded. This is only the case if it is either mapped as an Entity or a MappedSuperclass.
public void setFileExtension(string fileExtension)
Set the file extension used to look for mapping files under
Base driver for file-based metadata drivers.
A file driver operates in a mode where it loads the mapping files of individual classes on demand. This requires the user to adhere to the convention of 1 mapping file per class and the file names of the mapping files must correspond to the full class name, including namespace, with the namespace delimiters '\', replaced by dots '.'.