Fixed FlexObject::triggerEvent() does not emit events [#2816]

getgrav · Feb 10, 2020 · 234abb3 · 234abb3
1 parent 3a722ba
commit 234abb3
Show file tree

Hide file tree

Showing 37 changed files with 797 additions and 315 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
     * Regression: Fixed bad method call in FlexDirectory::getAuthorizeRule()
     * Regression: Fixed fatal error in admin if the site has custom permissions in `onAdminRegisterPermissions`
     * Regression: Fixed flex user index with folder storage
+    * Fixed `FlexObject::triggerEvent()` does not emit events [#2816](https://github.com/getgrav/grav/issues/2816)
     * Grav 1.7: Fixed saving Flex configuration with ignored values becoming null
 
 # v1.7.0-rc.5

diff --git a/system/blueprints/flex/pages.yaml b/system/blueprints/flex/pages.yaml
@@ -156,11 +156,11 @@ config:
 
   # Data Configuration
   data:
-    object: 'Grav\Common\Flex\Pages\PageObject'
-    collection: 'Grav\Common\Flex\Pages\PageCollection'
-    index: 'Grav\Common\Flex\Pages\PageIndex'
+    object: 'Grav\Common\Flex\Types\Pages\PageObject'
+    collection: 'Grav\Common\Flex\Types\Pages\PageCollection'
+    index: 'Grav\Common\Flex\Types\Pages\PageIndex'
     storage:
-      class: 'Grav\Common\Flex\Pages\PageStorage'
+      class: 'Grav\Common\Flex\Types\Pages\Storage\PageStorage'
       options:
         formatter:
           class: 'Grav\Framework\File\Formatter\MarkdownFormatter'

diff --git a/system/blueprints/flex/user-accounts.yaml b/system/blueprints/flex/user-accounts.yaml
@@ -97,11 +97,11 @@ config:
 
   # Data Configuration
   data:
-    object: 'Grav\Common\Flex\Users\UserObject'
-    collection: 'Grav\Common\Flex\Users\UserCollection'
-    index: 'Grav\Common\Flex\Users\UserIndex'
+    object: 'Grav\Common\Flex\Types\Users\UserObject'
+    collection: 'Grav\Common\Flex\Types\Users\UserCollection'
+    index: 'Grav\Common\Flex\Types\Users\UserIndex'
     storage:
-      class: 'Grav\Common\Flex\Users\Storage\UserFileStorage'
+      class: 'Grav\Common\Flex\Types\Users\Storage\UserFileStorage'
       options:
         formatter:
           class: 'Grav\Framework\File\Formatter\YamlFormatter'

diff --git a/system/blueprints/flex/user-groups.yaml b/system/blueprints/flex/user-groups.yaml
@@ -96,9 +96,9 @@ config:
 
   # Data Configuration
   data:
-    object: 'Grav\Common\Flex\UserGroups\UserGroupObject'
-    collection: 'Grav\Common\Flex\UserGroups\UserGroupCollection'
-    index: 'Grav\Common\Flex\UserGroups\UserGroupIndex'
+    object: 'Grav\Common\Flex\Types\UserGroups\UserGroupObject'
+    collection: 'Grav\Common\Flex\Types\UserGroups\UserGroupCollection'
+    index: 'Grav\Common\Flex\Types\UserGroups\UserGroupIndex'
     storage:
       class: 'Grav\Framework\Flex\Storage\SimpleStorage'
       options:

diff --git a/system/src/Grav/Common/Flex/Traits/FlexCollectionTrait.php b/system/src/Grav/Common/Flex/Traits/FlexCollectionTrait.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @package    Grav\Common\Flex
+ *
+ * @copyright  Copyright (C) 2015 - 2020 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Flex\Traits;
+
+use RocketTheme\Toolbox\Event\Event;
+
+/**
+ * Trait FlexCollectionTrait
+ * @package Grav\Common\Flex\Traits
+ */
+trait FlexCollectionTrait
+{
+    use FlexCommonTrait;
+
+    /**
+     * @param string $name
+     * @param object|null $event
+     * @return $this
+     */
+    public function triggerEvent(string $name, $event = null)
+    {
+        if (null === $event) {
+            $event = new Event(['collection' => $this]);
+        }
+        if (strpos($name, 'onFlexCollection') !== 0 && strpos($name, 'on') === 0) {
+            $name = 'onFlexCollection' . substr($name, 2);
+        }
+
+        $container = $this->getContainer();
+        $container->fireEvent($name, $event);
+
+        return $this;
+    }
+}
diff --git a/system/src/Grav/Common/Flex/Traits/FlexCommonTrait.php b/system/src/Grav/Common/Flex/Traits/FlexCommonTrait.php
@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @package    Grav\Common\Flex
+ *
+ * @copyright  Copyright (C) 2015 - 2020 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Flex\Traits;
+
+use Grav\Common\Debugger;
+use Grav\Common\Grav;
+use Grav\Common\Twig\Twig;
+use Twig\Error\LoaderError;
+use Twig\Error\SyntaxError;
+use Twig\Template;
+use Twig\TemplateWrapper;
+
+/**
+ * Trait FlexCommonTrait
+ * @package Grav\Common\Flex\Traits
+ */
+trait FlexCommonTrait
+{
+    /**
+     * @param string $layout
+     * @return Template|TemplateWrapper
+     * @throws LoaderError
+     * @throws SyntaxError
+     */
+    protected function getTemplate($layout)
+    {
+        $container = $this->getContainer();
+
+        /** @var Twig $twig */
+        $twig = $container['twig'];
+
+        try {
+            return $twig->twig()->resolveTemplate($this->getTemplatePaths($layout));
+        } catch (LoaderError $e) {
+            /** @var Debugger $debugger */
+            $debugger = Grav::instance()['debugger'];
+            $debugger->addException($e);
+
+            return $twig->twig()->resolveTemplate(['flex/404.html.twig']);
+        }
+    }
+
+    abstract protected function getTemplatePaths(string $layout): array;
+    abstract protected function getContainer(): Grav;
+}
diff --git a/system/src/Grav/Common/Flex/Traits/FlexGravTrait.php b/system/src/Grav/Common/Flex/Traits/FlexGravTrait.php
@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @package    Grav\Common\Flex
+ *
+ * @copyright  Copyright (C) 2015 - 2020 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Flex\Traits;
+
+use Grav\Common\Grav;
+use Grav\Common\User\Interfaces\UserInterface;
+use Grav\Framework\Flex\Flex;
+
+/**
+ * Implements Grav specific logic
+ */
+trait FlexGravTrait
+{
+    /**
+     * @return Grav
+     */
+    protected function getContainer(): Grav
+    {
+        return Grav::instance();
+    }
+
+    /**
+     * @return Flex
+     */
+    protected function getFlexContainer(): Flex
+    {
+        $container = $this->getContainer();
+
+        /** @var Flex $flex */
+        $flex = $container['flex'];
+
+        return $flex;
+    }
+
+    /**
+     * @return UserInterface|null
+     */
+    protected function getActiveUser(): ?UserInterface
+    {
+        $container = $this->getContainer();
+
+        /** @var UserInterface|null $user */
+        $user = $container['user'] ?? null;
+
+        return $user;
+    }
+
+    /**
+     * @return bool
+     */
+    protected function isAdminSite(): bool
+    {
+        $container = $this->getContainer();
+
+        return isset($container['admin']);
+    }
+
+    /**
+     * @return string
+     */
+    protected function getAuthorizeScope(): string
+    {
+        return $this->isAdminSite() ? 'admin' : 'site';
+    }
+}
diff --git a/system/src/Grav/Common/Flex/Traits/FlexIndexTrait.php b/system/src/Grav/Common/Flex/Traits/FlexIndexTrait.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @package    Grav\Common\Flex
+ *
+ * @copyright  Copyright (C) 2015 - 2020 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Flex\Traits;
+
+/**
+ * Trait FlexIndexTrait
+ * @package Grav\Common\Flex\Traits
+ */
+trait FlexIndexTrait
+{
+}
diff --git a/system/src/Grav/Common/Flex/Traits/FlexObjectTrait.php b/system/src/Grav/Common/Flex/Traits/FlexObjectTrait.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @package    Grav\Common\Flex
+ *
+ * @copyright  Copyright (C) 2015 - 2020 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Flex\Traits;
+
+use RocketTheme\Toolbox\Event\Event;
+
+/**
+ * Trait FlexObjectTrait
+ * @package Grav\Common\Flex\Traits
+ */
+trait FlexObjectTrait
+{
+    use FlexCommonTrait;
+
+    /**
+     * @param string $name
+     * @param object|null $event
+     * @return $this
+     */
+    public function triggerEvent(string $name, $event = null)
+    {
+        if (null === $event) {
+            $event = new Event(['object' => $this]);
+        }
+        if (strpos($name, 'onFlexObject') !== 0 && strpos($name, 'on') === 0) {
+            $name = 'onFlexObject' . substr($name, 2);
+        }
+
+        $container = $this->getContainer();
+        $container->fireEvent($name, $event);
+
+        return $this;
+    }
+}
diff --git a/system/src/Grav/Common/Flex/Types/Generic/GenericCollection.php b/system/src/Grav/Common/Flex/Types/Generic/GenericCollection.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @package    Grav\Common\Flex
+ *
+ * @copyright  Copyright (C) 2015 - 2020 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Flex\Types\Generic;
+
+use Grav\Common\Flex\Traits\FlexCollectionTrait;
+use Grav\Common\Flex\Traits\FlexGravTrait;
+use Grav\Framework\Flex\FlexCollection;
+
+/**
+ * Class GenericCollection
+ * @package Grav\Common\Flex\Generic
+ */
+class GenericCollection extends FlexCollection
+{
+    use FlexGravTrait;
+    use FlexCollectionTrait;
+}
diff --git a/system/src/Grav/Common/Flex/Types/Generic/GenericIndex.php b/system/src/Grav/Common/Flex/Types/Generic/GenericIndex.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @package    Grav\Common\Flex
+ *
+ * @copyright  Copyright (C) 2015 - 2020 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Flex\Types\Generic;
+
+use Grav\Common\Flex\Traits\FlexGravTrait;
+use Grav\Common\Flex\Traits\FlexIndexTrait;
+use Grav\Framework\Flex\FlexIndex;
+
+/**
+ * Class GenericIndex
+ * @package Grav\Common\Flex\Generic
+ */
+class GenericIndex extends FlexIndex
+{
+    use FlexGravTrait;
+    use FlexIndexTrait;
+}
diff --git a/system/src/Grav/Common/Flex/Types/Generic/GenericObject.php b/system/src/Grav/Common/Flex/Types/Generic/GenericObject.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @package    Grav\Common\Flex
+ *
+ * @copyright  Copyright (C) 2015 - 2020 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Flex\Types\Generic;
+
+use Grav\Common\Flex\Traits\FlexGravTrait;
+use Grav\Common\Flex\Traits\FlexObjectTrait;
+use Grav\Framework\Flex\FlexObject;
+
+/**
+ * Class GenericObject
+ * @package Grav\Common\Flex\Generic
+ */
+class GenericObject extends FlexObject
+{
+    use FlexGravTrait;
+    use FlexObjectTrait;
+}
diff --git a/...Grav/Common/Flex/Pages/PageCollection.php → ...ommon/Flex/Types/Pages/PageCollection.php b/...Grav/Common/Flex/Pages/PageCollection.php → ...ommon/Flex/Types/Pages/PageCollection.php
@@ -9,8 +9,10 @@
  * @license    MIT License; see LICENSE file for details.
  */
 
-namespace Grav\Common\Flex\Pages;
+namespace Grav\Common\Flex\Types\Pages;
 
+use Grav\Common\Flex\Traits\FlexCollectionTrait;
+use Grav\Common\Flex\Traits\FlexGravTrait;
 use Grav\Common\Page\Interfaces\PageCollectionInterface;
 use Grav\Common\Page\Interfaces\PageInterface;
 use Grav\Common\Utils;
@@ -34,6 +36,9 @@
  */
 class PageCollection extends FlexPageCollection implements PageCollectionInterface
 {
+    use FlexGravTrait;
+    use FlexCollectionTrait;
+
     /** @var array|null */
     protected $_params;