src/Services/Config/ModuleTools.php line 18

Open in your IDE?
  1. <?php
  2. //----------------------------------------------------------------------
  3. // src/Services/Config/ModuleTools.php
  4. //----------------------------------------------------------------------
  5. namespace App\Services\Config;
  7. use Doctrine\Persistence\ManagerRegistry;
  9. use App\Entity\Access;
  10. use App\Entity\SocietyGroup;
  11. use App\Entity\Config\Config;
  12. use App\Entity\Config\Module;
  13. use App\Entity\Config\ModuleConfig;
  14. use App\Services\LogTools;
  16. class ModuleTools
  17. {
  18.     public function __construct(ManagerRegistry $doctrine, LogTools $logTools)
  19.     {
  20.         $this->em = $doctrine->getManager();
  21.         $this->logTools = $logTools;
  22.     }
  24.     // Plan.io Task #3309
  25.     // Returns TRUE if the Guard is restricted according to active modules
  26.     // Returns FALSE otherwise
  27.     public function restrictGuardian(SocietyGroup $societyGroup, $modules)
  28.     {
  29.         // Test FREE_GUARD config
  30.         if ($this->applyGuardRestrictions())
  31.         {
  32.             // Test Module
  33.             if ($this->areInactiveByCode($societyGroup, $modules))
  34.             {
  35.                 // All Modules are inactive
  36.                 return true;
  37.             }
  38.         }
  39.         return false;
  40.     }
  42.     // Plan.io Task #3309
  43.     // Config :: $const FREE_GUARD
  44.     // FREE_GUARD = 1
  45.     //     - No restrictions are applied when creating a society group, or when executing the guard
  46.     //     - Default value in `matrix_global.yml`
  47.     // FREE_GUARD = 0
  48.     //     - Module related restrictions are applied when creating a society group, and when executing the guard
  49.     public function applyGuardRestrictions()
  50.     {
  51.         $config = $this->em->getRepository(Config::class)->findOneByName(Config::FREE_GUARD);
  52.         if ($config === null)
  53.         {
  54.             return false;
  55.         }
  57.         if ($config->getValue())
  58.         {
  59.             return false;
  60.         }
  62.         return true;
  63.     }
  65.     // Returns TRUE if all the Codes are INACTIVE
  66.     // Returns FALSE if at least one Code is ACTIVE
  67.     // We want to test if all the codes are inactive
  68.     // code1.inactive && code2.inactive && code3.inactive
  69.     // Therefore a single active code breaks the chain
  70.     public function areInactiveByCode(SocietyGroup $societyGroup, $codes)
  71.     {
  72.         $allInactive = true;
  73.         foreach ($codes as $code)
  74.         {
  75.             if ($this->isActiveByCode($societyGroup, $code))
  76.             {
  77.                 $allInactive = false;
  78.                 break;
  79.             }
  80.         }
  81.         return $allInactive;
  82.     }
  84.     public function isActiveByCode(SocietyGroup $societyGroup, $code)
  85.     {
  86.         $module = $this->em->getRepository(Module::class)->findOneByCode($code);
  87.         if ($module === null)
  88.         {
  89.             return false;
  90.         }
  92.         return $this->isActive($societyGroup, $module);
  93.     }
  95.     public function isInactiveByCode(SocietyGroup $societyGroup, $code)
  96.     {
  97.         return !$this->isActiveByCode($societyGroup, $code);
  98.     }
  100.     public function isActive(SocietyGroup $societyGroup, Module $module)
  101.     {
  102.         // Fetch them from the SocietyGroup instead of the database
  103.         // This way we can test the module even if the SocietyGroup
  104.         // has not been persisted to the database yet
  105.         return $societyGroup->hasModule($module);
  106.     }
  108.     public function getConfig(SocietyGroup $societyGroup, Module $module)
  109.     {
  110.         $config = $this->em->getRepository(ModuleConfig::class)
  111.             ->findOneBy(array(
  112.                 'societyGroup'        =>    $societyGroup,
  113.                 'module'            =>    $module,
  114.             ));
  115.         if ($config !== null)
  116.         {
  117.             return $config;
  118.         }
  119.         return null;
  120.     }
  122.     public function isActiveTrustpilot(SocietyGroup $societyGroup)
  123.     {
  124.         return $this->isActiveByCode($societyGroup, Module::MODULE_TRUSTPILOT);
  125.     }
  127.     public function isActiveClientAccount(SocietyGroup $societyGroup)
  128.     {
  129.         return $this->isActiveByCode($societyGroup, Module::MODULE_CLIENT_ACCOUNT);
  130.     }
  132.     public function isActiveRHForm(SocietyGroup $societyGroup)
  133.     {
  134.         return $this->isActiveByCode($societyGroup, Module::MODULE_RHFORM);
  135.     }
  137.     public function isActiveInvoice(SocietyGroup $societyGroup)
  138.     {
  139.         return $this->isActiveByCode($societyGroup, Module::MODULE_INVOICE);
  140.     }
  142.     public function isActiveEInvoicing(SocietyGroup $societyGroup)
  143.     {
  144.         return $this->isActiveByCode($societyGroup, Module::MODULE_EINVOICING);
  145.     }
  147.     public function isActiveIkeaServiceOrder(SocietyGroup $societyGroup)
  148.     {
  149.         return $this->isActiveByCode($societyGroup, Module::MODULE_IKEA_SERVICE_ORDER);
  150.     }
  151.     public function isActiveIkeaKitchenPlanner(SocietyGroup $societyGroup)
  152.     {
  153.         return $this->isActiveByCode($societyGroup, Module::MODULE_IKEA_KITCHEN_PLANNER);
  154.     }
  156.     public function isActiveDevis(SocietyGroup $societyGroup)
  157.     {
  158.         return $this->isActiveByCode($societyGroup, Module::MODULE_DEVIS);
  159.     }
  160.     public function isActiveDocument(SocietyGroup $societyGroup)
  161.     {
  162.         return $this->isActiveByCode($societyGroup, Module::MODULE_DOCUMENT);
  163.     }
  164.     public function isActiveProspect(SocietyGroup $societyGroup)
  165.     {
  166.         return $this->isActiveByCode($societyGroup, Module::MODULE_PROSPECT);
  167.     }
  168.     public function isActivePunchOut(SocietyGroup $societyGroup)
  169.     {
  170.         return $this->isActiveByCode($societyGroup, Module::MODULE_PUNCHOUT);
  171.     }
  172.     public function isActiveDemand(SocietyGroup $societyGroup)
  173.     {
  174.         return $this->isActiveByCode($societyGroup, Module::MODULE_DEMAND);
  175.     }
  177.     public function isActiveApplication(SocietyGroup $societyGroup)
  178.     {
  179.         $codes = array(
  180.             Module::MODULE_APPLICATION,
  181.         );
  183.         // One single positve answer is enough
  184.         foreach ($codes as $code)
  185.         {
  186.             if ($this->isActiveByCode($societyGroup, $code))
  187.             {
  188.                 return true;
  189.             }
  190.         }
  192.         // If we are here all hope is lost
  193.         return false;
  194.     }
  196.     public function isActiveMission(SocietyGroup $societyGroup)
  197.     {
  198.         $codes = array(
  199.             Module::MODULE_MISSION,
  200.             Module::MODULE_MISSION_LIGHT,
  201.             Module::MODULE_MISSION_PLUS,
  202.         );
  204.         // One single positve answer is enough
  205.         foreach ($codes as $code)
  206.         {
  207.             if ($this->isActiveByCode($societyGroup, $code))
  208.             {
  209.                 return true;
  210.             }
  211.         }
  213.         // If we are here all hope is lost
  214.         return false;
  215.     }
  217.     public function isActiveClientOrMission(SocietyGroup $societyGroup)
  218.     {
  219.         $codes = array(
  220.             Module::MODULE_CLIENT,
  221.             Module::MODULE_CLIENT_LIGHT,
  222.             Module::MODULE_MISSION,
  223.             Module::MODULE_MISSION_LIGHT,
  224.             Module::MODULE_MISSION_PLUS,
  225.         );
  227.         // One single positve answer is enough
  228.         foreach ($codes as $code)
  229.         {
  230.             if ($this->isActiveByCode($societyGroup, $code))
  231.             {
  232.                 return true;
  233.             }
  234.         }
  236.         // If we are here all hope is lost
  237.         return false;
  238.     }
  240.     public function isActiveMissionAndDevis(SocietyGroup $societyGroup)
  241.     {
  242.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_DEVIS))
  243.         {
  244.             // No need to go any further
  245.             return false;
  246.         }
  248.         // If we are here we know that the Devis module is active
  249.         // Only one mission option is required
  250.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION))
  251.         {
  252.             return true;
  253.         }
  254.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_LIGHT))
  255.         {
  256.             return true;
  257.         }
  258.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_PLUS))
  259.         {
  260.             return true;
  261.         }
  263.         // If we are here all hope is lost
  264.         return false;
  265.     }
  267.     public function isActiveMissionAndInvoice(SocietyGroup $societyGroup)
  268.     {
  269.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_INVOICE))
  270.         {
  271.             // No need to go any further
  272.             return false;
  273.         }
  275.         // If we are here we know that the Invoice module is active
  276.         // Only one mission option is required
  277.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION))
  278.         {
  279.             return true;
  280.         }
  281.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_LIGHT))
  282.         {
  283.             return true;
  284.         }
  285.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_PLUS))
  286.         {
  287.             return true;
  288.         }
  290.         // If we are here all hope is lost
  291.         return false;
  292.     }
  294.     public function isActiveMissionAndPlanning(SocietyGroup $societyGroup)
  295.     {
  296.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_PLANNING))
  297.         {
  298.             // No need to go any further
  299.             return false;
  300.         }
  302.         // If we are here we know that the Planning module is active
  303.         // Only one mission option is required
  304.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION))
  305.         {
  306.             return true;
  307.         }
  308.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_LIGHT))
  309.         {
  310.             return true;
  311.         }
  312.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_PLUS))
  313.         {
  314.             return true;
  315.         }
  317.         // If we are here all hope is lost
  318.         return false;
  319.     }
  321.     public function isActiveMissionAndDocument(SocietyGroup $societyGroup)
  322.     {
  323.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_DOCUMENT))
  324.         {
  325.             // No need to go any further
  326.             return false;
  327.         }
  329.         // If we are here we know that the Document module is active
  330.         // Only one mission option is required
  331.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION))
  332.         {
  333.             return true;
  334.         }
  335.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_LIGHT))
  336.         {
  337.             return true;
  338.         }
  339.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_PLUS))
  340.         {
  341.             return true;
  342.         }
  344.         // If we are here all hope is lost
  345.         return false;
  346.     }
  348.     public function isActiveMissionAndInvoiceAndDocument(SocietyGroup $societyGroup)
  349.     {
  350.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_INVOICE))
  351.         {
  352.             // No need to go any further
  353.             return false;
  354.         }
  356.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_DOCUMENT))
  357.         {
  358.             // No need to go any further
  359.             return false;
  360.         }
  362.         // If we are here we know that the Invoice and Document modules are active
  363.         // Only one mission option is required
  364.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION))
  365.         {
  366.             return true;
  367.         }
  368.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_LIGHT))
  369.         {
  370.             return true;
  371.         }
  372.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_PLUS))
  373.         {
  374.             return true;
  375.         }
  377.         // If we are here all hope is lost
  378.         return false;
  379.     }
  381.     // Plan.io Task #3631
  382.     public function isActiveSingleSociety(SocietyGroup $societyGroup)
  383.     {
  384.         return !$this->isActiveMultipleSocieties($societyGroup);
  385.     }
  386.     // Plan.io Task #3631
  387.     public function isActiveMultipleSocieties(SocietyGroup $societyGroup)
  388.     {
  389.         // If the society group has more than one society,
  390.         // we mult display them all
  391.         // without taking the config into account
  393.         if ($societyGroup->getSocieties()->count() > 1)
  394.         {
  395.             return true;
  396.         }
  398.         // If a single society in the group, check to see if the society module is activated
  399.         $societyModuleActivated = false;
  400.         if ($this->isActiveByCode($societyGroup, Module::MODULE_SOCIETY))
  401.         {
  402.             $societyModuleActivated = true;
  403.         }
  405.         if ($societyModuleActivated === true)
  406.         {
  407.             // Display multiple societies
  408.             return true;
  409.         }
  410.         else
  411.         {
  412.             // Don't display the society notion
  413.             return false;
  414.         }
  415.         return false;
  416.     }
  417. }