Indice

PBLA: PHP BlogLines API

PBLA contiene las siguientes funciones:

PBLA_Listsubs
PBLA_Update
PBLA_Getitems
PBLA_ListFolders
PBLA_ItemsInFolder
PBLA_Blogroll

PBLA_Listsubs

Llama a la función listsub de la API de Bloglines

array PBLA_Listsubs(string user, string pass)

Parámetros:

user: dirección de correo del usuario al que corresponde la cuenta de Bloglines
pass: contraseña de bloglines de ese usuario

Detalles:

Devuelve un array con el arbol del documento con la siguiente estructura:

Array
(
    [TITLE] => Bloglines Subscriptions
    [DATECREATED] => Wed, 07 Dec 2005 17:15:56 GMT
    [OWNERNAME] => owner@name.com
    [content] => Array
        (
            [0] => Array
                (
                    [TITLE] => Title
                    [HTMLURL] => http://foo.com/bar
                    [TYPE] => rss
                    [XMLURL] => http://foo.com/bar/rss
                    [BLOGLINESSUBID] => 1111111
                    [BLOGLINESUNREAD] => 0
                    [BLOGLINESIGNORE] => 0
                )

            [1] => Array
                (
                    [TITLE] => Folder Name
                    [BLOGLINESSUBID] => 2213453
                    [BLOGLINESIGNORE] => 0
                    [content] => Array
                        (
                            [0] => Array
                                (
                                    [TITLE] => Title 2
                                    [HTMLURL] =>http://toofoo.com/bar
                                    [TYPE] => rss
                                    [XMLURL] => http://foo.com/bar/rss
                                    [BLOGLINESSUBID] => 1234234
                                    [BLOGLINESUNREAD] => 0
                                    [BLOGLINESIGNORE] => 0
                                )

							[1] => Array
								(
									...
								)

						)

					[unread] => 0
				)
			[2] => Array
				(
					...
				)
		)
	[unread] => 0
)

Los campos [DATECREATED], [OWNERNAME], [TITLE], [HTMLURL], [TYPE], [XMLURL], [BLOGLINESSUBID], [BLOGLINESUNREAD] y [BLOGLINESIGNORE] se corresponden con los descritos en la API de bloglines (ver abajo).

[content] contiene las subscripciones de una carpeta determinada (o de la Raiz, en su caso).

[unread] contiene el número de mensajes sin leer de esa carpeta (o el total, si es en la raiz)

Si la función falla, devolverá un string con un código de tres dígitos: 000 si es un error de conexión, y 401 si user o pass son incorrectos.

Info de la API:

http://www.bloglines.com/services/api/listsubs

PBLA_Update

Llama a la función update de la API de Bloglines

array PBLA_Update(string user)

Parámetros:

user: Dirección de correo del usuario al que corresponde la cuenta de Bloglines

Detalles:

Retorna un array con dos posiciones:

La primera contiene el número de entradas sin leer (o -1 si la dirección de correo está equivocada).

La segunda no contiene nada, se reserva para indicar una URI de actualización (Ver información de la API).

Si la conexión falla, devolverá un string con el código 000.

Info de la API aquí:

http://www.bloglines.com/services/api/notifier

PBLA_Getitems

Llama a la función getitems de la API de Bloglines

string PBLA_Getitems(string user, string pass,string id, array options)

Parámetros:

user: Dirección de correo del usuario al que corresponde la cuenta de Bloglines.
pass: contraseña de bloglines de ese usuario.
id: Identificador de bloglines (BLOGLINESSUBID) de la carpeta o subscripción de la que se quieren obtener los mensajes (Poner a 0 para que sean todos los subscritos).
options: es un array asociativo con los siguente elementos:
- mark_reads: Si se pone a 1, marcará los mensajes recogidos como leídos
- date: Fecha en formato timestamp a partir de la que se quieren recoger los mensajes (si se omite, se obtienen todos los no leídos).

Detalles:

Retorna un archivo RSS2 con el contenido solicitado.

Si la función falla, devolverá un string con un código de tres dígitos: 000 si es un error de conexión, y el código de status HTTP si es un error en el servidor de Bloglines (Ver información de la API).

Info de la API:

http://www.bloglines.com/services/api/getitems

PBLA_ListFolders

Retorna un array con las carpetas de una suscripción

