Page History

Sponsorship is one of the most important features of the phpFox platform. Purpose of this tutorial is to provide some guideline for developers who want to integrate this feature with their apps.

Sponsor in app's block

...

Note: replace app with your app's alias

Sponsor methods

phpFox provides 2 sponsor methods: Sponsor without fee and Purchase sponsor.

...

When can_sponsor_app is Yes, user users of that user group can sponsor item without paying fee.
All you have to do in your app is mark item as sponsor by database query and don't forget to add sponsor via function addSponsor() in class Ad_Service_Process.

...

{permalink module='ad.sponsor' id={item-id} section={app}}

Note: replace app with your item app alias and item-id with your item id.

If your app has multiple items, please replace app with app_item (Ex: music_song, music_album, ...)

...

{permalink module='ad.sponsor' id={item-id} section={app_item}}

Callbacks

Belows is all required callbacks when integrating your app with Ad Sponsor.

...

{url link='ad.sponsor' where='feed' section='app' item={item-id}}

Note: replace app with your item app alias and item-id with your item id.

If your app has multiple items, please replace app with app_item (Ex: music_song, music_album, ...)

...

{url link='ad.sponsor' where='feed' section='{app_item}' item={item-id}}

Un-sponsor action

To un-sponsor an item, we usually use ajax call

$.ajaxCall('ad.removeSponsor', 'type_id={app}&item_id=`item-id`', 'GET');

Note: don't forget to replace app/app_item and app-id

Or we can use function deleteSponsor of class Ad_Service_Process.

...

Phpfox::getService('ad.process')->deleteSponsor($iSponsorId, true);

Check sponsored item

To check sponsored item, you can use function canSponsoredInFeed of class Feed_Service_Feed. This function will return true if item is sponsored.

Phpfox::getService('feed')->canSponsoredInFeed({app}, {app-id});

...