BenjaminMedia/wp-cxense

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 335 Commits
.circleci		.circleci
src		src
tests		tests
.env.codeception		.env.codeception
.gitignore		.gitignore
.styleci.yml		.styleci.yml
LICENSE.md		LICENSE.md
README.md		README.md
codeception.dist.yml		codeception.dist.yml
composer.json		composer.json
composer.lock		composer.lock
wp-cxense.php		wp-cxense.php

Repository files navigation

Bonnier Publications - WordPress cXense plugin

This plugin enables your WordPress site to integrate with cXense. It adds the meta tags and scripts needed by cXense in order to scan your site. It also calls cXense whenever you make changes to your content. Finally it adds the possibility to save a cXense recommendation widget per content type and provides hooks to call them in your view/theme.

Requirements

WordPress 4.3 or higher
Language support (Optional) Polylang plugin must installed and activated version 1.8.4 or higher
PHP 7.1 or higher

Installation/Configuration

Install through composer:

composer require benjaminmedia/wp-cxense

Download lastest release from: https://github.com/BenjaminMedia/wp-cxense/releases And unzip and place in your /wp-content/plugins directory.

Settings

Once you have installed and activated the plugin then make sure that you have a set of api credentials for the cXense API. Once you have your credentials you may go to the settings page labeled cXense. Here you must enter your cXense Site ID, cXense API user, cXense API key and finally your cXense Organisation prefix.

Remember the plugin will not work until you check the `Enable` switch in the settings page

Widgets

The plugin will generate a CX Widget ID settings field for each post type you have available on your WordPress Installation. Here you must enter the cXense recommendation widget ID that you would like represented on your content type.

For debug purpose you can enable or disable the query cache. It is recommended to be enabled in production.

SortBy Widget ID will be only used for widgets sortby options in wp-base.

Rendering widgets

In order to render the widgets available for your post you should make sure that you have filled out the CX widget ID field in the plugin settings page.

When rendering the widgets the plugin provides you with two options:

Let cXense render the HTML of the widgets
Get the data and for the widget and build the HMTL yourself

Once you have picked the method you want to use you should go to the theme file that represents the single view of your post_type from this file you may call the following methods to get the widget data:

Let cXense render the HTML of the widgets

WpCxense::instance()->render_widget();

The sample output of this function could look like:

Hindbaersmoothie med aeble og lakrids

Herkules Pavillonens bedste frokost-opskrifter

...

"><div id="targetElement"> <script type="text/javascript"> document.write(data.response.template + '\n'); script> <div class="item"> <a id="cXLinkIditl9abmrwgnm6p94" href="http://api.cxense.com/public/widget/click/GHVxM-yuEld7tlHB8lLrWC5jLoQYrF5gUs1rQK6CLuzqTVYiNXv6oZIhhNasqiBbPYlY2_nBmMn2aM8imnN5Y0VXxers9cYtaPN1-kIKDNd-dw78wcSKMCLNK45PnASBJagtCbsrhK9JwUfBEeuVtGs1L3HeqDWe5qKvKc7dWeFC77wB_w5fBFQlcXCgyOLmfQwO21Cfh2QcoBs4J8A2pN6OkKQOPyC0lwIbM30ZaHAUZ774R5ASnLc6GLOpPyN38YwdvjAL7iAigpE4fpAcq6O5HXG6PbQljmp-wk1GJvw6hWAigKp1gsSJmhPhZjhIP-pbABDfOl7OkS-k42wjAxKuCeukqgJW04_J0tWRGygNzTm4Tno54OQAgHVWnh4iZDyOaXBjkKAGQHDMPY7IGBfSjDZKOiviklKINjAbb1STXbgDr27BhMZKuWC-y4fMWVnganRI7IVRA8bgd6zl0V4DX9VjvTUEJLSOWq-T6kEzsdG-ENGrw4EVauuyd1h9kysOAuH_egm1XoDcmHpYSMzPmhmyeOgfJpGFg6L09vXFTi6GQ39q4kJYMeQSlC_xO3f1vJzIhn9Y9D6kRIVQMASyFC31lcSwR9pVoOcQav5duA-d4wVciKTKq_RehjVfwqEFxYz9v0WTo8Sqcoc0" target="_top"> <div class="thumbnail" style="width: 300px; height: 200px; overflow: hidden; position: relative;"><img style="position: relative; left: 0px; top: -7.2px;" src="http://content-thumbnail.cxpublic.com/content/dominantthumbnail/f95381682e3604de99d30788b24fb3a1538616ee.jpg?57e79849" width="300" height="236" alt="">div> <div class="text-wrapper"> <h3 class="title">Hindbaersmoothie med aeble og lakridsh3> div> a> div> <div class="item"> <a id="cXLinkIditl9abmrpj1kla6v" href="http://maaltid.nu/herkules-pavillonens-bedste-frokost-opskrifter" target="_top"> <div class="thumbnail" style="width: 300px; height: 200px; overflow: hidden; position: relative;"><img style="position: relative; left: 0px; top: -7.2px;" src="http://content-thumbnail.cxpublic.com/content/dominantthumbnail/cf4b03ff330434ddec3447a014ccbd4a15089290.jpg?57d6c1e2" width="300" height="236" alt="">div> <div class="text-wrapper"> <h3 class="title">Herkules Pavillonens bedste frokost-opskrifterh3> div> a> div> ... div>

