1
0
Fork 0
mirror of https://github.com/Yetangitu/ampache synced 2025-10-03 09:49:30 +02:00
ampache/modules/plugins/Flattr.plugin.php

105 lines
3.3 KiB
PHP

<?php
/* vim:set softtabstop=4 shiftwidth=4 expandtab: */
/**
*
* LICENSE: GNU General Public License, version 2 (GPLv2)
* Copyright 2001 - 2015 Ampache.org
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License v2
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
class AmpacheFlattr {
public $name = 'Flattr';
public $categories = 'user';
public $description = 'Flattr donation button on user page';
public $url = '';
public $version = '000001';
public $min_ampache = '370034';
public $max_ampache = '999999';
// These are internal settings used by this class, run this->load to
// fill them out
private $user_id;
/**
* Constructor
* This function does nothing...
*/
public function __construct() {
return true;
}
/**
* install
* This is a required plugin function. It inserts our preferences
* into Ampache
*/
public function install() {
// Check and see if it's already installed
if (Preference::exists('flattr_user_id')) { return false; }
Preference::insert('flattr_user_id','Flattr User ID','',25,'string','plugins');
return true;
}
/**
* uninstall
* This is a required plugin function. It removes our preferences from
* the database returning it to its original form
*/
public function uninstall() {
Preference::delete('flattr_user_id');
return true;
}
/**
* upgrade
* This is a recommended plugin function
*/
public function upgrade() {
return true;
}
/**
* display_user_field
* This display the module in user page
*/
public function display_user_field(User $user, library_item $libitem = null) {
$name = ($libitem != null) ? $libitem->get_fullname() : (T_('User') . " `" . $user->fullname . "` " . T_('on') . " " . AmpConfig::get('site_title'));
$link = ($libitem != null && $libitem->link) ? $libitem->link : $user->link;
echo "<a rel='nohtml' href='https://flattr.com/submit/auto?user_id=" . scrub_out($this->user_id) . "&url=" . rawurlencode($link) . "&category=audio&title=" . rawurlencode($name) . "' target='_blank'><img src='//button.flattr.com/flattr-badge-large.png' alt='Flattr this' title='Flattr this' border='0'></a>";
}
/**
* load
* This loads up the data we need into this object, this stuff comes
* from the preferences.
*/
public function load($user) {
$user->set_preferences();
$data = $user->prefs;
$this->user_id = trim($data['flattr_user_id']);
if (!strlen($this->user_id)) {
debug_event($this->name,'No Flattr User ID, user field plugin skipped','3');
return false;
}
return true;
}
}