Přístup k parametrům z requestu v presenteru a komponentách

Nebo #[RequestParameter]

Marek Bartoš napsal(a):

Já bych bral #[RequestParameter(persistent: false)]

Jelikož to nebude mít konstruktor, nic by nemělo bránit to psát i takto.

Jo, to se bude líp psát i číst, dobrý důvod zavést další atribut pro persistetní parametry.

Můžeš to rozvést?

I partially agree with m. brecher. What I liked about Presenters here in Nette is that it's (mostly) abstracted-away from the concept of Request and Response.

Furthermore having #[Persistent] and #[Request] (or #[RequestParameter]) is non-orthogonal.

The contrary of #[Persistent] would be #[Volatile] or #[Mutable]

@PavelKravčík

Pokud bych si mohl vynutit, že to bude přetypováno na int třeba atributem, bylo by to super.

Definice typu parametru requestu se provádí typehintem v akci nebo v deklaraci parametru jako property presenteru. Nedává moc smysl deklarovat parametr requestu $id jako property a v akci nepoužít $this->id, ale deklarovat parametr duplicitně přímo v akci – jak máš v ukázce kódu.

Mě dává smysl takovéto použití:

use Nette\Application\Attributes\Request;

class MyPresenter extends Nette\Application\UI\Presenter
{
	#[Request]
	public int $articleId;

	function handleBoo()
	{
		getEntityByID($this->id);
	}
}

Editoval m.brecher (1. 10. 2023 22:32)

#[Request] is excessively non-orthogonal with #[Persistent].

At this point it would be better to have #[RequestParameter] or even better #[Parameter] with (persistent: true) for the persistent one and deprecate #[Persistent] (or having it as alias)

@mbrecher

Definice typu parametru requestu se provádí typehintem v akci nebo v deklaraci parametru jako property presenteru. Nedává moc smysl deklarovat parametr requestu $id jako property a v akci nepoužít $this->id, ale deklarovat parametr duplicitně přímo v akci – jak máš v ukázce kódu.

Ano, to je jasný v presenteru. Chtěl bych to v komponentě. Ale je to trochu úkrok stranou od původního vlákna.

/?foo-dateFrom=10&foo-dateTo=20&do=foo-ping bych chtěl obojí dostat jako int (přijde jako string z ajaxu). Pokud bych to dokázal vynutit parametrem v komponentě, bylo by to super.

Předpokládám, že plánovaný atribut bude jak v presenteru, tak v komponentách.

Název tohoto vlákna a první věta úvodního postu by v tom mohla udělat trošku jasno

@DavidGrudl: Otestoval jsem a funguje to ok (s DI 3.1.6).

Akorát trochu mi zlobí jedna věc, možná to někdo řeší elegantněji. Chápu, že je to asi nesmysl v JS a není to extra důležité a dá se to snadno obejít (int|string), ale kdyby měl někdo nějaký nápad nebo by Nette tenhle případ přetypovalo (intval('PARAM_FROM')===0) bylo by to super.

<?php
declare(strict_types=1);

use Nette\Application\Attributes\Parameter;

class Foo extends \Nette\Application\UI\Control
{
	#[Parameter]
	public int $from = 10;

	#[Parameter]
	public int $to = 20;

	#[Parameter]
	public int $limit = 0;

	public function handlePing(): void
	{
		//output (dump $this->from, $this->to, $this->limit)
	}


	public function handleBing(int $from, int $to): void
	{
		//output (dump $this->from, $this->to, $this->limit)
	}
}

// JS doplňuje hodnoty intFrom = 40, intTo = 50

Na téhle variantě se mi nelíbí '0' jako zástupný znak (s tím zástupným znakem poslední úryvek funguje):

naja.makeRequest('GET', {link ping!, from => '0', to => '1'}.replace('0', intFrom).replace('1', intTo));
//output: 40, 50, 0

Pokud nahradím za něco lepšího, funguje ok:

naja.makeRequest('GET', {link ping!, from => 'PARAM_FROM', to => 'PARAM_TO'}.replace('PARAM_FROM', intFrom).replace('PARAM_TO', intTo));
//output: 40, 50, 0

Akorát se mi nelíbí možnost, upsat se:

naja.makeRequest('GET', {link ping!, from => 'PARAM_FROM', too => 'PARAM_TO'}.replace('PARAM_FROM', intFrom).replace('PARAM_TO', intTo));
//output: 40, 20, 0

Takže by se mi líbilo vynutit si poslání parametrů (např 2 z 3 výše handleBing) a vynutit jeho přetypování:

naja.makeRequest('GET', {link bing!, from => 'PARAM_FROM', too => 'PARAM_TO'}.replace('PARAM_FROM', intFrom).replace('PARAM_TO', intTo));
// output: ERR - must be int, string given
// očekávaný output: ERR - Missing parameter $to required

Finální kód by se mi líbil:

naja.makeRequest('GET', {link bing!, from => 'PARAM_FROM', to => 'PARAM_TO'}.replace('PARAM_FROM', intFrom).replace('PARAM_TO', intTo));
// output: 40, 50, 0

Editoval Pavel Kravčík (19. 10. 2023 14:14)

Návrh – implementovat parametr s atributem #[Parameter] jako stavový

