Skip to content

Commit

Permalink
update docblocks
Browse files Browse the repository at this point in the history
  • Loading branch information
juliangut committed Jul 27, 2016
1 parent e369836 commit 1c74fa1
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 34 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,15 +182,15 @@ These are general considerations when configuring both Entity and Document manag

Extending managers with custom types or custom mappings is really simple, here you'll find an example using two well known libraries.

### [ramsey/doctrine-uuid](https://github.com/ramsey/uuid-doctrine)
### [ramsey/uuid-doctrine](https://github.com/ramsey/uuid-doctrine)

```
composer require ramsey/doctrine-uuid
composer require ramsey/uuid-doctrine
```

```php
use Jgut\Slim\Doctrine\EntityManagerBuilder;
use Ramsey\Uuid\Doctrine\UuidType
use Ramsey\Uuid\Doctrine\UuidType;

$entityManagerSettings = [
'connection' => [
Expand All @@ -212,7 +212,7 @@ composer require gedmo/doctrine-extensions

```php
use Doctrine\Common\EventManager;
use Gedmo\DoctrineExtensions
use Gedmo\DoctrineExtensions;
use Gedmo\Sluggable\SluggableListener;
use Gedmo\Timestampable\TimestampableListener;
use Jgut\Slim\Doctrine\EntityManagerBuilder;
Expand Down
26 changes: 13 additions & 13 deletions src/DocumentManagerBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ class DocumentManagerBuilder
* @throws \InvalidArgumentException
* @throws \RuntimeException
*
* @return \Doctrine\ODM\MongoDB\DocumentManager
* @return DocumentManager
*/
public static function build(array $options)
{
Expand All @@ -70,14 +70,14 @@ public static function build(array $options)
static::setupAnnotationMetadata($options);

$config = static::getConfiguration($options);
static::setupMetadataDriver($config, self::getMetadataDriver($options));
static::setupMetadataDriver($config, static::getMetadataDriver($options));
static::setupDefaultDatabase($config, $options);
static::setupProxy($config, $options);
static::setupHydrator($config, $options);
static::setupLogger($config, $options);

return DocumentManager::create(
self::getConnection($config, $options),
static::getConnection($config, $options),
$config,
$options['event_manager']
);
Expand All @@ -90,7 +90,7 @@ public static function build(array $options)
*
* @throws \InvalidArgumentException
*
* @return \Doctrine\ODM\MongoDB\Configuration
* @return Configuration
*/
protected static function getConfiguration(array $options)
{
Expand Down Expand Up @@ -138,8 +138,8 @@ protected static function getMetadataDriver(array $options)
/**
* Setup default database.
*
* @param \Doctrine\ODM\MongoDB\Configuration $config
* @param array $options
* @param Configuration $config
* @param array $options
*/
protected static function setupDefaultDatabase(Configuration $config, array $options)
{
Expand All @@ -151,8 +151,8 @@ protected static function setupDefaultDatabase(Configuration $config, array $opt
/**
* Setup hydrators.
*
* @param \Doctrine\ODM\MongoDB\Configuration $config
* @param array $options
* @param Configuration $config
* @param array $options
*/
protected static function setupHydrator(Configuration $config, array $options)
{
Expand All @@ -166,8 +166,8 @@ protected static function setupHydrator(Configuration $config, array $options)
/**
* Setup logger.
*
* @param \Doctrine\ODM\MongoDB\Configuration $config
* @param array $options
* @param Configuration $config
* @param array $options
*/
protected static function setupLogger(Configuration $config, array $options)
{
Expand All @@ -179,13 +179,13 @@ protected static function setupLogger(Configuration $config, array $options)
/**
* Create MongoDB Connection.
*
* @param \Doctrine\ODM\MongoDB\Configuration $config
* @param array $options
* @param Configuration $config
* @param array $options
*
* @throws \InvalidArgumentException
* @throws \RuntimeException
*
* @return \Doctrine\MongoDB\Connection
* @return Connection
*/
protected static function getConnection(Configuration $config, array $options)
{
Expand Down
26 changes: 13 additions & 13 deletions src/EntityManagerBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ class EntityManagerBuilder
* @throws \InvalidArgumentException
* @throws \RuntimeException
*
* @return \Doctrine\ORM\EntityManager
* @return EntityManager
*/
public static function build(array $options)
{
Expand All @@ -79,7 +79,7 @@ public static function build(array $options)
static::setupAnnotationMetadata($options);

$config = static::getConfiguration($options);
static::setupMetadataDriver($config, self::getMetadataDriver($options));
static::setupMetadataDriver($config, static::getMetadataDriver($options));
static::setupNamingStrategy($config, $options);
static::setupQuoteStrategy($config, $options);
static::setupProxy($config, $options);
Expand All @@ -105,7 +105,7 @@ public static function build(array $options)
*
* @throws \InvalidArgumentException
*
* @return \Doctrine\ORM\Configuration
* @return Configuration
*/
protected static function getConfiguration(array $options)
{
Expand Down Expand Up @@ -155,8 +155,8 @@ protected static function getMetadataDriver(array $options)
/**
* Setup naming strategy.
*
* @param \Doctrine\ORM\Configuration $config
* @param array $options
* @param Configuration $config
* @param array $options
*
* @throws \InvalidArgumentException
*/
Expand All @@ -173,8 +173,8 @@ protected static function setupNamingStrategy(Configuration $config, array $opti
/**
* Setup quote strategy.
*
* @param \Doctrine\ORM\Configuration $config
* @param array $options
* @param Configuration $config
* @param array $options
*
* @throws \InvalidArgumentException
*/
Expand All @@ -191,8 +191,8 @@ protected static function setupQuoteStrategy(Configuration $config, array $optio
/**
* Setup SQL logger.
*
* @param \Doctrine\ORM\Configuration $config
* @param array $options
* @param Configuration $config
* @param array $options
*/
protected static function setupSQLLogger(Configuration $config, array $options)
{
Expand All @@ -204,8 +204,8 @@ protected static function setupSQLLogger(Configuration $config, array $options)
/**
* Setup custom DQL functions.
*
* @param \Doctrine\ORM\Configuration $config
* @param array $options
* @param Configuration $config
* @param array $options
*/
protected static function setupCustomDQLFunctions(Configuration $config, array $options)
{
Expand All @@ -219,8 +219,8 @@ protected static function setupCustomDQLFunctions(Configuration $config, array $
/**
* Setup Custom DBAL types.
*
* @param \Doctrine\DBAL\Connection $connection
* @param array $options
* @param Connection $connection
* @param array $options
*
* @throws \Doctrine\DBAL\DBALException
* @throws \RuntimeException
Expand Down
8 changes: 4 additions & 4 deletions src/ObjectManagerTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@
trait ObjectManagerTrait
{
/**
* @param \Doctrine\Common\Cache\CacheProvider|null $cacheDriver
* @param string $cacheNamespace
* @param CacheProvider|null $cacheDriver
* @param string $cacheNamespace
*
* @throws \InvalidArgumentException
*
* @return \Doctrine\Common\Cache\CacheProvider
* @return CacheProvider
*/
protected static function getCacheDriver($cacheDriver, $cacheNamespace)
{
Expand Down Expand Up @@ -95,7 +95,7 @@ protected static function setupAnnotationMetadata(array $options)
* Setup metadata driver.
*
* @param \Doctrine\ORM\Configuration|\Doctrine\ODM\MongoDB\Configuration $config
* @param \Doctrine\Common\Persistence\Mapping\Driver\MappingDriver $driver
* @param MappingDriver $driver
*
* @throws \RuntimeException
*/
Expand Down

0 comments on commit 1c74fa1

Please sign in to comment.