Skip to content

Add support to select custom columns on the find operations #19

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.

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/HashidScope.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ public function apply(Builder $builder, Model $model)

public function extend(Builder $builder)
{
$builder->macro('findByHashid', function (Builder $builder, $hashid) {
$builder->macro('findByHashid', function (Builder $builder, $hashid, $columns = ['*']) {
$id = $builder->getModel()->hashidToId($hashid);

return $builder->find($id);
return $builder->find($id, $columns);
});

$builder->macro('findByHashidOrFail', function (Builder $builder, $hashid)
$builder->macro('findByHashidOrFail', function (Builder $builder, $hashid, $columns = ['*'])
{
$id = $builder->getModel()->hashidToId($hashid);

return $builder->findOrFail($id);
return $builder->findOrFail($id, $columns);
});
}
}
41 changes: 41 additions & 0 deletions tests/HasHashidTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,45 @@ public function it_can_handle_invalid_hashids_properly()
$this->expectException(ModelNotFoundException::class);
Item::findByHashidOrFail('not a hashid');
}

/**
* @test
*/
public function it_can_find_a_model_by_its_hashid_with_specific_columns()
{
$item = factory(Item::class)->create();

$hashid = Hashids::encode($item->getKey());

$selectedColumns = ['id'];

$found = Item::findByHashid($hashid, $selectedColumns);

$this->assertNotNull($found);
$this->assertEquals($item->id, $found->id);
$this->assertEquals($selectedColumns, array_keys($found->getAttributes()));
}

/**
* @test
*/
public function it_can_find_a_model_by_its_hashid_with_specific_columns_or_fail()
{
$item = factory(Item::class)->create();

$hashid = Hashids::encode($item->getKey());

$selectedColumns = ['id'];

$found = Item::findByHashidOrFail($hashid, $selectedColumns);

$this->assertEquals($item->id, $found->id);
$this->assertEquals($selectedColumns, array_keys($found->getAttributes()));

$item->delete();

$this->expectException(ModelNotFoundException::class);

Item::findByHashidOrFail($hashid);
}
}