Get the data and for the widget and build the HMTL yourself

WpCxense::instance()->get_widget_data();

The sample output of this function could look like:

string '795' (length=3) public 'bod-pagetype' => string 'recipe' (length=6) public 'dominantthumbnail' => string 'http://content-thumbnail.cxpublic.com/content/dominantthumb nail/f95381682e3604de99d30788b24fb3a1538616ee.jpg?57e79849' (length=117) public 'dominantthumbnaildimensions' => string '300x236' (length=7) public 'title' => string 'Hindbaersmoothie med aeble og lakrids' (length=37) public 'click_url' => string 'http://api.cxense.com/public/widget/click/HV4bL7qxuVIVUmrME sh4zQ6S2A5_BkkxEuByIzyDKMZAYCrJlJOTpy7QFvYxf7dkW0ljBE_55ig9v YxG3FNaXmKGsr03HH5w1wa7-E6mbJI-gdqHJNx6pgIjvKyM8TUGnhfwe0Nsy jAkgzirNM66WfPhG9_Z9lsiWIJauO3C82KWYdRhA99EBXg6Ynsh9xwIq62wN JAaj_OPTVFhUuGiLxW7uVQ4DNT0BjRcn8ne0Uq6y8Ew0DYUDCfCFp6DwOy_D 9MK7j5wpKSfRykLOGNNo35udNcfALBcZJfoMZ7Uqgs19IZeGrAv11RDIz1cN BmWq3yEn-QKqeKFgK7cqwjKeCr91PERbwGbDu4kN9xkv1NPjTK1M_attpQjl CLy3E9_JstO-aCxP6XtmtnIExUnl1Qq7iVPXAbP3fxlT3wmIOetk4IvoGKsX hdFkRIMCD1owQwY27bVvzwuPCgTXJ-7UO'... (length=599) public 'url' => string 'http://maaltid.nu/opskrifter/hindbaersmoothie-med-aeble-og- lakrids' (length=66) 1 => object(stdClass)[2672] public 'recs-articleid' => string '1369' (length=4) public 'bod-pagetype' => string 'recipe' (length=6) public 'dominantthumbnail' => string 'http://content-thumbnail.cxpublic.com/content/dominantthumb nail/6b0ddce458039f3905b5b3515356002536ab614c.jpg?57ea261a' (length=117) public 'dominantthumbnaildimensions' => string '300x236' (length=7) public 'title' => string 'Italiensk til middag: Risotto med 2 slags graeskar og salvie' (length=60) public 'click_url' => string 'http://api.cxense.com/public/widget/click/mLsD8MoXunkEcOtky 6wQJXpRjzYcvvrFoXsONQdOI5FDqsmnlun6sVcaK-PIsvyT9KoXSvOKxiS4w zBrjGb0PaCtk_1bFn88sHSzq7LJF4CL7-Q4-50nJl3JC3oyrnAM1W_Cub7qX cAHSFmBjVkBjAGRaiA_F-Du9Y1q2by9YikilWco43hRZeUHVyQ2RLOZ7as8C 1SeEXdKHeDi8HT5SGqMox-hAdBhwHNLtXLdJ_t1u9G90QOmQw-xitTc4PUkn HSdtPyiDgYrBNNxHhOehs0_wHKGxka4k-g6VOAo7ovFGF2aRB-32QAqSPu_o hd-nNO_J0tEMll1uofTI9XCePnkI2O1W0Cq6MkEcyWVZQ-72hWiTrfn2z8x- BRd9ZE8cFvdWV8OU-Ojf02KEKesGfVgUltFY-HLImdE2NCkGV-jk7RoHYXes ghIvfTufvKnMORmayI5lkLDZQ5Dp7u9wh'... (length=613) public 'url' => string 'http://maaltid.nu/opskrifter/kom-i-godt-humor-med-graeskarr isotto-med-salvie' (length=76) 2 => ... ">array (size=12) 0 => object(stdClass)[2636] public 'recs-articleid' => string '795' (length=3) public 'bod-pagetype' => string 'recipe' (length=6) public 'dominantthumbnail' => string 'http://content-thumbnail.cxpublic.com/content/dominantthumbnail/f95381682e3604de99d30788b24fb3a1538616ee.jpg?57e79849' (length=117) public 'dominantthumbnaildimensions' => string '300x236' (length=7) public 'title' => string 'Hindbaersmoothie med aeble og lakrids' (length=37) public 'click_url' => string 'http://api.cxense.com/public/widget/click/HV4bL7qxuVIVUmrMEsh4zQ6S2A5_BkkxEuByIzyDKMZAYCrJlJOTpy7QFvYxf7dkW0ljBE_55ig9vYxG3FNaXmKGsr03HH5w1wa7-E6mbJI-gdqHJNx6pgIjvKyM8TUGnhfwe0NsyjAkgzirNM66WfPhG9_Z9lsiWIJauO3C82KWYdRhA99EBXg6Ynsh9xwIq62wNJAaj_OPTVFhUuGiLxW7uVQ4DNT0BjRcn8ne0Uq6y8Ew0DYUDCfCFp6DwOy_D9MK7j5wpKSfRykLOGNNo35udNcfALBcZJfoMZ7Uqgs19IZeGrAv11RDIz1cNBmWq3yEn-QKqeKFgK7cqwjKeCr91PERbwGbDu4kN9xkv1NPjTK1M_attpQjlCLy3E9_JstO-aCxP6XtmtnIExUnl1Qq7iVPXAbP3fxlT3wmIOetk4IvoGKsXhdFkRIMCD1owQwY27bVvzwuPCgTXJ-7UO'... (length=599) public 'url' => string 'http://maaltid.nu/opskrifter/hindbaersmoothie-med-aeble-og-lakrids' (length=66) 1 => object(stdClass)[2672] public 'recs-articleid' => string '1369' (length=4) public 'bod-pagetype' => string 'recipe' (length=6) public 'dominantthumbnail' => string 'http://content-thumbnail.cxpublic.com/content/dominantthumbnail/6b0ddce458039f3905b5b3515356002536ab614c.jpg?57ea261a' (length=117) public 'dominantthumbnaildimensions' => string '300x236' (length=7) public 'title' => string 'Italiensk til middag: Risotto med 2 slags graeskar og salvie' (length=60) public 'click_url' => string 'http://api.cxense.com/public/widget/click/mLsD8MoXunkEcOtky6wQJXpRjzYcvvrFoXsONQdOI5FDqsmnlun6sVcaK-PIsvyT9KoXSvOKxiS4wzBrjGb0PaCtk_1bFn88sHSzq7LJF4CL7-Q4-50nJl3JC3oyrnAM1W_Cub7qXcAHSFmBjVkBjAGRaiA_F-Du9Y1q2by9YikilWco43hRZeUHVyQ2RLOZ7as8C1SeEXdKHeDi8HT5SGqMox-hAdBhwHNLtXLdJ_t1u9G90QOmQw-xitTc4PUknHSdtPyiDgYrBNNxHhOehs0_wHKGxka4k-g6VOAo7ovFGF2aRB-32QAqSPu_ohd-nNO_J0tEMll1uofTI9XCePnkI2O1W0Cq6MkEcyWVZQ-72hWiTrfn2z8x-BRd9ZE8cFvdWV8OU-Ojf02KEKesGfVgUltFY-HLImdE2NCkGV-jk7RoHYXesghIvfTufvKnMORmayI5lkLDZQ5Dp7u9wh'... (length=613) public 'url' => string 'http://maaltid.nu/opskrifter/kom-i-godt-humor-med-graeskarrisotto-med-salvie' (length=76) 2 => ...

