8000 Compile PHP enums to PHP 7/8 lookalikes, PHP 8.1 native by thekid · Pull Request #106 · xp-framework/compiler · GitHub
[go: up one dir, main page]
Skip to content

Compile PHP enums to PHP 7/8 lookalikes, PHP 8.1 native #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 26 commits into from
Mar 13, 2021
Merged

Compile PHP enums to PHP 7/8 lookalikes, PHP 8.1 native #106

merged 26 commits into from
Mar 13, 2021

Conversation

thekid
Copy link
Member
@thekid thekid commented Mar 10, 2021 •
edited
Loading

Enums

Implement feature request #100. XP Compiler and XP Framework (10.8.0+) now support:

  • PHP 8.1 enums on PHP 8.1 with Implement enums php/php-src#6489 merged, where they are emitted as native code
  • PHP 8.1 enums on all PHP versions since 7.0, where they are emitted as lookalikes (see below)
  • Accessing XP enums' cases (which are public static members, see Enum support rfc#132 from 2011) via constants (WeekDay::MON)

⚠️ The xp-enums compiler extension, which defines an alternate enum syntax and compiles it to XP enums, will be deprecated! Its abstract enum feature is unsupported by PHP 8.1 enums, and may be reintroduced later via the tagged unions RFC.

Behind the scenes

What the user writes (and what will be emitted for PHP 8.1 once the enum PR is merged):

// Declaration
enum Suit {
  case Hearts;
  case Diamonds;
  case Clubs;
  case Spades;
}

// Usage
$e= Suit::Spades;

What is emitted for PHP < 8.1:

// Declaration
final class Suite implements UnitEnum {
  public static $Hearts, $Diamonds, $Clubs, $Spades;
  public $name;

  static function __static() {
    self::$Hearts= new self('Hearts');
  }

  /** @param string $name */
  public function __construct($name) { $this->name= $name; }

  /** UnitEnum implementation */
  public static function cases(): array {
    return [self::$Hearts, self::$Diamonds, self::$Clubs, self::$Spades];
  }
}

// Usage
$e= Suit::$Spades;

Backed enums also include a value member as well as from() and tryFrom() methods.

@thekid thekid changed the title Compile PHP 8.1 enums to PHP 7/8 lookalikes Compile PHP 8.1 enums to PHP 7/8 lookalikes, PHP 8.1 native Mar 13, 2021
@thekid thekid mentioned this pull request Mar 13, 2021
Merged
@thekid thekid changed the title Compile PHP 8.1 enums to PHP 7/8 lookalikes, PHP 8.1 native Compile PHP enums to PHP 7/8 lookalikes, PHP 8.1 native Mar 13, 2021
@thekid thekid merged commit 9be29fa into master Mar 13, 2021
@thekid thekid deleted the feature/php-enum-support branch March 13, 2021 15:49
@thekid
Copy link
Member Author
thekid commented Mar 13, 2021

:shipit: Released in https://github.com/xp-framework/compiler/releases/tag/v6.3.0

thekid added a commit to thekid/cas that referenced this pull request Mar 14, 2021
@thekid
Refactor code to no longer require xp-lang/xp-enums
f45ef86 
This package is deprecated, see xp-framework/compiler#106
@thekid
Copy link
Member Author
thekid commented Mar 14, 2021 •
edited
Loading

The xp-enums compiler extension [...] will be deprecated! Its abstract enum feature is unsupported by PHP 8.1 enums [...]

...and with support for arbitrary expressions as initializers (see #104), we can simply refactor code as follows:

@@ -3,8 +3,8 @@
 use xml\{Tree, Node};
 
 /** CAS service response - in XML and JSON */
-abstract enum ServiceResponse {
-  XML {
+abstract class ServiceResponse {
+  public static $XML= new class() extends self {
     public function success($user) {
       $n= new Node('cas:authenticationSuccess')->withChild(new Node('cas:user', $user['username']));
       if (isset($user['attributes'])) {
@@ -29,8 +29,8 @@ abstract enum ServiceResponse {
 
       $response->send($tree->getSource(INDENT_DEFAULT), 'text/xml');
     }
-  },
-  JSON {
+  };
+  public static $JSON= new class() extends self {
     public function success($user) {
       $success= ['user' => $user['username']];
       if (isset($user['attributes'])) {

(In this case, the class already had a static factory method and wasn't using Enum::valueOf(), so no further adjustments needed to be made)

@thekid
Copy link
Member Author
thekid commented Mar 20, 2021 •
edited
Loading

PHP 8.1 enums on PHP 8.1 with [enum PR] merged

PHP master build donwloaded from https://github.com/shivammathur/php-builder-windows/actions:

# Verify enum support
$ XP_RT=master xp -w 'enum SortOrder { case ASC; case DESC; } return SortOrder::ASC'
SortOrder {
  name => "ASC"
}

# Run XP core tests
core $ XP_RT=master xp test src/test/config/unittest/*ini
# ...
♥: 4205/4259 run (54 skipped), 4205 succeeded, 0 failed
Memory used: 22559.28 kB (43149.24 kB peak)
Time taken: 4.005 seconds

# Run XP compiler test
compiler $ XP_RT=master xp test src/test/php
# ...
♥: 563/564 run (1 skipped), 563 succeeded, 0 failed
Memory used: 9119.41 kB (9177.58 kB peak)
Time taken: 0.251 seconds

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@thekid
0