Jeśli Wasza strona oparta jest o WordPress – skorzystaj z pluginu WordPress FaniMani

Do czego służy skrypt?

Skrypt PHP służy do integracji integracji strony organizacji z programem FaniSEO. 

Skrypt ma następujące funkcje:

• łączy się z systemem fanimani.pl i pobiera aktualne linki do wyświetlanie na stronie,
• wyświetla na stronie aktualne linki sformatowane wg ustawień dostępnych w skrypcie

Korzystając z tego skryptu linki faniseo można zamieścić np. w stopce strony, albo w pasku bocznym (sidebar). 

Ważne jest, aby w efekcie linki wyświetlały się na wszystkich podstronach organizacji.

Pobieranie linków, wydajność 

Pobranie aktualnych linków dla danej strony następuje poprzez wywołanie na danej stronie parametru fanimaniFaniAction=fanimaniFaniSEOUpdate np. organizacja.org/?fanimaniFaniAction=fanimaniFaniSEOUpdate 

Po wywołaniu tego parametru skrypt łączy się z serwerem fanimani.pl i pobiera aktualne linki, a następnie zapisuje je w lokalnym pliku json na serwerze. 

Operacja pobrania aktualnych linków jest raz dziennie (w nocy) wywoływana przez system fanimani obsługujący program FaniSEO.

Dopóki ww. parametr nie zostanie wywołany – skrypt pełni tylko funkcję wyświetlania danych z lokalnego pliku json.

Wymagania

• Klucz Beneficjenta pobrany ze strony FaniMani.pl (Ustawienia > Użytkownicy i dostęp > Klucz dostępu dla aplikacji:)
• PHP 5.6+
• prawa zapisu dla pliku tekstowego z listą linków i ew. komunikatami błędów
• Kilkadziesiąt kb wolnego miejsca na plik tekstowy z listą linków i ew. komunikatami błędów

Instalacja

• Pobierz plik skryptu faniseo.php i umieć go w katalogu ze swoją stroną/projektem.
• Dołącz skrypt do swojej strony przez include/require

Wywołaj funkcję fanimaniFaniSEO() z odpowiednimi parametrami w miejscu, gdzie chcesz wyświetlać sekcję linków na swojej stronie. Pamiętaj, że linki muszą być wyświetlane na wszystkich podstronach.

Aktualną wersję skryptu PHP FaniSEO znajdziesz na: https://bitbucket.org/fanidevteam/faniseo-php/src/master/

Korzystanie ze skryptu FaniSEO

Aby automatycznie dodać linki na stronę, wywołaj funkcję fanimaniFaniSEO() z odpowiednimi parametrami

<?php
    require_once('./faniseo.php');
    fanimaniFaniSEO(
        array(
            'key' => 'XYZ'
            'title' => 'Wspierają nas:'
            'color' => '#ff0000',
            'background' => '#ffff00',
            'mode’ => 'inline'
        )
    );
?>

Parametry

nazwa	wymagane	opis	akceptowane wartości	domyślna wartość
key	tak	Klucz Beneficjenta	(string) 22-znakowy Klucz	brak
title	nie	Tytuł sekcji	(string) Własny tytuł	’Nasi darczyńcy’
color	nie	Kolor linków w sekcji	(string) Hex z kolorem	’#ffffff’
background	nie	Kolor tła sekcji	(string) Hex z kolorem	’#000000′
mode	nie	Forma wyświetlania linków: ostylowane linki jeden po drugim lub lista linków w formie <ul> bez stylowania	(string) 'inline’ / 'plain-ul’	’inline’
echo	nie	Forma zwracania treści sekcji: echo lub return	(bool) true / false	true
debug	nie	Debugowanie błędów	(bool) true / false	false

Przykłady

Wyświetlenie sekcji w formie nieostylowanej listy

<?php
      require_once('./faniseo.php');
      $linki_faniseo = fanimaniFaniSEO(
            array(
                  'key' => 'XYZ',
                  'mode' => 'plain-ul'
            )
      );
?>

Zwracanie całej sekcji w formie stringa zamiast automatycznego echo

<?php
     require_once('./faniseo.php');
     $linki_faniseo = fanimaniFaniSEO(
          array(
               'key' => 'XYZ',
               'echo' => false
          )
     );
// ... własny kod ...
echo $linki_faniseo;
?>

Debugowanie problemów:

Komunikaty błędów zapisywane są w pliku faniseo_debug_[KEY].json

Zawartość pliku z debugiem wraz z obecną konfiguracją skryptu można wywołać ?fanimaniFaniAction=fanimaniFaniSEODebug

Aby włączyć zapisywanie błędów dodaj parametr debug => true

<?php
     require_once('./faniseo.php');
     fanimaniFaniSEO(
          array(
               'key' => 'XYZ', // Unikalny klucz Beneficjenta
               'debug' => true, // domyślnie: false
          )
     );
?>

Ręczne odświeżenie linków

Aby ręcznie pobrać najnowsze linki z akcji FaniSEO dla swojej witryny, wywołaj stronę z parametrem ?fanimaniFaniAction=fanimaniFaniSEOUpdate, np. https://fanimani.pl/dobrezakupy/?fanimaniFaniAction=fanimaniFaniSEOUpdate

Jeśli masz pytania dotyczące skryptu FaniSEO wyślij wiadomość