jon48 / webtrees-lib

app/Common/GeoDispersion/GeoAnalysis/GeoAnalysisResults.php

Indentation +89 added lines, -89 removed lines

@@ -23,102 +23,102 @@
  */
 class GeoAnalysisResults
 {
-    private GeoAnalysisResult $global;
+	private GeoAnalysisResult $global;
 
-    /**
-     * @var Collection<string, GeoAnalysisResult> $detailed
-     */
-    private Collection $detailed;
+	/**
+	 * @var Collection<string, GeoAnalysisResult> $detailed
+	 */
+	private Collection $detailed;
 
-    /**
-     * Constructor for GeoAnalysisResults
-     */
-    public function __construct()
-    {
-        $this->global = new GeoAnalysisResult('Global', 0);
-        $this->detailed = new Collection();
-    }
+	/**
+	 * Constructor for GeoAnalysisResults
+	 */
+	public function __construct()
+	{
+		$this->global = new GeoAnalysisResult('Global', 0);
+		$this->detailed = new Collection();
+	}
 
-    /**
-     * Global result of the geographical analysis
-     *
-     * @return GeoAnalysisResult
-     */
-    public function global(): GeoAnalysisResult
-    {
-        return $this->global;
-    }
+	/**
+	 * Global result of the geographical analysis
+	 *
+	 * @return GeoAnalysisResult
+	 */
+	public function global(): GeoAnalysisResult
+	{
+		return $this->global;
+	}
 
-    /**
-     * List of results by category of the geographical analysis
-     *
-     * @return Collection<string, GeoAnalysisResult>
-     */
-    public function detailed(): Collection
-    {
-        return $this->detailed;
-    }
+	/**
+	 * List of results by category of the geographical analysis
+	 *
+	 * @return Collection<string, GeoAnalysisResult>
+	 */
+	public function detailed(): Collection
+	{
+		return $this->detailed;
+	}
 
-    /**
-     * List of results by category of the geographical analysis.
-     * The list is sorted first by the category order, then by the category description
-     */
-    public function sortedDetailed(): Collection
-    {
-        return $this->detailed->sortBy([
-            fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int => $a->order() <=> $b->order(),
-            fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int =>
-                I18N::comparator()($a->description(), $b->description())
-        ]);
-    }
+	/**
+	 * List of results by category of the geographical analysis.
+	 * The list is sorted first by the category order, then by the category description
+	 */
+	public function sortedDetailed(): Collection
+	{
+		return $this->detailed->sortBy([
+			fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int => $a->order() <=> $b->order(),
+			fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int =>
+				I18N::comparator()($a->description(), $b->description())
+		]);
+	}
 
-    /**
-     * Add a GeoAnalysis Place to the global result
-     *
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlace(GeoAnalysisPlace $place): void
-    {
-        $this->global()->addPlace($place);
-    }
+	/**
+	 * Add a GeoAnalysis Place to the global result
+	 *
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlace(GeoAnalysisPlace $place): void
+	{
+		$this->global()->addPlace($place);
+	}
 
-    /**
-     * Add a new category to the list of results, if it does not exist yet
-     *
-     * @param string $description
-     * @param int $order
-     */
-    public function addCategory(string $description, int $order): void
-    {
-        if (!$this->detailed->has($description)) {
-            $this->detailed->put($description, new GeoAnalysisResult($description, $order));
-        }
-    }
+	/**
+	 * Add a new category to the list of results, if it does not exist yet
+	 *
+	 * @param string $description
+	 * @param int $order
+	 */
+	public function addCategory(string $description, int $order): void
+	{
+		if (!$this->detailed->has($description)) {
+			$this->detailed->put($description, new GeoAnalysisResult($description, $order));
+		}
+	}
 
-    /**
-     * Add a GeoAnalysis Place to a category result, if the category exist.
-     *
-     * @param string $category_name
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlaceInCreatedCategory(string $category_name, GeoAnalysisPlace $place): void
-    {
-        if ($this->detailed->has($category_name)) {
-            $this->detailed->get($category_name)->addPlace($place);
-        }
-    }
+	/**
+	 * Add a GeoAnalysis Place to a category result, if the category exist.
+	 *
+	 * @param string $category_name
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlaceInCreatedCategory(string $category_name, GeoAnalysisPlace $place): void
+	{
+		if ($this->detailed->has($category_name)) {
+			$this->detailed->get($category_name)->addPlace($place);
+		}
+	}
 
-    /**
-     * Add a GeoAnalysis Place to a category result, after creating the category if it does not exist.
-     *
-     * @param string $category_name
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlaceInCategory(string $category_name, int $category_order, GeoAnalysisPlace $place): void
-    {
-        if (!$this->detailed->has($category_name)) {
-            $this->addCategory($category_name, $category_order);
-        }
-        $this->addPlaceInCreatedCategory($category_name, $place);
-    }
+	/**
+	 * Add a GeoAnalysis Place to a category result, after creating the category if it does not exist.
+	 *
+	 * @param string $category_name
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlaceInCategory(string $category_name, int $category_order, GeoAnalysisPlace $place): void
+	{
+		if (!$this->detailed->has($category_name)) {
+			$this->addCategory($category_name, $category_order);
+		}
+		$this->addPlaceInCreatedCategory($category_name, $place);
+	}
 }

app/Common/GeoDispersion/GeoAnalysis/GeoAnalysisPlace.php

Indentation +133 added lines, -133 removed lines

@@ -28,137 +28,137 @@
  */
 class GeoAnalysisPlace
 {
-    /**
-     * The default place name for invalid places
-     * @var string INVALID_PLACE
-     */
-    private const INVALID_PLACE = '##INVALID##';
-
-    private Place $place;
-    private int $depth;
-    private bool $strict_depth;
-    private bool $is_excluded;
-
-    /**
-     * Constructor for GeoAnalysisPlace
-     *
-     * @param Tree $tree Default tree
-     * @param Place|null $place Place resulting from the analysis
-     * @param int $depth Place hierarchy depth defined by the geographical analysis view
-     * @param bool $strict_depth Checks whether places with a lower depth than defined should be flagged as invalid
-     */
-    public function __construct(Tree $tree, ?Place $place, int $depth, bool $strict_depth = false)
-    {
-        $this->depth = $depth;
-        $this->strict_depth = $strict_depth;
-        $this->place = $this->extractPlace($place, $depth, $strict_depth) ?? new Place('', $tree);
-        $this->is_excluded = false;
-    }
-
-    /**
-     * Process the provided Place to determine its status for further usage
-     *
-     * @param Place|null $place
-     * @param int $depth
-     * @param bool $strict_depth
-     * @return Place|NULL
-     */
-    private function extractPlace(?Place $place, int $depth, bool $strict_depth): ?Place
-    {
-        if ($place === null) {
-            return null;
-        }
-        if (mb_strlen($place->gedcomName()) === 0) {
-            return null;
-        }
-        $parts = $place->lastParts($depth);
-        if ($strict_depth && $parts->count() !== $depth) {
-            return new Place(self::INVALID_PLACE, $place->tree());
-        }
-        return new Place($parts->implode(', '), $place->tree());
-    }
-
-    /**
-     * Get the GeoAnalysis Place key
-     *
-     * @return string
-     */
-    public function key(): string
-    {
-        return $this->place->gedcomName();
-    }
-
-    /**
-     * Get the underlying Place object
-     *
-     * @return Place
-     */
-    public function place(): Place
-    {
-        return $this->place;
-    }
-
-    /**
-     * Check if the GeoAnalysis Place is in the Known status
-     *
-     * @return bool
-     */
-    public function isKnown(): bool
-    {
-        return !$this->isUnknown();
-    }
-
-    /**
-     * Check if the GeoAnalysis Place is in the Unknown status
-     *
-     * @return bool
-     */
-    public function isUnknown(): bool
-    {
-        return mb_strlen($this->place->gedcomName()) === 0;
-    }
-
-    /**
-     * Check if the GeoAnalysis Place is in the Invalid status
-     *
-     * @return bool
-     */
-    public function isInvalid(): bool
-    {
-        return $this->place->gedcomName() === self::INVALID_PLACE;
-    }
-
-    /**
-     * Check if the GeoAnalysis Place is in the Excluded status
-     *
-     * @return bool
-     */
-    public function isExcluded(): bool
-    {
-        return $this->isUnknown() || $this->isInvalid() || $this->is_excluded;
-    }
-
-    /**
-     * Set the GeoAnalysis Place status to Found, if the parameter is true
-     *
-     * @param bool $include
-     * @return $this
-     */
-    public function include(bool $include = true): self
-    {
-        $this->is_excluded = !$include;
-        return $this;
-    }
-
-    /**
-     * Set the GeoAnalysis Place status to Excluded, if the parameter is true
-     *
-     * @param bool $exclude
-     * @return $this
-     */
-    public function exclude(bool $exclude = true): self
-    {
-        $this->is_excluded = $exclude;
-        return $this;
-    }
+	/**
+	 * The default place name for invalid places
+	 * @var string INVALID_PLACE
+	 */
+	private const INVALID_PLACE = '##INVALID##';
+
+	private Place $place;
+	private int $depth;
+	private bool $strict_depth;
+	private bool $is_excluded;
+
+	/**
+	 * Constructor for GeoAnalysisPlace
+	 *
+	 * @param Tree $tree Default tree
+	 * @param Place|null $place Place resulting from the analysis
+	 * @param int $depth Place hierarchy depth defined by the geographical analysis view
+	 * @param bool $strict_depth Checks whether places with a lower depth than defined should be flagged as invalid
+	 */
+	public function __construct(Tree $tree, ?Place $place, int $depth, bool $strict_depth = false)
+	{
+		$this->depth = $depth;
+		$this->strict_depth = $strict_depth;
+		$this->place = $this->extractPlace($place, $depth, $strict_depth) ?? new Place('', $tree);
+		$this->is_excluded = false;
+	}
+
+	/**
+	 * Process the provided Place to determine its status for further usage
+	 *
+	 * @param Place|null $place
+	 * @param int $depth
+	 * @param bool $strict_depth
+	 * @return Place|NULL
+	 */
+	private function extractPlace(?Place $place, int $depth, bool $strict_depth): ?Place
+	{
+		if ($place === null) {
+			return null;
+		}
+		if (mb_strlen($place->gedcomName()) === 0) {
+			return null;
+		}
+		$parts = $place->lastParts($depth);
+		if ($strict_depth && $parts->count() !== $depth) {
+			return new Place(self::INVALID_PLACE, $place->tree());
+		}
+		return new Place($parts->implode(', '), $place->tree());
+	}
+
+	/**
+	 * Get the GeoAnalysis Place key
+	 *
+	 * @return string
+	 */
+	public function key(): string
+	{
+		return $this->place->gedcomName();
+	}
+
+	/**
+	 * Get the underlying Place object
+	 *
+	 * @return Place
+	 */
+	public function place(): Place
+	{
+		return $this->place;
+	}
+
+	/**
+	 * Check if the GeoAnalysis Place is in the Known status
+	 *
+	 * @return bool
+	 */
+	public function isKnown(): bool
+	{
+		return !$this->isUnknown();
+	}
+
+	/**
+	 * Check if the GeoAnalysis Place is in the Unknown status
+	 *
+	 * @return bool
+	 */
+	public function isUnknown(): bool
+	{
+		return mb_strlen($this->place->gedcomName()) === 0;
+	}
+
+	/**
+	 * Check if the GeoAnalysis Place is in the Invalid status
+	 *
+	 * @return bool
+	 */
+	public function isInvalid(): bool
+	{
+		return $this->place->gedcomName() === self::INVALID_PLACE;
+	}
+
+	/**
+	 * Check if the GeoAnalysis Place is in the Excluded status
+	 *
+	 * @return bool
+	 */
+	public function isExcluded(): bool
+	{
+		return $this->isUnknown() || $this->isInvalid() || $this->is_excluded;
+	}
+
+	/**
+	 * Set the GeoAnalysis Place status to Found, if the parameter is true
+	 *
+	 * @param bool $include
+	 * @return $this
+	 */
+	public function include(bool $include = true): self
+	{
+		$this->is_excluded = !$include;
+		return $this;
+	}
+
+	/**
+	 * Set the GeoAnalysis Place status to Excluded, if the parameter is true
+	 *
+	 * @param bool $exclude
+	 * @return $this
+	 */
+	public function exclude(bool $exclude = true): self
+	{
+		$this->is_excluded = $exclude;
+		return $this;
+	}
 }

app/Common/GeoDispersion/GeoAnalysis/GeoAnalysisResult.php

Indentation +221 added lines, -221 removed lines

@@ -24,225 +24,225 @@
  */
 class GeoAnalysisResult
 {
-    private string $description;
-    private int $order;
-    private int $unknown_count;
-    /**
-     * @var Collection<GeoAnalysisResultItem>
-     */
-    private Collection $places;
-
-    /**
-     * Constructor for GeoAnalysisResult
-     *
-     * @param string $description
-     * @param int $order
-     * @param Collection<GeoAnalysisResultItem> $places
-     * @param int $unknown
-     */
-    final public function __construct(
-        string $description,
-        int $order = 0,
-        Collection $places = null,
-        int $unknown = 0
-    ) {
-        $this->description = $description;
-        $this->order = $order;
-        $this->places = $places ?? new Collection();
-        $this->unknown_count = $unknown;
-    }
-
-    /**
-     * Get the category description
-     *
-     * @return string
-     */
-    public function description(): string
-    {
-        return $this->description;
-    }
-
-    /**
-     * Get the category order
-     *
-     * @return int
-     */
-    public function order(): int
-    {
-        return $this->order;
-    }
-
-    /**
-     * Add a place to the analysis result
-     *
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlace(GeoAnalysisPlace $place): void
-    {
-        if ($place->isKnown()) {
-            /** @var GeoAnalysisResultItem $item */
-            $item = $this->places->get($place->key(), new GeoAnalysisResultItem($place));
-            $this->places->put($item->key(), $item->increment());
-        } else {
-            $this->addUnknown();
-        }
-    }
-
-    /**
-     * Exclude a place from the analysis result
-     *
-     * @param GeoAnalysisPlace $place
-     */
-    public function exclude(GeoAnalysisPlace $place): void
-    {
-        /** @var GeoAnalysisResultItem|null $item */
-        $item = $this->places->get($place->key());
-        if ($item !== null) {
-            $item->place()->exclude();
-        }
-    }
-
-    /**
-     * Add an unknown place to the analysis result
-     */
-    public function addUnknown(): void
-    {
-        $this->unknown_count++;
-    }
-
-    /**
-     * Take a copy of the current analysis result
-     *
-     * @return static
-     */
-    public function copy(): self
-    {
-        return new static(
-            $this->description(),
-            $this->order(),
-            $this->places->map(fn(GeoAnalysisResultItem $item): GeoAnalysisResultItem => clone $item),
-            $this->countUnknown()
-        );
-    }
-
-    /**
-     * Merge the current analysis result with another.
-     * The current object is modified, not the second one.
-     *
-     * @param GeoAnalysisResult $other
-     * @return $this
-     */
-    public function merge(GeoAnalysisResult $other): self
-    {
-        $this->places->each(function (GeoAnalysisResultItem $item) use ($other): void {
-            if ($other->places->has($item->key())) {
-                $item->place()->exclude(
-                    $item->place()->isExcluded()
-                    && $other->places->get($item->key())->place()->isExcluded()
-                );
-            }
-        });
-
-        $other->places->each(function (GeoAnalysisResultItem $item): void {
-            if (!$this->places->has($item->key())) {
-                $this->addPlace($item->place());
-            }
-        });
-
-        return $this;
-    }
-
-    /**
-     * Get the count of Known places
-     *
-     * @return int
-     */
-    public function countKnown(): int
-    {
-        return $this->places->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-
-    /**
-     * Get the count of Found places
-     *
-     * @return int
-     */
-    public function countFound(): int
-    {
-        return $this->places
-            ->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
-            ->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-
-    /**
-     * Get the count of Excluded places
-     *
-     * @return int
-     */
-    public function countExcluded(): int
-    {
-        return $this->places
-            ->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
-            ->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-
-    /**
-     * Get the count of Unknown places
-     *
-     * @return int
-     */
-    public function countUnknown(): int
-    {
-        return $this->unknown_count;
-    }
-
-    /**
-     * Get the count of the most represented Place in the analysis result
-     *
-     * @return int
-     */
-    public function maxCount(): int
-    {
-        return $this->places->max(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-
-    /**
-     * Get the list of Known places with their associated count
-     *
-     * @param bool $exclude_other
-     * @return Collection<GeoAnalysisResultItem>
-     */
-    public function knownPlaces(bool $exclude_other = false): Collection
-    {
-        if ($exclude_other) {
-            return $this->places->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
-        }
-        return $this->places;
-    }
-
-    /**
-     * Get the list of Known places with their associated count.
-     * The list is sorted first by descending count, then by ascending Place name
-     *
-     * @param bool $exclude_other
-     * @return Collection<GeoAnalysisResultItem>
-     */
-    public function sortedKnownPlaces(bool $exclude_other = false): Collection
-    {
-        return $this->knownPlaces($exclude_other)->sortBy([
-            fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int => $b->count() <=> $a->count(),
-            fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int =>
-                I18N::comparator()($a->place()->place()->gedcomName(), $b->place()->place()->gedcomName())
-        ]);
-    }
-
-    /**
-     * Get the list of Excluded places
-     *
-     * @return Collection<GeoAnalysisResultItem>
-     */
-    public function excludedPlaces(): Collection
-    {
-        return $this->places->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
-    }
+	private string $description;
+	private int $order;
+	private int $unknown_count;
+	/**
+	 * @var Collection<GeoAnalysisResultItem>
+	 */
+	private Collection $places;
+
+	/**
+	 * Constructor for GeoAnalysisResult
+	 *
+	 * @param string $description
+	 * @param int $order
+	 * @param Collection<GeoAnalysisResultItem> $places
+	 * @param int $unknown
+	 */
+	final public function __construct(
+		string $description,
+		int $order = 0,
+		Collection $places = null,
+		int $unknown = 0
+	) {
+		$this->description = $description;
+		$this->order = $order;
+		$this->places = $places ?? new Collection();
+		$this->unknown_count = $unknown;
+	}
+
+	/**
+	 * Get the category description
+	 *
+	 * @return string
+	 */
+	public function description(): string
+	{
+		return $this->description;
+	}
+
+	/**
+	 * Get the category order
+	 *
+	 * @return int
+	 */
+	public function order(): int
+	{
+		return $this->order;
+	}
+
+	/**
+	 * Add a place to the analysis result
+	 *
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlace(GeoAnalysisPlace $place): void
+	{
+		if ($place->isKnown()) {
+			/** @var GeoAnalysisResultItem $item */
+			$item = $this->places->get($place->key(), new GeoAnalysisResultItem($place));
+			$this->places->put($item->key(), $item->increment());
+		} else {
+			$this->addUnknown();
+		}
+	}
+
+	/**
+	 * Exclude a place from the analysis result
+	 *
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function exclude(GeoAnalysisPlace $place): void
+	{
+		/** @var GeoAnalysisResultItem|null $item */
+		$item = $this->places->get($place->key());
+		if ($item !== null) {
+			$item->place()->exclude();
+		}
+	}
+
+	/**
+	 * Add an unknown place to the analysis result
+	 */
+	public function addUnknown(): void
+	{
+		$this->unknown_count++;
+	}
+
+	/**
+	 * Take a copy of the current analysis result
+	 *
+	 * @return static
+	 */
+	public function copy(): self
+	{
+		return new static(
+			$this->description(),
+			$this->order(),
+			$this->places->map(fn(GeoAnalysisResultItem $item): GeoAnalysisResultItem => clone $item),
+			$this->countUnknown()
+		);
+	}
+
+	/**
+	 * Merge the current analysis result with another.
+	 * The current object is modified, not the second one.
+	 *
+	 * @param GeoAnalysisResult $other
+	 * @return $this
+	 */
+	public function merge(GeoAnalysisResult $other): self
+	{
+		$this->places->each(function (GeoAnalysisResultItem $item) use ($other): void {
+			if ($other->places->has($item->key())) {
+				$item->place()->exclude(
+					$item->place()->isExcluded()
+					&& $other->places->get($item->key())->place()->isExcluded()
+				);
+			}
+		});
+
+		$other->places->each(function (GeoAnalysisResultItem $item): void {
+			if (!$this->places->has($item->key())) {
+				$this->addPlace($item->place());
+			}
+		});
+
+		return $this;
+	}
+
+	/**
+	 * Get the count of Known places
+	 *
+	 * @return int
+	 */
+	public function countKnown(): int
+	{
+		return $this->places->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+
+	/**
+	 * Get the count of Found places
+	 *
+	 * @return int
+	 */
+	public function countFound(): int
+	{
+		return $this->places
+			->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
+			->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+
+	/**
+	 * Get the count of Excluded places
+	 *
+	 * @return int
+	 */
+	public function countExcluded(): int
+	{
+		return $this->places
+			->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
+			->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+
+	/**
+	 * Get the count of Unknown places
+	 *
+	 * @return int
+	 */
+	public function countUnknown(): int
+	{
+		return $this->unknown_count;
+	}
+
+	/**
+	 * Get the count of the most represented Place in the analysis result
+	 *
+	 * @return int
+	 */
+	public function maxCount(): int
+	{
+		return $this->places->max(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+
+	/**
+	 * Get the list of Known places with their associated count
+	 *
+	 * @param bool $exclude_other
+	 * @return Collection<GeoAnalysisResultItem>
+	 */
+	public function knownPlaces(bool $exclude_other = false): Collection
+	{
+		if ($exclude_other) {
+			return $this->places->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
+		}
+		return $this->places;
+	}
+
+	/**
+	 * Get the list of Known places with their associated count.
+	 * The list is sorted first by descending count, then by ascending Place name
+	 *
+	 * @param bool $exclude_other
+	 * @return Collection<GeoAnalysisResultItem>
+	 */
+	public function sortedKnownPlaces(bool $exclude_other = false): Collection
+	{
+		return $this->knownPlaces($exclude_other)->sortBy([
+			fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int => $b->count() <=> $a->count(),
+			fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int =>
+				I18N::comparator()($a->place()->place()->gedcomName(), $b->place()->place()->gedcomName())
+		]);
+	}
+
+	/**
+	 * Get the list of Excluded places
+	 *
+	 * @return Collection<GeoAnalysisResultItem>
+	 */
+	public function excludedPlaces(): Collection
+	{
+		return $this->places->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
+	}
 }

app/Common/GeoDispersion/Maps/SimpleFilesystemMap.php

Indentation +51 added lines, -51 removed lines

@@ -27,59 +27,59 @@
  */
 class SimpleFilesystemMap implements MapDefinitionInterface
 {
-    private string $id;
-    private string $title;
-    private string $path;
-    private FilesystemReader $filesystem;
+	private string $id;
+	private string $title;
+	private string $path;
+	private FilesystemReader $filesystem;
 
-    /**
-     * Constructor for SimpleFilesystemMap
-     *
-     * @param string $id
-     * @param string $title
-     * @param FilesystemReader $filesystem
-     * @param string $path
-     */
-    public function __construct(string $id, string $title, FilesystemReader $filesystem, string $path)
-    {
-        $this->id = $id;
-        $this->title = $title;
-        $this->filesystem = $filesystem;
-        $this->path = $path;
-    }
+	/**
+	 * Constructor for SimpleFilesystemMap
+	 *
+	 * @param string $id
+	 * @param string $title
+	 * @param FilesystemReader $filesystem
+	 * @param string $path
+	 */
+	public function __construct(string $id, string $title, FilesystemReader $filesystem, string $path)
+	{
+		$this->id = $id;
+		$this->title = $title;
+		$this->filesystem = $filesystem;
+		$this->path = $path;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::id()
-     */
-    public function id(): string
-    {
-        return $this->id;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::id()
+	 */
+	public function id(): string
+	{
+		return $this->id;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::title()
-     */
-    public function title(): string
-    {
-        return $this->title;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::title()
+	 */
+	public function title(): string
+	{
+		return $this->title;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::features()
-     */
-    public function features(): array
-    {
-        $reader = new GeoJSONReader();
-        try {
-            $feature_collection = $reader->read($this->filesystem->read($this->path));
-            if ($feature_collection instanceof FeatureCollection) {
-                return $feature_collection->getFeatures();
-            }
-        } catch (Throwable $ex) {
-        }
-        return [];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::features()
+	 */
+	public function features(): array
+	{
+		$reader = new GeoJSONReader();
+		try {
+			$feature_collection = $reader->read($this->filesystem->read($this->path));
+			if ($feature_collection instanceof FeatureCollection) {
+				return $feature_collection->getFeatures();
+			}
+		} catch (Throwable $ex) {
+		}
+		return [];
+	}
 }

app/Common/GeoDispersion/Config/GenericPlaceMapperConfig.php

Indentation +91 added lines, -91 removed lines

@@ -25,104 +25,104 @@
  */
 class GenericPlaceMapperConfig implements PlaceMapperConfigInterface
 {
-    private array $config = [];
+	private array $config = [];
 
-    /**
-     * Get the generic mapper's config
-     *
-     * @return array
-     */
-    public function config(): array
-    {
-        return $this->config;
-    }
+	/**
+	 * Get the generic mapper's config
+	 *
+	 * @return array
+	 */
+	public function config(): array
+	{
+		return $this->config;
+	}
 
-    /**
-     * Set the generic mapper's config
-     *
-     * @param array $config
-     * @return $this
-     */
-    public function setConfig(array $config): self
-    {
-        $this->config = $config;
-        return $this;
-    }
+	/**
+	 * Set the generic mapper's config
+	 *
+	 * @param array $config
+	 * @return $this
+	 */
+	public function setConfig(array $config): self
+	{
+		$this->config = $config;
+		return $this;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::get()
-     */
-    public function get(string $key, $default = null)
-    {
-        return $this->config[$key] ?? $default;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::get()
+	 */
+	public function get(string $key, $default = null)
+	{
+		return $this->config[$key] ?? $default;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::has()
-     */
-    public function has(string $key): bool
-    {
-        return key_exists($key, $this->config);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::has()
+	 */
+	public function has(string $key): bool
+	{
+		return key_exists($key, $this->config);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \JsonSerializable::jsonSerialize()
-     */
-    public function jsonSerialize()
-    {
-        return [
-            'class'     =>  get_class($this),
-            'config'    =>  $this->jsonSerializeConfig()
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \JsonSerializable::jsonSerialize()
+	 */
+	public function jsonSerialize()
+	{
+		return [
+			'class'     =>  get_class($this),
+			'config'    =>  $this->jsonSerializeConfig()
+		];
+	}
 
-    /**
-     * Returns a representation of the mapper config compatible with Json serialisation
-     *
-     * @return mixed
-     */
-    public function jsonSerializeConfig()
-    {
-        return $this->config;
-    }
+	/**
+	 * Returns a representation of the mapper config compatible with Json serialisation
+	 *
+	 * @return mixed
+	 */
+	public function jsonSerializeConfig()
+	{
+		return $this->config;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::jsonDeserialize()
-     *
-     * @param mixed $config
-     * @return $this
-     */
-    public function jsonDeserialize($config): self
-    {
-        if (is_string($config)) {
-            return $this->jsonDeserialize(json_decode($config));
-        }
-        if (is_array($config)) {
-            return $this->setConfig($config);
-        }
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::jsonDeserialize()
+	 *
+	 * @param mixed $config
+	 * @return $this
+	 */
+	public function jsonDeserialize($config): self
+	{
+		if (is_string($config)) {
+			return $this->jsonDeserialize(json_decode($config));
+		}
+		if (is_array($config)) {
+			return $this->setConfig($config);
+		}
+		return $this;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::configContent()
-     */
-    public function configContent(ModuleInterface $module, Tree $tree): string
-    {
-        return '';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::configContent()
+	 */
+	public function configContent(ModuleInterface $module, Tree $tree): string
+	{
+		return '';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::withConfigUpdate()
-     * @return $this
-     */
-    public function withConfigUpdate(ServerRequestInterface $request): self
-    {
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::withConfigUpdate()
+	 * @return $this
+	 */
+	public function withConfigUpdate(ServerRequestInterface $request): self
+	{
+		return $this;
+	}
 }

app/Common/GeoDispersion/Config/MapColorsConfig.php

Indentation +81 added lines, -81 removed lines

@@ -23,92 +23,92 @@
  */
 class MapColorsConfig implements JsonSerializable
 {
-    private Color $default;
-    private Color $stroke;
-    private Color $max_value;
-    private Color $hover;
+	private Color $default;
+	private Color $stroke;
+	private Color $max_value;
+	private Color $hover;
 
-    /**
-     * Constructor for MapColorsConfig
-     *
-     * @param Color $default
-     * @param Color $stroke
-     * @param Color $max_value
-     * @param Color $hover
-     */
-    public function __construct(
-        Color $default,
-        Color $stroke,
-        Color $max_value,
-        Color $hover
-    ) {
-        $this->default = $default;
-        $this->stroke = $stroke;
-        $this->max_value = $max_value;
-        $this->hover = $hover;
-    }
+	/**
+	 * Constructor for MapColorsConfig
+	 *
+	 * @param Color $default
+	 * @param Color $stroke
+	 * @param Color $max_value
+	 * @param Color $hover
+	 */
+	public function __construct(
+		Color $default,
+		Color $stroke,
+		Color $max_value,
+		Color $hover
+	) {
+		$this->default = $default;
+		$this->stroke = $stroke;
+		$this->max_value = $max_value;
+		$this->hover = $hover;
+	}
 
-    /**
-     * Get the default color for the features
-     *
-     * @return Color
-     */
-    public function defaultColor(): Color
-    {
-        return $this->default;
-    }
+	/**
+	 * Get the default color for the features
+	 *
+	 * @return Color
+	 */
+	public function defaultColor(): Color
+	{
+		return $this->default;
+	}
 
-    /**
-     * Get the color for the features' strokes
-     *
-     * @return Color
-     */
-    public function strokeColor(): Color
-    {
-        return $this->stroke;
-    }
+	/**
+	 * Get the color for the features' strokes
+	 *
+	 * @return Color
+	 */
+	public function strokeColor(): Color
+	{
+		return $this->stroke;
+	}
 
-    /**
-     * Get the color for the features with the lowest count
-     *
-     * @return Color
-     */
-    public function minValueColor(): Color
-    {
-        return new Rgb(255, 255, 255);
-    }
+	/**
+	 * Get the color for the features with the lowest count
+	 *
+	 * @return Color
+	 */
+	public function minValueColor(): Color
+	{
+		return new Rgb(255, 255, 255);
+	}
 
-    /**
-     * Get the color for the features with the highest count
-     *
-     * @return Color
-     */
-    public function maxValueColor(): Color
-    {
-        return $this->max_value;
-    }
+	/**
+	 * Get the color for the features with the highest count
+	 *
+	 * @return Color
+	 */
+	public function maxValueColor(): Color
+	{
+		return $this->max_value;
+	}
 
-    /**
-     * Get the color for feature hovering
-     *
-     * @return Color
-     */
-    public function hoverColor(): Color
-    {
-        return $this->hover;
-    }
+	/**
+	 * Get the color for feature hovering
+	 *
+	 * @return Color
+	 */
+	public function hoverColor(): Color
+	{
+		return $this->hover;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see JsonSerializable::jsonSerialize()
-     */
-    public function jsonSerialize()
-    {
-        return [
-            'default'   => (string) $this->defaultColor()->toHex(),
-            'stroke'    => (string) $this->strokeColor()->toHex(),
-            'maxvalue'  => (string) $this->maxValueColor()->toHex(),
-            'hover'     => (string) $this->hoverColor()->toHex(),
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see JsonSerializable::jsonSerialize()
+	 */
+	public function jsonSerialize()
+	{
+		return [
+			'default'   => (string) $this->defaultColor()->toHex(),
+			'stroke'    => (string) $this->strokeColor()->toHex(),
+			'maxvalue'  => (string) $this->maxValueColor()->toHex(),
+			'hover'     => (string) $this->hoverColor()->toHex(),
+		];
+	}
 }

app/Common/GeoDispersion/Config/NullPlaceMapperConfig.php

Indentation +52 added lines, -52 removed lines

@@ -26,61 +26,61 @@
  */
 class NullPlaceMapperConfig implements PlaceMapperConfigInterface
 {
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::get()
-     */
-    public function get(string $key, $default = null)
-    {
-        return $default;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::get()
+	 */
+	public function get(string $key, $default = null)
+	{
+		return $default;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::has()
-     */
-    public function has(string $key): bool
-    {
-        return false;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::has()
+	 */
+	public function has(string $key): bool
+	{
+		return false;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::jsonDeserialize()
-     *
-     * @param mixed $config
-     * @return $this
-     */
-    public function jsonDeserialize($config): self
-    {
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::jsonDeserialize()
+	 *
+	 * @param mixed $config
+	 * @return $this
+	 */
+	public function jsonDeserialize($config): self
+	{
+		return $this;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see JsonSerializable::jsonSerialize()
-     */
-    public function jsonSerialize()
-    {
-        return [];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see JsonSerializable::jsonSerialize()
+	 */
+	public function jsonSerialize()
+	{
+		return [];
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::configContent()
-     */
-    public function configContent(ModuleInterface $module, Tree $tree): string
-    {
-        return '';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::configContent()
+	 */
+	public function configContent(ModuleInterface $module, Tree $tree): string
+	{
+		return '';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::withConfigUpdate()
-     * @return $this
-     */
-    public function withConfigUpdate(ServerRequestInterface $request): self
-    {
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::withConfigUpdate()
+	 * @return $this
+	 */
+	public function withConfigUpdate(ServerRequestInterface $request): self
+	{
+		return $this;
+	}
 }

app/Common/GeoDispersion/Config/MapViewConfig.php

Indentation +43 added lines, -43 removed lines

@@ -23,51 +23,51 @@
  */
 class MapViewConfig implements MapViewConfigInterface
 {
-    private string $map_mapping_property;
-    private PlaceMapperConfigInterface $mapper_config;
+	private string $map_mapping_property;
+	private PlaceMapperConfigInterface $mapper_config;
 
-    /**
-     * Constructor for MapViewConfig
-     *
-     * @param string $map_mapping_property
-     * @param PlaceMapperConfigInterface $mapper_config
-     */
-    public function __construct(
-        string $map_mapping_property,
-        PlaceMapperConfigInterface $mapper_config = null
-    ) {
-        $this->map_mapping_property = $map_mapping_property;
-        $this->mapper_config = $mapper_config ?? new NullPlaceMapperConfig();
-    }
+	/**
+	 * Constructor for MapViewConfig
+	 *
+	 * @param string $map_mapping_property
+	 * @param PlaceMapperConfigInterface $mapper_config
+	 */
+	public function __construct(
+		string $map_mapping_property,
+		PlaceMapperConfigInterface $mapper_config = null
+	) {
+		$this->map_mapping_property = $map_mapping_property;
+		$this->mapper_config = $mapper_config ?? new NullPlaceMapperConfig();
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapViewConfigInterface::mapMappingProperty()
-     */
-    public function mapMappingProperty(): string
-    {
-        return $this->map_mapping_property;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapViewConfigInterface::mapMappingProperty()
+	 */
+	public function mapMappingProperty(): string
+	{
+		return $this->map_mapping_property;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapViewConfigInterface::mapperConfig()
-     */
-    public function mapperConfig(): PlaceMapperConfigInterface
-    {
-        return $this->mapper_config;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapViewConfigInterface::mapperConfig()
+	 */
+	public function mapperConfig(): PlaceMapperConfigInterface
+	{
+		return $this->mapper_config;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapViewConfigInterface::with()
-     * @return static
-     */
-    public function with(string $mapping_property, PlaceMapperConfigInterface $mapper_config): self
-    {
-        $new = clone $this;
-        $new->map_mapping_property = $mapping_property;
-        $new->mapper_config = $mapper_config;
-        return $new;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapViewConfigInterface::with()
+	 * @return static
+	 */
+	public function with(string $mapping_property, PlaceMapperConfigInterface $mapper_config): self
+	{
+		$new = clone $this;
+		$new->map_mapping_property = $mapping_property;
+		$new->mapper_config = $mapper_config;
+		return $new;
+	}
 }

app/Common/Tasks/TaskSchedule.php

Indentation +286 added lines, -286 removed lines

@@ -25,290 +25,290 @@
 class TaskSchedule
 {
 
-    /**
-     * Task Schedule ID
-     * @var int $id
-     */
-    private $id;
-
-    /**
-     * Task schedule status
-     * @var bool $enabled
-     */
-    private $enabled;
-
-    /**
-     * ID of the task attached to schedule
-     * @var string $task_id
-     */
-    private $task_id;
-
-    /**
-     * Last updated date
-     * @var Carbon $last_run
-     */
-    private $last_run;
-
-    /**
-     * Last run result
-     * @var bool $last_result
-     */
-    private $last_result;
-
-    /**
-     * Task run frequency
-     * @var CarbonInterval $frequency
-     */
-    private $frequency;
-
-    /**
-     * Task remaining runs
-     * @var int $nb_occurrences
-     */
-    private $nb_occurrences;
-
-    /**
-     * Current running status of the task
-     * @var bool $is_running
-     */
-    private $is_running;
-
-    /**
-     * Constructor for TaskSchedule
-     *
-     * @param int $id Schedule ID
-     * @param string $task_id Task ID
-     * @param bool $enabled Is the schedule enabled
-     * @param Carbon $last_run Last successful run date/time
-     * @param bool $last_result Result of the last run
-     * @param CarbonInterval $frequency Schedule frequency
-     * @param int $nb_occurrences Number of remaining occurrences to be run
-     * @param bool $is_running Is the task currently running
-     */
-    public function __construct(
-        int $id,
-        string $task_id,
-        bool $enabled,
-        Carbon $last_run,
-        bool $last_result,
-        CarbonInterval $frequency,
-        int $nb_occurrences,
-        bool $is_running
-    ) {
-        $this->id = $id;
-        $this->task_id = $task_id;
-        $this->enabled = $enabled;
-        $this->last_run = $last_run;
-        $this->last_result = $last_result;
-        $this->frequency = $frequency;
-        $this->nb_occurrences = $nb_occurrences;
-        $this->is_running = $is_running;
-    }
-
-    /**
-     * Get the schedule ID.
-     *
-     * @return int
-     */
-    public function id(): int
-    {
-        return $this->id;
-    }
-
-    /**
-     * Get the task ID.
-     *
-     * @return string
-     */
-    public function taskId(): string
-    {
-        return $this->task_id;
-    }
-
-    /**
-     * Returns whether the schedule is enabled
-     *
-     * @return bool
-     */
-    public function isEnabled(): bool
-    {
-        return $this->enabled;
-    }
-
-    /**
-     * Enable the schedule
-     *
-     * @return $this
-     */
-    public function enable(): self
-    {
-        $this->enabled = true;
-        return $this;
-    }
-
-    /**
-     * Disable the schedule
-     *
-     * @return $this
-     */
-    public function disable(): self
-    {
-        $this->enabled = false;
-        return $this;
-    }
-
-    /**
-     * Get the frequency of the schedule
-     *
-     * @return CarbonInterval
-     */
-    public function frequency(): CarbonInterval
-    {
-        return $this->frequency;
-    }
-
-    /**
-     * Set the frequency of the schedule
-     *
-     * @param CarbonInterval $frequency
-     * @return $this
-     */
-    public function setFrequency(CarbonInterval $frequency): self
-    {
-        $this->frequency = $frequency;
-        return $this;
-    }
-
-    /**
-     * Get the date/time of the last successful run.
-     *
-     * @return Carbon
-     */
-    public function lastRunTime(): Carbon
-    {
-        return $this->last_run;
-    }
-
-    /**
-     * Set the last successful run date/time
-     *
-     * @param Carbon $last_run
-     * @return $this
-     */
-    public function setLastRunTime(Carbon $last_run): self
-    {
-        $this->last_run = $last_run;
-        return $this;
-    }
-
-    /**
-     * Returns whether the last run was successful
-     *
-     * @return bool
-     */
-    public function wasLastRunSuccess(): bool
-    {
-        return $this->last_result;
-    }
-
-    /**
-     * Set the last run result
-     *
-     * @param bool $last_result
-     * @return $this
-     */
-    public function setLastResult(bool $last_result): self
-    {
-        $this->last_result = $last_result;
-        return $this;
-    }
-
-    /**
-     * Get the number of remaining of occurrences of task runs.
-     * Returns 0 if the tasks must be run indefinitely.
-     *
-     * @return int
-     */
-    public function remainingOccurences(): int
-    {
-        return $this->nb_occurrences;
-    }
-
-    /**
-     * Decrements the number of remaining occurences by 1.
-     * The task will be disabled when the number reaches 0.
-     *
-     * @return $this
-     */
-    public function decrementRemainingOccurences(): self
-    {
-        if ($this->nb_occurrences > 0) {
-            $this->nb_occurrences--;
-            if ($this->nb_occurrences == 0) {
-                $this->disable();
-            }
-        }
-        return $this;
-    }
-
-    /**
-     * Set the number of remaining occurences of task runs.
-     *
-     * @param int $nb_occurrences
-     * @return $this
-     */
-    public function setRemainingOccurences(int $nb_occurrences): self
-    {
-        $this->nb_occurrences = $nb_occurrences;
-        return $this;
-    }
-
-    /**
-     * Returns whether the task is running
-     * @return bool
-     */
-    public function isRunning(): bool
-    {
-        return $this->is_running;
-    }
-
-    /**
-     * Informs the schedule that the task is going to run
-     *
-     * @return $this
-     */
-    public function startRunning(): self
-    {
-        $this->is_running = true;
-        return $this;
-    }
-
-    /**
-     * Informs the schedule that the task has stopped running.
-     * @return $this
-     */
-    public function stopRunning(): self
-    {
-        $this->is_running = false;
-        return $this;
-    }
-
-    /**
-     * Returns the schedule details as an associate array
-     *
-     * @return array
-     */
-    public function toArray(): array
-    {
-        return [
-            'id'            =>  $this->id,
-            'task_id'       =>  $this->task_id,
-            'enabled'       =>  $this->enabled,
-            'last_run'      =>  $this->last_run,
-            'last_result'   =>  $this->last_result,
-            'frequency'     =>  $this->frequency,
-            'nb_occurrences' =>  $this->nb_occurrences,
-            'is_running'    =>  $this->is_running
-        ];
-    }
+	/**
+	 * Task Schedule ID
+	 * @var int $id
+	 */
+	private $id;
+
+	/**
+	 * Task schedule status
+	 * @var bool $enabled
+	 */
+	private $enabled;
+
+	/**
+	 * ID of the task attached to schedule
+	 * @var string $task_id
+	 */
+	private $task_id;
+
+	/**
+	 * Last updated date
+	 * @var Carbon $last_run
+	 */
+	private $last_run;
+
+	/**
+	 * Last run result
+	 * @var bool $last_result
+	 */
+	private $last_result;
+
+	/**
+	 * Task run frequency
+	 * @var CarbonInterval $frequency
+	 */
+	private $frequency;
+
+	/**
+	 * Task remaining runs
+	 * @var int $nb_occurrences
+	 */
+	private $nb_occurrences;
+
+	/**
+	 * Current running status of the task
+	 * @var bool $is_running
+	 */
+	private $is_running;
+
+	/**
+	 * Constructor for TaskSchedule
+	 *
+	 * @param int $id Schedule ID
+	 * @param string $task_id Task ID
+	 * @param bool $enabled Is the schedule enabled
+	 * @param Carbon $last_run Last successful run date/time
+	 * @param bool $last_result Result of the last run
+	 * @param CarbonInterval $frequency Schedule frequency
+	 * @param int $nb_occurrences Number of remaining occurrences to be run
+	 * @param bool $is_running Is the task currently running
+	 */
+	public function __construct(
+		int $id,
+		string $task_id,
+		bool $enabled,
+		Carbon $last_run,
+		bool $last_result,
+		CarbonInterval $frequency,
+		int $nb_occurrences,
+		bool $is_running
+	) {
+		$this->id = $id;
+		$this->task_id = $task_id;
+		$this->enabled = $enabled;
+		$this->last_run = $last_run;
+		$this->last_result = $last_result;
+		$this->frequency = $frequency;
+		$this->nb_occurrences = $nb_occurrences;
+		$this->is_running = $is_running;
+	}
+
+	/**
+	 * Get the schedule ID.
+	 *
+	 * @return int
+	 */
+	public function id(): int
+	{
+		return $this->id;
+	}
+
+	/**
+	 * Get the task ID.
+	 *
+	 * @return string
+	 */
+	public function taskId(): string
+	{
+		return $this->task_id;
+	}
+
+	/**
+	 * Returns whether the schedule is enabled
+	 *
+	 * @return bool
+	 */
+	public function isEnabled(): bool
+	{
+		return $this->enabled;
+	}
+
+	/**
+	 * Enable the schedule
+	 *
+	 * @return $this
+	 */
+	public function enable(): self
+	{
+		$this->enabled = true;
+		return $this;
+	}
+
+	/**
+	 * Disable the schedule
+	 *
+	 * @return $this
+	 */
+	public function disable(): self
+	{
+		$this->enabled = false;
+		return $this;
+	}
+
+	/**
+	 * Get the frequency of the schedule
+	 *
+	 * @return CarbonInterval
+	 */
+	public function frequency(): CarbonInterval
+	{
+		return $this->frequency;
+	}
+
+	/**
+	 * Set the frequency of the schedule
+	 *
+	 * @param CarbonInterval $frequency
+	 * @return $this
+	 */
+	public function setFrequency(CarbonInterval $frequency): self
+	{
+		$this->frequency = $frequency;
+		return $this;
+	}
+
+	/**
+	 * Get the date/time of the last successful run.
+	 *
+	 * @return Carbon
+	 */
+	public function lastRunTime(): Carbon
+	{
+		return $this->last_run;
+	}
+
+	/**
+	 * Set the last successful run date/time
+	 *
+	 * @param Carbon $last_run
+	 * @return $this
+	 */
+	public function setLastRunTime(Carbon $last_run): self
+	{
+		$this->last_run = $last_run;
+		return $this;
+	}
+
+	/**
+	 * Returns whether the last run was successful
+	 *
+	 * @return bool
+	 */
+	public function wasLastRunSuccess(): bool
+	{
+		return $this->last_result;
+	}
+
+	/**
+	 * Set the last run result
+	 *
+	 * @param bool $last_result
+	 * @return $this
+	 */
+	public function setLastResult(bool $last_result): self
+	{
+		$this->last_result = $last_result;
+		return $this;
+	}
+
+	/**
+	 * Get the number of remaining of occurrences of task runs.
+	 * Returns 0 if the tasks must be run indefinitely.
+	 *
+	 * @return int
+	 */
+	public function remainingOccurences(): int
+	{
+		return $this->nb_occurrences;
+	}
+
+	/**
+	 * Decrements the number of remaining occurences by 1.
+	 * The task will be disabled when the number reaches 0.
+	 *
+	 * @return $this
+	 */
+	public function decrementRemainingOccurences(): self
+	{
+		if ($this->nb_occurrences > 0) {
+			$this->nb_occurrences--;
+			if ($this->nb_occurrences == 0) {
+				$this->disable();
+			}
+		}
+		return $this;
+	}
+
+	/**
+	 * Set the number of remaining occurences of task runs.
+	 *
+	 * @param int $nb_occurrences
+	 * @return $this
+	 */
+	public function setRemainingOccurences(int $nb_occurrences): self
+	{
+		$this->nb_occurrences = $nb_occurrences;
+		return $this;
+	}
+
+	/**
+	 * Returns whether the task is running
+	 * @return bool
+	 */
+	public function isRunning(): bool
+	{
+		return $this->is_running;
+	}
+
+	/**
+	 * Informs the schedule that the task is going to run
+	 *
+	 * @return $this
+	 */
+	public function startRunning(): self
+	{
+		$this->is_running = true;
+		return $this;
+	}
+
+	/**
+	 * Informs the schedule that the task has stopped running.
+	 * @return $this
+	 */
+	public function stopRunning(): self
+	{
+		$this->is_running = false;
+		return $this;
+	}
+
+	/**
+	 * Returns the schedule details as an associate array
+	 *
+	 * @return array
+	 */
+	public function toArray(): array
+	{
+		return [
+			'id'            =>  $this->id,
+			'task_id'       =>  $this->task_id,
+			'enabled'       =>  $this->enabled,
+			'last_run'      =>  $this->last_run,
+			'last_result'   =>  $this->last_result,
+			'frequency'     =>  $this->frequency,
+			'nb_occurrences' =>  $this->nb_occurrences,
+			'is_running'    =>  $this->is_running
+		];
+	}
 }