Skip to content

Latest commit

 

History

History
114 lines (87 loc) · 3.06 KB

README.md

File metadata and controls

114 lines (87 loc) · 3.06 KB
Raw

ZfDisqus

Build Status Code Quality Code Coverage Latest Version

ZF module which facilitates integration of Disqus widgets.

Installation

The preferred method of installation is via Composer. Run the following command to install the latest version of a package and add it to your project's composer.json:

composer require nikolaposa/zf-disqus

Provide your Disqus shortname through configuration:

<?php
return [
    'disqus' => [
        'shortname' => 'your_disqus_shortname'
        //any other Disqus config can be provided here
    ],
    // ...
];

Enable the module in your application.config.php:

<?php
return [
    'modules' => [
        // ...
        'ZfDisqus',
    ],
    // ...
];

Usage

This module provides a Disqus view helper (ZfDisqus\View\Helper\Disqus) which is essentially a wrapper around the DisqusHelper. Refer to the DisqusHelper project documenation for more information about available widget methods.

Examples

Typical example would be in some application which uses layouts. Widgets should be rendered in specific templates, while Disqus assets will be rendered somewhere in the layout, most commonly within the head or tail sections:

Template

<!-- post.phtml -->

<?php
    //Page-specific Disqus configuration
    $this->disqus()->configure([
        'identifier' => 'article_' . $this->post->id
        'title' => $this->post->title,
    ]);
?>

<article>
    <h1><?php echo $this->escapeHtml($this->post->title); ?></h1>

    <?php echo $this->post->body; ?>
</article>

<div>
    <h2>Comments:</h2>
    <!-- Thread widget HTML -->
    <?php echo $this->disqus()->thread(); ?>
</div>

Layout

<!-- layout.phtml -->
<html>
    <head>
        <title>Blog</title>
    </head>

    <body>
        <?php echo $this->content; ?>

        <!-- Render Disqus JS code -->
        <?php echo $this->disqus(); ?>
    </body>
</html>

Credits

License

Released under MIT License - see the License File for details.