README Plugin Sledování TV

Plugin je navržen tak, aby se co nejlépe přizpůsobil Vašemu webu. Obsah je responzivní a přizpůsobuje se šířce okna i šířce obsahu stránky.
pro zpřístupnění všech funkcí pluginu doporučujeme vložit knihovnu jQuery (libovolné verze)

Plugin můžete na Váš web vložit několika způsoby:

Data o službách jsou stahována ze serveru sledovanitv.cz a jsou 1 hodinu cachována v adresáři cache-sledovanitv (cachování lze vypnout).

Plugin je lokalizován v češtině a slovenštině.

Změny ve verzích

Plugin pro Wordpress

Instalace

  1. V administraci Wordpress nahrajte archiv s pluginem.
  2. V administraci aktivujte plugin SledovaniTV
  3. V administraci > Nastavení > SledovaniTV si nastavte Váš identifikátor partnera, lokalizaci a určete, zda mají být data o službách cachována
  4. Pro správné zobrazení stránky zajistěte vložení knihovny jQuery (libovolné verze)

Použití

Obsah můžete vkládat do stránek pomocí shortcode značek:

  • [sledovanitv/] - vložení celé šablony bez vlastních úprav obsahu (s informací o Sledování TV a výpisem všech služeb nabízených partnerem)

Pokud si potřebujete obsah přizpůsobit, můžete vkládat obsah po částech:

  • [sledovanitv part="aboutTV"/] - informace o službě Sledování TV
  • [sledovanitv part="aboutTV"] vlastní html obsah [/sledovanitv] - informace o službě Sledování TV + další vlastní html obsah
  • [sledovanitv part="devices"/] - obrázky podporovaných zařízení
  • [sledovanitv part="allowedServices"/] - seznam povolených služeb partnera
    • [sledovanitv part="allowedService" code="kód_služby"/] - vložení konkrétní povolené služby partnera

      pokud chcete zjistit kódy všech dostupných služeb, můžete si je vypsat pomocí [sledovanitv part="servicesList"/]

    • [sledovanitv part="allowedService" code="kód_služby"] vlastní html obsah [/sledovanitv] - vložení konkrétní povolené služby partnera, navíc s vlastním obsahem
  • [sledovanitv part="services" withPrice="true|false"/] - seznam všech služeb z ceníku partnera, které lze objednat

    parametr withPrice je nepovinný a určuje, zda se mají u služeb zobrazovat ceny (dle ceníku partnera) a odkaz "více informací". Ceny jsou defaultně zobrazeny

    • [sledovanitv part="service" code="kód_služby" withPrice="true|false"/] - vložení konkrétní služby z ceníku partnera

      pokud chcete zjistit kódy všech dostupných služeb, můžete si je vypsat pomocí [sledovanitv part="servicesList"/]
      parametr withPrice je nepovinný a určuje, zda se má u služby zobrazovat cena (dle ceníku partnera) a odkaz "více informací". Cena je defaultně zobrazena

    • [sledovanitv part="service" code="kód_služby" withPrice="true|false"] vlastní html obsah [/sledovanitv] - vložení konkrétní služby z ceníku partnera, navíc s vlastním obsahem
  • [sledovanitv part="provider"/] - informace o provozovateli tuto informaci je povinné uvést

Plugin pro Joomla

Instalace

  1. V administraci Joomla nahrajte archiv s pluginem
  2. V administraci aktivujte plugin SledovaniTV
  3. Na stránce pluginu v záložce Konfigurace si nastavte Váš identifikátor partnera, lokalizaci a určete, zda mají být data o službách cachována
  4. Pro správné zobrazení stránky zajistěte vložení knihovny jQuery (libovolné verze)

Použití

Obsah můžete vkládat do stránek pomocí shortcode značek:

  • {sledovanitv/} - vložení celé šablony bez vlastních úprav obsahu (s informací o Sledování TV a výpisem všech služeb nabízených partnerem)

