jon48 / webtrees-lib

app/Module/Certificates/Http/RequestHandlers/AutoCompleteFile.php

Indentation +42 added lines, -42 removed lines

@@ -31,53 +31,53 @@
  */
 class AutoCompleteFile extends AbstractAutocompleteHandler
 {
-    // Tell the browser to cache the results
-    protected const CACHE_LIFE = 10;
+	// Tell the browser to cache the results
+	protected const CACHE_LIFE = 10;
 
-    private ?CertificatesModule $module;
-    private CertificateFilesystemService $certif_filesystem;
-    private UrlObfuscatorService $url_obfuscator_service;
+	private ?CertificatesModule $module;
+	private CertificateFilesystemService $certif_filesystem;
+	private UrlObfuscatorService $url_obfuscator_service;
 
-    /**
-     * Constructor for AutoCompleteFile Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param CertificateFilesystemService $certif_filesystem
-     * @param UrlObfuscatorService $url_obfuscator_service
-     * @param SearchService $search_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        CertificateFilesystemService $certif_filesystem,
-        UrlObfuscatorService $url_obfuscator_service,
-        SearchService $search_service
-    ) {
-        parent::__construct($search_service);
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-        $this->certif_filesystem = $certif_filesystem;
-        $this->url_obfuscator_service = $url_obfuscator_service;
-    }
+	/**
+	 * Constructor for AutoCompleteFile Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param CertificateFilesystemService $certif_filesystem
+	 * @param UrlObfuscatorService $url_obfuscator_service
+	 * @param SearchService $search_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		CertificateFilesystemService $certif_filesystem,
+		UrlObfuscatorService $url_obfuscator_service,
+		SearchService $search_service
+	) {
+		parent::__construct($search_service);
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+		$this->certif_filesystem = $certif_filesystem;
+		$this->url_obfuscator_service = $url_obfuscator_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Http\RequestHandlers\AbstractAutocompleteHandler::search()
-     */
-    protected function search(ServerRequestInterface $request): Collection
-    {
-        $tree = Validator::attributes($request)->tree();
-        $city = Validator::queryParams($request)->string('cityobf', '');
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Http\RequestHandlers\AbstractAutocompleteHandler::search()
+	 */
+	protected function search(ServerRequestInterface $request): Collection
+	{
+		$tree = Validator::attributes($request)->tree();
+		$city = Validator::queryParams($request)->string('cityobf', '');
 
-        if ($this->module === null || $city === '' || !$this->url_obfuscator_service->tryDeobfuscate($city)) {
-            return collect();
-        }
+		if ($this->module === null || $city === '' || !$this->url_obfuscator_service->tryDeobfuscate($city)) {
+			return collect();
+		}
 
-        $query  =  Validator::attributes($request)->string('query', '');
+		$query  =  Validator::attributes($request)->string('query', '');
 
-        /** @var Collection<int, string> $results */
-        $results =  $this->certif_filesystem
-            ->certificatesForCityContaining($tree, $city, $query)
-            ->map(fn(Certificate $certificate): string => $certificate->filename());
+		/** @var Collection<int, string> $results */
+		$results =  $this->certif_filesystem
+			->certificatesForCityContaining($tree, $city, $query)
+			->map(fn(Certificate $certificate): string => $certificate->filename());
 
-        return $results;
-    }
+		return $results;
+	}
 }

app/Module/Certificates/Http/RequestHandlers/AdminConfigPage.php

Indentation +42 added lines, -42 removed lines

@@ -35,56 +35,56 @@
  */
 class AdminConfigPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?CertificatesModule $module;
-    private TreeService $tree_service;
+	private ?CertificatesModule $module;
+	private TreeService $tree_service;
 
