/wplib-olm-juicer

A Juicer module for WPLib

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

WPLib Juicer Module

Scrutinizer Code Quality Code Coverage Build Status Waffle.io - Columns and their card count

This is a WPLib module for Juicer, a social media aggregation service.

Including in your project

Usage

The simplest way to use this module is to simply use the Juicer::get_feed( $args ) method. The parameter for this method should always include the feed name. All other parameters are optional:

$feed = Juicer::get_feed( array(
   'feed'        => 'myFeedName',
   'per'         => 10,
   'page'        => 1,
   'filter'      => 'Facebook',
   'starting_at' => '2017-01-01',
   'ending_at'   => '2017-01-07',
) );

The above method will return a Feed object.

Objects

The following objects are exposed by this module:

Feed

The feed object contains all information available about the feed.

Properties

There are no publicly accessible properties.

Methods

All of the properties exposed by the Juicer API can be accessed using the corresponding method. For example, to get the last_synced value you may simply call $feed->last_synced();.