Actualize rule example in docs, rename $ruleContext to $context

CHANGELOG.md

@@ -59,6 +59,7 @@
 - Enh #252: Return `$this` instead of throwing "already assigned" exception in `Manager::assign()` (@arogachev)
 - Enh #248: Add `SimpleRuleFactory` (@arogachev)
 - Enh #251: Allow checking for user's roles in `ManagerInterface::userHasPermission()` (@arogachev)
+- Chg #259: Rename `$ruleContext` argument to `$context` in `RuleInterface::execute()` (@arogachev) 
 
 ## 1.0.2 April 20, 2023
 

README.md

@@ -147,13 +147,15 @@ Sometimes, basic permissions are not enough. In this case, rules are helpful. Ru
 added to permissions and roles:
 
 ```php
+use Yiisoft\Rbac\Item;
+use Yiisoft\Rbac\RuleContext;
 use Yiisoft\Rbac\RuleInterface;
 
 class ActionRule implements RuleInterface
 {
-    public function execute(string $userId, Item $item, array $parameters = []): bool
+    public function execute(?string $userId, Item $item, RuleContext $context): bool;
     {
-        return isset($parameters['action']) && $parameters['action'] === 'home';
+        return $context->getParameterValue('action') === 'home';
     }
 }
 ```
@@ -164,7 +166,7 @@ The parameters are:
 
 - `$userId` is user id to check permission against;
 - `$item` is RBAC hierarchy item that rule is attached to;
-- `$parameters` is extra data supplied when checking for permission.
+- `$context` is a rule context providing access to parameters.
 
 To use rules with `Manager`, specify their names with added permissions or roles:
 

src/CompositeRule.php

@@ -43,14 +43,14 @@ public function __construct(
         }
     }
 
-    public function execute(?string $userId, Item $item, RuleContext $ruleContext): bool
+    public function execute(?string $userId, Item $item, RuleContext $context): bool
     {
         if (empty($this->ruleNames)) {
             return true;
         }
 
         foreach ($this->ruleNames as $ruleName) {
-            $result = $ruleContext->createRule($ruleName)->execute($userId, $item, $ruleContext);
+            $result = $context->createRule($ruleName)->execute($userId, $item, $context);
 
             if ($this->operator === self::AND && $result === false) {
                 return false;

src/RuleInterface.php

@@ -15,9 +15,9 @@ interface RuleInterface
      * @param string|null $userId The user ID. This should be a string representing the unique identifier of a user. For
      * guests the value is `null`.
      * @param Item $item The role or permission that this rule is associated with.
-     * @param RuleContext $ruleContext Rule context.
+     * @param RuleContext $context Rule context.
      *
      * @return bool Whether the rule permits the auth item, it is associated with.
      */
-    public function execute(?string $userId, Item $item, RuleContext $ruleContext): bool;
+    public function execute(?string $userId, Item $item, RuleContext $context): bool;
 }

tests/Support/AdsRule.php

@@ -10,8 +10,8 @@
 
 final class AdsRule implements RuleInterface
 {
-    public function execute(?string $userId, Item $item, RuleContext $ruleContext): bool
+    public function execute(?string $userId, Item $item, RuleContext $context): bool
     {
-        return $ruleContext->getParameterValue('dayPeriod') !== 'night';
+        return $context->getParameterValue('dayPeriod') !== 'night';
     }
 }

tests/Support/AuthorRule.php

@@ -13,8 +13,8 @@
  */
 final class AuthorRule implements RuleInterface
 {
-    public function execute(?string $userId, Item $item, RuleContext $ruleContext): bool
+    public function execute(?string $userId, Item $item, RuleContext $context): bool
     {
-        return (string) $ruleContext->getParameterValue('authorId') === $userId;
+        return (string) $context->getParameterValue('authorId') === $userId;
     }
 }

tests/Support/BanRule.php

@@ -10,8 +10,8 @@
 
 final class BanRule implements RuleInterface
 {
-    public function execute(?string $userId, Item $item, RuleContext $ruleContext): bool
+    public function execute(?string $userId, Item $item, RuleContext $context): bool
     {
-        return $ruleContext->getParameterValue('viewed') !== true;
+        return $context->getParameterValue('viewed') !== true;
     }
 }

tests/Support/FalseRule.php

@@ -10,7 +10,7 @@
 
 final class FalseRule implements RuleInterface
 {
-    public function execute(?string $userId, Item $item, RuleContext $ruleContext): bool
+    public function execute(?string $userId, Item $item, RuleContext $context): bool
     {
         return false;
     }

tests/Support/GuestRule.php

@@ -10,8 +10,8 @@
 
 final class GuestRule implements RuleInterface
 {
-    public function execute(?string $userId, Item $item, RuleContext $ruleContext): bool
+    public function execute(?string $userId, Item $item, RuleContext $context): bool
     {
-        return $ruleContext->getParameterValue('noGuestsModeOn') !== true;
+        return $context->getParameterValue('noGuestsModeOn') !== true;
     }
 }

tests/Support/SubscriptionRule.php

@@ -15,9 +15,9 @@ final class SubscriptionRule implements RuleInterface
         '4' => false,
     ];
 
-    public function execute(?string $userId, Item $item, RuleContext $ruleContext): bool
+    public function execute(?string $userId, Item $item, RuleContext $context): bool
     {
-        if ($userId === null || $ruleContext->getParameterValue('voidSubscription') === true) {
+        if ($userId === null || $context->getParameterValue('voidSubscription') === true) {
             return false;
         }
 

tests/Support/TrueRule.php

@@ -10,7 +10,7 @@
 
 final class TrueRule implements RuleInterface
 {
-    public function execute(?string $userId, Item $item, RuleContext $ruleContext): bool
+    public function execute(?string $userId, Item $item, RuleContext $context): bool
     {
         return true;
     }

tests/Support/WannabeRule.php

@@ -9,7 +9,7 @@
 
 final class WannabeRule
 {
-    public function execute(?string $userId, Item $item, RuleContext $ruleContext): bool
+    public function execute(?string $userId, Item $item, RuleContext $context): bool
     {
         return true;
     }