Skip to content

Commit

Permalink
Add @internal phpdoc to batch iterator functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
loevgaard committed Jan 26, 2024
1 parent 7ed9be4 commit 8f0c38f
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/BatchIterator/BatchIterator.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
use Setono\SyliusCalloutPlugin\Event\BatchIteratorEvent;

/**
* @internal The batch iterator functionality is internal because we want to extract it to an external library and bundle
*
* @template T
*
* @implements BatchIteratorInterface<T>
Expand Down
3 changes: 3 additions & 0 deletions src/BatchIterator/BatchIteratorFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
use Psr\EventDispatcher\EventDispatcherInterface;
use Setono\DoctrineObjectManagerTrait\ORM\ORMManagerTrait;

/**
* @internal The batch iterator functionality is internal because we want to extract it to an external library and bundle
*/
final class BatchIteratorFactory implements BatchIteratorFactoryInterface
{
use ORMManagerTrait;
Expand Down
3 changes: 3 additions & 0 deletions src/BatchIterator/BatchIteratorFactoryInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

namespace Setono\SyliusCalloutPlugin\BatchIterator;

/**
* @internal The batch iterator functionality is internal because we want to extract it to an external library and bundle
*/
interface BatchIteratorFactoryInterface
{
/**
Expand Down
2 changes: 2 additions & 0 deletions src/BatchIterator/BatchIteratorInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
use Doctrine\ORM\QueryBuilder;

/**
* @internal The batch iterator functionality is internal because we want to extract it to an external library and bundle
*
* @template T
*
* @extends \IteratorAggregate<array-key, T>
Expand Down
3 changes: 3 additions & 0 deletions src/Event/BatchIteratorEvent.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@

use Doctrine\ORM\QueryBuilder;

/**
* @internal The batch iterator functionality is internal because we want to extract it to an external library and bundle
*/
final class BatchIteratorEvent
{
/**
Expand Down

0 comments on commit 8f0c38f

Please sign in to comment.