Documents

Searching documents

If the key 'query' is missing from the search array then a DocumentSearchMissingSearch exception is thrown.

Search

'search_term', // mandatory 'page' => 1, // optional, defaults to 1 'count' => 10, // optional, defaults to 10 'filter_operator => 'AND', // optional, defaults to OR 'filter' => [ // optional 'field' => [ 'value', ], ], 'filter_exclude' => [ // optional 'field' => [ 'value', ], ], 'facets' => [ // optional 0 => [ 'type' => 'string', 'field' => 'field' ], 1 => [ 'type' => 'string', 'field' => 'field' ] ], 'spellcheck' => true, // optional 'highlights' => [ // optional 0 => [ 'field' => 'body', 'start' => '', 'stop' => '', 'length' => 50 ] ] ]);">WpCxense::instance()->search_documents([ 'query' => 'search_term', // mandatory 'page' => 1, // optional, defaults to 1 'count' => 10, // optional, defaults to 10 'filter_operator => 'AND', // optional, defaults to OR 'filter' => [ // optional 'field' => [ 'value', ], ], 'filter_exclude' => [ // optional 'field' => [ 'value', ], ], 'facets' => [ // optional 0 => [ 'type' => 'string', 'field' => 'field' ], 1 => [ 'type' => 'string', 'field' => 'field' ] ], 'spellcheck' => true, // optional 'highlights' => [ // optional 0 => [ 'field' => 'body', 'start' => '', 'stop' => '', 'length' => 50 ] ] ]);

