Feature: Top Companies

module/Organizations/config/module.config.php

@@ -1,9 +1,16 @@
 <?php
+
 /**
  * @author Mathias Weitz <[email protected]>
  * @author Mathias Gelhausen <[email protected]>
  */
 
+ declare(strict_types=1);
+
+ namespace Organizations;
+
+use Laminas\ServiceManager\Factory\InvokableFactory;
+
 return [
     'doctrine' => [
         'driver' => [
@@ -51,7 +58,8 @@
         'factories' => [
             'Organizations/InviteEmployee' => \Organizations\Factory\Controller\InviteEmployeeControllerFactory::class,
             'Organizations/Index' => 'Organizations\Factory\Controller\IndexControllerFactory',
-            'Organizations/Profile' => 'Organizations\Factory\Controller\ProfileControllerFactory'
+            'Organizations/Profile' => 'Organizations\Factory\Controller\ProfileControllerFactory',
+            Controller\FeaturedCompaniesController::class => Controller\FeaturedCompaniesControllerFactory::class,
         ]
     ],
 
@@ -74,6 +82,7 @@
              'organizations/error/invite' => __DIR__ . '/../view/error/invite.phtml',
              'organizations/mail/invite-employee' => __DIR__ . '/../view/mail/invite-employee.phtml',
              'organizations/form/workflow-fieldset' => __DIR__ . '/../view/form/workflow-fieldset.phtml',
+             'organizations/form/featured-companies-filter-radio' => __DIR__ . '/../view/form/featured-companies-filter-radio.phtml',
             'organizations/profile/disabled' => __DIR__ . '/../view/organizations/profile/disabled.phtml',
         ],
         // Where to look for view templates not mapped above
@@ -104,6 +113,7 @@
             'Organizations/Image'                        => \Organizations\Form\LogoImageFactory::class,
             'Organizations/EmployeesFieldset'            => 'Organizations\Factory\Form\EmployeesFieldsetFactory',
             'Organizations/EmployeeFieldset'             => 'Organizations\Factory\Form\EmployeeFieldsetFactory',
+            Form\Element\FeaturedCompaniesFilterRadio::class => InvokableFactory::class,
         ]
     ],
 
@@ -175,6 +185,11 @@
                     'route/lang/organizations/profileDetail'
                 ],
             ],
+            'admin' => [
+                'allow' => [
+                    'route/lang/organizations/featured',
+                ],
+            ],
         ],
         'assertions' => [
             'invokables' => [
@@ -204,9 +219,13 @@
                         'label' => /*@translate*/ 'Insert',
                         'route' => 'lang/organizations/edit',
                     ],
+                    'featured' => [
+                        'label' => /*@translate*/ 'Featured Companies',
+                        'route' => 'lang/organizations/featured',
+                        'resource' => 'route/lang/organizations/featured',
+                    ],
                 ],
             ],
-
         ],
     ],
 

module/Organizations/config/router.config.php

@@ -7,6 +7,11 @@
  * @copyright https://yawik.org/COPYRIGHT.php
  * @license   MIT
  */
+
+ declare(strict_types=1);
+
+ namespace Organizations;
+
 return array(
     'router' => array(
         'routes' => array(
@@ -112,6 +117,15 @@
                                     ),
                                 ),
                             ),
+                            'featured' => [
+                                'type' => 'Literal',
+                                'options' => [
+                                    'route' => '/featured',
+                                    'defaults' => [
+                                        'controller' => Controller\FeaturedCompaniesController::class
+                                    ]
+                                ],
+                            ],
                         ),
                     ),
                     'my-organization' => array(

module/Organizations/src/Controller/FeaturedCompaniesController.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * YAWIK
+ *
+ * @see       https://github.com/cross-solution/YAWIK for the canonical source repository
+ * @copyright https://github.com/cross-solution/YAWIK/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/YAWIK/blob/master/LICENSE
+ */
+
+declare(strict_types=1);
+
+namespace Organizations\Controller;
+
+use Laminas\Mvc\Controller\AbstractActionController;
+use Organizations\Repository\Organization;
+
+/**
+ * TODO: description
+ *
+ * @author Mathias Gelhausen
+ * TODO: write tests
+ */
+class FeaturedCompaniesController extends AbstractActionController
+{
+    private $repository;
+
+    public function __construct(Organization $repository)
+    {
+        $this->repository = $repository;
+    }
+
+    public function indexAction()
+    {
+
+    }
+}

module/Organizations/src/Controller/FeaturedCompaniesControllerFactory.php

@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * YAWIK
+ *
+ * @see       https://github.com/cross-solution/YAWIK for the canonical source repository
+ * @copyright https://github.com/cross-solution/YAWIK/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/YAWIK/blob/master/LICENSE
+ */
+
+declare(strict_types=1);
+
+namespace Organizations\Controller;
+
+use Psr\Container\ContainerInterface;
+
+/**
+ * Factory for \Organizations\Controller\FeaturedCompaniesController
+ *
+ * @author Mathias Gelhausen
+ * TODO: write tests
+ */
+class FeaturedCompaniesControllerFactory
+{
+    public function __invoke(
+        ContainerInterface $container,
+        string $requestedName,
+        ?array $options = null
+    ): FeaturedCompaniesController {
+        return new FeaturedCompaniesController(
+            $container->get('repositories')->get('Organizations')
+        );
+    }
+}

module/Organizations/src/Controller/ProfileController.php

@@ -19,6 +19,7 @@
 use Laminas\I18n\Translator\TranslatorInterface;
 use Laminas\Mvc\Controller\AbstractActionController;
 use Laminas\View\Model\ViewModel;
+use Organizations\Form\FeaturedCompaniesSearchForm;
 use Organizations\ImageFileCache\Manager as ImageFileCacheManager;
 
 /**
@@ -90,10 +91,11 @@ public function indexAction()
                 'as' => 'organizations',
                 'params' => [
                     'type' => 'profile',
+                    'featured' => $this->auth()->isAdmin() && (bool) $this->params('featured'),
                 ]
             ],
             'form' => [
-                'Core/Search',
+                $this->auth()->isAdmin() ? FeaturedCompaniesSearchForm::class : 'Core/Search',
                 'as' => 'form',
             ]
         ]);

module/Organizations/src/Entity/FeaturedCompanySettings.php

@@ -0,0 +1,38 @@
+<?php
+
+/**
+ * YAWIK
+ *
+ * @see       https://github.com/cross-solution/YAWIK for the canonical source repository
+ * @copyright https://github.com/cross-solution/YAWIK/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/YAWIK/blob/master/LICENSE
+ */
+
+declare(strict_types=1);
+
+namespace Organizations\Entity;
+
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+
+/**
+ * TODO: description
+ *
+ * @ODM\EmbeddedDocument
+ *
+ * @author Mathias Gelhausen
+ * TODO: write tests
+ */
+class FeaturedCompanySettings
+{
+    /**
+     * @ODM\Field(type="bool")
+     * @var bool
+     */
+    private $isFeaturedCompany = false;
+
+    /**
+     * @ODM\Field(type="int")
+     * @var int
+     */
+    private $priority = 1;
+}

module/Organizations/src/Entity/Organization.php

@@ -211,6 +211,13 @@ class Organization extends BaseEntity implements
      */
     protected $profileSetting;
 
+    /**
+     * @ODM\Field(type="bool")
+     * @var bool
+     */
+    protected $isFeaturedCompany = false;
+
+
     /**
      * @return string
      */
@@ -858,4 +865,24 @@ public function setWorkflowSettings($workflowSettings)
 
         return $this;
     }