Nový atribut #[Parameter] zpřehlední kód a zajistí správné typování. Navrhuji doplnit důležitou feature z hlediska existujícího komponentového modelu Nette. Parametry deklarované pomocí #[Parameter] by měly být automaticky zahrnuty do stavu akce presenteru (stavu komponenty).

#[Parameter]
public ?string $param = null;

by měl být zahrnut do aktuálního stavu akce stejně jako:

public function actionUpdate(?string $param = null)
{}

Argumenty:

Presenter

V presenteru je parametr s atributem #[Parameter] obdobou parameru akce. Není sice v akci deklarovaný, je ale deklarovaný v presenteru a v aktuální akci jej lze použít (libovolné akci). Je proto ze své podstaty součástí aktuálního stavu presenteru , kam patří presenter, akce a parametry akce (aktuální view).

V aktuální verzi Nette parametr #[Parameter] součástí aktuálního stavu presenteru není a signál presenteru, nebo submit formuláře parametr vymaže. To je v rozporu s principem komponentového modelu Nette, že signály komponent NEMĚNÍ aktuální stav akce presenteru.

Proto by bylo vhodné, aby parametr s atributem #[Parameter] byl součástí aktuálního stavu presenteru, a NEMĚNIL se signálem komponenty/submitu formuláře.

Je to navíc i chybějící užitečná funkcionalita pro formuláře. Pokud potřebujeme v parent komponentě formuláře řídící parametr pro formulář (přidání inputu, …), potom je jediné řešení deklarovat jej jako #[Persistent], což má vedlejší efekt – persistenci, která je na obtíž. Tento návrh to elegantně řeší.

Komponenta

V komponentě je situace s #[Parameter] parametrem obdobná jako v presenteru. Rozdíl je v tom, že komponenty nemají akce, ale mají stejně jako presentery stav, který by podřízené komponenty, včetně formulářů neměly měnit. Součástí stavu komponenty jsou stavové parametry komponenty – nyní persistentní parametry komponenty.

Pokud potřebujeme, aby subkomponenty neměnily aktuální stav komponenty, použijeme v komponentě #[Persistent] parametry. Stejně jako v presenteru ale tento atribut dělá víc než obvykle potřebujeme. Zajistí, že subkomponenty nemohou parametr měnit, ale přidají nadbytečnou funkci – persistence v presenteru, parametr se předá i do signálů nadřazené komponenty – to může být nežádoucí.

Tedy i v komponentách by bylo vhodné, aby #[Parameter] parametry byly součástí aktuálního stavu komponenty. Subkomponenty by je nemohly měnit, ale do odkazů nadřazených komponent by se nepřenášely.

Ajax

V ajaxovém payloadu se z Nette aplikace odesílá vedle položky snippets i položka state, kde jsou v současné době přenášeny persistentní parametry. Stavové parametry se mohou hodit v javascriptu zpracovávajícím ajaxový response. Proto si myslím, že by se #[Parameter] parametry měly předávat i v payloadu jako součást stavu presenteru/komponenty.

@Ages

jak vyřeším případný redirect v Presenteru?

Nezkoušel jsem to, ale řekl bych, že se to vyřeší tím, že se paralelně k deklaraci parametru pomocí #[Parameter] uvede parametr jako parametr příslušné akce:

public function actionFoo(int $orderId = 0): void
    {
        bdump($this->orderId);
    }

Je to v podstatě ten samý problém, který popisuji zde: https://forum.nette.org/…komponentach#…

Atribut #[Parameter] je výborná myšlenka, ale není v této chvíli příliš funkční – problém se submitem formuláře, problém s redirectem. Aby se dal bezproblémově používat, je potřeba, aby byl frameworkem považován za parametr aktuální akce.

@Ages Ty se spoléháš na pořadí, namísto na názvy parametrů, což může fungovat pro parametry funkce, ale už ne pro properties. Plus by měly být parametry odkazu pole.

$this->redirect('foo', ['orderId' => $entity->id]);

Ten vygenerovaný odkaz v Latte ti skutečně funguje? Výchozí chování při neplatném odkazu je myslím warning, ne exception.

Editoval Marek Bartoš (6. 2. 2024 10:24)

@Ages

Skutečně jsem to asi špatně pochopil, nemá jít o náhradu parametrů v metodě ale pouze o alternativní přístup k parametru mimo metodu.

Je to tak. Praktická využitelnost takovéto funkce je ovšem otázkou. Má neočekávané chování, že když se deklaruje parametr pomocí #[Parameter] a odešle v nějaké akci formulář, tak parametr zmizí – podobně jako u toho přesměrování. Očekávané chování by bylo, že je to syntakticky jiný způsob deklarace parametru akce.

Copak v presenteru, tam jednoduše použiju starý zápis a je to vyřešeno, ale v komponentách akce nemáme a tak když chci zajistit, aby nějaký parametr přežil submit formuláře, tak mám jedinou možnost použít #[Persistent]. Ten ovšem vše komplikuje, protože přidává nežádoucí persistenci, což vadí, musí se to potom pečlivě ošetřovat v odkazech, jinak komponenty dělají psí kusy. Takže atribut #[Parameter], který by byl plnokrevným stavovým atributem v Nette vyloženě chybí a v komponentách ho není de facto jak nahradit. Protože použít #[Persistent] je jenom dočasné řešení.

Editoval m.brecher (6. 2. 2024 13:05)

@MarekBartoš

Ano, založím issue s podrobným popisem problému.