reyneke-vosz / toxid-curl Goto Github PK

################################
#   TOXID cURL version 1.4.0   #
################################
#
# Please notice: We are developing on GitHub.
# To be sure to get the latest version, look there
# https://github.com/jkrug/TOXID-cURL
#
#

What it is
#########################
1) Renders CMS-pages and Navigation in OXID from any XML-Source

2) adjusts link-urls from source


What it is NOT
#########################
1) NO Single-Sign-On (so no restriced pages are possible)
   See TOXID with OxAPI

2) NO out-of-the-box solution


Installation / Config
#########################

1) copy files from "eshop" to your shop

#####
2) Add autloader to modules/functions.php

	require_once('toxid_curl/toxid_curl_autoloader.php');


#####
3) OXID eShop from Version 4.6
	Activate module in admin

   OXID eShop Version < 4.6
	Add the following module-entries in your configuration

	oxseodecoder => toxid_curl/core/toxid_curl_oxseodecoder
	oxviewconfig => toxid_curl/core/toxid_curl_oxviewconfig


#####
4) Set up your CMS to deliver the pages in UTF-8 XML-format

	<?xml version="1.0"?>
	<toxid>
		<part1></part1>
		<part2></part2>
	</toxid>

It is STRONGLY recommended to wrap your snippets/parts in CDATA to prevent XML-mistaktes


#####
5) Configure your System in config.inc.php

	// your URL-Snippet to dectect TOXID-Pages
	$this->aToxidCurlSeoSnippets = array(
									'0' => 'toxid-curl',
									'1' => 'toxid-curl-en',
								  );

	// URL to your CMS
	$this->aToxidCurlSource	= array(
								'0' => 'http://yourcmspage.com/',
								'1' => 'http://yourcmspage.com/en/',
							  );
	// Additional Params for URL
	$this->aToxidCurlUrlParams = array(
								'0' => '?type=1',
								'1' => '?type=1',
							  );

    // If actual Site is an SSL-site, replace first URL with second URL (only replaces image-source-attributes)
    $this->aToxidCurlSslPicReplacement = array(
        '0' => array('http://yourcmspage.com/', 'https://yourcmspage.com'),
        '1' => array('http://yourcmspage.com/en/', 'https://yourcmspage.com/en/'),
    );

	// FOR BACKWARDS COMPATABILITY UNCOMENT
	// template variable name, with will be accessible like [{$toxid_curl_cmp->getCmsSnippet('text1')}]
	// $this->sTplVariable = 'toxid_curl_cmp';



#####
6) now you can call your snippets via the component like this

   [{assign var='toxid' value=$oViewConf->getToxid()}]
   [{ $toxid->getCmsSnippet(part1) }]

#####
7) to use search functionality, config.inc.php mus contain search urls:

        // typo3 search url
        $this->aToxidSearchUrl	= array(
            '0' => 'http://www.marmalade.de/nc/suche.html?tx_indexedsearch[sword]=',
            '1' => 'http://www.marmalade.de/nc/suche.html?tx_indexedsearch[sword]=',
        );

    keep in mind, that search keywords will be attached in the end

    and in tpl/search.tpl (if you use basic theme), or tpl/page/search/search.tpl add following code:

    [{assign var='toxid' value=$oViewConf->getToxid()}]
    [{assign var='typo3result' value=$toxid->getSearchResult($oView->getSearchParamForHtml())}]
    [{if $typo3result}]
      <div>
        [{$typo3result}]
      </div>
    [{/if}]

#####
8) Adjust your templates!


What we already implemented
######################################

1) done: Multi-Language-Support
2) done: Caching
3) done: Add products as CMS-Content, rendered by OXID


What will come
###############################
Version 2
4) Configuration via admin-area
5) Demo-Templates