-    /**
-     * Constructor for Admin Config page request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service, TreeService $tree_service)
-    {
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-        $this->tree_service = $tree_service;
-    }
+	/**
+	 * Constructor for Admin Config page request handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service, TreeService $tree_service)
+	{
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+		$this->tree_service = $tree_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $this->layout = 'layouts/administration';
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$this->layout = 'layouts/administration';
 
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $user = Validator::attributes($request)->user();
+		$user = Validator::attributes($request)->user();
 
-        $all_trees = $this->tree_service->all()->filter(fn(Tree $tree) => Auth::isManager($tree, $user));
-        if ($all_trees->count() === 0) {
-            throw new HttpAccessDeniedException();
-        }
+		$all_trees = $this->tree_service->all()->filter(fn(Tree $tree) => Auth::isManager($tree, $user));
+		if ($all_trees->count() === 0) {
+			throw new HttpAccessDeniedException();
+		}
 
-        $tree = Validator::attributes($request)->treeOptional('tree') ?? $all_trees->first();
+		$tree = Validator::attributes($request)->treeOptional('tree') ?? $all_trees->first();
 
-        $data_folder = Registry::filesystem()->dataName();
+		$data_folder = Registry::filesystem()->dataName();
 
-        $same_tree = fn(Tree $tree_collection): bool => $tree->id() === $tree_collection->id();
-        if (!$all_trees->contains($same_tree)) {
-            throw new HttpAccessDeniedException();
-        }
+		$same_tree = fn(Tree $tree_collection): bool => $tree->id() === $tree_collection->id();
+		if (!$all_trees->contains($same_tree)) {
+			throw new HttpAccessDeniedException();
+		}
 
-        return $this->viewResponse($this->module->name() . '::admin/config', [
-            'module_name'       =>  $this->module->name(),
-            'title'             =>  $this->module->title(),
-            'tree'              =>  $tree,
-            'other_trees'       =>  $all_trees->reject($same_tree),
-            'data_folder'       =>  $data_folder
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::admin/config', [
+			'module_name'       =>  $this->module->name(),
+			'title'             =>  $this->module->title(),
+			'tree'              =>  $tree,
+			'other_trees'       =>  $all_trees->reject($same_tree),
+			'data_folder'       =>  $data_folder
+		]);
+	}
 }

app/Module/Certificates/Http/RequestHandlers/CertificateImage.php

Indentation +102 added lines, -102 removed lines

@@ -38,106 +38,106 @@
  */
 class CertificateImage implements RequestHandlerInterface
 {
-    private ?CertificatesModule $module;
-    private CertificateFilesystemService $certif_filesystem;
-    private CertificateImageFactory $certif_image_factory;
-    private CertificateDataService $certif_data_service;
-    private UrlObfuscatorService $url_obfuscator_service;
-
-    /**
-     * Constructor for Certificate Image Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        CertificateFilesystemService $certif_filesystem,
-        CertificateDataService $certif_data_service,
-        UrlObfuscatorService $url_obfuscator_service
-    ) {
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-        $this->certif_filesystem = $certif_filesystem;
-        $this->certif_image_factory = new CertificateImageFactory($this->certif_filesystem);
-        $this->certif_data_service = $certif_data_service;
-        $this->url_obfuscator_service = $url_obfuscator_service;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
-
-        $tree = Validator::attributes($request)->tree();
-        $user = Validator::attributes($request)->user();
-
-        $certif_path = Validator::attributes($request)->string('cid', '');
-        $certificate = null;
-        if ($certif_path !== '' && $this->url_obfuscator_service->tryDeobfuscate($certif_path)) {
-            $certificate = $this->certif_filesystem->certificate($tree, $certif_path);
-        }
-
-        if ($certificate === null) {
-            return $this->certif_image_factory
-                ->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND)
-                ->withHeader('X-Image-Exception', I18N::translate('The certificate was not found in this family tree.'))
-            ;
-        }
-
-        $use_watermark = $this->certif_image_factory->certificateNeedsWatermark($certificate, $user);
-        $watermark = $use_watermark ? $this->watermark($request, $certificate) : null;
-
-        return $this->certif_image_factory->certificateFileResponse(
-            $certificate,
-            $use_watermark,
-            $watermark
-        );
-    }
-
-    /**
-     * Get watermark data for a certificate.
-     *
-     * @param ServerRequestInterface $request
-     * @param Certificate $certificate
-     * @return Watermark
-     */
-    private function watermark(ServerRequestInterface $request, Certificate $certificate): Watermark
-    {
-        $color = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_COLOR', Watermark::DEFAULT_COLOR);
-        $size = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_MAXSIZE');
-        $text = $this->watermarkText($request, $certificate);
-
-        return new Watermark($text, $color, is_numeric($size) ? (int) $size : Watermark::DEFAULT_SIZE);
-    }
-
-    /**
-     * Get the text to be watermarked for a certificate.
-     *
-     * @param ServerRequestInterface $request
-     * @param Certificate $certificate
-     * @return string
-     */
-    private function watermarkText(ServerRequestInterface $request, Certificate $certificate): string
-    {
-        $sid = Validator::queryParams($request)->isXref()->string('sid', '');
-        if ($sid !== '') {
-            $source = Registry::sourceFactory()->make($sid, $certificate->tree());
-        } else {
-            $source = $this->certif_data_service->oneLinkedSource($certificate);
-        }
-
-        if ($source !== null && $source->canShowName()) {
-            $repo = $source->facts(['REPO'])->first();
-            if ($repo !== null && ($repo = $repo->target()) !== null && $repo->canShowName()) {
-                return I18N::translate('© %s - %s', strip_tags($repo->fullName()), strip_tags($source->fullName()));
-            }
-            return strip_tags($source->fullName());
-        }
-        $default_text = $certificate->tree()->getPreference('MAJ_CERTIF_WM_DEFAULT');
-        return $default_text !== '' ? $default_text : I18N::translate('This image is protected under copyright law.');
-    }
+	private ?CertificatesModule $module;
+	private CertificateFilesystemService $certif_filesystem;
+	private CertificateImageFactory $certif_image_factory;
+	private CertificateDataService $certif_data_service;
+	private UrlObfuscatorService $url_obfuscator_service;
+
+	/**
+	 * Constructor for Certificate Image Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		CertificateFilesystemService $certif_filesystem,
+		CertificateDataService $certif_data_service,
+		UrlObfuscatorService $url_obfuscator_service
+	) {
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+		$this->certif_filesystem = $certif_filesystem;
+		$this->certif_image_factory = new CertificateImageFactory($this->certif_filesystem);
+		$this->certif_data_service = $certif_data_service;
+		$this->url_obfuscator_service = $url_obfuscator_service;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
+
+		$tree = Validator::attributes($request)->tree();
+		$user = Validator::attributes($request)->user();
+
+		$certif_path = Validator::attributes($request)->string('cid', '');
+		$certificate = null;
+		if ($certif_path !== '' && $this->url_obfuscator_service->tryDeobfuscate($certif_path)) {
+			$certificate = $this->certif_filesystem->certificate($tree, $certif_path);
+		}
+
+		if ($certificate === null) {
+			return $this->certif_image_factory
+				->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND)
+				->withHeader('X-Image-Exception', I18N::translate('The certificate was not found in this family tree.'))
+			;
+		}
+
+		$use_watermark = $this->certif_image_factory->certificateNeedsWatermark($certificate, $user);
+		$watermark = $use_watermark ? $this->watermark($request, $certificate) : null;
+
+		return $this->certif_image_factory->certificateFileResponse(
+			$certificate,
+			$use_watermark,
+			$watermark
+		);
+	}
+
+	/**
+	 * Get watermark data for a certificate.
+	 *
+	 * @param ServerRequestInterface $request
+	 * @param Certificate $certificate
+	 * @return Watermark
+	 */
+	private function watermark(ServerRequestInterface $request, Certificate $certificate): Watermark
+	{
+		$color = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_COLOR', Watermark::DEFAULT_COLOR);
+		$size = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_MAXSIZE');
+		$text = $this->watermarkText($request, $certificate);
+
+		return new Watermark($text, $color, is_numeric($size) ? (int) $size : Watermark::DEFAULT_SIZE);
+	}
+
+	/**
+	 * Get the text to be watermarked for a certificate.
+	 *
+	 * @param ServerRequestInterface $request
+	 * @param Certificate $certificate
+	 * @return string
+	 */
+	private function watermarkText(ServerRequestInterface $request, Certificate $certificate): string
+	{
+		$sid = Validator::queryParams($request)->isXref()->string('sid', '');
+		if ($sid !== '') {
+			$source = Registry::sourceFactory()->make($sid, $certificate->tree());
+		} else {
+			$source = $this->certif_data_service->oneLinkedSource($certificate);
+		}
+
+		if ($source !== null && $source->canShowName()) {
+			$repo = $source->facts(['REPO'])->first();
+			if ($repo !== null && ($repo = $repo->target()) !== null && $repo->canShowName()) {
+				return I18N::translate('© %s - %s', strip_tags($repo->fullName()), strip_tags($source->fullName()));
+			}
+			return strip_tags($source->fullName());
+		}
+		$default_text = $certificate->tree()->getPreference('MAJ_CERTIF_WM_DEFAULT');
+		return $default_text !== '' ? $default_text : I18N::translate('This image is protected under copyright law.');
+	}
 }

app/Module/Certificates/Http/RequestHandlers/CertificatesList.php

Indentation +50 added lines, -50 removed lines

@@ -32,63 +32,63 @@
  */
 class CertificatesList implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?CertificatesModule $module;
-    private CertificateFilesystemService $certif_filesystem;
-    private UrlObfuscatorService $url_obfuscator_service;
+	private ?CertificatesModule $module;
+	private CertificateFilesystemService $certif_filesystem;
+	private UrlObfuscatorService $url_obfuscator_service;
 
