Initial commit

Author: xiaohutai

.gitignore

@@ -0,0 +1,6 @@
+.DS_*
+config.yml
+composer.lock
+vendor/
+tests/tmp/
+

README.md

@@ -0,0 +1,69 @@
+# Social Hub Extension
+
+Helper functions for the Social Hub website.
+
+# Is Useful Extension
+
+This is a simple extension that adds the feature to add a  "Is this page useful? Yes No"
+to your pages. It has two modes:
+
+- `link`: If a user clicks 'No', it will go to that page.
+- `boltforms`: If a user clicks 'No', it will expand a form (requires `bolt/boltforms`).
+
+For `link` mode, you can get the `url` parameter from the query string.
+
+For `boltforms` mode, you need to add a form named `feedback` and set `ajax` to
+`true`. An example form as follows:
+
+```
+feedback:
+    submission:
+        ajax: true
+    notification:
+        enabled: true
+        # debug: true
+        # debug_address:
+        # debug_smtp: true
+        subject: Feedback
+        from_name: no-reply@example.com
+        from_email: no-reply@example.com
+        to_name: Example
+        to_email: info@example.com
+    feedback:
+        success: Success
+        error: Error
+    fields:
+        message:
+            type: textarea
+            options:
+                required: false
+                label: Feedback
+                attr:
+                    placeholder: How should we improve this page?
+                    class: message
+        url:
+            type: hidden
+            options:
+                label: URL
+                required: false
+                attr:
+                    class: hidden
+        submit:
+            type: submit
+            options:
+                label: Send
+                attr:
+                    class: button primary
+```
+
+In your template add:
+
+```
+{{ include('@is_useful/_is_useful.twig') }}
+```
+
+Or copy the twig file to your theme, customize it and include that file.
+
+<!--
+Inspired from GOV.UK, e.g. https://www.gov.uk/service-manual/measuring-success/measuring-user-satisfaction
+-->

composer.json

@@ -0,0 +1,34 @@
+{
+    "name": "twokings/socialhub",
+    "description": "Social Hub helper functions",
+    "type": "bolt-extension",
+    "keywords": [
+        "useful",
+        "feedback"
+    ],
+    "require": {
+        "bolt/bolt": "^3.0"
+    },
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Xiao-Hu Tai",
+            "email": "xiao@twokings.nl"
+        }
+    ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "autoload": {
+        "psr-4": {
+            "Bolt\\Extension\\TwoKings\\SocialHub\\": "src"
+        }
+    },
+    "extra": {
+        "bolt-assets": "web",
+        "bolt-class": "Bolt\\Extension\\TwoKings\\SocialHub\\SocialHubExtension",
+        "bolt-icon": "bolt-icon.png",
+    },
+    "suggest": {
+        "bolt/boltforms": "A form generator for Bolt CMS"
+    }
+}

config/config.yml.dist

@@ -0,0 +1,40 @@
+# Pick one of two options.
+
+# ------------------------------------------------------------------------------
+# Option 1: Link
+# ------------------------------------------------------------------------------
+
+type: link
+link: '/contact'
+
+# ------------------------------------------------------------------------------
+# Option 2: Boltforms
+# ------------------------------------------------------------------------------
+
+# type: boltforms
+# formname: feedback
+
+# ------------------------------------------------------------------------------
+# General
+# ------------------------------------------------------------------------------
+
+label:
+    question: Is this page useful?
+    yes: Yes
+    yes_detail: this page is useful
+    no: No
+    no_detail: this page is not useful
+    thanks: Thanks for your feedback
+    close: Close form
+
+# visuallyhidden: Classes for visually hidden elements; these elements can be
+#                 read/interpreted by screen readers and other assisitive
+#                 technologies. Common class names are 'sr-only', 'at-only',
+#                 and 'visually-hidden'.
+css:
+    wrapper        : 'is-useful-wrapper' # do not change if you use default js/css
+    expand         : 'expand'            # do not change if you use default js/css
+    visuallyhidden : 'visually-hidden'
+
+add_js: true
+add_css: true

src/Config/Config.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Bolt\Extension\TwoKings\SocialHub\Config;
+
+use Symfony\Component\HttpFoundation\ParameterBag;
+
+/**
+ * @author Xiao-Hu Tai <xiao@twokings.nl>
+ */
+class Config extends ParameterBag
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function __construct($parameters = [])
+    {
+        parent::__construct($parameters);
+    }
+
+    /**
+     * This function is aken from \Bolt\Config class:
+     * @link https://github.com/bolt/bolt/blob/release/3.2/src/Config.php#L202-L239
+     *
+     * Get a config value, using a path. So the third parameter $deep is ignored.
+     *
+     * For example:
+     * $var = $config->get('general/wysiwyg/ck/contentsCss');
+     *
+     * @param string               $path
+     * @param string|array|boolean $default
+     * @param bool                 $deep
+     *
+     * @return mixed
+     */
+    public function get($path, $default = null, $deep = false)
+    {
+        $path = explode('/', $path);
+
+        // Only do something if we get at least one key.
+        if (empty($path[0]) || !isset($this->parameters[$path[0]])) {
+            return false;
+        }
+
+        $part = & $this->parameters;
+        $value = null;
+
+        foreach ($path as $key) {
+            if (!isset($part[$key])) {
+                $value = null;
+                break;
+            }
+
+            $value = $part[$key];
+            $part = & $part[$key];
+        }
+        if ($value !== null) {
+            return $value;
+        }
+
+        return $default;
+    }
+}

