PHP Interface AppserverIo\Appserver\Core\Api\Node\PersistenceUnitNodeInterface

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Inheritance: extends AppserverIo\Configuration\Interfaces\NodeInterface
Show file Open project: appserver-io/appserver Interface Usage Examples

Public Methods

Method Description
getAnnotationRegistries ( ) : array Returns the entity managers annotation registries configuration.
getDatasource ( ) : AppserverIo\Appserver\Core\Api\Node\DatasourceNode Returns the entity manager's datasource configuration.
getDirectories ( ) : DirectoryNode[] Array with the directories.
getDirectoriesAsArray ( string $prepend = null ) : The Returns an array with the directories as string value, each prepended with the passed value.
getFactory ( ) : string Returns the entity manager's factory class name.
getInterface ( ) : string Returns the entity manager's interface.
getMetadataCacheConfiguration ( ) : AppserverIo\Appserver\Core\Api\Node\MetadataCacheConfigurationNode Returns the entity manager's metadata cache configuration.
getMetadataConfiguration ( ) : AppserverIo\Appserver\Core\Api\Node\MetadataConfigurationNode Returns the entity manager's metadata configuration.
getName ( ) : string Returns the entity manager's name.
getParam ( string $name ) : mixed Returns the param with the passed name casted to the specified type.
getParams ( ) : array Array with the handler params to use.
getParamsAsArray ( ) : array Returns the params casted to the defined type as associative array.
getQueryCacheConfiguration ( ) : AppserverIo\Appserver\Core\Api\Node\MetadataConfigurationNode Returns the entity manager's query cache configuration.
getResultCacheConfiguration ( ) : AppserverIo\Appserver\Core\Api\Node\MetadataConfigurationNode Returns the entity manager's result cache configuration.
getType ( ) : string Returns the entity manager's class name.

Method Details

getAnnotationRegistries() public method

Returns the entity managers annotation registries configuration.
public getAnnotationRegistries ( ) : array
return array The entity managers annotation registries configuration

getDatasource() public method

Returns the entity manager's datasource configuration.
public getDatasource ( ) : AppserverIo\Appserver\Core\Api\Node\DatasourceNode
return AppserverIo\Appserver\Core\Api\Node\DatasourceNode The entity manager's datasource configuration

getDirectories() public method

Array with the directories.
public getDirectories ( ) : DirectoryNode[]
return DirectoryNode[]

getDirectoriesAsArray() public method

Returns an array with the directories as string value, each prepended with the passed value.
public getDirectoriesAsArray ( string $prepend = null ) : The
$prepend string Prepend to each directory
return The array with the directories as string

getFactory() public method

Returns the entity manager's factory class name.
public getFactory ( ) : string
return string The entity manager's factory class name

getInterface() public method

Returns the entity manager's interface.
public getInterface ( ) : string
return string The entity manager's interface

getMetadataCacheConfiguration() public method

Returns the entity manager's metadata cache configuration.
public getMetadataCacheConfiguration ( ) : AppserverIo\Appserver\Core\Api\Node\MetadataCacheConfigurationNode
return AppserverIo\Appserver\Core\Api\Node\MetadataCacheConfigurationNode The entity manager's metadata cache configuration

getMetadataConfiguration() public method

Returns the entity manager's metadata configuration.
public getMetadataConfiguration ( ) : AppserverIo\Appserver\Core\Api\Node\MetadataConfigurationNode
return AppserverIo\Appserver\Core\Api\Node\MetadataConfigurationNode The entity manager's metadata configuration

getName() public method

Returns the entity manager's name.
public getName ( ) : string
return string The entity manager's name

getParam() public method

Returns the param with the passed name casted to the specified type.
public getParam ( string $name ) : mixed
$name string The name of the param to be returned
return mixed The requested param casted to the specified type

getParams() public method

Array with the handler params to use.
public getParams ( ) : array
return array

getParamsAsArray() public method

Returns the params casted to the defined type as associative array.
public getParamsAsArray ( ) : array
return array The array with the casted params

getQueryCacheConfiguration() public method

Returns the entity manager's query cache configuration.
public getQueryCacheConfiguration ( ) : AppserverIo\Appserver\Core\Api\Node\MetadataConfigurationNode
return AppserverIo\Appserver\Core\Api\Node\MetadataConfigurationNode The entity manager's query cache configuration

getResultCacheConfiguration() public method

Returns the entity manager's result cache configuration.
public getResultCacheConfiguration ( ) : AppserverIo\Appserver\Core\Api\Node\MetadataConfigurationNode
return AppserverIo\Appserver\Core\Api\Node\MetadataConfigurationNode The entity manager's result cache configuration

getType() public method

Returns the entity manager's class name.
public getType ( ) : string
return string The entity manager's class name