jon48 / webtrees-lib

app/Module/Certificates/Factories/CertificateImageFactory.php

Indentation +159 added lines, -159 removed lines

@@ -39,163 +39,163 @@
  */
 class CertificateImageFactory extends ImageFactory implements ImageFactoryInterface
 {
-    /**
-     * @var CertificateFilesystemService $filesystem_service
-     */
-    private $filesystem_service;
-
-    /**
-     * Constructor for the Certificate Image Factory
-     *
-     * @param CertificateFilesystemService $filesystem_service
-     */
-    public function __construct(CertificateFilesystemService $filesystem_service)
-    {
-        $this->filesystem_service = $filesystem_service;
-    }
-
-    /**
-     * Check is a file MIME type is supported by the system.
-     *
-     * @param string $mime
-     * @return bool
-     */
-    public function isMimeTypeSupported(string $mime): bool
-    {
-        return array_key_exists($mime, self::INTERVENTION_FORMATS);
-    }
-
-    /**
-     * Create a full-size version of a certificate.
-     *
-     * @param Certificate $certificate
-     * @param bool $add_watermark
-     * @param Watermark $watermark
-     * @throws InvalidArgumentException
-     * @return ResponseInterface
-     */
-    public function certificateFileResponse(
-        Certificate $certificate,
-        bool $add_watermark = false,
-        Watermark $watermark = null
-    ): ResponseInterface {
-        $filesystem =  $this->filesystem_service->filesystem($certificate->tree());
-        $filename   = $certificate->path();
-
-        if (!$add_watermark) {
-            return $this->fileResponse($filesystem, $filename, false);
-        }
-
-        try {
-            $image = $this->imageManager()->make($filesystem->readStream($filename));
-            $image = $this->autorotateImage($image);
-
-            if ($watermark == null) {
-                throw new InvalidArgumentException('Watermark data not defined');
-            }
-
-            $width = $image->width();
-            $height = $image->height();
-
-            $watermark->adjustSize($width);
-            $watermark_x = (int) ceil($watermark->textLengthEstimate() * 1.5);
-            $watermark_y = $watermark->size() * 12 + 1;
-
-            $font_definition = function (AbstractFont $font) use ($watermark): void {
-                $font->file(Webtrees::ROOT_DIR . 'resources/fonts/DejaVuSans.ttf');
-                $font->color($watermark->color());
-                $font->size($watermark->size());
-                $font->valign('top');
-            };
-
-            for ($i = min((int) ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) {
-                for ($j = min((int) ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) {
-                    $image = $image->text($watermark->text(), $i, $j, $font_definition);
-                }
-            }
-
-            $format  = static::INTERVENTION_FORMATS[$image->mime()] ?? 'jpg';
-            $quality = $this->extractImageQuality($image, static::GD_DEFAULT_IMAGE_QUALITY);
-            $data    = (string) $image->encode($format, $quality);
-
-            return $this->imageResponse($data, $image->mime(), '');
-        } catch (NotReadableException $ex) {
-            return $this->replacementImageResponse(pathinfo($filename, PATHINFO_EXTENSION))
-            ->withHeader('X-Image-Exception', $ex->getMessage());
-        } catch (FilesystemException | UnableToReadFile $ex) {
-            return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND);
-        } catch (Throwable $ex) {
-            return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR)
-            ->withHeader('X-Image-Exception', $ex->getMessage());
-        }
-    }
-
-    /**
-     * Does a full-sized certificate need a watermark?
-     *
-     * @param Certificate $certificate
-     * @param UserInterface $user
-     * @return bool
-     */
-    public function certificateNeedsWatermark(Certificate $certificate, UserInterface $user): bool
-    {
-        $tree = $certificate->tree();
-
-        return Auth::accessLevel($tree, $user) > $tree->getPreference('MAJ_CERTIF_SHOW_NO_WATERMARK');
-    }
-
-    /**
-     * Neutralise the methods associated with MediaFile.
-     */
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileResponse()
-     */
-    public function mediaFileResponse(MediaFile $media_file, bool $add_watermark, bool $download): ResponseInterface
-    {
-        throw new BadMethodCallException("Invalid method for Certificates");
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileThumbnailResponse()
-     */
-    public function mediaFileThumbnailResponse(
-        MediaFile $media_file,
-        int $width,
-        int $height,
-        string $fit,
-        bool $add_watermark
-    ): ResponseInterface {
-        throw new BadMethodCallException("Invalid method for Certificates");
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Factories\ImageFactory::createWatermark()
-     */
-    public function createWatermark(int $width, int $height, MediaFile $media_file): Image
-    {
-
-        throw new BadMethodCallException("Invalid method for Certificates");
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Factories\ImageFactory::fileNeedsWatermark()
-     */
-    public function fileNeedsWatermark(MediaFile $media_file, UserInterface $user): bool
-    {
-        throw new BadMethodCallException("Invalid method for Certificates");
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Factories\ImageFactory::thumbnailNeedsWatermark()
-     */
-    public function thumbnailNeedsWatermark(MediaFile $media_file, UserInterface $user): bool
-    {
-        throw new BadMethodCallException("Invalid method for Certificates");
-    }
+	/**
+	 * @var CertificateFilesystemService $filesystem_service
+	 */
+	private $filesystem_service;
+
+	/**
+	 * Constructor for the Certificate Image Factory
+	 *
+	 * @param CertificateFilesystemService $filesystem_service
+	 */
+	public function __construct(CertificateFilesystemService $filesystem_service)
+	{
+		$this->filesystem_service = $filesystem_service;
+	}
+
+	/**
+	 * Check is a file MIME type is supported by the system.
+	 *
+	 * @param string $mime
+	 * @return bool
+	 */
+	public function isMimeTypeSupported(string $mime): bool
+	{
+		return array_key_exists($mime, self::INTERVENTION_FORMATS);
+	}
+
+	/**
+	 * Create a full-size version of a certificate.
+	 *
+	 * @param Certificate $certificate
+	 * @param bool $add_watermark
+	 * @param Watermark $watermark
+	 * @throws InvalidArgumentException
+	 * @return ResponseInterface
+	 */
+	public function certificateFileResponse(
+		Certificate $certificate,
+		bool $add_watermark = false,
+		Watermark $watermark = null
+	): ResponseInterface {
+		$filesystem =  $this->filesystem_service->filesystem($certificate->tree());
+		$filename   = $certificate->path();
+
+		if (!$add_watermark) {
+			return $this->fileResponse($filesystem, $filename, false);
+		}
+
+		try {
+			$image = $this->imageManager()->make($filesystem->readStream($filename));
+			$image = $this->autorotateImage($image);
+
+			if ($watermark == null) {
+				throw new InvalidArgumentException('Watermark data not defined');
+			}
+
+			$width = $image->width();
+			$height = $image->height();
+
+			$watermark->adjustSize($width);
+			$watermark_x = (int) ceil($watermark->textLengthEstimate() * 1.5);
+			$watermark_y = $watermark->size() * 12 + 1;
+
+			$font_definition = function (AbstractFont $font) use ($watermark): void {
+				$font->file(Webtrees::ROOT_DIR . 'resources/fonts/DejaVuSans.ttf');
+				$font->color($watermark->color());
+				$font->size($watermark->size());
+				$font->valign('top');
+			};
+
+			for ($i = min((int) ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) {
+				for ($j = min((int) ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) {
+					$image = $image->text($watermark->text(), $i, $j, $font_definition);
+				}
+			}
+
+			$format  = static::INTERVENTION_FORMATS[$image->mime()] ?? 'jpg';
+			$quality = $this->extractImageQuality($image, static::GD_DEFAULT_IMAGE_QUALITY);
+			$data    = (string) $image->encode($format, $quality);
+
+			return $this->imageResponse($data, $image->mime(), '');
+		} catch (NotReadableException $ex) {
+			return $this->replacementImageResponse(pathinfo($filename, PATHINFO_EXTENSION))
+			->withHeader('X-Image-Exception', $ex->getMessage());
+		} catch (FilesystemException | UnableToReadFile $ex) {
+			return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND);
+		} catch (Throwable $ex) {
+			return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR)
+			->withHeader('X-Image-Exception', $ex->getMessage());
+		}
+	}
+
+	/**
+	 * Does a full-sized certificate need a watermark?
+	 *
+	 * @param Certificate $certificate
+	 * @param UserInterface $user
+	 * @return bool
+	 */
+	public function certificateNeedsWatermark(Certificate $certificate, UserInterface $user): bool
+	{
+		$tree = $certificate->tree();
+
+		return Auth::accessLevel($tree, $user) > $tree->getPreference('MAJ_CERTIF_SHOW_NO_WATERMARK');
+	}
+
+	/**
+	 * Neutralise the methods associated with MediaFile.
+	 */
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileResponse()
+	 */
+	public function mediaFileResponse(MediaFile $media_file, bool $add_watermark, bool $download): ResponseInterface
+	{
+		throw new BadMethodCallException("Invalid method for Certificates");
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileThumbnailResponse()
+	 */
+	public function mediaFileThumbnailResponse(
+		MediaFile $media_file,
+		int $width,
+		int $height,
+		string $fit,
+		bool $add_watermark
+	): ResponseInterface {
+		throw new BadMethodCallException("Invalid method for Certificates");
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Factories\ImageFactory::createWatermark()
+	 */
+	public function createWatermark(int $width, int $height, MediaFile $media_file): Image
+	{
+
+		throw new BadMethodCallException("Invalid method for Certificates");
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Factories\ImageFactory::fileNeedsWatermark()
+	 */
+	public function fileNeedsWatermark(MediaFile $media_file, UserInterface $user): bool
+	{
+		throw new BadMethodCallException("Invalid method for Certificates");
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Factories\ImageFactory::thumbnailNeedsWatermark()
+	 */
+	public function thumbnailNeedsWatermark(MediaFile $media_file, UserInterface $user): bool
+	{
+		throw new BadMethodCallException("Invalid method for Certificates");
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -79,7 +79,7 @@ 
         bool $add_watermark = false,
         Watermark $watermark = null
     ): ResponseInterface {
-        $filesystem =  $this->filesystem_service->filesystem($certificate->tree());
+        $filesystem = $this->filesystem_service->filesystem($certificate->tree());
         $filename   = $certificate->path();
 
         if (!$add_watermark) {
@@ -98,34 +98,34 @@ 
             $height = $image->height();
 
             $watermark->adjustSize($width);
-            $watermark_x = (int) ceil($watermark->textLengthEstimate() * 1.5);
+            $watermark_x = (int)ceil($watermark->textLengthEstimate() * 1.5);
             $watermark_y = $watermark->size() * 12 + 1;
 
-            $font_definition = function (AbstractFont $font) use ($watermark): void {
-                $font->file(Webtrees::ROOT_DIR . 'resources/fonts/DejaVuSans.ttf');
+            $font_definition = function(AbstractFont $font) use ($watermark): void {
+                $font->file(Webtrees::ROOT_DIR.'resources/fonts/DejaVuSans.ttf');
                 $font->color($watermark->color());
                 $font->size($watermark->size());
                 $font->valign('top');
             };
 
-            for ($i = min((int) ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) {
-                for ($j = min((int) ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) {
+            for ($i = min((int)ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) {
+                for ($j = min((int)ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) {
                     $image = $image->text($watermark->text(), $i, $j, $font_definition);
                 }
             }
 
             $format  = static::INTERVENTION_FORMATS[$image->mime()] ?? 'jpg';
             $quality = $this->extractImageQuality($image, static::GD_DEFAULT_IMAGE_QUALITY);
-            $data    = (string) $image->encode($format, $quality);
+            $data    = (string)$image->encode($format, $quality);
 
             return $this->imageResponse($data, $image->mime(), '');
         } catch (NotReadableException $ex) {
             return $this->replacementImageResponse(pathinfo($filename, PATHINFO_EXTENSION))
             ->withHeader('X-Image-Exception', $ex->getMessage());
         } catch (FilesystemException | UnableToReadFile $ex) {
-            return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND);
+            return $this->replacementImageResponse((string)StatusCodeInterface::STATUS_NOT_FOUND);
         } catch (Throwable $ex) {
-            return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR)
+            return $this->replacementImageResponse((string)StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR)
             ->withHeader('X-Image-Exception', $ex->getMessage());
         }
     }

app/Module/Certificates/Model/Watermark.php

Indentation +108 added lines, -108 removed lines

@@ -19,112 +19,112 @@
  */
 class Watermark
 {
-    /**
-     * Default font color for watermarks
-     * @var string DEFAULT_COLOR
-     * */
-    public const DEFAULT_COLOR = '#4D6DF3';
-
-    /**
-     * Default maximum font size for watermarks
-     * @var string DEFAULT_SIZE
-     * */
-    public const DEFAULT_SIZE = 18;
-
-    /**
-     * @var string $text
-     */
-    private $text;
-
-    /**
-     * @var string $color;
-     */
-    private $color;
-
-
-    /**
-     * @var int $size
-     */
-    private $size;
-
-    /**
-     * Constructor for Watermark data class
-     *
-     * @param string $text
-     * @param string $color
-     * @param int $size
-     */
-    public function __construct(string $text, string $color, int $size)
-    {
-        $this->text = $text;
-        $this->color = $color;
-        $this->size = $size;
-    }
-
-    /**
-     * Get the watermark text.
-     *
-     * @return string
-     */
-    public function text(): string
-    {
-        return $this->text;
-    }
-
-    /**
-     * Get the watermark font color.
-     *
-     * @return string
-     */
-    public function color(): string
-    {
-        return $this->color;
-    }
-
-    /**
-     * Get the watermark maximum font size.
-     * @return int
-     */
-    public function size(): int
-    {
-        return $this->size;
-    }
-
-    /**
-     * Return an estimate of the size in pixels of the watermark text length.
-     *
-     * @return int
-     */
-    public function textLengthEstimate(): int
-    {
-        return $this->stringLengthEstimate(mb_strlen($this->text), $this->size);
-    }
-
-    /**
-     * Decrease the font size if necessary, based on the image width.
-     *
-     * @param int $width
-     */
-    public function adjustSize(int $width): void
-    {
-        $len = mb_strlen($this->text);
-        while ($this->stringLengthEstimate($len, $this->size) > 0.9 * $width) {
-            $this->size--;
-            if ($this->size == 2) {
-                return;
-            }
-        }
-    }
-
-    /**
-     * Return an estimate of the size in pixels of a text in a specified font size.
-     *
-     * @param int $text_length
-     * @param int $font_size
-     * @return int
-     */
-    private function stringLengthEstimate(int $text_length, int $font_size): int
-    {
-        return $text_length * (int) ceil(($font_size + 2) * 0.5);
-    }
+	/**
+	 * Default font color for watermarks
+	 * @var string DEFAULT_COLOR
+	 * */
+	public const DEFAULT_COLOR = '#4D6DF3';
+
+	/**
+	 * Default maximum font size for watermarks
+	 * @var string DEFAULT_SIZE
+	 * */
+	public const DEFAULT_SIZE = 18;
+
+	/**
+	 * @var string $text
+	 */
+	private $text;
+
+	/**
+	 * @var string $color;
+	 */
+	private $color;
+
+
+	/**
+	 * @var int $size
+	 */
+	private $size;
+
+	/**
+	 * Constructor for Watermark data class
+	 *
+	 * @param string $text
+	 * @param string $color
+	 * @param int $size
+	 */
+	public function __construct(string $text, string $color, int $size)
+	{
+		$this->text = $text;
+		$this->color = $color;
+		$this->size = $size;
+	}
+
+	/**
+	 * Get the watermark text.
+	 *
+	 * @return string
+	 */
+	public function text(): string
+	{
+		return $this->text;
+	}
+
+	/**
+	 * Get the watermark font color.
+	 *
+	 * @return string
+	 */
+	public function color(): string
+	{
+		return $this->color;
+	}
+
+	/**
+	 * Get the watermark maximum font size.
+	 * @return int
+	 */
+	public function size(): int
+	{
+		return $this->size;
+	}
+
+	/**
+	 * Return an estimate of the size in pixels of the watermark text length.
+	 *
+	 * @return int
+	 */
+	public function textLengthEstimate(): int
+	{
+		return $this->stringLengthEstimate(mb_strlen($this->text), $this->size);
+	}
+
+	/**
+	 * Decrease the font size if necessary, based on the image width.
+	 *
+	 * @param int $width
+	 */
+	public function adjustSize(int $width): void
+	{
+		$len = mb_strlen($this->text);
+		while ($this->stringLengthEstimate($len, $this->size) > 0.9 * $width) {
+			$this->size--;
+			if ($this->size == 2) {
+				return;
+			}
+		}
+	}
+
+	/**
+	 * Return an estimate of the size in pixels of a text in a specified font size.
+	 *
+	 * @param int $text_length
+	 * @param int $font_size
+	 * @return int
+	 */
+	private function stringLengthEstimate(int $text_length, int $font_size): int
+	{
+		return $text_length * (int) ceil(($font_size + 2) * 0.5);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -125,6 +125,6 @@
      */
     private function stringLengthEstimate(int $text_length, int $font_size): int
     {
-        return $text_length * (int) ceil(($font_size + 2) * 0.5);
+        return $text_length * (int)ceil(($font_size + 2) * 0.5);
     }
 }

app/Module/Certificates/Model/Certificate.php

Spacing +3 added lines, -3 removed lines

@@ -202,11 +202,11 @@
     {
         $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) {
+            $sort_prefix = implode('_', array_map(function($match) {
                 return $match[1];
-            }, $matches)) . '_';
+            }, $matches)).'_';
         }
-        return $sort_prefix . $this->description();
+        return $sort_prefix.$this->description();
     }
 
     /**

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($path);
-        $this->city = $path_parts['dirname'];
-        $this->basename = $path_parts['basename'];
-        $this->filename = $path_parts['filename'];
-        $this->extension = strtolower($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($path);
+		$this->city = $path_parts['dirname'];
+		$this->basename = $path_parts['basename'];
+		$this->filename = $path_parts['filename'];
+		$this->extension = strtolower($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/Certificates/Elements/SourceCertificate.php

Indentation +52 added lines, -52 removed lines

@@ -28,61 +28,61 @@
  */
 class SourceCertificate extends AbstractElement
 {
-    protected CertificatesModule $module;
-    protected CertificateFilesystemService $certif_filesystem;
-    protected UrlObfuscatorService $url_obfuscator_service;
+	protected CertificatesModule $module;
+	protected CertificateFilesystemService $certif_filesystem;
+	protected UrlObfuscatorService $url_obfuscator_service;
 
-    /**
-     * Constructor for SourceCertificate element
-     *
-     * @param string $label
-     * @param CertificatesModule $module
-     * @param CertificateFilesystemService $certif_filesystem
-     * @param UrlObfuscatorService $url_obfuscator_service
-     */
-    public function __construct(
-        string $label,
-        CertificatesModule $module,
-        CertificateFilesystemService $certif_filesystem = null,
-        UrlObfuscatorService $url_obfuscator_service = null
-    ) {
-        parent::__construct($label, null);
-        $this->module = $module;
-        $this->certif_filesystem = $certif_filesystem ?? app(CertificateFilesystemService::class);
-        $this->url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
-    }
+	/**
+	 * Constructor for SourceCertificate element
+	 *
+	 * @param string $label
+	 * @param CertificatesModule $module
+	 * @param CertificateFilesystemService $certif_filesystem
+	 * @param UrlObfuscatorService $url_obfuscator_service
+	 */
+	public function __construct(
+		string $label,
+		CertificatesModule $module,
+		CertificateFilesystemService $certif_filesystem = null,
+		UrlObfuscatorService $url_obfuscator_service = null
+	) {
+		parent::__construct($label, null);
+		$this->module = $module;
+		$this->certif_filesystem = $certif_filesystem ?? app(CertificateFilesystemService::class);
+		$this->url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Elements\AbstractElement::canonical()
-     */
-    public function canonical($value): string
-    {
-        return strtr($value, '\\', '/');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Elements\AbstractElement::canonical()
+	 */
+	public function canonical($value): string
+	{
+		return strtr($value, '\\', '/');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Elements\AbstractElement::edit()
-     */
-    public function edit(string $id, string $name, string $value, Tree $tree): string
-    {
-        list($city, $file) = explode('/', $this->canonical($value), 2) + ['', ''];
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Elements\AbstractElement::edit()
+	 */
+	public function edit(string $id, string $name, string $value, Tree $tree): string
+	{
+		list($city, $file) = explode('/', $this->canonical($value), 2) + ['', ''];
 
-        $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));
 
-        return view($this->module->name() . '::components/edit-certificate', [
-            'module_name'   =>  $this->module->name(),
-            'tree'          =>  $tree,
-            'id'            =>  $id,
-            'name'          =>  $name,
-            'cities'        =>  $cities,
-            'value'         =>  $this->canonical($value),
-            'value_city'    =>  $city,
-            'value_file'    =>  $file,
-            'js_script_url' =>  $this->module->assetUrl('js/certificates.min.js')
-        ]);
-    }
+		return view($this->module->name() . '::components/edit-certificate', [
+			'module_name'   =>  $this->module->name(),
+			'tree'          =>  $tree,
+			'id'            =>  $id,
+			'name'          =>  $name,
+			'cities'        =>  $cities,
+			'value'         =>  $this->canonical($value),
+			'value_city'    =>  $city,
+			'value_file'    =>  $file,
+			'js_script_url' =>  $this->module->assetUrl('js/certificates.min.js')
+		]);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -69,11 +69,11 @@
     {
         list($city, $file) = explode('/', $this->canonical($value), 2) + ['', ''];
 
-        $cities = array_map(function (string $item): array {
+        $cities = array_map(function(string $item): array {
             return [$this->url_obfuscator_service->obfuscate($item), $item];
         }, $this->certif_filesystem->cities($tree));
 
-        return view($this->module->name() . '::components/edit-certificate', [
+        return view($this->module->name().'::components/edit-certificate', [
             'module_name'   =>  $this->module->name(),
             'tree'          =>  $tree,
             'id'            =>  $id,

app/Module/AdminTasks/Http/RequestHandlers/TasksList.php

Indentation +82 added lines, -82 removed lines

@@ -31,90 +31,90 @@
  */
 class TasksList implements RequestHandlerInterface
 {
-    private ?AdminTasksModule $module;
-    private TaskScheduleService $taskschedules_service;
+	private ?AdminTasksModule $module;
+	private TaskScheduleService $taskschedules_service;
 
-    /**
-     * Constructor for TasksList Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param TaskScheduleService $taskschedules_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        TaskScheduleService $taskschedules_service
-    ) {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->taskschedules_service = $taskschedules_service;
-    }
+	/**
+	 * Constructor for TasksList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param TaskScheduleService $taskschedules_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		TaskScheduleService $taskschedules_service
+	) {
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->taskschedules_service = $taskschedules_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.'));
+		}
 
-        $module = $this->module;
-        $module_name = $this->module->name();
-        return response(['data' => $this->taskschedules_service->all(true, true)
-            ->map(function (TaskSchedule $schedule) use ($module, $module_name): array {
-                $task = $this->taskschedules_service->findTask($schedule->taskId());
-                $task_name = $task !== null ? $task->name() : I18N::translate('Task not found');
+		$module = $this->module;
+		$module_name = $this->module->name();
+		return response(['data' => $this->taskschedules_service->all(true, true)
+			->map(function (TaskSchedule $schedule) use ($module, $module_name): array {
+				$task = $this->taskschedules_service->findTask($schedule->taskId());
+				$task_name = $task !== null ? $task->name() : I18N::translate('Task not found');
 
-                return [
-                    'edit' =>   view($module_name . '::admin/tasks-table-options', [
-                        'task_sched_id' => $schedule->id(),
-                        'task_sched_enabled' => $schedule->isEnabled(),
-                        'task_edit_route' => route(TaskEditPage::class, ['task' => $schedule->id()]),
-                        'task_status_route' => route(TaskStatusAction::class, [
-                            'task' => $schedule->id(),
-                            'enable' => $schedule->isEnabled() ? 0 : 1
-                        ])
-                    ]),
-                    'status'    =>  [
-                        'display'   =>  view($module_name . '::components/yes-no-icons', [
-                            'yes' => $schedule->isEnabled()
-                        ]),
-                        'raw'       =>  $schedule->isEnabled() ? 1 : 0
-                    ],
-                    'task_name' =>  [
-                        'display'   =>  '<span dir="auto">' . e($task_name) . '</span>',
-                        'raw'       =>  $task_name
-                    ],
-                    'last_run'  =>  [
-                        'display'   =>  $schedule->lastRunTime()->unix() === 0 ?
-                            view('components/datetime', ['timestamp' => $schedule->lastRunTime()]) :
-                            view('components/datetime-diff', ['timestamp' => $schedule->lastRunTime()]),
-                        'raw'       =>  $schedule->lastRunTime()->unix()
-                    ],
-                    'last_result'   =>  [
-                        'display'   => view($module_name . '::components/yes-no-icons', [
-                            'yes' => $schedule->wasLastRunSuccess()
-                        ]),
-                        'raw'       =>  $schedule->wasLastRunSuccess() ? 1 : 0
-                    ],
-                    'frequency' =>  '<span dir="auto">' . e($schedule->frequency()->cascade()->forHumans()) . '</span>',
-                    'nb_occurrences'    =>  $schedule->remainingOccurences() > 0 ?
-                        I18N::number($schedule->remainingOccurences()) :
-                        I18N::translate('Unlimited'),
-                    'running'   =>  view($module_name . '::components/yes-no-icons', [
-                        'yes' => $schedule->isRunning(),
-                        'text_yes' => I18N::translate('Running'),
-                        'text_no' => I18N::translate('Not running')
-                    ]),
-                    'run'       =>  view($module_name . '::admin/tasks-table-run', [
-                        'task_sched_id' => $schedule->id(),
-                        'run_route' => route(TaskTrigger::class, [
-                            'task'  =>  $schedule->taskId(),
-                            'force' =>  $module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN')
-                        ])
-                    ])
-                ];
-            })
-        ]);
-    }
+				return [
+					'edit' =>   view($module_name . '::admin/tasks-table-options', [
+						'task_sched_id' => $schedule->id(),
+						'task_sched_enabled' => $schedule->isEnabled(),
+						'task_edit_route' => route(TaskEditPage::class, ['task' => $schedule->id()]),
+						'task_status_route' => route(TaskStatusAction::class, [
+							'task' => $schedule->id(),
+							'enable' => $schedule->isEnabled() ? 0 : 1
+						])
+					]),
+					'status'    =>  [
+						'display'   =>  view($module_name . '::components/yes-no-icons', [
+							'yes' => $schedule->isEnabled()
+						]),
+						'raw'       =>  $schedule->isEnabled() ? 1 : 0
+					],
+					'task_name' =>  [
+						'display'   =>  '<span dir="auto">' . e($task_name) . '</span>',
+						'raw'       =>  $task_name
+					],
+					'last_run'  =>  [
+						'display'   =>  $schedule->lastRunTime()->unix() === 0 ?
+							view('components/datetime', ['timestamp' => $schedule->lastRunTime()]) :
+							view('components/datetime-diff', ['timestamp' => $schedule->lastRunTime()]),
+						'raw'       =>  $schedule->lastRunTime()->unix()
+					],
+					'last_result'   =>  [
+						'display'   => view($module_name . '::components/yes-no-icons', [
+							'yes' => $schedule->wasLastRunSuccess()
+						]),
+						'raw'       =>  $schedule->wasLastRunSuccess() ? 1 : 0
+					],
+					'frequency' =>  '<span dir="auto">' . e($schedule->frequency()->cascade()->forHumans()) . '</span>',
+					'nb_occurrences'    =>  $schedule->remainingOccurences() > 0 ?
+						I18N::number($schedule->remainingOccurences()) :
+						I18N::translate('Unlimited'),
+					'running'   =>  view($module_name . '::components/yes-no-icons', [
+						'yes' => $schedule->isRunning(),
+						'text_yes' => I18N::translate('Running'),
+						'text_no' => I18N::translate('Not running')
+					]),
+					'run'       =>  view($module_name . '::admin/tasks-table-run', [
+						'task_sched_id' => $schedule->id(),
+						'run_route' => route(TaskTrigger::class, [
+							'task'  =>  $schedule->taskId(),
+							'force' =>  $module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN')
+						])
+					])
+				];
+			})
+		]);
+	}
 }

Spacing +10 added lines, -12 removed lines

@@ -61,12 +61,12 @@ 
         $module = $this->module;
         $module_name = $this->module->name();
         return response(['data' => $this->taskschedules_service->all(true, true)
-            ->map(function (TaskSchedule $schedule) use ($module, $module_name): array {
+            ->map(function(TaskSchedule $schedule) use ($module, $module_name): array {
                 $task = $this->taskschedules_service->findTask($schedule->taskId());
                 $task_name = $task !== null ? $task->name() : I18N::translate('Task not found');
 
                 return [
-                    'edit' =>   view($module_name . '::admin/tasks-table-options', [
+                    'edit' =>   view($module_name.'::admin/tasks-table-options', [
                         'task_sched_id' => $schedule->id(),
                         'task_sched_enabled' => $schedule->isEnabled(),
                         'task_edit_route' => route(TaskEditPage::class, ['task' => $schedule->id()]),
@@ -76,37 +76,35 @@ 
                         ])
                     ]),
                     'status'    =>  [
-                        'display'   =>  view($module_name . '::components/yes-no-icons', [
+                        'display'   =>  view($module_name.'::components/yes-no-icons', [
                             'yes' => $schedule->isEnabled()
                         ]),
                         'raw'       =>  $schedule->isEnabled() ? 1 : 0
                     ],
                     'task_name' =>  [
-                        'display'   =>  '<span dir="auto">' . e($task_name) . '</span>',
+                        'display'   =>  '<span dir="auto">'.e($task_name).'</span>',
                         'raw'       =>  $task_name
                     ],
                     'last_run'  =>  [
                         'display'   =>  $schedule->lastRunTime()->unix() === 0 ?
-                            view('components/datetime', ['timestamp' => $schedule->lastRunTime()]) :
-                            view('components/datetime-diff', ['timestamp' => $schedule->lastRunTime()]),
+                            view('components/datetime', ['timestamp' => $schedule->lastRunTime()]) : view('components/datetime-diff', ['timestamp' => $schedule->lastRunTime()]),
                         'raw'       =>  $schedule->lastRunTime()->unix()
                     ],
                     'last_result'   =>  [
-                        'display'   => view($module_name . '::components/yes-no-icons', [
+                        'display'   => view($module_name.'::components/yes-no-icons', [
                             'yes' => $schedule->wasLastRunSuccess()
                         ]),
                         'raw'       =>  $schedule->wasLastRunSuccess() ? 1 : 0
                     ],
-                    'frequency' =>  '<span dir="auto">' . e($schedule->frequency()->cascade()->forHumans()) . '</span>',
+                    'frequency' =>  '<span dir="auto">'.e($schedule->frequency()->cascade()->forHumans()).'</span>',
                     'nb_occurrences'    =>  $schedule->remainingOccurences() > 0 ?
-                        I18N::number($schedule->remainingOccurences()) :
-                        I18N::translate('Unlimited'),
-                    'running'   =>  view($module_name . '::components/yes-no-icons', [
+                        I18N::number($schedule->remainingOccurences()) : I18N::translate('Unlimited'),
+                    'running'   =>  view($module_name.'::components/yes-no-icons', [
                         'yes' => $schedule->isRunning(),
                         'text_yes' => I18N::translate('Running'),
                         'text_no' => I18N::translate('Not running')
                     ]),
-                    'run'       =>  view($module_name . '::admin/tasks-table-run', [
+                    'run'       =>  view($module_name.'::admin/tasks-table-run', [
                         'task_sched_id' => $schedule->id(),
                         'run_route' => route(TaskTrigger::class, [
                             'task'  =>  $schedule->taskId(),

app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php

Indentation +147 added lines, -147 removed lines

@@ -33,151 +33,151 @@
  */
 class TaskEditAction implements RequestHandlerInterface
 {
-    private ?AdminTasksModule $module;
-    private TaskScheduleService $taskschedules_service;
-
-    /**
-     * Constructor for TaskEditAction Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param TaskScheduleService $taskschedules_service
-     */
-    public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
-    {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->taskschedules_service = $taskschedules_service;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $admin_config_route = route(AdminConfigPage::class);
-
-        if ($this->module === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The attached module could not be found.'),
-                'danger'
-            );
-            return redirect($admin_config_route);
-        }
-
-        $task_sched_id = (int) $request->getAttribute('task');
-        $task_schedule = $this->taskschedules_service->find($task_sched_id);
-
-        if ($task_schedule === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The task shedule with ID “%s” does not exist.', I18N::number($task_sched_id)),
-                'danger'
-            );
-            return redirect($admin_config_route);
-        }
-
-        $success = $this->updateGeneralSettings($task_schedule, $request);
-        $success = $success && $this->updateSpecificSettings($task_schedule, $request);
-
-        if ($success) {
-            FlashMessages::addMessage(
-                I18N::translate('The scheduled task has been successfully updated.'),
-                'success'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
-        }
-
-        return redirect($admin_config_route);
-    }
-
-    /**
-     * Update general settings for the task, based on the request parameters
-     *
-     * @param TaskSchedule $task_schedule
-     * @param ServerRequestInterface $request
-     * @return bool
-     */
-    private function updateGeneralSettings(TaskSchedule $task_schedule, ServerRequestInterface $request): bool
-    {
-        if ($this->module === null) {
-            return false;
-        }
-
-        $params = (array) $request->getParsedBody();
-
-        $frequency = (int) $params['frequency'];
-        if ($frequency > 0) {
-            $task_schedule->setFrequency(CarbonInterval::minutes($frequency));
-        } else {
-            FlashMessages::addMessage(I18N::translate('The frequency is not in a valid format.'), 'danger');
-        }
-
-        $is_limited = (bool) $params['is_limited'];
-        $nb_occur = (int) $params['nb_occur'];
-
-        if ($is_limited) {
-            if ($nb_occur > 0) {
-                $task_schedule->setRemainingOccurences($nb_occur);
-            } else {
-                FlashMessages::addMessage(
-                    I18N::translate('The number of remaining occurences is not in a valid format.'),
-                    'danger'
-                );
-            }
-        } else {
-            $task_schedule->setRemainingOccurences(0);
-        }
-
-        try {
-            $this->taskschedules_service->update($task_schedule);
-            return true;
-        } catch (Throwable $ex) {
-            Log::addErrorLog(
-                sprintf(
-                    'Error while updating the Task Schedule "%s". Exception: %s',
-                    $task_schedule->id(),
-                    $ex->getMessage()
-                )
-            );
-        }
-
-        FlashMessages::addMessage(I18N::translate('An error occured while updating the scheduled task.'), 'danger');
-        //@phpcs:ignore Generic.Files.LineLength.TooLong
-        Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
-        return false;
-    }
-
-    /**
-     * Update general settings for the task, based on the request parameters
-     *
-     * @param TaskSchedule $task_schedule
-     * @param ServerRequestInterface $request
-     * @return bool
-     */
-    private function updateSpecificSettings(TaskSchedule $task_schedule, ServerRequestInterface $request): bool
-    {
-        if ($this->module === null) {
-            return false;
-        }
-
-        $task = $this->taskschedules_service->findTask($task_schedule->taskId());
-        if ($task === null || !($task instanceof ConfigurableTaskInterface)) {
-            return true;
-        }
-
-        /** @var \MyArtJaub\Webtrees\Contracts\Tasks\TaskInterface&\MyArtJaub\Webtrees\Contracts\Tasks\ConfigurableTaskInterface $task */
-        if (!$task->updateConfig($request, $task_schedule)) {
-            FlashMessages::addMessage(
-                I18N::translate(
-                    'An error occured while updating the specific settings of administrative task “%s”.',
-                    $task->name()
-                ),
-                'danger'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : AdminTask “' . $task->name() . '” specific settings could not be updated. See error log.');
-        }
-
-        return true;
-    }
+	private ?AdminTasksModule $module;
+	private TaskScheduleService $taskschedules_service;
+
+	/**
+	 * Constructor for TaskEditAction Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param TaskScheduleService $taskschedules_service
+	 */
+	public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
+	{
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->taskschedules_service = $taskschedules_service;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$admin_config_route = route(AdminConfigPage::class);
+
+		if ($this->module === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The attached module could not be found.'),
+				'danger'
+			);
+			return redirect($admin_config_route);
+		}
+
+		$task_sched_id = (int) $request->getAttribute('task');
+		$task_schedule = $this->taskschedules_service->find($task_sched_id);
+
+		if ($task_schedule === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The task shedule with ID “%s” does not exist.', I18N::number($task_sched_id)),
+				'danger'
+			);
+			return redirect($admin_config_route);
+		}
+
+		$success = $this->updateGeneralSettings($task_schedule, $request);
+		$success = $success && $this->updateSpecificSettings($task_schedule, $request);
+
+		if ($success) {
+			FlashMessages::addMessage(
+				I18N::translate('The scheduled task has been successfully updated.'),
+				'success'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
+		}
+
+		return redirect($admin_config_route);
+	}
+
+	/**
+	 * Update general settings for the task, based on the request parameters
+	 *
+	 * @param TaskSchedule $task_schedule
+	 * @param ServerRequestInterface $request
+	 * @return bool
+	 */
+	private function updateGeneralSettings(TaskSchedule $task_schedule, ServerRequestInterface $request): bool
+	{
+		if ($this->module === null) {
+			return false;
+		}
+
+		$params = (array) $request->getParsedBody();
+
+		$frequency = (int) $params['frequency'];
+		if ($frequency > 0) {
+			$task_schedule->setFrequency(CarbonInterval::minutes($frequency));
+		} else {
+			FlashMessages::addMessage(I18N::translate('The frequency is not in a valid format.'), 'danger');
+		}
+
+		$is_limited = (bool) $params['is_limited'];
+		$nb_occur = (int) $params['nb_occur'];
+
+		if ($is_limited) {
+			if ($nb_occur > 0) {
+				$task_schedule->setRemainingOccurences($nb_occur);
+			} else {
+				FlashMessages::addMessage(
+					I18N::translate('The number of remaining occurences is not in a valid format.'),
+					'danger'
+				);
+			}
+		} else {
+			$task_schedule->setRemainingOccurences(0);
+		}
+
+		try {
+			$this->taskschedules_service->update($task_schedule);
+			return true;
+		} catch (Throwable $ex) {
+			Log::addErrorLog(
+				sprintf(
+					'Error while updating the Task Schedule "%s". Exception: %s',
+					$task_schedule->id(),
+					$ex->getMessage()
+				)
+			);
+		}
+
+		FlashMessages::addMessage(I18N::translate('An error occured while updating the scheduled task.'), 'danger');
+		//@phpcs:ignore Generic.Files.LineLength.TooLong
+		Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
+		return false;
+	}
+
+	/**
+	 * Update general settings for the task, based on the request parameters
+	 *
+	 * @param TaskSchedule $task_schedule
+	 * @param ServerRequestInterface $request
+	 * @return bool
+	 */
+	private function updateSpecificSettings(TaskSchedule $task_schedule, ServerRequestInterface $request): bool
+	{
+		if ($this->module === null) {
+			return false;
+		}
+
+		$task = $this->taskschedules_service->findTask($task_schedule->taskId());
+		if ($task === null || !($task instanceof ConfigurableTaskInterface)) {
+			return true;
+		}
+
+		/** @var \MyArtJaub\Webtrees\Contracts\Tasks\TaskInterface&\MyArtJaub\Webtrees\Contracts\Tasks\ConfigurableTaskInterface $task */
+		if (!$task->updateConfig($request, $task_schedule)) {
+			FlashMessages::addMessage(
+				I18N::translate(
+					'An error occured while updating the specific settings of administrative task “%s”.',
+					$task->name()
+				),
+				'danger'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addConfigurationLog('Module ' . $this->module->title() . ' : AdminTask “' . $task->name() . '” specific settings could not be updated. See error log.');
+		}
+
+		return true;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -64,7 +64,7 @@ 
             return redirect($admin_config_route);
         }
 
-        $task_sched_id = (int) $request->getAttribute('task');
+        $task_sched_id = (int)$request->getAttribute('task');
         $task_schedule = $this->taskschedules_service->find($task_sched_id);
 
         if ($task_schedule === null) {
@@ -84,7 +84,7 @@ 
                 'success'
             );
             //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
+            Log::addConfigurationLog('Module '.$this->module->title().' : Task Schedule “'.$task_schedule->id().'” has been updated.');
         }
 
         return redirect($admin_config_route);
@@ -103,17 +103,17 @@ 
             return false;
         }
 
-        $params = (array) $request->getParsedBody();
+        $params = (array)$request->getParsedBody();
 
-        $frequency = (int) $params['frequency'];
+        $frequency = (int)$params['frequency'];
         if ($frequency > 0) {
             $task_schedule->setFrequency(CarbonInterval::minutes($frequency));
         } else {
             FlashMessages::addMessage(I18N::translate('The frequency is not in a valid format.'), 'danger');
         }
 
-        $is_limited = (bool) $params['is_limited'];
-        $nb_occur = (int) $params['nb_occur'];
+        $is_limited = (bool)$params['is_limited'];
+        $nb_occur = (int)$params['nb_occur'];
 
         if ($is_limited) {
             if ($nb_occur > 0) {
@@ -143,7 +143,7 @@ 
 
         FlashMessages::addMessage(I18N::translate('An error occured while updating the scheduled task.'), 'danger');
         //@phpcs:ignore Generic.Files.LineLength.TooLong
-        Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
+        Log::addConfigurationLog('Module '.$this->module->title().' : Task Schedule “'.$task_schedule->id().'” could not be updated. See error log.');
         return false;
     }
 
@@ -175,7 +175,7 @@ 
                 'danger'
             );
             //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : AdminTask “' . $task->name() . '” specific settings could not be updated. See error log.');
+            Log::addConfigurationLog('Module '.$this->module->title().' : AdminTask “'.$task->name().'” specific settings could not be updated. See error log.');
         }
 
         return true;

app/Module/AdminTasks/Http/RequestHandlers/TaskStatusAction.php

Indentation +55 added lines, -55 removed lines

@@ -29,68 +29,68 @@
  */
 class TaskStatusAction implements RequestHandlerInterface
 {
-    private ?AdminTasksModule $module;
-    private TaskScheduleService $taskschedules_service;
+	private ?AdminTasksModule $module;
+	private TaskScheduleService $taskschedules_service;
 
-    /**
-     * Constructor for TaskStatusAction Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param TaskScheduleService $taskschedules_service
-     */
-    public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
-    {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->taskschedules_service = $taskschedules_service;
-    }
+	/**
+	 * Constructor for TaskStatusAction Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param TaskScheduleService $taskschedules_service
+	 */
+	public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
+	{
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->taskschedules_service = $taskschedules_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $admin_config_route = route(AdminConfigPage::class);
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$admin_config_route = route(AdminConfigPage::class);
 
-        if ($this->module === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The attached module could not be found.'),
-                'danger'
-            );
-            return redirect($admin_config_route);
-        }
+		if ($this->module === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The attached module could not be found.'),
+				'danger'
+			);
+			return redirect($admin_config_route);
+		}
 
-        $task_sched_id = (int) $request->getAttribute('task');
-        $task_schedule = $this->taskschedules_service->find($task_sched_id);
+		$task_sched_id = (int) $request->getAttribute('task');
+		$task_schedule = $this->taskschedules_service->find($task_sched_id);
 
-        $admin_config_route = route(AdminConfigPage::class);
+		$admin_config_route = route(AdminConfigPage::class);
 
-        if ($task_schedule === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The task shedule with ID “%s” does not exist.', I18N::number($task_sched_id)),
-                'danger'
-            );
-            return redirect($admin_config_route);
-        }
+		if ($task_schedule === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The task shedule with ID “%s” does not exist.', I18N::number($task_sched_id)),
+				'danger'
+			);
+			return redirect($admin_config_route);
+		}
 
-        ((bool) $request->getAttribute('enable', false)) ? $task_schedule->enable() : $task_schedule->disable();
+		((bool) $request->getAttribute('enable', false)) ? $task_schedule->enable() : $task_schedule->disable();
 
-        if ($this->taskschedules_service->update($task_schedule) > 0) {
-            FlashMessages::addMessage(
-                I18N::translate('The scheduled task has been successfully updated.'),
-                'success'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
-        } else {
-            FlashMessages::addMessage(
-                I18N::translate('An error occured while updating the scheduled task.'),
-                'danger'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
-        }
+		if ($this->taskschedules_service->update($task_schedule) > 0) {
+			FlashMessages::addMessage(
+				I18N::translate('The scheduled task has been successfully updated.'),
+				'success'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
+		} else {
+			FlashMessages::addMessage(
+				I18N::translate('An error occured while updating the scheduled task.'),
+				'danger'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
+		}
 
-        return redirect($admin_config_route);
-    }
+		return redirect($admin_config_route);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -60,7 +60,7 @@ 
             return redirect($admin_config_route);
         }
 
-        $task_sched_id = (int) $request->getAttribute('task');
+        $task_sched_id = (int)$request->getAttribute('task');
         $task_schedule = $this->taskschedules_service->find($task_sched_id);
 
         $admin_config_route = route(AdminConfigPage::class);
@@ -73,7 +73,7 @@ 
             return redirect($admin_config_route);
         }
 
-        ((bool) $request->getAttribute('enable', false)) ? $task_schedule->enable() : $task_schedule->disable();
+        ((bool)$request->getAttribute('enable', false)) ? $task_schedule->enable() : $task_schedule->disable();
 
         if ($this->taskschedules_service->update($task_schedule) > 0) {
             FlashMessages::addMessage(
@@ -81,14 +81,14 @@ 
                 'success'
             );
             //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
+            Log::addConfigurationLog('Module '.$this->module->title().' : Task Schedule “'.$task_schedule->id().'” has been updated.');
         } else {
             FlashMessages::addMessage(
                 I18N::translate('An error occured while updating the scheduled task.'),
                 'danger'
             );
             //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
+            Log::addConfigurationLog('Module '.$this->module->title().' : Task Schedule “'.$task_schedule->id().'” could not be updated. See error log.');
         }
 
         return redirect($admin_config_route);

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

Indentation +37 added lines, -37 removed lines

@@ -29,47 +29,47 @@
  */
 class AdminConfigPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?AdminTasksModule $module;
-    private TokenService $token_service;
+	private ?AdminTasksModule $module;
+	private TokenService $token_service;
 
-    /**
-     * Constructor for Admin Config request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service, TokenService $token_service)
-    {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->token_service = $token_service;
-    }
+	/**
+	 * Constructor for Admin Config request handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service, TokenService $token_service)
+	{
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->token_service = $token_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.'));
+		}
 
-        $token = $this->module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN');
-        if ($token === '') {
-            $token = $this->token_service->generateRandomToken();
-            $this->module->setPreference('PAT_FORCE_EXEC_TOKEN', $token);
-        }
+		$token = $this->module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN');
+		if ($token === '') {
+			$token = $this->token_service->generateRandomToken();
+			$this->module->setPreference('PAT_FORCE_EXEC_TOKEN', $token);
+		}
 
-        return $this->viewResponse($this->module->name() . '::admin/config', [
-            'title'             =>  $this->module->title(),
-            'trigger_token'     =>  $token,
-            'trigger_route'     =>  route(TaskTrigger::class, ['task' => '__TASKNAME__', 'force' => '__TOKEN__']),
-            'new_token_route'   =>  route(TokenGenerate::class),
-            'tasks_data_route'  =>  route(TasksList::class),
-            'js_script_url'     =>  $this->module->assetUrl('js/admintasks.min.js')
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::admin/config', [
+			'title'             =>  $this->module->title(),
+			'trigger_token'     =>  $token,
+			'trigger_route'     =>  route(TaskTrigger::class, ['task' => '__TASKNAME__', 'force' => '__TOKEN__']),
+			'new_token_route'   =>  route(TokenGenerate::class),
+			'tasks_data_route'  =>  route(TasksList::class),
+			'js_script_url'     =>  $this->module->assetUrl('js/admintasks.min.js')
+		]);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
             $this->module->setPreference('PAT_FORCE_EXEC_TOKEN', $token);
         }
         
-        return $this->viewResponse($this->module->name() . '::admin/config', [
+        return $this->viewResponse($this->module->name().'::admin/config', [
             'title'             =>  $this->module->title(),
             'trigger_token'     =>  $token,
             'trigger_route'     =>  route(TaskTrigger::class, ['task' => '__TASKNAME__', 'force' => '__TOKEN__']),

app/Module/AdminTasks/Http/RequestHandlers/TaskTrigger.php

Indentation +31 added lines, -31 removed lines

@@ -28,41 +28,41 @@
  */
 class TaskTrigger implements RequestHandlerInterface
 {
-    private ?AdminTasksModule $module;
-    private TaskScheduleService $taskschedules_service;
+	private ?AdminTasksModule $module;
+	private TaskScheduleService $taskschedules_service;
 
-    /**
-     * Constructor for TaskTrigger request handler
-     * @param ModuleService $module_service
-     * @param TaskScheduleService $taskschedules_service
-     */
-    public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
-    {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->taskschedules_service = $taskschedules_service;
-    }
+	/**
+	 * Constructor for TaskTrigger request handler
+	 * @param ModuleService $module_service
+	 * @param TaskScheduleService $taskschedules_service
+	 */
+	public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
+	{
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->taskschedules_service = $taskschedules_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.'));
+		}
 
-        $task_id = $request->getAttribute('task');
-        $token = $this->module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN');
-        $force_token = $request->getQueryParams()['force'] ?? '';
-        $force = $token == $force_token;
+		$task_id = $request->getAttribute('task');
+		$token = $this->module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN');
+		$force_token = $request->getQueryParams()['force'] ?? '';
+		$force = $token == $force_token;
 
-        $task_schedules = $this->taskschedules_service->findTasksToRun($force, $task_id);
+		$task_schedules = $this->taskschedules_service->findTasksToRun($force, $task_id);
 
-        foreach ($task_schedules as $task_schedule) {
-            $this->taskschedules_service->run($task_schedule, $force);
-        }
+		foreach ($task_schedules as $task_schedule) {
+			$this->taskschedules_service->run($task_schedule, $force);
+		}
 
-        return response();
-    }
+		return response();
+	}
 }