Merge pull request #145 from php-http/clarify-error-plugin

sagikazarmark · web-flow · commit 953d3381a528 · 2016-09-06T14:45:42.000+02:00
clarify use case of error plugin
diff --git a/plugins/error.rst b/plugins/error.rst
@@ -30,3 +30,9 @@ and the response coming from them::
             // Something has not been found
         }
     }
+
+The error plugin is intended for when an application operates with the client directly. When
+writing a library around an API, the best practice is to have the client convert responses into
+domain objects, and transform HTTP errors into meaningful domain exceptions. In that scenario,
+the ErrorPlugin is not needed. It is more efficient to check the HTTP status codes yourself than
+throwing and catching exceptions.

Original file line number	Diff line number	Diff line change
`@@ -30,3 +30,9 @@ and the response coming from them::`
`30`	`30`	`// Something has not been found`
`31`	`31`	`}`
`32`	`32`	`}`
	`33`	`+`
	`34`	`+The error plugin is intended for when an application operates with the client directly. When`
	`35`	`+writing a library around an API, the best practice is to have the client convert responses into`
	`36`	`+domain objects, and transform HTTP errors into meaningful domain exceptions. In that scenario,`
	`37`	`+the ErrorPlugin is not needed. It is more efficient to check the HTTP status codes yourself than`
	`38`	`+throwing and catching exceptions.`