Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Open up Paginator::$documents for read

Aperta
  • Qualcosa non va?
#8,118 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
elasticsearch, php
Ambito
api, backend

Direzione di ricerca

Parti dalla classe Elasticsearch\Paginator e verifica come i suoi documenti vengono consumati dal normalizzatore della collection Hydra. Usa l’esempio di decorator nell’issue per verificare che le aggregazioni Elasticsearch possano essere lette senza sostituire il provider nativo; il lavoro è completo quando i documenti rimangono di sola lettura ma sono accessibili pubblicamente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Elasticsearch

Description
In Elasticsearch\Paginator, the results of the query stored in $this->documents are private readonly.

Since the property is readonly anyway, would you be willing to make it public readonly?

A lot of the time, Elasticsearch returns metadata such as aggregations, necessary for building feature-rich search experiences.

It is a total waste of time to implement a custom Elasticsearch provider. The native one is great and does a lot of heavy lifting. If the property was open for read, I could simply decorate the normalizer, see example.

Example

#[AsDecorator('api_platform.hydra.normalizer.collection')]
class ElasticsearchNormalizer implements NormalizerInterface, NormalizerAwareInterface
{
    public function __construct(
        private NormalizerInterface $normalizer,
    ) {
    }

    public function normalize(mixed $object, string $format = null, array $context = []): array
    {
        if (!$object instanceof Elasticsearch\Paginator) {
            throw new \LogicException();
        }

        return array_merge(
            $this->normalizer->normalize($object, $format, $context), // produces a valid hydra:collection
            ['aggregations => $object->documents['aggregations']], // metadata returned by Elasticsearch read from the raw result
        ));
    }
}
Lingua principale
PHP
Stelle
2.6k
Fork
989
Merge medio
1g 23h
PR unite (30g)
102

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di api-platform/core

Tutte le issue di api-platform/core

Issue simili

Altre issue su PHP

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.