128 lines
3.2 KiB
PHP
128 lines
3.2 KiB
PHP
<?php
|
|
/**
|
|
* This file is part of Avatar Privacy.
|
|
*
|
|
* Copyright 2018-2023 Peter Putzer.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* ***
|
|
*
|
|
* @package mundschenk-at/avatar-privacy
|
|
* @license http://www.gnu.org/licenses/gpl-2.0.html
|
|
*/
|
|
|
|
namespace Avatar_Privacy\Avatar_Handlers\Default_Icons;
|
|
|
|
use Avatar_Privacy\Avatar_Handlers\Default_Icons\Icon_Provider;
|
|
|
|
/**
|
|
* An abstract implementation of the Default_Icon_Provider interface.
|
|
*
|
|
* @since 1.0.0
|
|
* @since 2.0.0 Moved to Avatar_Privacy\Avatar_Handlers\Default_Icons
|
|
*
|
|
* @author Peter Putzer <github@mundschenk.at>
|
|
*/
|
|
abstract class Abstract_Icon_Provider implements Icon_Provider {
|
|
|
|
/**
|
|
* An array containing valid types as indexes.
|
|
*
|
|
* @var string[]
|
|
*/
|
|
private array $valid_types;
|
|
|
|
/**
|
|
* The primary type (option value).
|
|
*
|
|
* @var string
|
|
*/
|
|
private string $primary_type;
|
|
|
|
/**
|
|
* Creates a new instance.
|
|
*
|
|
* @since 2.0.0 Parameter $name added.
|
|
* @since 2.1.0 Parameter $name removed to allow proper translation loading.
|
|
*
|
|
* @param string[] $types An array of valid types.
|
|
*/
|
|
protected function __construct( array $types ) {
|
|
$this->valid_types = \array_flip( $types );
|
|
$this->primary_type = $types[0];
|
|
}
|
|
|
|
/**
|
|
* Checks if this Default_Icon_Provider handles the given icon type.
|
|
*
|
|
* @param string $type The default icon type.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function provides( $type ) {
|
|
return isset( $this->valid_types[ $type ] );
|
|
}
|
|
|
|
/**
|
|
* Retrieves all icon types handled by the class.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public function get_provided_types() {
|
|
return \array_keys( $this->valid_types );
|
|
}
|
|
|
|
/**
|
|
* Retrieves the default icon.
|
|
*
|
|
* @since 2.7.0 Parameter `$force` added.
|
|
*
|
|
* @param string $identity The identity (mail address) hash.
|
|
* @param int $size The requested size in pixels.
|
|
* @param bool $force Whether the icon cache should be invalidated (if applicable).
|
|
*
|
|
* @return string
|
|
*/
|
|
abstract public function get_icon_url( $identity, $size, bool $force = false );
|
|
|
|
/**
|
|
* Retrieves the option value (the primary provided type).
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_option_value() {
|
|
return $this->primary_type;
|
|
}
|
|
|
|
/**
|
|
* Retrieves the user-visible, translated name. Replacements for existing
|
|
* core default icon styles may return the empty string instead (as does the
|
|
* default implementation).
|
|
*
|
|
* @since 2.0.0
|
|
* @since 2.1.0 Always returns '' to encourage subclasses to do just-in-time translation loading.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_name() {
|
|
return '';
|
|
}
|
|
}
|