-    /**
-     * Constructor for CertificatesList Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        CertificateFilesystemService $certif_filesystem,
-        UrlObfuscatorService $url_obfuscator_service
-    ) {
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-        $this->certif_filesystem = $certif_filesystem;
-        $this->url_obfuscator_service = $url_obfuscator_service;
-    }
+	/**
+	 * Constructor for CertificatesList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		CertificateFilesystemService $certif_filesystem,
+		UrlObfuscatorService $url_obfuscator_service
+	) {
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+		$this->certif_filesystem = $certif_filesystem;
+		$this->url_obfuscator_service = $url_obfuscator_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $tree = Validator::attributes($request)->tree();
+		$tree = Validator::attributes($request)->tree();
 
-        $title = I18N::translate('Certificates');
+		$title = I18N::translate('Certificates');
 
-        $cities = array_map(function (string $item): array {
-            return [$this->url_obfuscator_service->obfuscate($item), $item];
-        }, $this->certif_filesystem->cities($tree));
+		$cities = array_map(function (string $item): array {
+			return [$this->url_obfuscator_service->obfuscate($item), $item];
+		}, $this->certif_filesystem->cities($tree));
 
-        $city = Validator::queryParams($request)->string(
-            'cityobf',
-            Validator::attributes($request)->string('cityobf', '')
-        );
+		$city = Validator::queryParams($request)->string(
+			'cityobf',
+			Validator::attributes($request)->string('cityobf', '')
+		);
 
-        if ($city !== '' && $this->url_obfuscator_service->tryDeobfuscate($city)) {
-            $title = I18N::translate('Certificates for %s', $city);
-            $certificates = $this->certif_filesystem->certificatesForCity($tree, $city);
-        }
+		if ($city !== '' && $this->url_obfuscator_service->tryDeobfuscate($city)) {
+			$title = I18N::translate('Certificates for %s', $city);
+			$certificates = $this->certif_filesystem->certificatesForCity($tree, $city);
+		}
 
-        return $this->viewResponse($this->module->name() . '::certificates-list', [
-            'title'                     =>  $title,
-            'tree'                      =>  $tree,
-            'module_name'               =>  $this->module->name(),
-            'cities'                    =>  $cities,
-            'selected_city'             =>  $city,
-            'certificates_list'         =>  $certificates ?? collect(),
-            'url_obfuscator_service'    =>  $this->url_obfuscator_service
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::certificates-list', [
+			'title'                     =>  $title,
+			'tree'                      =>  $tree,
+			'module_name'               =>  $this->module->name(),
+			'cities'                    =>  $cities,
+			'selected_city'             =>  $city,
+			'certificates_list'         =>  $certificates ?? collect(),
+			'url_obfuscator_service'    =>  $this->url_obfuscator_service
+		]);
+	}
 }

app/Module/Certificates/Services/CertificateDataService.php

Indentation +132 added lines, -132 removed lines

@@ -28,144 +28,144 @@
  */
 class CertificateDataService
 {
-    /**
-     * Find individuals linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Individual>
-     */
-    public function linkedIndividuals(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('individuals')
-            ->where('i_file', '=', $tree->id())
-            ->where('i_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['individuals.*'])
-            ->get()
-            ->map(Registry::individualFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find individuals linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Individual>
+	 */
+	public function linkedIndividuals(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('individuals')
+			->where('i_file', '=', $tree->id())
+			->where('i_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['individuals.*'])
+			->get()
+			->map(Registry::individualFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Find families linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Family>
-     */
-    public function linkedFamilies(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('families')
-            ->where('f_file', '=', $tree->id())
-            ->where('f_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['families.*'])
-            ->get()
-            ->map(Registry::familyFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find families linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Family>
+	 */
+	public function linkedFamilies(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('families')
+			->where('f_file', '=', $tree->id())
+			->where('f_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['families.*'])
+			->get()
+			->map(Registry::familyFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Find media objects linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Media>
-     */
-    public function linkedMedias(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('media')
-            ->where('m_file', '=', $tree->id())
-            ->where('m_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['media.*'])
-            ->get()
-            ->map(Registry::mediaFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find media objects linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Media>
+	 */
+	public function linkedMedias(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('media')
+			->where('m_file', '=', $tree->id())
+			->where('m_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['media.*'])
+			->get()
+			->map(Registry::mediaFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Find notes linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Note>
-     */
-    public function linkedNotes(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('other')
-            ->where('o_file', '=', $tree->id())
-            ->where('o_type', '=', 'NOTE')
-            ->where('o_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['other.*'])
-            ->get()
-            ->map(Registry::noteFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find notes linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Note>
+	 */
+	public function linkedNotes(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('other')
+			->where('o_file', '=', $tree->id())
+			->where('o_type', '=', 'NOTE')
+			->where('o_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['other.*'])
+			->get()
+			->map(Registry::noteFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Return an escaped string to be used in SQL LIKE comparisons.
-     * This would not work well for Sqlite, if the escape character is not defined.
-     *
-     * @param Certificate $certificate
-     * @return string
-     */
-    protected function escapedSqlPath(Certificate $certificate): string
-    {
-        return str_replace(array('\\', '%', '_'), array('\\\\', '\\%', '\\_'), $certificate->gedcomPath());
-    }
+	/**
+	 * Return an escaped string to be used in SQL LIKE comparisons.
+	 * This would not work well for Sqlite, if the escape character is not defined.
+	 *
+	 * @param Certificate $certificate
+	 * @return string
+	 */
+	protected function escapedSqlPath(Certificate $certificate): string
+	{
+		return str_replace(array('\\', '%', '_'), array('\\\\', '\\%', '\\_'), $certificate->gedcomPath());
+	}
 
-    /**
-     * Find a source linked to a citation where a certificate file is referenced.
-     *
-     * @param Certificate $certificate
-     * @return Source|NULL
-     */
-    public function oneLinkedSource(Certificate $certificate): ?Source
-    {
-        $regex_query = preg_quote($certificate->gedcomPath(), '/');
-        $regex_pattern = '/[1-9] SOUR @(' . Gedcom::REGEX_XREF . ')@(?:\n[2-9]\s(?:(?!SOUR)\w+)\s.*)*\n[2-9] _ACT ' . $regex_query . '/i'; //phpcs:ignore Generic.Files.LineLength.TooLong
+	/**
+	 * Find a source linked to a citation where a certificate file is referenced.
+	 *
+	 * @param Certificate $certificate
+	 * @return Source|NULL
+	 */
+	public function oneLinkedSource(Certificate $certificate): ?Source
+	{
+		$regex_query = preg_quote($certificate->gedcomPath(), '/');
+		$regex_pattern = '/[1-9] SOUR @(' . Gedcom::REGEX_XREF . ')@(?:\n[2-9]\s(?:(?!SOUR)\w+)\s.*)*\n[2-9] _ACT ' . $regex_query . '/i'; //phpcs:ignore Generic.Files.LineLength.TooLong
 
-        foreach ($this->linkedRecordsLists($certificate) as $linked_records) {
-            foreach ($linked_records as $gedcom_record) {
-                foreach ($gedcom_record->facts() as $fact) {
-                    if (preg_match_all($regex_pattern, $fact->gedcom(), $matches, PREG_SET_ORDER) >= 1) {
-                        foreach ($matches as $match) {
-                            $source = Registry::sourceFactory()->make($match[1], $certificate->tree());
-                            if ($source !== null && $source->canShowName()) {
-                                return $source;
-                            }
-                        }
-                    }
-                }
-            }
-        }
+		foreach ($this->linkedRecordsLists($certificate) as $linked_records) {
+			foreach ($linked_records as $gedcom_record) {
+				foreach ($gedcom_record->facts() as $fact) {
+					if (preg_match_all($regex_pattern, $fact->gedcom(), $matches, PREG_SET_ORDER) >= 1) {
+						foreach ($matches as $match) {
+							$source = Registry::sourceFactory()->make($match[1], $certificate->tree());
+							if ($source !== null && $source->canShowName()) {
+								return $source;
+							}
+						}
+					}
+				}
+			}
+		}
 
-        return null;
-    }
+		return null;
+	}
 
-    /**
-     * Yield lists of gedcom records linked to a certificate.
-     *
-     * @param Certificate $certificate
-     * @return Generator<int, Collection<GedcomRecord>, mixed, void>
-     * @psalm-suppress InvalidReturnType
-     */
-    protected function linkedRecordsLists(Certificate $certificate): Generator
-    {
-        yield $this->linkedIndividuals($certificate);
-        yield $this->linkedFamilies($certificate);
-        yield $this->linkedMedias($certificate);
-        yield $this->linkedNotes($certificate);
-    }
+	/**
+	 * Yield lists of gedcom records linked to a certificate.
+	 *
+	 * @param Certificate $certificate
+	 * @return Generator<int, Collection<GedcomRecord>, mixed, void>
+	 * @psalm-suppress InvalidReturnType
+	 */
+	protected function linkedRecordsLists(Certificate $certificate): Generator
+	{
+		yield $this->linkedIndividuals($certificate);
+		yield $this->linkedFamilies($certificate);
+		yield $this->linkedMedias($certificate);
+		yield $this->linkedNotes($certificate);
+	}
 }

app/Module/Certificates/Services/UrlObfuscatorService.php

Indentation +116 added lines, -116 removed lines

@@ -23,120 +23,120 @@
  */
 class UrlObfuscatorService
 {
-    /**
-     * @var string|null $encryption_key
-     */
-    private $encryption_key;
-
-
-    /**
-     * Return (and generate) the key to be used for the encryption step
-     *
-     * @return string Encryption key
-     */
-    protected function encryptionKey(): string
-    {
-        if ($this->encryption_key === null) {
-            /** @var ServerRequestInterface $request **/
-            $request = app(ServerRequestInterface::class);
-            $server_name = $request->getServerParams()['SERVER_NAME'] ?? '';
-            $server_software = $request->getServerParams()['SERVER_SOFTWARE'] ?? '';
-            $this->encryption_key = str_pad(md5(
-                $server_name !== '' && $server_software !== '' ?
-                $server_name . $server_software :
-                'STANDARDKEYIFNOSERVER'
-            ), SODIUM_CRYPTO_SECRETBOX_KEYBYTES, "1234567890ABCDEF");
-        }
-        return $this->encryption_key;
-    }
-
-    /**
-     * Obfuscate a clear text, with a combination of encryption and base64 encoding.
-     * The return string is URL-safe.
-     *
-     * @param string $cleartext Text to obfuscate
-     * @param string $key
-     * @param string $nonce
-     * @return string
-     */
-    public function obfuscate(string $cleartext, string $key = '', string $nonce = ''): string
-    {
-        if ($nonce === '') {
-            $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
-        }
-        if ($key === '') {
-            $key = $this->encryptionKey();
-        }
-
-        if (strlen($nonce) !== SODIUM_CRYPTO_SECRETBOX_NONCEBYTES) {
-            throw new InvalidArgumentException('The nonce needs to be SODIUM_CRYPTO_SECRETBOX_NONCEBYTES long');
-        }
-
-        if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) {
-            throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long');
-        }
-
-        $encryted = sodium_crypto_secretbox($cleartext, $nonce, $key);
-        return strtr(base64_encode($nonce . $encryted), '+/=', '._-');
-    }
-
-    /**
-     * Deobfuscate a string from an URL to a clear text.
-     *
-     * @param string $obfuscated Text to deobfuscate
-     * @param string $key
-     * @throws InvalidArgumentException
-     * @return string
-     */
-    public function deobfuscate(string $obfuscated, string $key = ''): string
-    {
-        $obfuscated = strtr($obfuscated, '._-', '+/=');
-        if ($key === '') {
-            $key = $this->encryptionKey();
-        }
-
-        if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) {
-            throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long');
-        }
-
-        $encrypted = base64_decode($obfuscated, true);
-        if ($encrypted === false) {
-            throw new InvalidArgumentException('The encrypted value is not in correct base64 format.');
-        }
-
-        if (mb_strlen($encrypted, '8bit') < (SODIUM_CRYPTO_SECRETBOX_NONCEBYTES + SODIUM_CRYPTO_SECRETBOX_MACBYTES)) {
-            throw new InvalidArgumentException('The encrypted value does not contain enough characters for the key.');
-        }
-
-        $nonce = mb_substr($encrypted, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, '8bit');
-        $ciphertext = mb_substr($encrypted, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, null, '8bit');
-
-        $decrypted = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
-
-        if ($decrypted === false) {
-            throw new InvalidArgumentException('The message has been tampered with in transit.');
-        }
-
-        //sodium_memzero($ciphertext);    // sodium_compat cannot handle it, only through libsodium
-
-        /** @var string $decrypted - Psalm detect as string|true otherwise */
-        return $decrypted;
-    }
-
-    /**
-     * Try to deobfuscate a string from an URL to a clear text, returning whether the operation is a success.
-     *
-     * @param string $obfuscated Text to deobfuscate
-     * @param string $key
-     * @return bool
-     */
-    public function tryDeobfuscate(string &$obfuscated, string $key = ''): bool
-    {
-        try {
-            $obfuscated = $this->deobfuscate($obfuscated, $key);
-            return true;
-        } catch (InvalidArgumentException $ex) {
-        }
-        return false;
-    }
+	/**
+	 * @var string|null $encryption_key
+	 */
+	private $encryption_key;
+
+
+	/**
+	 * Return (and generate) the key to be used for the encryption step
+	 *
+	 * @return string Encryption key
+	 */
+	protected function encryptionKey(): string
+	{
+		if ($this->encryption_key === null) {
+			/** @var ServerRequestInterface $request **/
+			$request = app(ServerRequestInterface::class);
+			$server_name = $request->getServerParams()['SERVER_NAME'] ?? '';
+			$server_software = $request->getServerParams()['SERVER_SOFTWARE'] ?? '';
+			$this->encryption_key = str_pad(md5(
+				$server_name !== '' && $server_software !== '' ?
+				$server_name . $server_software :
+				'STANDARDKEYIFNOSERVER'
+			), SODIUM_CRYPTO_SECRETBOX_KEYBYTES, "1234567890ABCDEF");
+		}
+		return $this->encryption_key;
+	}
+
+	/**
+	 * Obfuscate a clear text, with a combination of encryption and base64 encoding.
+	 * The return string is URL-safe.
+	 *
+	 * @param string $cleartext Text to obfuscate
+	 * @param string $key
+	 * @param string $nonce
+	 * @return string
+	 */
+	public function obfuscate(string $cleartext, string $key = '', string $nonce = ''): string
+	{
+		if ($nonce === '') {
+			$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
+		}
+		if ($key === '') {
+			$key = $this->encryptionKey();
+		}
+
+		if (strlen($nonce) !== SODIUM_CRYPTO_SECRETBOX_NONCEBYTES) {
+			throw new InvalidArgumentException('The nonce needs to be SODIUM_CRYPTO_SECRETBOX_NONCEBYTES long');
+		}
+
+		if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) {
+			throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long');
+		}
+
+		$encryted = sodium_crypto_secretbox($cleartext, $nonce, $key);
+		return strtr(base64_encode($nonce . $encryted), '+/=', '._-');
+	}
+
+	/**
+	 * Deobfuscate a string from an URL to a clear text.
+	 *
+	 * @param string $obfuscated Text to deobfuscate
+	 * @param string $key
+	 * @throws InvalidArgumentException
+	 * @return string
+	 */
+	public function deobfuscate(string $obfuscated, string $key = ''): string
+	{
+		$obfuscated = strtr($obfuscated, '._-', '+/=');
+		if ($key === '') {
+			$key = $this->encryptionKey();
+		}
+
+		if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) {
+			throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long');
+		}
+
+		$encrypted = base64_decode($obfuscated, true);
+		if ($encrypted === false) {
+			throw new InvalidArgumentException('The encrypted value is not in correct base64 format.');
+		}
+
+		if (mb_strlen($encrypted, '8bit') < (SODIUM_CRYPTO_SECRETBOX_NONCEBYTES + SODIUM_CRYPTO_SECRETBOX_MACBYTES)) {
+			throw new InvalidArgumentException('The encrypted value does not contain enough characters for the key.');
+		}
+
+		$nonce = mb_substr($encrypted, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, '8bit');
+		$ciphertext = mb_substr($encrypted, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, null, '8bit');
+
+		$decrypted = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
+
+		if ($decrypted === false) {
+			throw new InvalidArgumentException('The message has been tampered with in transit.');
+		}
+
+		//sodium_memzero($ciphertext);    // sodium_compat cannot handle it, only through libsodium
+
+		/** @var string $decrypted - Psalm detect as string|true otherwise */
+		return $decrypted;
+	}
+
+	/**
+	 * Try to deobfuscate a string from an URL to a clear text, returning whether the operation is a success.
+	 *
+	 * @param string $obfuscated Text to deobfuscate
+	 * @param string $key
+	 * @return bool
+	 */
+	public function tryDeobfuscate(string &$obfuscated, string $key = ''): bool
+	{
+		try {
+			$obfuscated = $this->deobfuscate($obfuscated, $key);
+			return true;
+		} catch (InvalidArgumentException $ex) {
+		}
+		return false;
+	}
 }

app/Module/Certificates/Model/Certificate.php

Indentation +189 added lines, -189 removed lines

@@ -25,193 +25,193 @@
  */
 class Certificate
 {
-    /**
-     * Pattern to extract information from a file name.
-     * Specific to the author's workflow.
-     * @var string
-     */
-    private const FILENAME_PATTERN = '/^(?<year>\d{1,4})(\.(?<month>\d{1,2}))?(\.(?<day>\d{1,2}))?( (?<type>[A-Z]{1,2}))?\s(?<descr>.*)/'; //phpcs:ignore Generic.Files.LineLength.TooLong
-
-    private Tree $tree;
-    private string $path;
-    private ?string $city = null;
-    private ?string $basename = null;
-    private ?string $filename = null;
-    private ?string $extension = null;
-    private ?string $type = null;
-    private ?string $description = null;
-    private ?Date $date = null;
-
-    /**
-     * Contructor for Certificate
-     *
-     * @param Tree $tree
-     * @param string $path
-     */
-    public function __construct(Tree $tree, string $path)
-    {
-        $this->tree = $tree;
-        $this->path = $path;
-        $this->extractDataFromPath($path);
-    }
-
-    /**
-     * Populate fields from the filename, based on a predeterminate pattern.
-     * Logic specific to the author.
-     *
-     * @param string $path
-     */
-    protected function extractDataFromPath(string $path): void
-    {
-        $path_parts = pathinfo($this->gedcomPath());
-        $this->city = $path_parts['dirname'];
-        $this->basename = $path_parts['basename'];
-        $this->filename = $path_parts['filename'];
-        $this->extension = strtoupper($path_parts['extension'] ?? '');
-
-        if (preg_match(self::FILENAME_PATTERN, $this->filename, $match) === 1) {
-            $this->type = $match['type'];
-            $this->description = $match['descr'];
-
-            $day = $match['day'] ?? '';
-            $month_date = DateTime::createFromFormat('m', $match['month'] ?? '');
-            $month = $month_date !== false ? strtoupper($month_date->format('M')) : '';
-            $year = $match['year'] ?? '';
-
-            $this->date = new Date(sprintf('%s %s %s', $day, $month, $year));
-        } else {
-            $this->description = $this->filename;
-        }
-    }
-
-    /**
-     * Get the family tree of the certificate
-     *
-     * @return Tree
-     */
-    public function tree(): Tree
-    {
-        return $this->tree;
-    }
-
-    /**
-     * Get the path of the certificate in the file system.
-     *
-     * @return string
-     */
-    public function path(): string
-    {
-        return $this->path;
-    }
-
-    /**
-     * The the path of the certificate, in a Gedcom canonical form.
-     *
-     * @return string
-     */
-    public function gedcomPath(): string
-    {
-        return str_replace('\\', '/', $this->path);
-    }
-
-    /**
-     * Get the certificate name.
-     *
-     * @return string
-     */
-    public function name(): string
-    {
-        return $this->filename ?? '';
-    }
-
-    /**
-     * Get the certificate file name.
-     *
-     * @return string
-     */
-    public function filename(): string
-    {
-        return $this->basename ?? '';
-    }
-
-    /**
-     * Get the certificate's city (the first level folder).
-     *
-     * @return string
-     */
-    public function city(): string
-    {
-        return $this->city ?? '';
-    }
-
-    /**
-     * Get the certificate's date. Extracted from the file name.
-     *
-     * @return Date
-     */
-    public function date(): Date
-    {
-        return $this->date ?? new Date('');
-    }
-
-    /**
-     * Get the certificate's type. Extracted from the file name.
-     *
-     * @return string
-     */
-    public function type(): string
-    {
-        return $this->type ?? '';
-    }
-
-    /**
-     * Get the certificate's description.  Extracted from the file name.
-     * @return string
-     */
-    public function description(): string
-    {
-        return $this->description ?? '';
-    }
-
-    /**
-     * Get the certificate's description to be used for sorting.
-     * This is based on surnames (at least 3 letters) found in the file name.
-     *
-     * @return string
-     */
-    public function sortDescription(): string
-    {
-        $sort_prefix = '';
-        if (preg_match_all('/\b([A-Z]{3,})\b/', $this->description(), $matches, PREG_SET_ORDER) >= 1) {
-            $sort_prefix = implode('_', array_map(function ($match) {
-                return $match[1];
-            }, $matches)) . '_';
-        }
-        return $sort_prefix . $this->description();
-    }
-
-    /**
-     * Get the certificate's MIME type.
-     *
-     * @return string
-     */
-    public function mimeType(): string
-    {
-        return Mime::TYPES[$this->extension] ?? Mime::DEFAULT_TYPE;
-    }
-
-    /**
-     * Get the base parameters to be used in url referencing the certificate.
-     *
-     * @param UrlObfuscatorService $url_obfuscator_service
-     * @return array{tree: string, cid: mixed}
-     */
-    public function urlParameters(UrlObfuscatorService $url_obfuscator_service = null): array
-    {
-        $url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
-        return [
-            'tree' => $this->tree->name(),
-            'cid' => $url_obfuscator_service->obfuscate($this->path)
-        ];
-    }
+	/**
+	 * Pattern to extract information from a file name.
+	 * Specific to the author's workflow.
+	 * @var string
+	 */
+	private const FILENAME_PATTERN = '/^(?<year>\d{1,4})(\.(?<month>\d{1,2}))?(\.(?<day>\d{1,2}))?( (?<type>[A-Z]{1,2}))?\s(?<descr>.*)/'; //phpcs:ignore Generic.Files.LineLength.TooLong
+
+	private Tree $tree;
+	private string $path;
+	private ?string $city = null;
+	private ?string $basename = null;
+	private ?string $filename = null;
+	private ?string $extension = null;
+	private ?string $type = null;
+	private ?string $description = null;
+	private ?Date $date = null;
+
+	/**
+	 * Contructor for Certificate
+	 *
+	 * @param Tree $tree
+	 * @param string $path
+	 */
+	public function __construct(Tree $tree, string $path)
+	{
+		$this->tree = $tree;
+		$this->path = $path;
+		$this->extractDataFromPath($path);
+	}
+
+	/**
+	 * Populate fields from the filename, based on a predeterminate pattern.
+	 * Logic specific to the author.
+	 *
+	 * @param string $path
+	 */
+	protected function extractDataFromPath(string $path): void
+	{
+		$path_parts = pathinfo($this->gedcomPath());
+		$this->city = $path_parts['dirname'];
+		$this->basename = $path_parts['basename'];
+		$this->filename = $path_parts['filename'];
+		$this->extension = strtoupper($path_parts['extension'] ?? '');
+
+		if (preg_match(self::FILENAME_PATTERN, $this->filename, $match) === 1) {
+			$this->type = $match['type'];
+			$this->description = $match['descr'];
+
+			$day = $match['day'] ?? '';
+			$month_date = DateTime::createFromFormat('m', $match['month'] ?? '');
+			$month = $month_date !== false ? strtoupper($month_date->format('M')) : '';
+			$year = $match['year'] ?? '';
+
+			$this->date = new Date(sprintf('%s %s %s', $day, $month, $year));
+		} else {
+			$this->description = $this->filename;
+		}
+	}
+
+	/**
+	 * Get the family tree of the certificate
+	 *
+	 * @return Tree
+	 */
+	public function tree(): Tree
+	{
+		return $this->tree;
+	}
+
+	/**
+	 * Get the path of the certificate in the file system.
+	 *
+	 * @return string
+	 */
+	public function path(): string
+	{
+		return $this->path;
+	}
+
+	/**
+	 * The the path of the certificate, in a Gedcom canonical form.
+	 *
+	 * @return string
+	 */
+	public function gedcomPath(): string
+	{
+		return str_replace('\\', '/', $this->path);
+	}
+
+	/**
+	 * Get the certificate name.
+	 *
+	 * @return string
+	 */
+	public function name(): string
+	{
+		return $this->filename ?? '';
+	}
+
+	/**
+	 * Get the certificate file name.
+	 *
+	 * @return string
+	 */
+	public function filename(): string
+	{
+		return $this->basename ?? '';
+	}
+
+	/**
+	 * Get the certificate's city (the first level folder).
+	 *
+	 * @return string
+	 */
+	public function city(): string
+	{
+		return $this->city ?? '';
+	}
+
+	/**
+	 * Get the certificate's date. Extracted from the file name.
+	 *
+	 * @return Date
+	 */
+	public function date(): Date
+	{
+		return $this->date ?? new Date('');
+	}
+
+	/**
+	 * Get the certificate's type. Extracted from the file name.
+	 *
+	 * @return string
+	 */
+	public function type(): string
+	{
+		return $this->type ?? '';
+	}
+
+	/**
+	 * Get the certificate's description.  Extracted from the file name.
+	 * @return string
+	 */
+	public function description(): string
+	{
+		return $this->description ?? '';
+	}
+
+	/**
+	 * Get the certificate's description to be used for sorting.
+	 * This is based on surnames (at least 3 letters) found in the file name.
+	 *
+	 * @return string
+	 */
+	public function sortDescription(): string
+	{
+		$sort_prefix = '';
+		if (preg_match_all('/\b([A-Z]{3,})\b/', $this->description(), $matches, PREG_SET_ORDER) >= 1) {
+			$sort_prefix = implode('_', array_map(function ($match) {
+				return $match[1];
+			}, $matches)) . '_';
+		}
+		return $sort_prefix . $this->description();
+	}
+
+	/**
+	 * Get the certificate's MIME type.
+	 *
+	 * @return string
+	 */
+	public function mimeType(): string
+	{
+		return Mime::TYPES[$this->extension] ?? Mime::DEFAULT_TYPE;
+	}
+
+	/**
+	 * Get the base parameters to be used in url referencing the certificate.
+	 *
+	 * @param UrlObfuscatorService $url_obfuscator_service
+	 * @return array{tree: string, cid: mixed}
+	 */
+	public function urlParameters(UrlObfuscatorService $url_obfuscator_service = null): array
+	{
+		$url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
+		return [
+			'tree' => $this->tree->name(),
+			'cid' => $url_obfuscator_service->obfuscate($this->path)
+		];
+	}
 }

app/Module/IsSourced/IsSourcedModule.php

Indentation +90 added lines, -90 removed lines

@@ -33,105 +33,105 @@
  * IsSourced Module
  */
 class IsSourcedModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleGlobalInterface,
-    ModuleSidebarInterface,
-    ModuleHookSubscriberInterface
+	ModuleMyArtJaubInterface,
+	ModuleGlobalInterface,
+	ModuleSidebarInterface,
+	ModuleHookSubscriberInterface
 {
-    use ModuleMyArtJaubTrait;
-    use ModuleGlobalTrait;
-    use ModuleSidebarTrait;
+	use ModuleMyArtJaubTrait;
+	use ModuleGlobalTrait;
+	use ModuleSidebarTrait;
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Sourced events');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Sourced events');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        return I18N::translate('Indicate if events related to an record are sourced.');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		return I18N::translate('Indicate if events related to an record are sourced.');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.1.1-v.1';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.1.1-v.1';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
-     */
-    public function headContent(): string
-    {
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
+	 */
+	public function headContent(): string
+	{
+		return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
-     */
-    public function bodyContent(): string
-    {
-        return '<script src="' . $this->assetUrl('js/issourced.min.js') . '"></script>';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
+	 */
+	public function bodyContent(): string
+	{
+		return '<script src="' . $this->assetUrl('js/issourced.min.js') . '"></script>';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
-     */
-    public function hasSidebarContent(Individual $individual): bool
-    {
-        return true;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
+	 */
+	public function hasSidebarContent(Individual $individual): bool
+	{
+		return true;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
-     */
-    public function getSidebarContent(Individual $individual): string
-    {
-        /** @var SourceStatusService $source_status_service */
-        $source_status_service = app(SourceStatusService::class);
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
+	 */
+	public function getSidebarContent(Individual $individual): string
+	{
+		/** @var SourceStatusService $source_status_service */
+		$source_status_service = app(SourceStatusService::class);
 
-        $spouse_families_status = $individual->spouseFamilies()->map(
-            function (Family $sfamily) use ($source_status_service): array {
-                return [ $sfamily, $source_status_service->sourceStatusForMarriage($sfamily)];
-            }
-        )->filter(function (array $item): bool {
-            return $item[1]->isSet();
-        });
+		$spouse_families_status = $individual->spouseFamilies()->map(
+			function (Family $sfamily) use ($source_status_service): array {
+				return [ $sfamily, $source_status_service->sourceStatusForMarriage($sfamily)];
+			}
+		)->filter(function (array $item): bool {
+			return $item[1]->isSet();
+		});
 
-        return view($this->name() . '::sidebar/content', [
-            'module_name'               => $this->name(),
-            'individual'                =>  $individual,
-            'source_status_individual'  =>  $source_status_service->sourceStatusForRecord($individual),
-            'source_status_birth'       =>  $source_status_service->sourceStatusForBirth($individual),
-            'source_status_marriages'   =>  $spouse_families_status,
-            'source_status_death'       =>  $source_status_service->sourceStatusForDeath($individual)
-        ]);
-    }
+		return view($this->name() . '::sidebar/content', [
+			'module_name'               => $this->name(),
+			'individual'                =>  $individual,
+			'source_status_individual'  =>  $source_status_service->sourceStatusForRecord($individual),
+			'source_status_birth'       =>  $source_status_service->sourceStatusForBirth($individual),
+			'source_status_marriages'   =>  $spouse_families_status,
+			'source_status_death'       =>  $source_status_service->sourceStatusForDeath($individual)
+		]);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
-     */
-    public function listSubscribedHooks(): array
-    {
-        return [
-            app()->makeWith(IsSourcedStatusHook::class, [ 'module' => $this ]),
-            app()->makeWith(IsSourcedStatusColumnsHook::class, [ 'module' => $this ])
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
+	 */
+	public function listSubscribedHooks(): array
+	{
+		return [
+			app()->makeWith(IsSourcedStatusHook::class, [ 'module' => $this ]),
+			app()->makeWith(IsSourcedStatusColumnsHook::class, [ 'module' => $this ])
+		];
+	}
 }

app/Module/IsSourced/Data/FactSourceStatus.php

Indentation +229 added lines, -229 removed lines

@@ -22,233 +22,233 @@
  */
 class FactSourceStatus extends SourceStatus
 {
-    /**
-     * @var boolean $has_date
-     */
-    private $has_date = false;
-
-    /**
-     * @var boolean $has_precise_date
-     */
-    private $has_precise_date = false;
-
-    /**
-     * @var boolean $has_source_date
-     */
-    private $has_source_date = false;
-
-    /**
-     * @var boolean $source_date_match
-     */
-    private $source_date_match = false;
-
-    /**
-     * Return whether the fact is dated.
-     *
-     * @return bool
-     */
-    public function factHasDate(): bool
-    {
-        return $this->has_date;
-    }
-
-    /**
-     * Set whether the fact is dated.
-     *
-     * @param bool $has_date
-     * @return $this
-     */
-    public function setFactHasDate(bool $has_date): self
-    {
-        $this->has_date = $has_date;
-        return $this;
-    }
-
-    /**
-     * Combinate whether the fact is dated with the previous status.
-     *
-     * @param bool $has_date
-     * @return $this
-     */
-    public function addFactHasDate(bool $has_date): self
-    {
-        $this->has_date = $this->has_date || $has_date;
-        return $this;
-    }
-
-    /**
-     * Return whether the fact is dated with a precise day.
-     * Any date modifier will be considered as not precise.
-     * A month or year will be considered as not precise.
-     *
-     * @return bool
-     */
-    public function factHasPreciseDate(): bool
-    {
-        return $this->has_date && $this->has_precise_date;
-    }
-
-    /**
-     * Set whather the fact is dated with a precise day.
-     *
-     * @param bool $has_precise_date
-     * @return $this
-     */
-    public function setFactHasPreciseDate(bool $has_precise_date): self
-    {
-        $this->has_precise_date = $has_precise_date;
-        return $this;
-    }
-
-    /**
-     * Combine whether the fact is dated with a precise day.
-     *
-     * @param bool $has_precise_date
-     * @return $this
-     */
-    public function addFactHasPreciseDate(bool $has_precise_date): self
-    {
-        $this->has_precise_date = $this->has_precise_date || $has_precise_date;
-        return $this;
-    }
-
-    /**
-     * Return whether the source citation is dated.
-     *
-     * @return bool
-     */
-    public function sourceHasDate(): bool
-    {
-        return $this->has_source_date;
-    }
-
-    /**
-     * Set whether the source citation is dated.
-     *
-     * @param bool $has_source_date
-     * @return $this
-     */
-    public function setSourceHasDate(bool $has_source_date): self
-    {
-        $this->has_source_date = $has_source_date;
-        return $this;
-    }
-
-    /**
-     * Combine whether the source citation is dated with the previous status.
-     *
-     * @param bool $has_source_date
-     * @return $this
-     */
-    public function addSourceHasDate(bool $has_source_date): self
-    {
-        $this->has_source_date = $this->has_source_date || $has_source_date;
-        return $this;
-    }
-
-    /**
-     * Return whether the source citation date is close to the fact date.
-     *
-     * @return bool
-     */
-    public function sourceMatchesFactDate(): bool
-    {
-        return $this->has_precise_date && $this->has_source_date && $this->source_date_match;
-    }
-
-    /**
-     * Set whether the source citation date is close to the fact date.
-     *
-     * @param bool $source_date_match
-     * @return $this
-     */
-    public function setSourceMatchesFactDate(bool $source_date_match): self
-    {
-        $this->source_date_match = $source_date_match;
-        return $this;
-    }
-
-    /**
-     * Combine whether the source citation date is close to the fact date with the previous status.
-     *
-     * @param bool $source_date_match
-     * @return $this
-     */
-    public function addSourceMatchesFactDate(bool $source_date_match): self
-    {
-        $this->source_date_match = $this->source_date_match || $source_date_match;
-        return $this;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::isFullySourced()
-     */
-    public function isFullySourced(): bool
-    {
-        return parent::isFullySourced() && $this->sourceMatchesFactDate();
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::label()
-     */
-    public function label(string $context): string
-    {
-        $context_label = Registry::elementFactory()->make($context)->label();
-
-        if ($this->factHasPreciseDate()) {
-            if ($this->hasSource()) {
-                if ($this->hasSupportingDocument()) {
-                    if ($this->sourceMatchesFactDate()) {
-                        return I18N::translate('%s sourced with exact certificate', $context_label);
-                    } else {
-                        return I18N::translate('%s sourced with a certificate', $context_label);
-                    }
-                }
-
-                if ($this->sourceMatchesFactDate()) {
-                    return I18N::translate('%s precisely sourced', $context_label);
-                }
-                return I18N::translate('%s sourced', $context_label);
-            }
-            return I18N::translate('%s not sourced', $context_label);
-        }
-
-        if ($this->factHasDate()) {
-            return I18N::translate('%s not precise', $context_label);
-        }
-        return I18N::translate('%s not found', $context_label);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::order()
-     */
-    public function order(): int
-    {
-        return ($this->factHasDate() ? 1 : 0) * ($this->hasSource() ? 1 : -1) *
-            ( 1 + ($this->factHasPreciseDate() ? 1 : 0) * (1 +
-                0b010 * ($this->sourceMatchesFactDate() ? 1 : 0) +
-                0b100 * ($this->hasSupportingDocument() ? 1 : 0)
-            )
-        );
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::combineWith()
-     */
-    public function combineWith(SourceStatus $other)
-    {
-        if ($other instanceof FactSourceStatus) {
-            $this->addFactHasDate($other->factHasDate());
-            $this->addFactHasPreciseDate($other->factHasPreciseDate());
-            $this->addSourceHasDate($other->sourceHasDate());
-            $this->addSourceMatchesFactDate($other->sourceMatchesFactDate());
-        }
-
-        parent::combineWith($other);
-        return $this;
-    }
+	/**
+	 * @var boolean $has_date
+	 */
+	private $has_date = false;
+
+	/**
+	 * @var boolean $has_precise_date
+	 */
+	private $has_precise_date = false;
+
+	/**
+	 * @var boolean $has_source_date
+	 */
+	private $has_source_date = false;
+
+	/**
+	 * @var boolean $source_date_match
+	 */
+	private $source_date_match = false;
+
+	/**
+	 * Return whether the fact is dated.
+	 *
+	 * @return bool
+	 */
+	public function factHasDate(): bool
+	{
+		return $this->has_date;
+	}
+
+	/**
+	 * Set whether the fact is dated.
+	 *
+	 * @param bool $has_date
+	 * @return $this
+	 */
+	public function setFactHasDate(bool $has_date): self
+	{
+		$this->has_date = $has_date;
+		return $this;
+	}
+
+	/**
+	 * Combinate whether the fact is dated with the previous status.
+	 *
+	 * @param bool $has_date
+	 * @return $this
+	 */
+	public function addFactHasDate(bool $has_date): self
+	{
+		$this->has_date = $this->has_date || $has_date;
+		return $this;
+	}
+
+	/**
+	 * Return whether the fact is dated with a precise day.
+	 * Any date modifier will be considered as not precise.
+	 * A month or year will be considered as not precise.
+	 *
+	 * @return bool
+	 */
+	public function factHasPreciseDate(): bool
+	{
+		return $this->has_date && $this->has_precise_date;
+	}
+
+	/**
+	 * Set whather the fact is dated with a precise day.
+	 *
+	 * @param bool $has_precise_date
+	 * @return $this
+	 */
+	public function setFactHasPreciseDate(bool $has_precise_date): self
+	{
+		$this->has_precise_date = $has_precise_date;
+		return $this;
+	}
+
+	/**
+	 * Combine whether the fact is dated with a precise day.
+	 *
+	 * @param bool $has_precise_date
+	 * @return $this
+	 */
+	public function addFactHasPreciseDate(bool $has_precise_date): self
+	{
+		$this->has_precise_date = $this->has_precise_date || $has_precise_date;
+		return $this;
+	}
+
+	/**
+	 * Return whether the source citation is dated.
+	 *
+	 * @return bool
+	 */
+	public function sourceHasDate(): bool
+	{
+		return $this->has_source_date;
+	}
+
+	/**
+	 * Set whether the source citation is dated.
+	 *
+	 * @param bool $has_source_date
+	 * @return $this
+	 */
+	public function setSourceHasDate(bool $has_source_date): self
+	{
+		$this->has_source_date = $has_source_date;
+		return $this;
+	}
+
+	/**
+	 * Combine whether the source citation is dated with the previous status.
+	 *
+	 * @param bool $has_source_date
+	 * @return $this
+	 */
+	public function addSourceHasDate(bool $has_source_date): self
+	{
+		$this->has_source_date = $this->has_source_date || $has_source_date;
+		return $this;
+	}
+
+	/**
+	 * Return whether the source citation date is close to the fact date.
+	 *
+	 * @return bool
+	 */
+	public function sourceMatchesFactDate(): bool
+	{
+		return $this->has_precise_date && $this->has_source_date && $this->source_date_match;
+	}
+
+	/**
+	 * Set whether the source citation date is close to the fact date.
+	 *
+	 * @param bool $source_date_match
+	 * @return $this
+	 */
+	public function setSourceMatchesFactDate(bool $source_date_match): self
+	{
+		$this->source_date_match = $source_date_match;
+		return $this;
+	}
+
+	/**
+	 * Combine whether the source citation date is close to the fact date with the previous status.
+	 *
+	 * @param bool $source_date_match
+	 * @return $this
+	 */
+	public function addSourceMatchesFactDate(bool $source_date_match): self
+	{
+		$this->source_date_match = $this->source_date_match || $source_date_match;
+		return $this;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::isFullySourced()
+	 */
+	public function isFullySourced(): bool
+	{
+		return parent::isFullySourced() && $this->sourceMatchesFactDate();
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::label()
+	 */
+	public function label(string $context): string
+	{
+		$context_label = Registry::elementFactory()->make($context)->label();
+
+		if ($this->factHasPreciseDate()) {
+			if ($this->hasSource()) {
+				if ($this->hasSupportingDocument()) {
+					if ($this->sourceMatchesFactDate()) {
+						return I18N::translate('%s sourced with exact certificate', $context_label);
+					} else {
+						return I18N::translate('%s sourced with a certificate', $context_label);
+					}
+				}
+
+				if ($this->sourceMatchesFactDate()) {
+					return I18N::translate('%s precisely sourced', $context_label);
+				}
+				return I18N::translate('%s sourced', $context_label);
+			}
+			return I18N::translate('%s not sourced', $context_label);
+		}
+
+		if ($this->factHasDate()) {
+			return I18N::translate('%s not precise', $context_label);
+		}
+		return I18N::translate('%s not found', $context_label);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::order()
+	 */
+	public function order(): int
+	{
+		return ($this->factHasDate() ? 1 : 0) * ($this->hasSource() ? 1 : -1) *
+			( 1 + ($this->factHasPreciseDate() ? 1 : 0) * (1 +
+				0b010 * ($this->sourceMatchesFactDate() ? 1 : 0) +
+				0b100 * ($this->hasSupportingDocument() ? 1 : 0)
+			)
+		);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::combineWith()
+	 */
+	public function combineWith(SourceStatus $other)
+	{
+		if ($other instanceof FactSourceStatus) {
+			$this->addFactHasDate($other->factHasDate());
+			$this->addFactHasPreciseDate($other->factHasPreciseDate());
+			$this->addSourceHasDate($other->sourceHasDate());
+			$this->addSourceMatchesFactDate($other->sourceMatchesFactDate());
+		}
+
+		parent::combineWith($other);
+		return $this;
+	}
 }