+
+    /**
+     * Get isFeaturedCompany
+     *
+     * @return bool
+     */
+    public function isFeaturedCompany(): bool
+    {
+        return $this->isFeaturedCompany;
+    }
+
+    /**
+     * Set isFeaturedCompany
+     *
+     * @param bool $isFeaturedCompany
+     */
+    public function setIsFeaturedCompany(bool $isFeaturedCompany): void
+    {
+        $this->isFeaturedCompany = $isFeaturedCompany;
+    }
 }

module/Organizations/src/Entity/ProfileSettings.php

@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * YAWIK
+ *
+ * @see       https://github.com/cross-solution/YAWIK for the canonical source repository
+ * @copyright https://github.com/cross-solution/YAWIK/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/YAWIK/blob/master/LICENSE
+ */
+
+declare(strict_types=1);
+
+namespace Organizations\Entity;
+
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+
+/**
+ * TODO: description
+ *
+ * @ODM\EmbeddedDocument
+ *
+ * @author Mathias Gelhausen
+ * TODO: write tests
+ */
+class ProfileSettings
+{
+    private $type;
+
+    private $isPrimeCompany;
+}

module/Organizations/src/Form/Element/FeaturedCompaniesFilterRadio.php

@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * YAWIK
+ *
+ * @see       https://github.com/cross-solution/YAWIK for the canonical source repository
+ * @copyright https://github.com/cross-solution/YAWIK/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/YAWIK/blob/master/LICENSE
+ */
+
+declare(strict_types=1);
+
+namespace Organizations\Form\Element;
+
+use Core\Form\ViewPartialProviderInterface;
+use Core\Form\ViewPartialProviderTrait;
+use Laminas\Form\Element\Radio;
+
+/**
+ * TODO: description
+ *
+ * @author Mathias Gelhausen
+ * TODO: write tests
+ */
+class FeaturedCompaniesFilterRadio extends Radio implements ViewPartialProviderInterface
+{
+    use ViewPartialProviderTrait;
+
+    private $defaultPartial = 'organizations/form/featured-companies-filter-radio';
+
+    public function init()
+    {
+        $this->setName('featured');
+        $this->setValueOptions([
+            'none' => /*@translate*/ 'All',
+            'on' => /*@translate*/ 'Featured',
+            'off' => /*@translate*/ 'Not Featured',
+        ]);
+        $this->setAttributes([
+            'value' => 'none',
+            'data-submit-on-change' => 'true'
+        ]);
+    }
+}

module/Organizations/src/Form/FeaturedCompaniesSearchForm.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * YAWIK
+ *
+ * @see       https://github.com/cross-solution/YAWIK for the canonical source repository
+ * @copyright https://github.com/cross-solution/YAWIK/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/YAWIK/blob/master/LICENSE
+ */
+
+declare(strict_types=1);
+
+namespace Organizations\Form;
+
+use Core\Form\SearchForm;
+use Organizations\Form\Element\FeaturedCompaniesFilterRadio;
+
+/**
+ * TODO: description
+ *
+ * @author Mathias Gelhausen
+ * TODO: write tests
+ */
+class FeaturedCompaniesSearchForm extends SearchForm
+{
+
+    public function init()
+    {
+        $this->setName($this->getOption('name') ?: 'searchform');
+
+        $this->addTextElement(
+            $this->getOption('text_name') ?: 'q',
+            $this->getOption('text_label') ?: /*@translate*/ 'Search',
+            $this->getOption('text_placeholder') ?: /*@translate*/ 'Search query',
+            $this->getOption('text_span') ?: 12,
+            50,
+            true
+        );
+
+        $this->add([
+            'type' => FeaturedCompaniesFilterRadio::class
+        ]);
+
+        $this->addButton(/*@translate*/ 'Search', -1000, 'submit');
+        $this->addButton(/*@translate*/ 'Clear', -1001, 'reset');
+
+        $this->addElements();
+    }
+}