contao-module contao-share {🖫 350, ⚐ 30, ★ 0}

heimrichhannot/contao-share

A helper module for pdf-print, print and social share functionality based on bootstrap to custom modules.

Tuesday, May 29, 2018
by digitales@heimrich-hannot.de
Repository
5 Watchers
0 Stars
350 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
1 Open issues
30 Versions
2 % Grown

The README.md

A helper module for pdf-print, print and social share functionality based on bootstrap to custom modules., _(*1)

Features

news & calendar support
add syndication to modules and articles
syndication options:
- print pdf
- print by a custom module template or call the default browser print fun
- ical-event
- mailto
- feedback
- facebook share
- twitter share
- googleplus share

Usage

Setup for modules

Add {share_legend},addShare; to your model default palette., _(*2)

Example:, _(*3)

$dca = &$GLOBALS['TL_DCA']['tl_module'];
$dca['palettes']['newsreader'] = str_replace(
    '{image_legend',
    '{share_legend},addShare;{image_legend',
    $dca['palettes']['newsreader']
);

To show the share buttons in your module, you need to add the return of Settings->generate() to your template., _(*4)

Example:, _(*5)

// Module class: 

public function compile()
{
    ...
    $this->generateShare();
    ...
}

protected function generateShare()
{
    if ($this->addShare)
    {
        $objShare = new \HeimrichHannot\Share\Share($this->objModel, [Entity to print]);

        $this->template->share = $objShare->generate();
    }
    return null;
}

// Template file:

= $this->share ?>

// Add this to the generateShare method from above, after calling generate():
if ($this->module->share_addTemplateLinks)
{
    $this->template->shareUrls = $objShare->generateShareUrls();
}

This will add an array to the template with following key containing just the urls: * mailto * facebook * twitter * linkedin * whatsapp, _(*6)

Setup for articles

Since version 1.5 you can also print complete articles., _(*7)

Setup a new model, which has share enabled (=has addShare added to the module palette, the module type doesn't matter). This module will hold the settings for the article., _(*8)
Check "Add Syndication" on the article settings page and choose the module setup before., _(*9)
Echo $this->share in your article template., _(*10)

Custom name for your pdf files

Your module has to implement ModulePdfReaderInterface. The return-value of getFileName() is used as pdf file name. Don't add .pdf, it will be added by the module itself., _(*11)

1, _(*12)

Print page

To address your custom module print layout, the url must contain the print parameter with the module id as value. (Example: ?print=57). The default print link will do that for you and will create a new tab/window and close it immediately after the window was printed by the user. To debug the print layout, add the pDebug=1 parameter to your print url (Example: ?print=57&pDebug=1)., _(*13)

For regions within your templates that should not be printable, add  before that region and  afterwards., _(*14)

<!-- print::stop -->
DO NOT PRINT THIS!
<!-- print::continue -->

It is also possible to simple call the browser print windows to print the complete page by checking 'printWithoutTemplate' withing the syndication selection in module settings., _(*15)

The Versions

29/05 2018

dev-master

9999999-dev https://github.com/heimrichhannot/contao-share

A helper module for pdf-print, print and social share functionality based on bootstrap to custom modules.

contao-module contao-share

A helper module for pdf-print, print and social share functionality based on bootstrap to custom modules.

heimrichhannot/contao-share

The README.md

Share

Features

Usage

Setup for modules

Add Share to your module palette

Generate share output

Add Share urls to your template

Setup for articles

Custom name for your pdf files

Print page

The Versions

dev-master

The Requires

by Heimrich & Hannot

1.7.0

The Requires

by Heimrich & Hannot

1.6.0

The Requires

by Heimrich & Hannot

1.5.2

The Requires

by Heimrich & Hannot

1.5.1

The Requires

by Heimrich & Hannot

v2.x-dev

The Requires

The Development Requires

by Heimrich & Hannot

1.5.0

The Requires

by Heimrich & Hannot

1.4.1

The Requires

by Heimrich & Hannot

1.4.0

The Requires

by Heimrich & Hannot

1.3.6

The Requires

by Heimrich & Hannot

1.3.5

The Requires

by Heimrich & Hannot

1.3.4

The Requires

by Heimrich & Hannot

1.3.3

The Requires

by Heimrich & Hannot

1.3.2

The Requires

by Heimrich & Hannot

1.3.1

The Requires

by Heimrich & Hannot

1.3.0

The Requires

by Heimrich & Hannot

dev-mpdf-migration

The Requires

by Heimrich & Hannot

1.2.6

The Requires

by Heimrich & Hannot

1.2.5

The Requires

by Heimrich & Hannot

1.2.4

The Requires

by Heimrich & Hannot

1.2.3

The Requires

by Heimrich & Hannot

1.2.2