Skip to content

Commit

Permalink
Updated phpdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
gquemener committed Oct 16, 2013
1 parent 8183eb8 commit fbfc531
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 13 deletions.
9 changes: 5 additions & 4 deletions Item/ItemProcessorInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,14 @@ interface ItemProcessorInterface
{
/**
* Process the provided item, returning a potentially modified or new item for continued
* processing. If the returned result is null, it is assumed that processing of the item
* should not continue.
* processing. It should not return null, instead it should throw an InvalidItemException
* in case of warning;
*
* @param mixed $item item to be processed
*
* @return mixed Potentially modified or new item for continued processing, null if processing of the
* provided item should not continue.
* @return mixed Potentially modified or new item for continued processing
* @throws InvalidItemException if there is a problem processing the current record
* (but the next one may still be valid)
* @throws \Exception
*/
public function process($item);
Expand Down
14 changes: 5 additions & 9 deletions Item/ItemReaderInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,12 @@ interface ItemReaderInterface
* <strong>must</strong> return <code>null</code> at the end of the input
* data set.
*
* @throws ParseException if there is a problem parsing the current record
* @throws InvalidItemException if there is a problem reading the current record
* (but the next one may still be valid)
* @throws NonTransientResourceException if there is a fatal exception in
* the underlying resource. After throwing this exception implementations
* should endeavour to return null from subsequent calls to read.
* @throws UnexpectedInputException if there is an uncategorised problem
* with the input data. Assume potentially transient, so subsequent calls to
* read might succeed.
* @throws \Exception if an there is a non-specific error.
* @return null|mixed Returns false in case of reading error
* @throws \Exception if an there is a non-specific error. (step execution will
* be stopped in that case)
*
* @return null|mixed
*/
public function read();
}
2 changes: 2 additions & 0 deletions Item/ItemWriterInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ interface ItemWriterInterface
*
* FIXME: array is not maybe the best structure to hold the items. Investigate this point.
*
* @throw InvalidItemException if there is a warning, step execution will continue to the
* next item.
* @throws \Exception if there are errors. The framework will catch the
* exception and convert or rethrow it as appropriate.
*/
Expand Down

0 comments on commit fbfc531

Please sign in to comment.