gnu-social/src/Entity/Avatar.php

158 lines
4.7 KiB
PHP
Raw Normal View History

<?php
// {{{ License
// This file is part of GNU social - https://www.gnu.org/software/soci
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as publ
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public Li
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
// }}}
namespace App\Entity;
/**
* Entity for user's avatar
*
* @category DB
* @package GNUsocial
*
* @author Zach Copley <zach@status.net>
* @copyright 2010 StatusNet Inc.
* @author Mikael Nordfeldth <mmn@hethane.se>
* @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
* @author Hugo Sales <hugo@fc.up.pt>
* @copyright 2020 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
class Avatar
{
// {{{ Autocode
private int $profile_id;
private ?bool $original;
private int $width;
private int $height;
private string $mediatype;
private ?string $filename;
private DateTime $created;
private DateTime $modified;
public function setProfileId(int $profile_id): self
{
$this->profile_id = $profile_id;
return $this;
}
public function getProfileId(): int
{
return $this->profile_id;
}
public function setOriginal(?bool $original): self
{
$this->original = $original;
return $this;
}
public function getOriginal(): ?bool
{
return $this->original;
}
public function setWidth(int $width): self
{
$this->width = $width;
return $this;
}
public function getWidth(): int
{
return $this->width;
}
public function setHeight(int $height): self
{
$this->height = $height;
return $this;
}
public function getHeight(): int
{
return $this->height;
}
public function setMediatype(string $mediatype): self
{
$this->mediatype = $mediatype;
return $this;
}
public function getMediatype(): string
{
return $this->mediatype;
}
public function setFilename(?string $filename): self
{
$this->filename = $filename;
return $this;
}
public function getFilename(): ?string
{
return $this->filename;
}
public function setCreated(DateTime $created): self
{
$this->created = $created;
return $this;
}
public function getCreated(): DateTime
{
return $this->created;
}
public function setModified(DateTime $modified): self
{
$this->modified = $modified;
return $this;
}
public function getModified(): DateTime
{
return $this->modified;
}
// }}} Autocode
public static function schemaDef(): array
{
return [
'name' => 'avatar',
'fields' => [
'profile_id' => ['type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'],
'original' => ['type' => 'bool', 'default' => false, 'description' => 'uploaded by user or generated?'],
'width' => ['type' => 'int', 'not null' => true, 'description' => 'image width'],
'height' => ['type' => 'int', 'not null' => true, 'description' => 'image height'],
'mediatype' => ['type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'file type'],
'filename' => ['type' => 'varchar', 'length' => 191, 'description' => 'local filename, if local'],
'created' => ['type' => 'datetime', 'not null' => true, 'default' => '0000-00-00 00:00:00', 'description' => 'date this record was created'],
'modified' => ['type' => 'datetime', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
],
'primary key' => ['profile_id', 'width', 'height'],
'unique keys' => [
// 'avatar_filename_key' => array('filename'),
],
'foreign keys' => [
'avatar_profile_id_fkey' => ['profile', ['profile_id' => 'id']],
],
'indexes' => [
'avatar_profile_id_idx' => ['profile_id'],
],
];
Avatar resizing improvements and better code reuse * getOriginal added to Avatar class This is a static function that retrieves the original avatar in a leaner way than Profile->getOriginalAvatar() did (see below). This will throw an Exception if there was none to be found. * getProfileAvatars added to Avatar class This gets all Avatars from a profile and returns them in an array. * newSize added to Avatar class This will scale an original avatar or throw an Exception (originally from Avatar::getOriginal) if one wasn't found. * deleteFromProfile added to Avatar class Deletes all avatars for a Profile. This makes the code much smarter when removing all avatars from a user. Previously only specific, hardcoded (through constants) sizes would be deleted. If you ever changed lib/framework.php then many oddsized avatars would remain with the old method. * Migrated Profile class to new Avatar::getOriginal support Profile class now uses Avatar::getOriginal through its own $this->getOriginalAvatar and thus remains backwards compatible. * Updating stock GNU Social to use Avatar::getOriginal All places where core StatusNet code used the $profile->getOriginalAvatar, it will now useAvatar::getOriginal with proper error handling. * Updated Profile class to use Avatar::newSize When doing setOriginal, the scaling will be done with the new method introduced in this merge. This also edits the _fillAvatar function to avoid adding NULL values to the array (which causes errors when attempting to access array entries as objects). See issue #3478 at http://status.net/open-source/issues/3478
2013-09-30 21:13:37 +01:00
}
}