Skip to content

Commit 9076ee0

Browse files
committed
Updated phpdoc
1 parent 255b94a commit 9076ee0

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

Item/ItemProcessorInterface.php

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ interface ItemProcessorInterface
1616
{
1717
/**
1818
* Process the provided item, returning a potentially modified or new item for continued
19-
* processing. If the returned result is null, it is assumed that processing of the item
20-
* should not continue.
19+
* processing. It should not return null, instead it should throw an InvalidItemException
20+
* in case of warning;
2121
*
2222
* @param mixed $item item to be processed
2323
*
24-
* @return mixed Potentially modified or new item for continued processing, null if processing of the
25-
* provided item should not continue.
24+
* @return mixed Potentially modified or new item for continued processing
25+
* @throws InvalidItemException if there is a problem processing the current record
26+
* (but the next one may still be valid)
2627
* @throws \Exception
2728
*/
2829
public function process($item);

Item/ItemReaderInterface.php

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,12 @@ interface ItemReaderInterface
2121
* <strong>must</strong> return <code>null</code> at the end of the input
2222
* data set.
2323
*
24-
* @throws ParseException if there is a problem parsing the current record
24+
* @throws InvalidItemException if there is a problem reading the current record
2525
* (but the next one may still be valid)
26-
* @throws NonTransientResourceException if there is a fatal exception in
27-
* the underlying resource. After throwing this exception implementations
28-
* should endeavour to return null from subsequent calls to read.
29-
* @throws UnexpectedInputException if there is an uncategorised problem
30-
* with the input data. Assume potentially transient, so subsequent calls to
31-
* read might succeed.
32-
* @throws \Exception if an there is a non-specific error.
33-
* @return null|mixed Returns false in case of reading error
26+
* @throws \Exception if an there is a non-specific error. (step execution will
27+
* be stopped in that case)
28+
*
29+
* @return null|mixed
3430
*/
3531
public function read();
3632
}

Item/ItemWriterInterface.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ interface ItemWriterInterface
2828
*
2929
* FIXME: array is not maybe the best structure to hold the items. Investigate this point.
3030
*
31+
* @throw InvalidItemException if there is a warning, step execution will continue to the
32+
* next item.
3133
* @throws \Exception if there are errors. The framework will catch the
3234
* exception and convert or rethrow it as appropriate.
3335
*/

0 commit comments

Comments
 (0)