[BE] to be defined

[mstaack]

to be defined

• Test Annotation
  • Using data providers needs the notation at the bottom

/** @test */
public function it_does_sth()

// VS

/**
 * @test
 */
public function it_does_sth()

• action naming
  • AttachModelToRelationAction vs AttachModelToRelationAction
  • class naming says SHOULD suffix - but actions are very special classes as they are more like functions.
• pivot accessor
  • pivot vs attribute_category
  • MUST use pivot table name as accessor
• PSR-12 - single use statements
• abort() & throw() helper

[Gummibeer]

2020-02-05 - #11 & #12

• Import FQN Standard Definition - use statt FQCN im code
  • \Closure vs use Closure
  • notice: fully qualified namespace in code sometimes have a usage to prevent the aliasing rabbithole (hello Client::class)

MUST all classes referenced in code will be imported use and classes with common name conflicts will get aliased use Guzzle\Client as GuzzleClient

• Native PHP over Laravel helpers
  • https://twitter.com/marcelpociot/status/1215183351788818433
  • notes: there are several helpers that are easily readable and save code. First differentiation I could imagine is the return/throw keyword replacement.

SHOULD use the explicit keywords if, throw, return over Laravel short helpers.

• Dynamic "const" methods - UPPER_SNAKE_CASE
  • Image::PATH_PATTERN() vs Image::getPathPattern() - the pattern is generated by config values (function calls) but is something like a constant.

MUST use normal method naming also for macro/const like methods.

• make it clearer when to use string interpolation, sprintf() and concationation.
  • https://bitbucket.org/elbgoods/eventgear_equipment_api/pull-requests/15/fix-image-logo-urls-and-all-wrong/diff#Lapp/AvatarImage.phpT21

every solution has a right for existence/usage - this rule will be removed and all three ways are allowed.

• Explicity over magic
  • protected $with => with() & load()
  • protected $appends => resource

MUST use explicit calls in query builder and resources to generate arrays

• composer thanks
  • https://github.com/symfony/thanks

SHOULD be used from time to time

• inverted instance of checking
  • ! $object instanceof MyClass => ! is_a()

SHOULD use ! is_a() for inverted instance checking and can use both for normal instance checking

• test case method naming (@eisfeuer ?)
  • index_returns_an_ok_response

SHOULD use [entity:it]_can_[do_something]{_when_[some_condition]} naming pattern

• route name prefixes
• https://laravel.com/docs/5.8/routing#route-group-name-prefixes

SHOULD use name() on groups that have a prefix() call

• compact() vs explicit array definition
  • route('api.admin.attribute_groups.destroy', ['attributeGroup' => $attributeGroup]);
  • route('api.admin.attribute_groups.destroy', compact('attributeGroup'));

MUST use explicit array definition in business logic app/
SHOULD use compact() in phpunit test route() generation

• custom validation exception of route parameter - validation array key naming
  • https://bitbucket.org/elbgoods/eventgear/pull-requests/34/feature-eg-165-delete-attribute-groups/diff#Lequipment_api/app/Http/Controllers/Api/Admin/AttributeGroupController.phpT35
  • attributeGroup.attributes vs attribute_group.attributes

MUST respect Array Keys rule - lower_snake_case.dot.notation

• enum naming - lowerCamel, lower_snake, UPPER_SNAKE, UpperCamel ...

MUST use UPPER_SNAKE_CASE for enum naming

• DB standard

MUST use postgresql for SQL based databases also for prototypes