Skip to content

Commit

Permalink
feat(v2): fixing some names
Browse files Browse the repository at this point in the history
  • Loading branch information
razshare committed Jan 11, 2024
1 parent 288d46a commit 6bd1fee
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Install `^php8.2` and the following extenstions:

Clone the repository with
```sh
git clone [email protected]:tncrazvan/catpaw-core.git
git clone [email protected]:tncrazvan/catpaw.git
```

Install dependencies with
Expand All @@ -30,7 +30,7 @@ This will also download [build.phar](https://github.com/tncrazvan/catpaw-build/r
- All source code should follow the `PSR-12` rules and remove all unused
imports before being committed, this can be done by running `composer fix`.
- Whenever possible, convert all methods into functions or at least
all classes into [services](https://github.com/tncrazvan/catpaw-core/blob/master/docs/13.Services.md).
all classes into [services](https://github.com/tncrazvan/catpaw/blob/master/docs/13.Services.md).
- Avoid exposing `__construct` to the end user.
- Avoid returning `\Generator` to the end user.
- Avoid returning `null` to the end user, return `false` or a proper default value instead.
Expand Down
2 changes: 1 addition & 1 deletion docs/13.services.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A class annotated with the `\CatPaw\Core\Attributes\Service` attribute is a [sin
Services themselves are injectable dependencies.


Services are the building blocks of `catpaw-core`, whenever possible, classes should be converted into services, requiring their dependencies through the `__construct` method or [entry method](https://github.com/tncrazvan/catpaw-core/blob/main/docs/5.entry.md).
Services are the building blocks of `catpaw`, whenever possible, classes should be converted into services, requiring their dependencies through the `__construct` method or [entry method](https://github.com/tncrazvan/catpaw/blob/main/docs/5.entry.md).


The following are 2 bare services and a 3rd one requiring them.
Expand Down
4 changes: 2 additions & 2 deletions src/lib/Core/Interfaces/OnFunctionMount.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
interface OnFunctionMount {
/**
* Invoked when this attribute is detected on a function.
* @see https://github.com/tncrazvan/catpaw-core/blob/main/docs/1.RouteHandlers.md
* @see https://github.com/tncrazvan/catpaw-core/blob/main/docs/9.Filters.md
* @see https://github.com/tncrazvan/catpaw/blob/main/docs/1.RouteHandlers.md
* @see https://github.com/tncrazvan/catpaw/blob/main/docs/9.Filters.md
* @param ReflectionFunction $reflection reflection of the function.
* @param Closure $value function to which this attribute is attached to.
* @param DependenciesOptions $options options used to find dependencies.
Expand Down
4 changes: 2 additions & 2 deletions src/lib/Web/Interfaces/OnRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
interface OnRequest extends AttributeInterface {
/**
* Invoked before a route is executed.
* @see https://github.com/tncrazvan/catpaw-core/blob/main/docs/1.RouteHandlers.md
* @see https://github.com/tncrazvan/catpaw-core/blob/main/docs/9.Filters.md
* @see https://github.com/tncrazvan/catpaw/blob/main/docs/1.RouteHandlers.md
* @see https://github.com/tncrazvan/catpaw/blob/main/docs/9.Filters.md
* @param Request $request this is the incoming request.
* @return Unsafe<void>
*/
Expand Down
4 changes: 2 additions & 2 deletions src/lib/Web/Interfaces/OnResult.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
interface OnResult extends AttributeInterface {
/**
* Invoked after a route is executed.
* @see https://github.com/tncrazvan/catpaw-core/blob/main/docs/1.RouteHandlers.md
* @see https://github.com/tncrazvan/catpaw-core/blob/main/docs/9.Filters.md
* @see https://github.com/tncrazvan/catpaw/blob/main/docs/1.RouteHandlers.md
* @see https://github.com/tncrazvan/catpaw/blob/main/docs/9.Filters.md
* @param Request $request this is the incoming request.
* @param mixed $result this is the result of the route.
*
Expand Down

0 comments on commit 6bd1fee

Please sign in to comment.