Expose enum constants

[jlsjonas]

Allows exposing the constants for usage in frontend (where $data is being used for more descriptive labels)

[aocneanu]

Do you know about the frontend Enum class?

[jlsjonas]

I did not, but I also can't find any usages nor documentations surrounding it.

I'm currently adding my enums to AppState's enums(), where I needed a certain type as their constant (comparing a custom select field to it's value)

Any example or reference to doing it properly would of course be welcome.

[aocneanu]

You should add local enums to a LocalStateBuilder and reuse the bootEnums helper available in the FE.

The you can do

computed: {
   ...mapState('local', ['enums']),
}

....

$this.enums.myEnum._get(key)`

usage example

full api

BTW if you have the time a PR in the docs with this would be great ;)

[jlsjonas]

Thanks, I'll look into using & documenting it!

I do believe certain use-cases could benefit from this simpler exposure.
Feel free to disagree and close this PR though 😁

p.s.: I hope you had a nice holiday :-)

[aocneanu]

I hope you had a nice holiday :-)

Yes I did, finally leveraged 3.2.0 :))))

The same for you :)

[jlsjonas]

Thanks, I did recently :)

Just as a small follow-up (reason why I exposed constants() in the first place):

If you have an enum (LaravelEnso\Helpers\app\Classes\Enum declared with both constants & a $data object; only the numerical keys & strings contained in the data object are exposed to the frontend, right?

ex.:

class MyEnumClass extends Enum
{
    const onEnter = 0;
    const onExit = 1;
    const manual = 2;

    protected static $data = [
        self::onEnter => 'Automatically on enter',
        self::onExit => 'Automatically on exit',
        self::manual => 'Manually',
    ];
}

In the frontend, I want to check something === enums.myEnumClass.manual; the Enum class doesn't provide a method for it,does it? (it's methods always seem to return the full string declared in $data; which makes sense as that's the only data it received from the api)

If confirmed, I'd document exposing via ::constants() too, for this kind of usecase; unless you have an idea to modify Enum.js + the way it's receive the classes to allow for both sets to be defined simultaneously (even then load-wise it's probably interesting to document the constants() method too.

[aocneanu]

It has a little magic but only if you are using self::MyConstantName' => 'My Constant Name'

[jlsjonas]

@aocneanu commented on May 2, 2019, 9:06 AM GMT+2:

It has a little magic but only if you are using `self::MyConstantName' => 'My Constant Name'

Do you mean declaring self::MyConstantName as a string instead of a direct reference, and thus passing it along back to back-end as a string instead of integer? 🤔 If not, could you provide a more complete example?

Thanks!

[aocneanu]

Basically the constant name should match the label without spaces

[jlsjonas]

Ah, yes; because spaces get trimmed in the flip.

I'll note it alongside the constant method 👍