Provide a usefull error when ask*() is not used wihtin a task() #1083
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This small new function can obviously be used in more places but I thought this would be a good start. |
|
Cool. i think this is helpful. |
|
Please update changelog. |
|
done. |
antonmedv
requested changes
Mar 10, 2017
src/functions.php
Outdated
| * This method provides a usefull error to the end-user to make him/her aware | ||
| * to use a function in the required task-context. | ||
| */ | ||
| function requiresTaskContext($callerName) |
There was a problem hiding this comment.
I think better to create method in Context:
Context::required();There was a problem hiding this comment.
also thought about that option. will change it.
There was a problem hiding this comment.
now I know again why I decided against a method in Context ;-):
the message and logic here is rather task specific and Context class atm is rather generic.
/**
* Throws a Exception when not called within a task-context.
*
* This method provides a usefull error to the end-user to make him/her aware
* to use a function in the required task-context.
*
* @throws Exception
* @return Context
*/
public static function required($callerName)
{
$ctx = self::get();
if (!$ctx) {
throw new Exception("'$callerName' can only be used within a 'task()'-function!");
}
return $ctx;
}do you still think we should move it to Context, I am fine with any solution you will accept.
|
adjusted per feedback |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
before this change a newcomer to this project sees errors like
when using a
ask()function within global scope instead of atask().After this change the error turns into
based on a "discussion" in #371 (comment)