zeng407/l5-repository

Laravel 5 - Repositories to the database layer

v2.8 2018-09-03 06:21 UTC

Requires

• illuminate/config: ~5.0
• illuminate/console: ~5.0
• illuminate/database: ~5.0
• illuminate/filesystem: ~5.0
• illuminate/http: ~5.0
• illuminate/pagination: ~5.0
• illuminate/support: ~5.0
• prettus/laravel-validation: 1.1.*

Suggests

• league/fractal: Required to use the Fractal Presenter (0.12.*).
• prettus/laravel-validation: Required to provide easy validation with the repository (1.1.*)
• robclancy/presenter: Required to use the Presenter Model (1.3.*)

MIT

• Bill Zeng

• cache
• repository
• model
• laravel
• eloquent

README

install

composer require zeng407/l5-repository

filtering

give serchable columns like this

class UserRepository extedns BaseRepository
{
	protected $fieldSearchable = [
		'user_name' => [
			'column' => 'name'
			// default column value is 'user_name' if you don't specify column name
		],
		'age' => [
			'operators' => ['=','in','>=']
			//limit operators input
		],
		'gender',
		'post_title' => [
			'relation' => 'posts', // give the relation name in User Model
			'column' => 'title'
		],
		'phone_number' => [
			'relation' => 'profile.phones'
		]
	];
}

then you can do these query

localhost/users?user_name_like="john"
// select * from users where name like '%john%'

localhost/users?age_gte=20
// select * from users where age >= 20

localhost/users?gender=female
// select * from users where gender = 'female'

localhost/users?age_in[]=20&age_in[]=30age_in[]=35
// select * from users where age in (20,30,35)

localhost/users?post_title_like='announcement'
// select * from users where exists
//  (select * from posts where posts.user_id = users.id 
//.   and posts.title like '% announcement%')

the operations are defined at

class RequestCriteria implements CriteriaInterface {

protected $operatorMap = [
        'gt' => '>',
        'gte' => '>=',
        'lt' => '<',
        'lte' => '<=',
        'like' => 'like',
        'in' => 'in'
    ];

}

sorting

class UserRepository extedns BaseRepository
{
	protected $sortable = [
		'user_name' => [
			'column' => 'name'
		],
		'post_title' => [
			'join' => 'posts',
			'column' => 'title'
		],
		'phone_number' => [
			'relation' => 'profiles.phones'
			//give the table name, not the relation name in User model
		]
	];
}

query

localhost/users?order_by=user_name
// select * from users order by name

localhost/users?order_by=phone_number&order_dir=desc (default order_dir=asc)
// select * form users 
// left join profiles on profiles.user_id = users.id
// join phones on phones.profile_id = profiles.id
// order by phone_number asec