Simple Flaker v.1.0

Wstęp

Nazywam się Adam Stankiewicz aka sh33run

Niniejsza klasa jest portem Flakerowego API na język PHP.
Starałem się maksymalnie uprościć jej użytkowanie.

Jeśli uprościłem także Twoją pracę dodaj mnie do znajomych na Flakerze lub Blipie.
Chciałbym mieć kontakt z innymi deweloperami.

Licencja

Simple Flaker udostępniony jest na licencji BJTW.
Niemniej miło będzie jak powiadomisz mnieo użyciu w swoim projekcie.

Instalacja

Należy pobrać plik SimpleFlaker.php zawierający naszą klasę
Przenieść go do folderu naszego skryptu
Dołączyć go instrukcją:
```
include 'SimpleFlaker.php';
```
Oraz utworzyć nowy obiekt klasy:
```
$flaker = new SimpleFlaker();
```
Można też od razu podać nazwę użytkownika i hasło:
```
$flaker = new SimpleFlaker('użytkownik', 'hasło');
```

Uwagi początkowe

Jeśli metodę tej klasy chcemy wywołać bez argumentów, można pobrać ją jak zmienną:

foreach($flaker->bookmarks as $id) {
  // Do something
}

Możemy ustawić parametry domyślne dla każdego zapytania. Mają one jednak niższy priorytet niż podane w samm wywołaniu funkcji. Przykładowo:

$flaker = new SimpleFlaker();
$flaker->limit = 5;
$flaker->source = 'flaker';

// Pobranie ostatnich 5 wpisów z flakosfery
$entries = $flaker->flakosfera;

// Pobranie ostatnich 7 wpisów z flakosfery
$entries = $flaker->flakosfera(array('limit' => 7));

Dostępne zmienne:

limit - domyślna ilość pobieranych wpisów
login - domyślny login powiązany z pobieranymi wpisami
from - domyślna liczba rekordów pominiętych od początku wyniku
start - domyślne id wpisu od którego chcemy rozpocząć pobieranie
sort - domyślny roczaj sortowania (asc|desc)
avatars - wielkość pobieranych avatarów (small|medium|big)
comments - czy pobierać także komentarze? (true/false)
source - domyślne źródło z którego pobierane będą wpisy
tag - domyślnie zwracaj tylko wpisy zawierający ten tag

Przykłady

$flaker = new SimpleFlaker();
$flaker->login = 'sh33run';
$flaker->source = 'rss';
$flaker->sort = 'asc';
$flaker->from = 40;

Dostępne metody:

send($message, [$picture]) - wysyła Flaka o danej treści. Opcjonalnie załącza obrazek *

flakosfera($limit, [$options]) - pobiera daną liczę flaków z flakosfery
user($username, [$options]) - pobiera wpisy danego użytkownika
friends($username, [$options]) - pobiera wpisy przyjaciół danego użytkownika
tags($username, [$options]) - pobiera wpisy z obserwowanymi tagami użytkownika
source($source, [$options]) - pobiera wpisy z danego źródła
show($id, [$options]) - pobiera wpis o podanym $id
story($id, [$options]) - pobiera wpisy historyjki o podanym $id
search($query, [$options]) - wyszukuje wpisy z podaną frazą $query
traker($url, [$options]) - pobiera wpisy trakera na dany $url
tag($tag, [$options]) - pobiera wpisy zawierające dany tag

bookmark($action, $id) - dodaje (set) lub usuwa (unset) bookmark o danym $id
bookmarks([$username]) - pobiera listę zakładek użytkownika *
following([$username]) - pubiera listę obserwowanych przez użytkownika
followedby([$username]) - pubiera listę obserwujących użytkownika

* - wymaga autoryzacji

Większość powyższych metod zawiera argument $options. Można w nim podać tablicę nadpisującą domyślne opcje.

Przykłady

$flaker = new SimpleFlaker('jan', 'pass');
$flaker->limit = 10;
$flaker->story = 31337;

// Pobranie ostatnich 10 flaków użytkownika sh33run
$entries = $flaker->user('sh33run');

// Od tąd wpisy będą pobierane z komentarzami
$flaker->comments = 'true';

// Pobranie 10 ostatnich wpisów z historyjki 31337
$entries = $flaker->story();

// Wypisanie wszystkich obserwujących @jan
foreach($flaker->followedby as $user) {
	echo $user . "\n";
}

// Wyświetlenie wpisu o id = 666 z dużym avatarem
print_r($flaker->entry(666, array(
	'avatar' => 'big'
)));

// Dodanie zakładki na wpis o id = 31337
$flaker->bookmark('set', 31337);

// Oraz jej usunięcie
$flaker->bookmark('unset', 31337);

// Pobranie 5 ostatnich wpisów z Flakosfery, bez komentarzy
$entries = $flaker->flakosfera(5, array(
	'comments' => 'false'
));

Uwagi końcowe

Arkusz stylów został zaczerpnięty z blipowego API

Enjoy..