Documentation

BffServiceClient extends BaseStub
in package

Table of Contents

Methods

__construct()  : mixed
CreateLetter()  : UnaryCall
Crea una carta con los datos que el usuario introduce en el formulario de creación de cartas.
CreateRecipe()  : UnaryCall
Crea una receta con los datos que el usuario introduce en el formulario de creación de recetas.
GetBoard()  : UnaryCall
Muestra una pizarra completa. Aunque retorna un Board completo el distribuidor y fecha de entrada son obligatorios así que tendrá como máximo un solo resultado.
GetBoards()  : UnaryCall
Obtiene un listado resumen de las pizarras. Nos sirve tanto para la home de a2000 donde tenemos que ignorar los precios individuales como para la página de pizarra donde mostramos todos los datos.
GetLetter()  : UnaryCall
Obtiene los datos de una carta para la página donde se renderizan enteras.
GetRecipe()  : UnaryCall
Obtiene toda la información necesaria de una receta para la página donde se renderiza.
GetRecipesHome()  : UnaryCall
Muestra los datos necesarios para la home de gastronomia como las recetas destacadas y del dia, los tipos y categorias existentes.
ListDistributors()  : UnaryCall
Lista los distribuidores disponibles de la pizarra de agricultura.
ListLetters()  : UnaryCall
Obtiene la informacion necesaria para pintar la pagina de la home de Opinion.
ListRecipes()  : UnaryCall
Obtiene un listado de recetas que pertenezcan a la categoria indicada junto con la información necesaria para renderizar la página del listado por categorias.
RenderHome()  : UnaryCall
Renderiza la home de la web.
RenderRecipes()  : UnaryCall
Muestra los datos necesarios para la sección de gastronomia como las recetas destacadas y del dia, los tipos y categorias existentes.
RenderSection()  : UnaryCall
Renderiza una sección.
SearchBoards()  : UnaryCall
Busca las pizarras, opcionalmente por distribuidor, fecha o ambos. Devuelve solamente las pizarras que existen para vincularlas pero no los datos de la pizarra en sí mismos.

Methods

__construct()

public __construct(string $hostname, array<string|int, mixed> $opts[, Channel $channel = null ]) : mixed
Parameters
$hostname : string

hostname

$opts : array<string|int, mixed>

channel options

$channel : Channel = null

(optional) re-use channel object

CreateLetter()

Crea una carta con los datos que el usuario introduce en el formulario de creación de cartas.

public CreateLetter(CreateLetterRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Es obligatorio indicar el token del usuario autenticado que la crea.

Parameters
$argument : CreateLetterRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

CreateRecipe()

Crea una receta con los datos que el usuario introduce en el formulario de creación de recetas.

public CreateRecipe(CreateRecipeRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Es obligatorio indicar el token del usuario autenticado que la crea.

Parameters
$argument : CreateRecipeRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

GetBoard()

Muestra una pizarra completa. Aunque retorna un Board completo el distribuidor y fecha de entrada son obligatorios así que tendrá como máximo un solo resultado.

public GetBoard(GetBoardRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Si no encuentra la pizarra devuelve error de NotFound.

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/boards/foo

Parameters
$argument : GetBoardRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

GetBoards()

Obtiene un listado resumen de las pizarras. Nos sirve tanto para la home de a2000 donde tenemos que ignorar los precios individuales como para la página de pizarra donde mostramos todos los datos.

public GetBoards(GPBEmpty $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/boards:overview

Parameters
$argument : GPBEmpty

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

GetLetter()

Obtiene los datos de una carta para la página donde se renderizan enteras.

public GetLetter(GetLetterRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/letters/2004

Parameters
$argument : GetLetterRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

GetRecipe()

Obtiene toda la información necesaria de una receta para la página donde se renderiza.

public GetRecipe(GetRecipeRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Activar el flag de previsualizacion en el caso de que se quiera previsualizar una receta no visible aun.

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/recipes/294

Parameters
$argument : GetRecipeRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

GetRecipesHome()

Muestra los datos necesarios para la home de gastronomia como las recetas destacadas y del dia, los tipos y categorias existentes.

public GetRecipesHome(GPBEmpty $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/recipes:home

Parameters
$argument : GPBEmpty

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

ListDistributors()

Lista los distribuidores disponibles de la pizarra de agricultura.

public ListDistributors(GPBEmpty $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/distributors

Parameters
$argument : GPBEmpty

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

ListLetters()

Obtiene la informacion necesaria para pintar la pagina de la home de Opinion.

public ListLetters(ListLettersRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/letters

Parameters
$argument : ListLettersRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

ListRecipes()

Obtiene un listado de recetas que pertenezcan a la categoria indicada junto con la información necesaria para renderizar la página del listado por categorias.

public ListRecipes(ListRecipesRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/recipes/9

Parameters
$argument : ListRecipesRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

RenderHome()

Renderiza la home de la web.

public RenderHome(GPBEmpty $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/menus:home

Parameters
$argument : GPBEmpty

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

RenderRecipes()

Muestra los datos necesarios para la sección de gastronomia como las recetas destacadas y del dia, los tipos y categorias existentes.

public RenderRecipes(GPBEmpty $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/recipes

Parameters
$argument : GPBEmpty

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

RenderSection()

Renderiza una sección.

public RenderSection(RenderSectionRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Si la sección no existe devolverá un error de NotFound.

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/sections/3

Parameters
$argument : RenderSectionRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

SearchBoards()

Busca las pizarras, opcionalmente por distribuidor, fecha o ambos. Devuelve solamente las pizarras que existen para vincularlas pero no los datos de la pizarra en sí mismos.

public SearchBoards(SearchBoardsRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall

Aquí retornaremos las 300 primeras pizarras que encontremos. Si hay más se activará el flag en la respuesta que permite avisar al usuario de que filtren un poco más si desea ver el resto mientras le enseñamos los 300 que hemos encontrado.

Ejemplo: https://php-bff-ubirgsu2wa-ew.a.run.app/boards:search

Parameters
$argument : SearchBoardsRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results