Searching documents will return an object of the following format:

array (size=2) 0 => object(stdClass)[538] public 'buckets' => array (size=6) ... 1 => object(stdClass)[542] public 'buckets' => array (size=3) ... public 'totalCount' => int 79 public 'matches' => array (size=10) 0 => object(Bonnier\WP\Cxense\Parsers\Document)[521] public 'id' => string '551790ba522b4b9427ca947e1b3353e137d78a85' (length=40) public 'siteId' => string '1129402680464567580' (length=19) public 'score' => float 2.0455377 public 'fields' => array (size=10) ... public 'highlights' => array (size=1) ... public 'spellcheck' => array (size=1) 0 => object(stdClass)[663] public 'term' => string 'mor' (length=3) public 'suggestions' => array (size=0) ...">object(stdClass)[543] public 'facets' => array (size=2) 0 => object(stdClass)[538] public 'buckets' => array (size=6) ... 1 => object(stdClass)[542] public 'buckets' => array (size=3) ... public 'totalCount' => int 79 public 'matches' => array (size=10) 0 => object(Bonnier\WP\Cxense\Parsers\Document)[521] public 'id' => string '551790ba522b4b9427ca947e1b3353e137d78a85' (length=40) public 'siteId' => string '1129402680464567580' (length=19) public 'score' => float 2.0455377 public 'fields' => array (size=10) ... public 'highlights' => array (size=1) ... public 'spellcheck' => array (size=1) 0 => object(stdClass)[663] public 'term' => string 'mor' (length=3) public 'suggestions' => array (size=0) ...

The 'matches' key contains an array of objects that have the 'fields' value accessible directly through the magic method __get(). This means that you can call any field from the 'fields' with the direct pointer:

