Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Check interface class #6

Closed
Tracked by #3
mehulkaklotar opened this issue Nov 21, 2022 · 0 comments · Fixed by #49
Closed
Tracked by #3

Create Check interface class #6

mehulkaklotar opened this issue Nov 21, 2022 · 0 comments · Fixed by #49
Labels
Infrastructure Issues for the overall plugin infrastructure [Type] Enhancement A suggestion for improvement of an existing feature
Milestone

Comments

@mehulkaklotar
Copy link
Member

mehulkaklotar commented Nov 21, 2022

The Check interface will be implemented by all concrete check classes. Using an interface helps to define required methods for checks and enforce those on concrete check classes. This ensures that these methods are available to use by other structures in the plugin reliably. Currently, the interface will likely define a single run method but this may be expanded on in the future.

Acceptance Criteria

  • A new Check interface class is created
  • The Check interface contains a single public run() method
  • The run method accepts a single $result parameter
  • The $result parameter is an instance of the Check_Result class
  • Full method - public function run( Check_Result $result )
  • If the Check_Result class does not exist in the repo, create an empty Check_Result class as a scaffold to be implemented in Create Check_Result class #11
@mehulkaklotar mehulkaklotar added [Type] Enhancement A suggestion for improvement of an existing feature Infrastructure Issues for the overall plugin infrastructure labels Nov 23, 2022
@FlicHollis FlicHollis added this to the Sprint 1 milestone Dec 7, 2022
@jjgrainger jjgrainger self-assigned this Dec 7, 2022
@jjgrainger jjgrainger added 1 and removed 1 labels Dec 7, 2022
@jjgrainger jjgrainger removed their assignment Dec 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Infrastructure Issues for the overall plugin infrastructure [Type] Enhancement A suggestion for improvement of an existing feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants