Files
MDAllowedValueSets/src/enums/MDSourceContributorRole.php
T

158 lines
3.6 KiB
PHP

<?PHP
declare(strict_types = 1);
/**
* Represents a type of contribution to a source.
*/
enum MDSourceContributorRole implements MDValueEnumInterface, JsonSerializable {
case author;
case editor;
/**
* Returns a value of this type based on a string.
*
* @param string $input Input to get a value from.
*
* @return MDSourceContributorRole
*/
public static function fromString(string $input):MDSourceContributorRole {
return match($input) {
"author" => self::author,
"editor" => self::editor,
default => throw new MDpageParameterNotFromListException("Unknown source contributor role"),
};
}
/**
* Returns a value of this type based on an integer.
*
* @param integer $input Input to get a value from.
*
* @return MDSourceContributorRole
*/
public static function fromInt(int $input):MDSourceContributorRole {
return match($input) {
0 => self::author,
1 => self::editor,
default => throw new MDpageParameterNotFromListException("Unknown source contributor role"),
};
}
/**
* Lists all available names.
*
* @return array<string>
*/
public static function caseNames():array {
$output = [];
$cases = self::cases();
foreach ($cases as $case) {
$output[] = $case->name;
}
return $output;
}
/**
* Gets an unsorted list of the entries in a translated version.
*
* @param MDTlLoader $tlLoader Translation loader.
*
* @return array<string, string>
*/
public static function getUnsortedList(MDTlLoader $tlLoader):array {
return MDValueSet::getTlUnsortedList($tlLoader, self::caseNames(), "source_contributor_roles", "source_contributor_roles");
}
/**
* Gets a sorted list of the entries in a translated version.
*
* @param MDTlLoader $tlLoader Translation loader.
*
* @return array<string, string>
*/
public static function getSortedList(MDTlLoader $tlLoader):array {
return MDValueSet::getTlSortedList($tlLoader, self::caseNames(), "source_contributor_roles", "source_contributor_roles");
}
/**
* Lists all available names.
*
* @return array<integer>
*/
public static function caseInts():array {
$output = [];
$cases = self::cases();
foreach ($cases as $case) {
$output[] = $case->toInt();
}
return $output;
}
/**
* Returns integer representation of source contributor status.
*
* @return integer
*/
public function toInt():int {
return match($this) {
self::author => 0,
self::editor => 1,
};
}
/**
* Returns canonical string representation of source contributor status.
*
* @return string
*/
public function toString():string {
return match($this) {
self::author => 'author',
self::editor => 'editor',
};
}
/**
* Returns the name of the current value in translation.
*
* @param MDTlLoader $tlLoader Translation loader.
*
* @return string
*/
public function getTledName(MDTlLoader $tlLoader):string {
return $tlLoader->tl("source_contributor_roles", "source_contributor_roles", $this->name);
}
/**
* Provides the option to serialize as a string during json_encode().
*
* @return string
*/
public function jsonSerialize():string {
return $this->name;
}
}