Pokud si potřebujete obsah přizpůsobit, můžete vkládat obsah po částech:

  • {sledovanitv part="aboutTV"/} - informace o službě Sledování TV
  • {sledovanitv part="aboutTV"} vlastní html obsah {/sledovanitv} - informace o službě Sledování TV + další vlastní html obsah
  • {sledovanitv part="devices"/} - obrázky podporovaných zařízení
  • {sledovanitv part="allowedServices"/} - seznam povolených služeb partnera
    • {sledovanitv part="allowedService" code="kód_služby"/} - vložení konkrétní povolené služby partnera

      pokud chcete zjistit kódy všech dostupných služeb, můžete si je vypsat pomocí {sledovanitv part="servicesList"/}

    • {sledovanitv part="allowedService" code="kód_služby"} vlastní html obsah {/sledovanitv} - vložení konkrétní povolené služby partnera, navíc s vlastním obsahem
  • {sledovanitv part="services" withPrice="true|false"/} - seznam všech služeb z ceníku partnera, které lze objednat

    parametr withPrice je nepovinný a určuje, zda se mají u služeb zobrazovat ceny (dle ceníku partnera) a odkaz "více informací". Ceny jsou defaultně zobrazeny

    • {sledovanitv part="service" code="kód_služby" withPrice="true|false"/} - vložení konkrétní služby z ceníku partnera

      pokud chcete zjistit kódy všech dostupných služeb, můžete si je vypsat pomocí {sledovanitv part="servicesList"/}
      parametr withPrice je nepovinný a určuje, zda se má u služby zobrazovat cena (dle ceníku partnera) a odkaz "více informací". Cena je defaultně zobrazena

    • {sledovanitv part="service" code="kód_služby" withPrice="true|false"} vlastní html obsah {/sledovanitv} - vložení konkrétní služby z ceníku partnera, navíc s vlastním obsahem
  • {sledovanitv part="provider"/} - informace o provozovateli tuto informaci je povinné uvést

Plugin v PHP

Instalace

  1. Rozbalte archiv s pluginem do požadovaného umístění (<library_path>)
  2. Do stránky s pluginem mezi tagy <head> vložte:
    • <library_path>/resource/sledovanitv.css - základní styly
    • <library_path>/resource/sledovanitv.js - přizpůsobení obsahu šířce okna i šířce obsahu stránky
  3. Pro správné zobrazení stránky zajistěte vložení knihovny jQuery (libovolné verze)

Použití

Ve Vašem PHP kódu si vytvořte instanci třídy SledovaniTV, nad kterou můžete volat požadované metody pro výpis obsahu:

  • require_once('<library_path>/libs/Sledovanitv.php');
    
    $sledovanitv = new SledovaniTV($partner, $chacheEnabled = true, $localization = SledovanitvLanguages::$cs_CZ);

    argument $partner udává Váš identifikátor partnera (jakým se přihlašujete do API)
    argument $chacheEnabled povoluje nebo zakazuje cachování dat o službách (data se cachují na 24 hodin)
    argument $localization určuje jazyk pluginu a server, ze kterého se mají stahovat data. Validní hodnoty jsou:
         SledovanitvLanguages::$cs_CZ - čeština (sledovanitv.cz)
         SledovanitvLanguages::$sk_SK - slovenština (sledovanietv.sk)

  • Vložení celé šablony bez vlastních úprav obsahu (s informací o Sledování TV a výpisem všech služeb nabízených partnerem)
    $sledovanitv->printAll();

Pokud si potřebujete obsah přizpůsobit, můžete vkládat obsah po částech. K dispozici jsou následující metody:

  • printAboutTV() - informace o službě Sledování TV
  • printAboutTV('vlastní html obsah') - informace o službě Sledování TV + další vlastní html obsah
  • printDevices() - obrázky podporovaných zařízení
  • printServices( $withPrices = true, $servicesContent = array() ) - seznam všech služeb z ceníku partnera, které lze objednat

    argument $withPrices udává, zda se mají ke službám zobrazovat i ceny (dle ceníku partnera) a odkaz "více informací". Ceny jsou defaultně zobrazeny
    argument $servicesContent je pole hodnot ve tvaru $code => 'vlastní html obsah služby', kde $code je kód služby. Specifikovaným službám je pak přidán zadaný html obsah. Pokud chcete zjistit identifikátory všech dostupných služeb, můžete si je vypsat pomocí printServicesList()

    • printService($code, $withPrice = true, $htmlContent = null) - vložení konkrétní služby z ceníku partnera

      argument $code udává kód služby. Pokud chcete zjistit identifikátory všech dostupných služeb, můžete si je vypsat pomocí printServicesList()
      argument $withPrice udává, zda se má zobrazovat i cena služby (dle ceníku partnera) a odkaz "více informací". Cena je defaultně zobrazena
      argument $htmlContent specifikuje další html obsah služby

  • printAllowedServices($servicesContent = array() ) - seznam povolených služeb partnera

    argument $servicesContent je pole hodnot ve tvaru $code => 'vlastní html obsah služby', kde $code je kód služby. Specifikovaným službám je pak přidán zadaný html obsah. Pokud chcete zjistit identifikátory všech dostupných služeb, můžete si je vypsat pomocí printServicesList()

    • printAllowedService($code, $htmlContent = null) - vložení konkrétní povolené služby partnera

      argument $code udává kód služby. Pokud chcete zjistit identifikátory všech dostupných služeb, můžete si je vypsat pomocí printServicesList()
      argument $htmlContent specifikuje další html obsah služby

  • printProvider() - informace o provozovateli tuto informaci je povinné uvést

Změny ve verzích