.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Elements;
use Fisharebest\Webtrees\I18N;
use function strtoupper;
/**
* RESTRICTION_NOTICE := {Size=6:7}
* [confidential | locked | privacy ]
* The restriction notice is defined for Ancestral File usage. Ancestral File
* download GEDCOM files may contain this data.
* Where:
* confidential = This data was marked as confidential by the user. In some systems data marked as
* confidential will be treated differently, for example, there might be an option
* that would stop confidential data from appearing on printed reports or would
* prevent that information from being exported.
* locked = Some records in Ancestral File have been satisfactorily proven by evidence, but
* because of source conflicts or incorrect traditions, there are repeated attempts
* to change this record. By arrangement, the Ancestral File Custodian can lock a
* record so that it cannot be changed without an agreement from the person assigned
* as the steward of such a record. The assigned steward is either the submitter
* listed for the record or Family History Support when no submitter is listed.
* privacy = Indicate that information concerning this record is not present due to rights of
* or an approved request for privacy. For example, data from requested downloads of
* the Ancestral File may have individuals marked with ‘privacy’ if they are assumed
* living, that is they were born within the last 110 years and there isn’t a death
* date. In certain cases family records may also be marked with the RESN tag of
* privacy if either individual acting in the role of HUSB or WIFE is assumed living.
*/
class RestrictionNotice extends AbstractElement
{
public const VALUE_NONE = 'NONE';
public const VALUE_PRIVACY = 'PRIVACY';
public const VALUE_CONFIDENTIAL = 'CONFIDENTIAL';
public const VALUE_LOCKED = 'LOCKED';
private const CANONICAL = [
// Store the locked value after the privacy value.
self::VALUE_LOCKED . ', ' . self::VALUE_NONE => self::VALUE_NONE . ', ' . self::VALUE_LOCKED,
self::VALUE_LOCKED . ', ' . self::VALUE_PRIVACY => self::VALUE_PRIVACY . ', ' . self::VALUE_LOCKED,
self::VALUE_LOCKED . ', ' . self::VALUE_CONFIDENTIAL => self::VALUE_CONFIDENTIAL . ', ' . self::VALUE_LOCKED,
// Old versions of Legacy
'invisible' => self::VALUE_PRIVACY,
];
private const ICON_CONFIDENTIAL = '';
private const ICON_LOCKED = ' ';
private const ICON_NONE = '';
private const ICON_PRIVACY = '';
/**
* Convert a value to a canonical form.
*
* @param string $value
*
* @return string
*/
public function canonical(string $value): string
{
$value = strtoupper(parent::canonical($value));
$value = trim($value, ', ');
$value = preg_replace('/[, ]+/', ', ', $value);
return self::CANONICAL[$value] ?? $value;
}
/**
* A list of controlled values for this element
*
* @return array
*/
public function values(): array
{
// Note: "1 RESN none" is not valid gedcom.
// However, webtrees privacy rules will interpret it as "show an otherwise private record to public".
$confidential = I18N::translate('Show to managers');
$locked = I18N::translate('Only managers can edit');
$none = I18N::translate('Show to visitors');
$privacy = I18N::translate('Show to members');
return [
'' => '',
self::VALUE_NONE => self::ICON_NONE . ' ' . $none,
self::VALUE_NONE . ', ' . self::VALUE_LOCKED => self::ICON_NONE . self::ICON_LOCKED . ' ' . $none . ' — ' . $locked,
self::VALUE_PRIVACY => self::ICON_PRIVACY . ' ' . $privacy,
self::VALUE_PRIVACY . ', ' . self::VALUE_LOCKED => self::ICON_PRIVACY . self::ICON_LOCKED . ' ' . $privacy . ' — ' . $locked,
self::VALUE_CONFIDENTIAL => self::ICON_CONFIDENTIAL . ' ' . $confidential,
self::VALUE_CONFIDENTIAL . ', ' . self::VALUE_LOCKED => self::ICON_CONFIDENTIAL . ' ' . self::ICON_LOCKED . ' ' . $confidential . ' — ' . $locked,
self::VALUE_LOCKED => self::ICON_LOCKED . ' ' . $locked,
];
}
}