How to parse URL segment Identifiers in Laravel?

Question

I'm using OctoberCMS based on Laravel.

I'm trying to capture segments of the URL to pass into a Scope Function to filter Database Results.

Visiting localhost/user/john/nature would parse and filter back those results.

URL → Identifiers → Param Variables → Scope → Database Results

Page

[builderDetails builderUser]
identifierValue "{{ :username }}"

[builderDetails builderCategory]
identifierValue "{{ :category }}"

[builderList]
scope = "scopeApplyType"

url = /user/:username?/:category?/:page?

Model Scope

I want to filter Database Results using URL Identifers :username and :category.

public function scopeApplyType($query) {
    $params = ['username' => $username, 'category' => $category];
    return $query->where($params);
}

Get Identifiers

This will output the requested identifers in the URL, in routes.php

Route::get('user/{username?}/{category?}', function ($username = null, $category = null) {
    echo $username;
    echo $category;
});

Output

localhost/user/john/nature

john
nature

Soultion?

A Route::get() won't work, I need something inside or passed to the Scope to define the params variables.

Something like:

$username = '{username?}'; 
$username = request()->url('username');
$username = $this->param('username'); //Components)
$username = $this->route('username');
$username = \Route::current()->getParameter('username');

All return null or error.

Like the way you would normally parse a Query

$param = "username=john&category=nature";
$username = $category = ''; 
parse_str($param);
echo $username;
echo $category;

Or similar to Request Segment

$username = request()->segment(2); //user/:username

segment(2) is a static location unlike {:category} which can change position on different URL's.

Have you tried $request->route('parameter_name') or $request->route()->parameters()? — Ben Swinburne
– Ben Swinburne, Commented Feb 12, 2017 at 18:42
You'd need to get the request object request() should give you it. request()->route() — Ben Swinburne
– Ben Swinburne, Commented Feb 12, 2017 at 19:30
@BenSwinburne $request is now defined but the parameters return null. i.imgur.com/J9vB5TW.png — Matt McManis
– Matt McManis, Commented Feb 12, 2017 at 19:41
@BenSwinburne My mistake, it is still not defined. Code placement was wrong. — Matt McManis
– Matt McManis, Commented Feb 12, 2017 at 19:43

LukeTowers · Accepted Answer · 2017-02-13 19:58:56Z

1

What you are trying to do has gone beyond the scope of the very basic components provided by the builder plugin.

You should now look at creating your own Components within your plugin. See http://octobercms.com/docs/plugin/components and http://octobercms.com/docs/cms/components for further information, as well as the section on routing parameters specifically

A very basic example of your custom component might look like this:

<?php namespace MyVendor/MyPlugin/Components;

use Cms\Classes\ComponentBase;
use MyVendor\MyPlugin\Models\Result as ResultModel;

class MyComponent extends ComponentBase
{
    public $results;

    public function defineProperties()
    {
        return [
            'categorySlug' => [
            'title' => 'Category Slug',
            'type' => 'string',
            'default' => '{{ :category }}',
            ],
            'username' => [
                'title' => 'Username',
                'type' => 'string',
                'default' => '{{ :username }}',
            ],
        ];
    }

    public function init()
    {
        $this->results = $this->page['results'] = $this->loadResults();
    }

    public function loadResults()
    {
        return ResultModel::where('username', $this->property('username'))
                      ->where('category', $this->property('categorySlug'))
                      ->get();
    }
}

Then in your component's default.htm view you'd do something like this:

{% for result in __SELF__.results %}
    {{ result.title }}
{% endfor %}

And in your OctoberCMS page:

url = /user/:username?/:category?/:page?

[myComponent]
categorySlug = "{{ :category }}"
username = "{{ :username }}"
==
{% component 'myComponent' %}

answered Feb 13, 2017 at 19:58

LukeTowers

1,3167 silver badges14 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Matt McManis Over a year ago

octobercms.com/docs/database/model#query-scopes Here under Dynamic Scopes it shows how to applyType, but it doesn't work. I put it in my Page htm php, and directed it at my custom Component. $user = Gallery::applyType('john')->get(); It says "Call to undefined method October\Rain\Database\QueryBuilder::applyType()".

Matt McManis Over a year ago

I will try your solution and add your code to my component.

LukeTowers Over a year ago

@MattMcManis how did you write your scope method in your model? It needs to be defined in the form of public function scopeApplyType($query, $type)

Matt McManis Over a year ago

You've got me very close to solving this, here is an extension to the question showing the scope. stackoverflow.com/q/42337725/6806643

Ben Swinburne · Accepted Answer · 2017-02-13 15:00:13Z

0

Given the following route

Route::get('foo/{name?}', function ($name = null) {
    dd(request()->route()->parameters());
});

When visiting /foo/bar the output is as below.

array:1 [▼
  "name" => "bar"
]

Similarly you can use

dd(request()->route()->parameter('name')); // bar

answered Feb 13, 2017 at 15:00

Ben Swinburne

26.6k10 gold badges75 silver badges113 bronze badges

9 Comments

Matt McManis Over a year ago

I used OctoberCMS to create the Page. When I use Route::get() in routes.php, it overrides my Page with a blank one. I used the dd() with 'username' and it returned a blank page with the word 'null'. But 'slug' returned 'user/john', the whole uri.

Matt McManis Over a year ago

I can get the Identifier {username?} with $username = $this->param('username') only when used in the Page php, but how to use that same code in the Model or send to the Scope?

Ben Swinburne Over a year ago

What does $this refer to? the above way is the Laravel 5 way to do it so it should work. What version of Laravel are you using?

Matt McManis Over a year ago

If I echo $this in the Page php, it returns "Object of class Cms58a1e3092320e853718389_1418827154Class could not be converted to string". It must be some sort of Page Class October is creating?

Ben Swinburne Over a year ago

Presumably, yes. I'm not familiar with OctoberCMS but i'd have assumed that the standard Laravel stuff would work

|

Collectives™ on Stack Overflow

How to parse URL segment Identifiers in Laravel?

2 Answers 2

4 Comments

9 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

9 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related