Initial commit

kirby/src/Content/Translations.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Kirby\Content;
+
+use Kirby\Cms\Collection;
+use Kirby\Cms\Language;
+use Kirby\Cms\Languages;
+use Kirby\Cms\ModelWithContent;
+
+/**
+ * @package   Kirby Content
+ * @author    Bastian Allgeier <bastian@getkirby.com>
+ * @link      https://getkirby.com
+ * @copyright Bastian Allgeier
+ * @license   https://getkirby.com/license
+ *
+ * @extends \Kirby\Cms\Collection<\Kirby\Content\Translation>
+ */
+class Translations extends Collection
+{
+	/**
+	 * Creates a new Translations collection from
+	 * an array of translations properties. This is
+	 * used in ModelWithContent::setTranslations to properly
+	 * normalize an array definition.
+	 *
+	 * @todo Needs to be refactored as soon as Version::create becomes static
+	 * 		 (see https://github.com/getkirby/kirby/pull/6491#discussion_r1652264408)
+	 */
+	public static function create(
+		ModelWithContent $model,
+		Version $version,
+		array $translations
+	): static {
+		foreach ($translations as $translation) {
+			Translation::create(
+				model: $model,
+				version: $version,
+				language: Language::ensure($translation['code'] ?? 'default'),
+				fields: $translation['content'] ?? [],
+				slug: $translation['slug'] ?? null
+			);
+		}
+
+		return static::load(
+			model: $model,
+			version: $version
+		);
+	}
+
+	/**
+	 * Simplifies `Translations::find` by allowing to pass
+	 * Language codes that will be properly validated here.
+	 */
+	public function findByKey(string $key): Translation|null
+	{
+		return parent::get(Language::ensure($key)->code());
+	}
+
+	/**
+	 * Loads all available translations for a given model
+	 */
+	public static function load(
+		ModelWithContent $model,
+		Version $version
+	): static {
+		$translations = [];
+
+		foreach (Languages::ensure() as $language) {
+			$translations[] = new Translation(
+				model: $model,
+				version: $version,
+				language: $language
+			);
+		}
+
+		return new static($translations);
+	}
+}