thuecat/Classes/Domain/Import/Entity/Base.php

202 lines
4.2 KiB
PHP
Raw Normal View History

<?php
declare(strict_types=1);
/*
* Copyright (C) 2021 Daniel Siepmann <coding@daniel-siepmann.de>
*
* 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.
*/
namespace WerkraumMedia\ThueCat\Domain\Import\Entity;
use WerkraumMedia\ThueCat\Domain\Import\Entity\Properties\ForeignReference;
class Base
{
/**
* URL to the original source at ThüCAT.
* Not unique within our system. We have one entity per language,
* while ThüCAT has a single entity containing all languages.
*
* @var string
*/
protected $id = '';
/**
* Short name of the thing.
* Can be translated.
*
* @var string
*/
protected $name = '';
/**
* Long text describing the thing.
* Can be translated.
*
* @var string
*/
protected $description = '';
/**
* URL to official version of this thing outside of ThüCAT.
*
* @var string
*/
protected $url = '';
/**
* @var ForeignReference
*/
protected $photo;
/**
* Images of this Thing.
*
* @var ForeignReference[]
*/
protected $images = [];
/**
* The Thing responsible for the data within this Thing.
*
* @var ForeignReference
*/
protected $managedBy;
public function getId(): string
{
return $this->id;
}
public function hasName(): bool
{
return trim($this->name) !== '';
}
public function getName(): string
{
return $this->name;
}
public function getDescription(): string
{
return $this->description;
}
public function getUrl(): string
{
return $this->url;
}
public function getPhoto(): ?ForeignReference
{
return $this->photo;
}
/**
* @return ForeignReference[]
*/
public function getImages(): array
{
return $this->images;
}
public function getManagedBy(): ?ForeignReference
{
return $this->managedBy;
}
/**
* @internal for mapping via Symfony component.
*/
public function setId(string $url): void
{
$this->id = $url;
}
/**
* @internal for mapping via Symfony component.
*/
public function setName(string $name): void
{
$this->name = $name;
}
/**
* @internal for mapping via Symfony component.
*/
public function setDescription(string $description): void
{
$this->description = $description;
}
/**
* @internal for mapping via Symfony component.
*/
public function setUrl(string $url): void
{
$this->url = $url;
}
/**
* @internal for mapping via Symfony component.
*/
public function setPhoto(ForeignReference $photo): void
{
$this->photo = $photo;
}
/**
* @internal for mapping via Symfony component.
* @return ForeignReference[]
*/
public function getImage(): array
{
return $this->images;
}
/**
* @internal for mapping via Symfony component.
*/
public function addImage(ForeignReference $image): void
{
$this->images[] = $image;
}
/**
* @internal for mapping via Symfony component.
*/
public function removeImage(ForeignReference $image): void
{
}
/**
* @internal for mapping via Symfony component.
*/
public function setContentResponsible(ForeignReference $contentResponsible): void
{
$this->managedBy = $contentResponsible;
}
// TODO: Address
// TODO: Offers
// TODO: containedInPlace -> resolve to town, etc.
}