Adonis Lucid Polymorphic


Polymorphic Relations support for Adonis Lucid ^4.1.0.

Installation

1. Add package:

``bash
$ npm i adonis-lucid-polymorphic --save
`
or

`bash
$ yarn add adonis-lucid-polymorphic
`

2. Register providers inside the your bootstrap/app.js file.

`js
const providers = [
...
'adonis-lucid-polymorphic/providers/PolymorphicProvider',
...
]
`


Examples

$3

`
posts
id - integer
title - string
body - text

videos
id - integer
title - string
url - string

comments
id - integer
body - text
commentable_id - integer
commentable_type - string
`

$3

`js
// App/Model/Post
'use strict'

const Model = use('Lucid')

class Post extends Model {
static get traits () {
return ['@provider:Morphable']
}

comments () {
return this.morphMany('App/Models/Comment', 'id', 'commentable_id', 'commentable_type')
}
}

module.exports = Post
`

`js
// App/Model/Video
'use strict'

const Model = use('Lucid')

class Video extends Model {
static get traits () {
return ['@provider:Morphable']
}

comments () {
return this.morphMany('App/Models/Comment', 'id', 'commentable_id', 'commentable_type')
}
}

module.exports = Video
`

`js
// App/Model/Comment
'use strict'

const Model = use('Lucid')

class Comment extends Model {
static get traits () {
return ['@provider:Morphable']
}

commentable () {
return this.morphTo([
'App/Models/Post', 'App/Models/Video'
], 'id', 'id', 'commentable_id', 'commentable_type')
}
}

module.exports = Video
`

API

$3

`js
...

class Comment extends Model {
static get traits () {
return ['@provider:Morphable']
}

commentable () {
return this.morphTo([
'App/Models/Post', 'App/Models/Video'
], 'id', 'id', 'commentable_id', 'commentable_type')
}
}

...
`

$3

`js
...

class Post extends Model {
static get traits () {
return ['@provider:Morphable']
}

comments () {
return this.morphMany('App/Models/Comment', 'id', 'commentable_id', 'commentable_type')
}
}

...
`

$3

`js
...

class Publication extends Model {
static get traits () {
return ['@provider:Morphable']
}

content () {
return this.morphOne('App/Models/Content', 'id', 'contentable_id', 'contentable_type')
}
}

...
``

Credits

- Evgeni Razumov

Support

Having trouble? Open an issue!

License

The MIT License (MIT). Please see License File for more information.