api/src/Gamification/Interfaces/GamificationRuleInterface.php
<?php
/**
* Copyright (c) 2021, MOBICOOP. All rights reserved.
* This project is dual licensed under AGPL and proprietary licence.
***************************
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <gnu.org/licenses>.
***************************
* Licence MOBICOOP described in the file
* LICENSE
**************************/
namespace App\Gamification\Interfaces;
use App\Action\Entity\Log;
use App\Gamification\Entity\SequenceItem;
/**
* Gamification Rule interface.
*
* @author Maxime Bardot <maxime.bardot@mobicoop.org>
*
*/
interface GamificationRuleInterface
{
/**
* Code to execute to validate the rule.
*
* @param User|App $requester The requester
* @param Log $log associated to the rule
* @return bool True if the rule is validated, false either
*/
public function execute(Log $log, SequenceItem $sequenceItem);
}