publisher/publisher

Library to publish multiple entries (all at once).

0.9.1 2017-04-19 15:11 UTC

Requires

• php: >=7.0.0
• symfony/http-foundation: ^3.1

Requires (Dev)

• phpunit/phpunit: ^5.7

Suggests

• publisher/entry_facebook: Adds entries for posting on Facebook.
• publisher/entry_twitter: Adds entries for posting on Twitter.
• publisher/entry_xing: Adds entries for posting on XING.
• publisher/mode_recommendation: Adds mode for publishing.

MIT

• Jacqueline Lueken

• oauth
• publish
• post
• publisher

README

Publish / post via OAuth1 and OAuth2 services.

Publisher offers classes and interfaces that allow you to post several entries at once.

Main components

• Entry
  • EntryInterface and AbstractEntry as an abstraction of entries in a social network
• Mode
  • a strategy of filling an Entry with content
• Selector
  • helps you to collect all parameters that the entry requires (e.g. a forum id if you want to post in a forum)
• Publisher
  • manages postings of multiple entries at once

Installation

The recommended way to install this is through composer.

Edit your composer.json and add:

{
    "require": {
        "publisher/publisher": "dev-master"
    }
}

And install dependencies:

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar install

Suggestions

• Entry
  • publisher/entry_facebook -> adds entries for posting on Facebook
  • publisher/entry_twitter -> adds entries for posting on Twitter
  • publisher/entry_xing -> adds entries for posting on XING
• Mode
  • publisher/mode_recommendation -> adds mode for publishing

Examples

Examples of basic usage are located in the examples/ directory.

Development

Package structure (namespaces)

Szenario: A Service (e.g. social network) called 'Foo' offers to post a status and to post in groups that the user is a member of.

FooEntry:

• Selector
  • FooGroupSelector.php
• FooUserEntry.php
• FooGroupEntry.php

Then we have a mode called 'Recommendation'. It provides the content generation

Recommendation

• Resources
  • config
    • validation.yml
  • views
    • recommendation.html.twig
• src
  • AbstractRecommendation.php
  • Form
    • Type RecommendationType.php

Modes should provide a Form and an base Entity for mapping and for validation. Entries that implement a Mode should implement the abstract entity given by the Mode.

FooRecommendation

• Resources
  • config
    • validation.yml
• src
  • FooUserRecommendation.php
  • FooGroupRecommendation.php

Please refer to the following repositories for examples:

• Entry
  • publisher/entry_facebook
  • publisher/entry_twitter
  • publisher/entry_xing
• Mode
  • publisher/mode_recommendation
• Entity
  • publisher/entity_facebook_recommendation
  • publisher/entity_twitter_recommendation
  • publisher/entity_xing_recommendation

Naming Conventions

• EntyNamespace: Publisher\Entry\ServiceId

• EntryClassName: ServiceId(User|Page|Group|Forum)Entry

• SelectorNamespace: Publisher\Entry\ServiceId\Selector

• SelectorClassName: ServiceId(User|Page|Group|Forum)Selector

The Selector should be matching with the id of the Entry that it belongs to. If their is no Selector needed, then their is no need to implement one. But you should add the 'Selector' directory nonetheless.

• ModeNamespace: Publisher\Mode\ModeId
• ModeClass: ModeIdMode

Then we have the EntryModeEntities. The implement an base mode entity like AbstractRecommendation for a specific entry type of a service.

• EntityNamespace: Publisher\Entry\ServiceId\Mode\ModeId\
• EntityClass: EntryIdModeId

It is recommended to follow these conventions. In this way you can rely on the already implemented Supervisor to find the Entries and Modes, when the EntryHelper requires them.