Download the PHP package ondrakoupil/heureka-recenze without Composer

On this page you can find all versions of the php package ondrakoupil/heureka-recenze. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of ondrakoupil/heureka-recenze

Informations about the package heureka-recenze

PHP knihovna pro zpracování recenzí z Heuréky

Build Status

Instalace

Nainstalujte knihovnu přes Composer:

Nepoužíváte-li Composer, includujte soubor dist/heureka.php, který obsahuje celou knihovnu pohromadě, anebo libovolným způsobem zajistěte autoloading tříd z adresáře src.

Použití

Knihovna za vás zajistí stažení a parsování XML souborů s exporty recenzí z Heuréky a v případě recenzí produktů je umí sdružit dle jednotlivých produktů a případně pro ně vytvořit souhrnné hodnocení. Co naopak neřeší je ukládání načtených recenzí a integraci s vaším webem / eshopem / aplikací - tuto část si musíte doprogramovat sami.

Jak jistě víte, Heuréka sbírá od vašich zákazníků dva typy recenzí - jednak názory na váš e-shop jako takový, kde se zákazníci mohou vyjádřit k spolehlivosti, komunikaci, dodacím lhůtám, přehlednosti webu apod., a jednak ke konkrétním produktům, které koupili. Heuréka bohužel poskytne jen recenze k objednávkám z vašeho e-shopu, i když daný produkt nakoupilo spousta lidí na jiných e-shopech.

Recenzím e-shopu se věnují třídy EshopReviewsClient a EshopReview, recenzím produktů se věnují ProductReviewsClient, ProductReview a ProductReviewSummary.

Kromě knihovny budete potřebovat ještě tajný klíč, který váš e-shop používá pro komunikaci s Heurékou. Klíč kdyžtak získáte v administraci Heuréky ve svém účtu v sekci Ověřeno zákazníky, podrobnější popis exportu recenzí najdete zde.

Následující příklady neuvádějí celá jména tříd - buď si před ně doplňte namespace OndraKoupil\Heureka, anebo na začátek programu doplňte

Vytvoření klienta

Při instancování třídy klienta lze zadat rovnou tajný klíč, anebo celou adresu (vhodné pro SK Heuréku). U recenzí produktů lze navíc omezit, jak staré recenze chcete (max. 6 měsíců). U recenzí e-shopu tento parametr Heuréka nepodporuje.

Nastavení

Oba klienti interně využívají XmlReader, stažené XML zpracovávají sekvenčně a jsou tedy schopni zprocesovat i velké XML soubory s relativně malými nároky na paměť. K tomu ale potřebují možnost stáhnout si nejprve XML soubor z Heuréky někam do dočasného umístění a odtamtud si je postupně číst. Druhý argument umožňuje nastavit, zda po úspěšném zpracování má být dočasný soubor automaticky smazán (default true).

Dále je třeba implementovat nějakou funkci, která bude načtené recenze zpracovávat. Funkce dostane jako argument objekt třídy EshopReview nebo ProductReview a s ní si může dělat, co chce. Nejspíš recenzi uloží někam do databáze. Obě třídy jsou obyčejné hloupé třídy s public proměnnými (více v jejich dokumentaci) a s metodou getAsArray(), která je kdyžtak převede do podoby obyčejného pole.

Určená funkce se zavolá jednou pro každou recenzi, která je z Heuréky stažena.

Stažení a zpracování souboru

A pak už jen stačí zavolat metodu run(). Klient stáhne soubor a jeho obsah recenzi po recenzi postupně předá dříve definované funkci.

Pokud byste z nějakého důvodu nechtěli soubor rovnou zpracovávat, lze ho pouze stáhnout:

Anebo naopak, pokud již máte soubor stažený, lze klientovi říct, že ho nemá stahovat a místo toho použít zadaný soubor:

Recenze produktů

U recenzí produktů může být užitečné je sdružovat podle jednotlivých produktů, kterých se týkají, případně vás může zajímat jen souhrnné hodnocení a ne jednotlivé recenze. Heuréka bohužel vyexportuje nesetříděnou hromadu recenzí a o jejich roztřídění se musíte postarat sami. Knihovna vám s tím pomůže a data z XML souboru přelouská do podoby přehledných výsledků v objektech třídy ProductReviewSummary.

První zádrhel bude, že v exportu z Heuréky nenajdete žádný jednoznačný identifikátor produktu (alespoň ne nyní), i když ve vašem feedu máte uvedeno . To celou věc trochu komplikuje. Nejprve je tedy třeba implementovat nějakou funkci, která převádí dostupná data na jednoznačné ID ve vašem e-shopu. ID může být číslo nebo řetězec, zkrátka libovolná skalární hodnota. V tomto příkladu prostě předpokládám, že každý produkt má právě jednu URL, která je vždy jedinečná a stejná. Pro stejné produkty se definovaná funkce spustí jen jednou.

Pokud funkci nenastavíte, nic se neděje, jen nebude možné používat proměnnou $productId v objektech ProductReview a žádné z níže uvedených funkcí.

Dále si můžete nastavit, zda chcete nebo nechcete zpracovávat souhrnné informace o produktech. Pokud to neuděláte, funkce pracující s ProductReviewSummary budou vracet null nebo prázdné pole.

Druhý argument říká, zda chcete ukládat pro pozdější použítí úplně všechny recenze (u větších feedů to může být dost náročné na paměť). Pokud ho dáte false (nebo vynecháte úplně), tak budou mít poskytované objekty ProductReviewSummary v proměnné $reviews vždy jen prázdné pole. Recenze si můžete tak jako tak postupně poukládat ve funkci definované přes setCallback().

Poté lze klasicky spustit run() a využít různé metody vracející souhrnná data.

Samozřejmě, celou taškařici okolo ProductReviewSummary můžete ignorovat a jen načtené recenze dál zpracovat pomocí funkce definované v setCallback().

Problémy?

Pokud jste narazili na bug, něco nefunguje nebo máte návrh na zlepšení, přidejte issue nebo mě bez obav kontaktujte napřímo :-)

All versions of heureka-recenze with dependencies

PHP Build Version
Package Version
Requires ext-curl Version *
php Version >=5.3.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ondrakoupil/heureka-recenze contains the following files

Loading the files please wait ....