src/IsUsefulTable.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Bolt\Extension\TwoKings\SocialHub;
+
+use Bolt\Storage\Database\Schema\Table\BaseTable;
+
+class IsUsefulTable extends BaseTable
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function addColumns()
+    {
+        $this->table->addColumn('id', 'integer', ['autoincrement' => true]);
+        $this->table->addColumn('contenttype', 'string', ['notnull' => false]);
+        $this->table->addColumn('contentid', 'integer', ['notnull' => false]);
+        $this->table->addColumn('totals', 'json_array');
+        $this->table->addColumn('ips', 'json_array');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function addIndexes()
+    {
+        // This will create a joint index of both columns
+        $this->table->addIndex(['contenttype', 'contentid']);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function setPrimaryKey()
+    {
+        $this->table->setPrimaryKey(['id']);
+    }
+}

src/SocialHubExtension.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace Bolt\Extension\TwoKings\SocialHub;
+
+use Bolt\Asset\File\JavaScript;
+use Bolt\Asset\File\Stylesheet;
+use Bolt\Controller\Zone;
+use Bolt\Extension\DatabaseSchemaTrait;
+use Bolt\Extension\SimpleExtension;
+use Bolt\Extension\TwoKings\SocialHub\Config\Config;
+use Silex\Application;
+use Silex\ControllerCollection;
+
+/**
+ * @author Xiao-Hu Tai <xiao@twokings.nl>
+ */
+class SocialHubExtension extends SimpleExtension
+{
+    use DatabaseSchemaTrait;
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function registerExtensionTables()
+    {
+        return [
+            'is_useful' => IsUsefulTable::class,
+        ];
+    }
+
+    protected function registerFrontendRoutes(ControllerCollection $collection)
+    {
+        // $collection->match('/async/is-useful', [$this, '']);
+        // Update with a 'yes' or a 'no' and count them in the database
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function registerTwigPaths()
+    {
+        return [
+            'templates' => [
+                'position'  => 'prepend',
+                'namespace' => 'is_useful'
+            ]
+        ];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function registerAssets()
+    {
+        $assets = [];
+
+        $config = $this->getConfig();
+
+        // By default, add JavaScript and CSS files, unless it is explicityly
+        // set to `false`.
+        if (!isset($config['add_js']) || $config['add_js'] !== false) {
+            $assets[] = JavaScript::create()
+                ->setFileName('extensions/vendor/twokings/is-useful/extension.js')
+                ->setLate(true)
+                ->setZone(Zone::FRONTEND)
+            ;
+        }
+
+        if (!isset($config['add_css']) || $config['add_css'] !== false) {
+            $assets[] = StyleSheet::create()
+                ->setFileName('extensions/vendor/twokings/is-useful/extension.css')
+                ->setLate(true)
+                ->setZone(Zone::FRONTEND)
+            ;
+        }
+
+        return $assets;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function registerServices(Application $app)
+    {
+        $this->extendDatabaseSchemaServices();
+
+        $app['is_useful.config'] = $app->share(function () { return new Config($this->getConfig()); });
+    }
+}

templates/_is_useful.twig

@@ -0,0 +1,38 @@
+{% set config = app['is_useful.config'].all() %}
+{% set attributes = '' %}
+{% if config.type == 'boltforms' %}
+    {% set attributes = 'aria-expanded="false"' %}
+{% elseif config.type == 'link' %}
+    {% set attributes = 'href="' ~ config.link ~ '?url=' ~ global.request.getUri()|url_encode ~ '"' %}
+{% endif %}
+
+<div
+    class="{{ config.css.wrapper }}"
+    data-thanks="{{ config.label.thanks }}"
+    data-type="{{ config.type }}">
+    <p>
+        {{ config.label.question }}
+        {% spaceless %}
+        <a class="is-useful">
+            {{- config.label.yes -}}
+            <span class="{{ config.css.visuallyhidden }}"> {{ config.label.yes_detail -}}
+            </span>
+        </a>
+        <a class="is-not-useful" {{ attributes|raw }}>
+            {{- config.label.no -}}
+            <span class="{{ config.css.visuallyhidden }}"> {{ config.label.no_detail -}}
+            </span>
+        </a>
+        {% endspaceless %}
+    </p>
+    {% if config.type == 'boltforms' and config.formname is defined %}
+        <div class="{{ config.css.expand }}" aria-hidden="true">
+            <button class="close-button" aria-label="{{ config.label.close }}" type="button">
+                <span aria-hidden="true">&times;</span>
+            </button>
+            {{ boltforms(config.formname, defaults = {
+                url: global.request.getUri()
+            }) }}
+        </div>
+    {% endif %}
+</div>