src/Content/Image/Entity/MasonryImage.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2024, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Content\Image\Entity;
  23
  24 use Friendica\BaseEntity;
  25 use Psr\Http\Message\UriInterface;
  26
  27 /**
  28  * @property-read int $uriId
  29  * @property-read UriInterface $url
  30  * @property-read ?UriInterface $preview
  31  * @property-read string $description
  32  * @property-read float $heightRatio
  33  * @property-read float $widthRatio
  34  * @see \Friendica\Content\Image::getHorizontalMasonryHtml()
  35  */
  36 class MasonryImage extends BaseEntity
  37 {
  38         /** @var int */
  39         protected $uriId;
  40         /** @var UriInterface */
  41         protected $url;
  42         /** @var ?UriInterface */
  43         protected $preview;
  44         /** @var string */
  45         protected $description;
  46         /** @var float Ratio of the width of the image relative to the total width of the images on the row */
  47         protected $widthRatio;
  48         /** @var float Ratio of the height of the image relative to its width for height allocation */
  49         protected $heightRatio;
  50
  51         public function __construct(int $uriId, UriInterface $url, ?UriInterface $preview, string $description, float $widthRatio, float $heightRatio)
  52         {
  53                 $this->url         = $url;
  54                 $this->uriId       = $uriId;
  55                 $this->preview     = $preview;
  56                 $this->description = $description;
  57                 $this->widthRatio  = $widthRatio;
  58                 $this->heightRatio = $heightRatio;
  59         }
  60 }