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 isActiveClientAccount(SocietyGroup $societyGroup)
  123.     {
  124.         return $this->isActiveByCode($societyGroup, Module::MODULE_CLIENT_ACCOUNT);
  125.     }
  127.     public function isActiveRHForm(SocietyGroup $societyGroup)
  128.     {
  129.         return $this->isActiveByCode($societyGroup, Module::MODULE_RHFORM);
  130.     }
  132.     public function isActiveInvoice(SocietyGroup $societyGroup)
  133.     {
  134.         return $this->isActiveByCode($societyGroup, Module::MODULE_INVOICE);
  135.     }
  137.     public function isActiveEInvoicing(SocietyGroup $societyGroup)
  138.     {
  139.         return $this->isActiveByCode($societyGroup, Module::MODULE_EINVOICING);
  140.     }
  142.     public function isActiveIkeaServiceOrder(SocietyGroup $societyGroup)
  143.     {
  144.         return $this->isActiveByCode($societyGroup, Module::MODULE_IKEA_SERVICE_ORDER);
  145.     }
  146.     public function isActiveIkeaKitchenPlanner(SocietyGroup $societyGroup)
  147.     {
  148.         return $this->isActiveByCode($societyGroup, Module::MODULE_IKEA_KITCHEN_PLANNER);
  149.     }
  151.     public function isActiveDevis(SocietyGroup $societyGroup)
  152.     {
  153.         return $this->isActiveByCode($societyGroup, Module::MODULE_DEVIS);
  154.     }
  155.     public function isActiveDocument(SocietyGroup $societyGroup)
  156.     {
  157.         return $this->isActiveByCode($societyGroup, Module::MODULE_DOCUMENT);
  158.     }
  159.     public function isActiveProspect(SocietyGroup $societyGroup)
  160.     {
  161.         return $this->isActiveByCode($societyGroup, Module::MODULE_PROSPECT);
  162.     }
  163.     public function isActivePunchOut(SocietyGroup $societyGroup)
  164.     {
  165.         return $this->isActiveByCode($societyGroup, Module::MODULE_PUNCHOUT);
  166.     }
  167.     public function isActiveDemand(SocietyGroup $societyGroup)
  168.     {
  169.         return $this->isActiveByCode($societyGroup, Module::MODULE_DEMAND);
  170.     }
  172.     public function isActiveApplication(SocietyGroup $societyGroup)
  173.     {
  174.         $codes = array(
  175.             Module::MODULE_APPLICATION,
  176.         );
  178.         // One single positve answer is enough
  179.         foreach ($codes as $code)
  180.         {
  181.             if ($this->isActiveByCode($societyGroup, $code))
  182.             {
  183.                 return true;
  184.             }
  185.         }
  187.         // If we are here all hope is lost
  188.         return false;
  189.     }
  191.     public function isActiveMission(SocietyGroup $societyGroup)
  192.     {
  193.         $codes = array(
  194.             Module::MODULE_MISSION,
  195.             Module::MODULE_MISSION_LIGHT,
  196.             Module::MODULE_MISSION_PLUS,
  197.         );
  199.         // One single positve answer is enough
  200.         foreach ($codes as $code)
  201.         {
  202.             if ($this->isActiveByCode($societyGroup, $code))
  203.             {
  204.                 return true;
  205.             }
  206.         }
  208.         // If we are here all hope is lost
  209.         return false;
  210.     }
  212.     public function isActiveClientOrMission(SocietyGroup $societyGroup)
  213.     {
  214.         $codes = array(
  215.             Module::MODULE_CLIENT,
  216.             Module::MODULE_CLIENT_LIGHT,
  217.             Module::MODULE_MISSION,
  218.             Module::MODULE_MISSION_LIGHT,
  219.             Module::MODULE_MISSION_PLUS,
  220.         );
  222.         // One single positve answer is enough
  223.         foreach ($codes as $code)
  224.         {
  225.             if ($this->isActiveByCode($societyGroup, $code))
  226.             {
  227.                 return true;
  228.             }
  229.         }
  231.         // If we are here all hope is lost
  232.         return false;
  233.     }
  235.     public function isActiveMissionAndDevis(SocietyGroup $societyGroup)
  236.     {
  237.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_DEVIS))
  238.         {
  239.             // No need to go any further
  240.             return false;
  241.         }
  243.         // If we are here we know that the Devis module is active
  244.         // Only one mission option is required
  245.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION))
  246.         {
  247.             return true;
  248.         }
  249.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_LIGHT))
  250.         {
  251.             return true;
  252.         }
  253.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_PLUS))
  254.         {
  255.             return true;
  256.         }
  258.         // If we are here all hope is lost
  259.         return false;
  260.     }
  262.     public function isActiveMissionAndInvoice(SocietyGroup $societyGroup)
  263.     {
  264.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_INVOICE))
  265.         {
  266.             // No need to go any further
  267.             return false;
  268.         }
  270.         // If we are here we know that the Invoice module is active
  271.         // Only one mission option is required
  272.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION))
  273.         {
  274.             return true;
  275.         }
  276.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_LIGHT))
  277.         {
  278.             return true;
  279.         }
  280.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_PLUS))
  281.         {
  282.             return true;
  283.         }
  285.         // If we are here all hope is lost
  286.         return false;
  287.     }
  289.     public function isActiveMissionAndPlanning(SocietyGroup $societyGroup)
  290.     {
  291.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_PLANNING))
  292.         {
  293.             // No need to go any further
  294.             return false;
  295.         }
  297.         // If we are here we know that the Planning module is active
  298.         // Only one mission option is required
  299.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION))
  300.         {
  301.             return true;
  302.         }
  303.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_LIGHT))
  304.         {
  305.             return true;
  306.         }
  307.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_PLUS))
  308.         {
  309.             return true;
  310.         }
  312.         // If we are here all hope is lost
  313.         return false;
  314.     }
  316.     public function isActiveMissionAndDocument(SocietyGroup $societyGroup)
  317.     {
  318.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_DOCUMENT))
  319.         {
  320.             // No need to go any further
  321.             return false;
  322.         }
  324.         // If we are here we know that the Document module is active
  325.         // Only one mission option is required
  326.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION))
  327.         {
  328.             return true;
  329.         }
  330.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_LIGHT))
  331.         {
  332.             return true;
  333.         }
  334.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_PLUS))
  335.         {
  336.             return true;
  337.         }
  339.         // If we are here all hope is lost
  340.         return false;
  341.     }
  343.     public function isActiveMissionAndInvoiceAndDocument(SocietyGroup $societyGroup)
  344.     {
  345.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_INVOICE))
  346.         {
  347.             // No need to go any further
  348.             return false;
  349.         }
  351.         if ($this->isInactiveByCode($societyGroup, Module::MODULE_DOCUMENT))
  352.         {
  353.             // No need to go any further
  354.             return false;
  355.         }
  357.         // If we are here we know that the Invoice and Document modules are active
  358.         // Only one mission option is required
  359.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION))
  360.         {
  361.             return true;
  362.         }
  363.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_LIGHT))
  364.         {
  365.             return true;
  366.         }
  367.         if ($this->isActiveByCode($societyGroup, Module::MODULE_MISSION_PLUS))
  368.         {
  369.             return true;
  370.         }
  372.         // If we are here all hope is lost
  373.         return false;
  374.     }
  376.     // Plan.io Task #3631
  377.     public function isActiveSingleSociety(SocietyGroup $societyGroup)
  378.     {
  379.         return !$this->isActiveMultipleSocieties($societyGroup);
  380.     }
  381.     // Plan.io Task #3631
  382.     public function isActiveMultipleSocieties(SocietyGroup $societyGroup)
  383.     {
  384.         // If the society group has more than one society,
  385.         // we mult display them all
  386.         // without taking the config into account
  388.         if ($societyGroup->getSocieties()->count() > 1)
  389.         {
  390.             return true;
  391.         }
  393.         // If a single society in the group, check to see if the society module is activated
  394.         $societyModuleActivated = false;
  395.         if ($this->isActiveByCode($societyGroup, Module::MODULE_SOCIETY))
  396.         {
  397.             $societyModuleActivated = true;
  398.         }
  400.         if ($societyModuleActivated === true)
  401.         {
  402.             // Display multiple societies
  403.             return true;
  404.         }
  405.         else
  406.         {
  407.             // Don't display the society notion
  408.             return false;
  409.         }
  410.         return false;
  411.     }
  412. }