Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Open up Paginator::$documents for read

Abierto
  • ¿Algo no está bien?
#8,118 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
45/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
elasticsearch, php
Área
api, backend

Línea de trabajo

Comienza por la clase Elasticsearch\Paginator e inspecciona cómo consume sus documentos el normalizador de colecciones de Hydra. Usa el ejemplo de decorador del issue para verificar que las agregaciones de Elasticsearch se pueden leer sin reemplazar el proveedor nativo; el trabajo estará terminado cuando los documentos sigan siendo de solo lectura, pero sean accesibles públicamente.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
        ));
    }
}
Lenguaje dominante
PHP
Estrellas
2.6k
Forks
989
Merge medio
1 d 22 h
PR fusionados (30 d)
100

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de api-platform/core

Todos los issues de api-platform/core

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.