$objResults->matches[0]->author;

A complete document result looks like:

string '551790ba522b4b9427ca947e1b3353e137d78a85' (length=40) public 'siteId' => string '1129402680464567580' (length=19) public 'score' => float 0.40566906 public 'fields' => array (size=9) 0 => object(stdClass)[715] public 'field' => string 'author' (length=6) public 'value' => string 'i form' (length=6) 1 => object(stdClass)[718] public 'field' => string 'bod-cat' (length=7) public 'value' => string 'Sund graviditet' (length=15) 2 => object(stdClass)[719] public 'field' => string 'bod-cat-top' (length=11) public 'value' => string 'Sundhed' (length=7) 3 => object(stdClass)[720] public 'field' => string 'bod-cat-url' (length=11) public 'value' => string 'http://iform.dk/sundhed/sund-graviditet' (length=39) 4 => object(stdClass)[721] public 'field' => string 'bod-pagetype' (length=12) public 'value' => string 'article' (length=7) 5 => object(stdClass)[722] public 'field' => string 'description' (length=11) public 'value' => string 'Gar du med babytanker, har du en fordel, hvis du bor taet pa din mor.' (length=71) 6 => object(stdClass)[723] public 'field' => string 'recs-publishtime' (length=16) public 'value' => string '2015-04-19T22:00:00.000Z' (length=24) 7 => object(stdClass)[724] public 'field' => string 'title' (length=5) public 'value' => string 'Din mor oger dine baby-chancer' (length=31) 8 => object(stdClass)[725] public 'field' => string 'url' (length=3) public 'value' => string 'http://iform.dk/sundhed/sund-graviditet/din-mor-kan-hjaelpe -til-familieforoegelsen' (length=82)">object(Bonnier\WP\Cxense\Parsers\Document)[710] public 'id' => string '551790ba522b4b9427ca947e1b3353e137d78a85' (length=40) public 'siteId' => string '1129402680464567580' (length=19) public 'score' => float 0.40566906 public 'fields' => array (size=9) 0 => object(stdClass)[715] public 'field' => string 'author' (length=6) public 'value' => string 'i form' (length=6) 1 => object(stdClass)[718] public 'field' => string 'bod-cat' (length=7) public 'value' => string 'Sund graviditet' (length=15) 2 => object(stdClass)[719] public 'field' => string 'bod-cat-top' (length=11) public 'value' => string 'Sundhed' (length=7) 3 => object(stdClass)[720] public 'field' => string 'bod-cat-url' (length=11) public 'value' => string 'http://iform.dk/sundhed/sund-graviditet' (length=39) 4 => object(stdClass)[721] public 'field' => string 'bod-pagetype' (length=12) public 'value' => string 'article' (length=7) 5 => object(stdClass)[722] public 'field' => string 'description' (length=11) public 'value' => string 'Gar du med babytanker, har du en fordel, hvis du bor taet pa din mor.' (length=71) 6 => object(stdClass)[723] public 'field' => string 'recs-publishtime' (length=16) public 'value' => string '2015-04-19T22:00:00.000Z' (length=24) 7 => object(stdClass)[724] public 'field' => string 'title' (length=5) public 'value' => string 'Din mor oger dine baby-chancer' (length=31) 8 => object(stdClass)[725] public 'field' => string 'url' (length=3) public 'value' => string 'http://iform.dk/sundhed/sund-graviditet/din-mor-kan-hjaelpe-til-familieforoegelsen' (length=82)

Widget documents

If the key 'widget_id' is missing from the input array then a WidgetMissingId exception is thrown.

Example how to fetch cxense data

setMatchingMode($this->getCxenseTaxonomy()) ->addParameter('pageType', 'article gallery story') ->setCategories(array($this->getCategory())) ->setTags(array($this->getTag())) ->get();">WidgetDocumentQuery::make() ->addContext('url', get_permalink()) ->setMatchingMode($this->getCxenseTaxonomy()) ->addParameter('pageType', 'article gallery story') ->setCategories(array($this->getCategory())) ->setTags(array($this->getTag())) ->get();