array PBLA_ListFolders(array listsubs)

Parámetros:

listsubs: array resultado de la función Listsubs()

Detalles:

Retorna un array con todas las carpetas de la subscripción.

Los elementos [TITLE], [BLOGLINESSUBID] y [BLOGLINESIGNORE] se corresponden con los descritos en la API de bloglines (ver abajo).

El campo [content] contiene el número de subscripciones de una carpeta determinada. [unread] contiene el número de mensajes sin leer de esa carpeta.

Info de la API:

http://www.bloglines.com/services/api/listsubs

PBLA_ItemsInFolder

Retorna las suscripciones de una carpeta.

array PBLA_ItemsInFolder(array Listsubs, string folderid)

Parámetros:

listsubs: array resultado de Listsubs()
folderid: Id de Bloglines (BLOGLINESSUBID) de la carpeta de la que se quieren obtener los elementos. Si es una cadena vacía, dará los correspondientes a la raiz (lo que no estén en ninguna carpeta), si contiene la cadena 'all' retornará todos los elementos de todas las carpetas.

Detalles:

Retorna un array de elemetos subscritos con este formato:

Array
(
    [0] => Array
        (
            [TITLE] => Title 1
            [HTMLURL] => http://foo.com/bar
            [TYPE] => rss
            [XMLURL] => http://foo.com/bar/rss
            [BLOGLINESSUBID] => 11111111
            [BLOGLINESUNREAD] => 0
            [BLOGLINESIGNORE] => 0
            [folder] => 
        )

    [1] => Array
        (
            [TITLE] => Title 2
            [HTMLURL] => http://toofoo.com/bar
            [TYPE] => rss
            [XMLURL] => http://toofoo.com/bar/rss
            [BLOGLINESSUBID] => 12234355
            [BLOGLINESUNREAD] => 0
            [BLOGLINESIGNORE] => 0
            [folder] => Folder Name
        )
	...
)

Los elementos [TITLE], [HTMLURL], [TYPE], [XMLURL], [BLOGLINESSUBID], [BLOGLINESUNREAD], [BLOGLINESIGNORE] se corresponden con los descritos en la API "listsubs" de bloglines (ver abajo).

En [folder] está el nombre de la carpeta que contiene a la subscripción. Si esta está en la raiz, [folder] estará vacío.

Info de la API:

http://www.bloglines.com/services/api/listsubs

PBLA_Blogroll

Genera autoáticamente un Blogroll (listado de enlaces) odernado por carpetas.

string PBLA_Blogroll(array listsubs,array folders_ignore, array options)

Parámetros:

listsubs: array resultado de Listsubs()
folders_ignore: array con los nombres de las carpetas que NO quieren mostrarse. Si $folders_ignore no se inicia, se mostrarán todas las carpetas.
options: array asociativo con los siguientes elementos:
- unreads: Si se pone a 1, mostrará las entradas no leídas de cada elemento
- rsslink: Si se pone a 1, mostrará un enlace a la fuente RSS del elemento subscrito

Detalles:

Retorna un blogroll con este formato básico:

<div class="pblamain">
<div class="pblaitem"><a href="http://foo.com/bar">Title</a></div>
<div class="pblafolder">
<div class="pblatitle">Folder Name</div>
<div class="pblaitem"><a href="http://too.foo.com/bar">Title 1</a></div>
</div>
</div>

si se ha asignado el valor 1 a rsslink se mostrarán los enlaces a las fuentes rss de este modo:

Retorna un blogroll con este formato básico:

<div class="pblamain">
<div class="pblaitem"><a href="http://foo.com/bar">Title</a> <a class="pblarsslink" href="http://too.foo.com/bar/rss">RSS</a></div>
<div class="pblafolder">
<div class="pblatitle">Folder Name</div>
<div class="pblaitem"><a href="http://too.foo.com/bar">Title 1</a> <a class="pblarsslink" href="http://too.foo.com/bar/rss">RSS</a></div>
</div>
</div>

Pueden usarse las clases "pblamain", "pblafolder", "pblaitem" y "pblarsslink" para asignar estilos a los diferentes elementos mediante CSS.

NOTA: Este blogroll no usa el script blogroll de Bloglines (que dicho sea de paso, tiene un código horrible). Se pantea como una alternativa más adaptable.