-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
35 changed files
with
1,371 additions
and
549 deletions.
There are no files selected for viewing
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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| # Upgrading from 3.x to 4.0 | ||
|
|
||
| API client release 4.0 contains backward incompatible changes. | ||
|
|
||
| This guide will help you upgrade your codebase. | ||
|
|
||
| ## Sorting renamed to ItemSorting | ||
| Class `Sorting` was renamed to `ItemSorting`. All its methods and behavior remained the same. | ||
|
|
||
| #### Before | ||
| ```php | ||
| $response = $matej->request() | ||
| ->sorting(Sorting::create('user-id', ['item-id-1', 'item-id-2', 'item-id-3'])) | ||
| ->send(); | ||
| ``` | ||
|
|
||
| #### After | ||
| ```php | ||
| $response = $matej->request() | ||
| ->sorting(ItemSorting::create('user-id', ['item-id-1', 'item-id-2', 'item-id-3'])) | ||
| ->send(); | ||
| ``` | ||
|
|
||
|
|
||
| ## New types of recommendations | ||
| API client now supports new types of recommendation commands: | ||
| - Recommend items to user (`UserItemRecommendation`, originally `UserRecommendation`) | ||
| - Recommend users to user (`UserUserRecommendation`) | ||
| - Recommend items to item (`ItemItemRecommendation`) | ||
| - Recommend users to item (`ItemUserRecommendation`) | ||
|
|
||
| Each recommendation type supports different parameter options. | ||
| Available parameters are documented in [readme](README.md#available-recommendation-attributes). | ||
|
|
||
| ## Recommending items to users | ||
| Class `UserRecommendation` was renamed to `UserItemRecommendation`. Class `MinimalRelevance` was | ||
| renamed to `ItemMinimalRelevance`. All other methods and attributes remained unchanged. | ||
|
|
||
| #### Before | ||
| ```php | ||
| $recommendation = UserRecommendation::create('user-id', 'scenario') | ||
| ->setMinimalRelevance(MinimalRelevance::LOW()) | ||
| ->setCount(5) | ||
| ->setRotationRate(1.0) | ||
| ->setRotationTime(3600); | ||
| ``` | ||
|
|
||
| #### After | ||
| ```php | ||
| $recommendation = UserItemRecommendation::create('user-id', 'scenario') | ||
| ->setMinimalRelevance(ItemMinimalRelevance::LOW()) | ||
| ->setCount(5) | ||
| ->setRotationRate(1.0) | ||
| ->setRotationTime(3600); | ||
| ``` | ||
|
|
||
| ## New recommendation types | ||
| New types of recommendations can be created in a similar way to `UserItemRecommendation`. For example: | ||
|
|
||
| ### Users that might be interested in an item | ||
| ```php | ||
| $recommendation = ItemUserRecommendation::create('item-id', 'scenario') | ||
| ->setCount(5) | ||
| ->setAllowSeen(false); | ||
| ``` | ||
|
|
||
| ### Users that are similar to a user | ||
| ```php | ||
| $recommendation = UserUserRecommendation::create('user-id', 'scenario') | ||
| ->setCount(5) | ||
| ->setRotationRate(1.0) | ||
| ->setRotationTime(3600); | ||
| ``` | ||
|
|
||
| ### Items that are similar to an item | ||
| ```php | ||
| $recommendation = ItemItemRecommendation::create('item-id', 'scenario') | ||
| ->setCount(5); | ||
| ``` |
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| namespace Lmc\Matej\Model\Command; | ||
|
|
||
| use Lmc\Matej\Model\Assertion; | ||
|
|
||
| /** | ||
| * Deliver recommendations for given item. | ||
| */ | ||
| abstract class AbstractItemRecommendation extends AbstractRecommendation | ||
| { | ||
| /** @var string */ | ||
| private $itemId; | ||
|
|
||
| protected function __construct(string $itemId, string $scenario) | ||
| { | ||
| parent::__construct($scenario); | ||
| $this->setItemId($itemId); | ||
| } | ||
|
|
||
| protected function setItemId(string $itemId): void | ||
| { | ||
| Assertion::typeIdentifier($itemId); | ||
|
|
||
| $this->itemId = $itemId; | ||
| } | ||
|
|
||
| protected function getCommandParameters(): array | ||
| { | ||
| $parameters = parent::getCommandParameters(); | ||
|
|
||
| $parameters['item_id'] = $this->itemId; | ||
|
|
||
| return $parameters; | ||
| } | ||
| } |
Oops, something went wrong.