Referencia Liquid - Drops

Drops

Los drops son representaciones de los objetos. Éstos tienen una serie de atributos que representan las propiedades del objeto. Por ejemplo, para obtener el nombre del drop blog bastaría con escribir {{ blog.name }}. Dependiendo de que recurso de la web se esté accediendo estarán disponibles unos u otros drops. A continuación un listado de los drops disponibles:

UserDrop

El drop Usuario tiene los siguientes atributos:

• logged_in?

  Devuelve true si el usuario está logeado. False en caso contrario.

• login_url

  Devuelve la url necesaria para conectarse.

• logout_url

  Devuelve la url necesaria para desconectarse.

• register_url

  Devuelve la url necesaria para registrarse

• dashboard_url

  Devuelve la url de acceso al dashboard de usuario.

• edit_url

  Devuelve la url necesaria para modificar los datos del usuario.

• full_name

  Devuelve el nombre completo del usuario.

• company

  Devuelve la compañía del usuario.

• nif

  Devuelve el nif del usuario.

• address

  Devuelve la dirección del usuario.

• webs

  Devuelve las webs del usuario.

• phones

  Devuelve los teléfonos del usuario.

• mails

  Devuelve las direcciones de e-mail del usuario.

• discount

  Si el usuario obtiene algun descuento por grupo devolverá el porcentaje de descuento.

• orders

  Devuelve los pedidos del usuario.

• has_pending_orders?

  Devuelve true si el usuario tiene pedidos pendientes. False en caso contrario.

• pending_orders

  Devuelve una lista con los pedidos pendientes del usuario. Cada elemento de la lista es un drop de tipo Order.

• has_completed_orders?

  Devuelve true si el usuario tiene pedidos completados. False en caso contrario.

• completed_orders

  Devuelve una lista con los pedidos completados del usuario. Cada elemento de la lista es un drop del tipo Order.

• has_downloadables?

  Devuelve true si el usuario ha comprado productos de tipo descarga. False en caso contrario.

• downloadables

  Devuelve una lista con los productos de tipo descarga del usuario. Cada elemento de la lista es un drop de tipo Product.

UserAddress

• full_address

  Devuelve la dirección completa en formato texto.

• postal_code

  Devuelve el código postal.

• city

  Devuelve la ciudad.

• province

  Devuelve la provincia.

• country

  Devuelve el país.

Blog

• id

  Devuelve el id del blog

• url

  Devuelve la url del blog.

• name

  Devuelve el nombre del blog.

• posts

  Devuelve la lista con los artículos publicados. Cada elemento de la lista es un drop de tipo Post.

• untranslated_name

  Nombre del blog sin traducir.

Post

El drop Post contiene los siguientes atributos:

• id

  Devuelve el id del artículo.

• url

  Devuelve la url del artículo.

• title

  Devuelve el título del artículo.

• short_text

  Devuelve el texto del artículo introducido antes de la etiqueta de texto extendido (--more--). Al mismo tiempo, ésta etiqueta es reemplazada por un enlace al artículo completo.

• short_text_without_link

  Devuelve el texto del artículo introducido antes de la etiqueta de texto extendido (--more--) sin mostrarla.

• text

  Devuelve el texto completo sin la etiqueta de texto extendido.

• related_articles

  Devuelve una lista de artículos relacionados con el artículo. Cada elemento es un drop de tipo Post.

• blog

  Devuelve el blog al que pertenece el artículo. El elemento es un drop de tipo Blog.

• blog_name

  Devuelve el nombre del blog al que pertenece el artículo.

• blog_url

  Devuelve la url del blog al que pertenece el artículo

• created_at

  Devuelve la fecha de creación del artículo

• klass

  Devuelve la 'post'. Necesario para personalizar el formulario de comentarios.

• comments

  Devuelve una lista de drops de comentario del artículo. Cada elemento es un drop de tipo Comment.

Este drop además dispone de los atributos de 'campos personalizados'.

Comment

El drop Comment tiene los siguientes atributos:

• id

  Devuelve el identificador del comentario.

• url

  Devuelve la url del elemento al que comenta el comentario.

• name

  Devuelve el nombre del usuario del comentario.

• website

  Devuelve la web del usuario del comentario.

• value

  Devuelve la valoración del producto al que comenta el comentario (sólo en caso de que comente un producto).

• created_at

  Devuelve la fecha de creación del comentario.

• comment

  Devuelve el texto del comentario.

• avatar_path

  Devuelve la ruta de la imagen que el usuario haya elegido como avatar.

• gravatar_url

  Devuelve la ruta de la imagen para el gravatar.

Category

El drop Categoría tiene los siguientes atributos:

• id

  Devuelve el identificador de la categoría.

• url

  Devuelve la url de la categoría. Ej: "/1221/categoria-uno

• name

  Devuelve el nombre de la categoría. Ej: "Categoría Uno"

• google_name

  Devuelve el nombre de la categoría en minusculas, con los espacios sustituidos por guiones y sin acentos. Ej: "categoria-uno"

• description

  Devuelve la descripción de la categoría.

• images

  Devuelve una lista con las imágenes de la categoría. Cada elemento de la lista es un drop de tipo Image

• main_image

  Devuelve la imagen principal. El elemento es un drop de tipo Image

• main_image_url

  Devuelve la url de la imágen principal.

• products

  Devuelve una lista con los productos de la categoría. Cada elemento es un drop de tipo Product.

• highlight_products

  Devuelve una lista con los productos destacados de la categoría y subcategorías. Cada elemento es un drop de tipo Product.

• products_count

  Devuelve el numero de productos de la categoría y de sus subcategorías.

• total_products

  Devuelve una lista con los productos de la categoría y de sus subcategorías. Cada elemento es un drop de tipo Product.

• tags

  Devuelve una lista de los tags de la categoría. Cada elemento es un drop de tipo Tag.

• parent

  Devuelve la categoría padre de la categoría. El elemento es un drop de tipo Category.

• children

  Devuelve una lista con las subcategorías de la categoría. Cada elemento es un drop de tipo Category.

• brothers

  Devuelve una lista con las categorías cuyo padre es el padre de la categoría. Cada elemento es un drop de tipo Category.

Este drop además dispone de los atributos de 'campos personalizados'.

Product

El drop Product tiene los siguientes atributos:

• id

  Devuelve el identificador del producto.

• url

  Devuelve la url del producto: "/product/(id de producto)/(nombre-de-producto)".

• title

  Devuelve el nombre del producto.

• price

  Devuelve el precio del producto.

• previous_price

  Devuelve el precio anterior del producto.

• stock

  Devuelve el stock del producto. Si es un producto con opciones de venta, devuelve la suma del stock de todas las opciones de venta.

• available

  Devuelve verdadero si el producto o ninguna de sus opciones de venta está en stock y el producto o todas sus opciones de venta están configuradas para parar la venta si no queda stock.

• units_sold

  Devuelve el número de unidades vendidas del producto. Si es un producto con opciones de venta devuelve la suma de unidades vendidas de todas sus opciones de venta.

• discount

  Si el producto obtiene algun descuento por grupo devolverá el porcentaje de descuento.

• images

  Devuelve la lista de imágenes que contenga el producto. Cada elemento de la lista es un drop de tipo Image.

• sell_options

  Devuelve la lista de opciones de venta del producto. Cada elemento de la lista es un drop de tipo SellOption.

• has_sell_options?

  Devuelve verdadero si el producto tiene opciones de venta

• add_cart_url

  Devuelve la url para añadir el producto al carro de la compra: "/store/cart/add_to_cart/(id de producto)".

• related_products

  Devuelve una lista productos relacionados. Cada elemento de la lista es un drop de tipo Product.

• content

  Devuelve la descripción del producto.

• main_image

  Devuelve la imagen principal del producto. El elemento devuelto es un drop de tipo Image.

• shipping_time

  Devuelve el tiempo de envío expresado en días.

• tags

  Devuelve la lista de tags del producto. Cada elemento de la lista es un drop de tipo Tag.

• category

  Devuelve la categoría del producto. El elemento es un drop de tipo Category.

• klass

  Devuelve 'product'. Necesario para el formulario de comentarios.

• comments

  Devuelve la lista de comentarios del producto. Cada elemento de la lista es un drop de tipo Comment.

Este drop además dispone de los atributos de 'campos personalizados'.

ProductGroup

El drop ProductGroup tiene los siguientes atributos:

• id

  Devuelve el identificador del grupo de productos.

• url

  Devuelve la url del grupo de productos: "/group/(id de grupo)/(nombre-de-grupo)".

• name

  Devuelve el nombre del grupo de productos.

• products

  Devuelve la lista de productos que pertenecen al grupo de productos. Cada elemento de la lista es un drop de tipo Product.

• description

  Devuelve la descripción de la agrupación.

• images

  Devuelve una lista con las imágenes de la agrupación. Cada elemento de la lista es un drop de tipo Image

• main_image

  Devuelve la imagen principal. El elemento es un drop de tipo Image

Este drop además dispone de los atributos de 'campos personalizados'.

SellOption

Los atributos de las opciones de venta son:

• id

  Devuelve el identificador de la opción de venta.

• title

  Devuelve el nombre de la opción de venta. Si la opción tiene variantes, el nombre se obtiene juntando todas las variantes con un espacio.

• name1

  Devuelve el valor de la primera variante.

• name2

  Devuelve el valor de la segunda variante.

• name3

  Devuelve el valor de la tercera variante.

• price

  Devuelve el precio de la opción de venta.

• previous_price

  Devuelve el precio anterior de la opción de venta.

• stock

  Devuelve el stock de la opción de venta.

• available

  Devuelve verdadero si la opción de venta está en stock o la opción de venta no está en stock pero no está configurada para parar la venta si no queda stock.

• units_sold

  Devuelve el número de unidades vendidas de la opción de venta.

• weight

  Devuelve el peso de la opción de venta.

• shipping_time

  Devuelve el plazo de entrega de la opción de venta.

Cart

El drop cart tiene los siguientes atributos:

• products

  Devuelve la lista de productos añadidos al carro de la compra. Cada elemento de la lista es un drop de tipo CartItem.

• total_base

  Devuelve el precio total del carro de la compra

• total

  Devuelve el precio total del carro de la compra con descuentos aplicados.

• total_base_price_with_shipping

  Devuelve el precio total del carro de la compra sin gastos de envio.

• total_price_with_shipping

  Devuelve el precio total del carro de la compra sin gastos de envio, con descuentos aplicados.

• discount

  En caso de existir algún descuento sobre el carro de la compra podremos acceder a los siguientes métodos:

  • items

    Devuelve la cantidad descontada sobre los productos

  • user

    Devuelve la cantidad descontada sobre el total del carro, por grupo de usuario

  • coupon

    Devuelve la cantidad descontada por cupón

  • total

    Devuelve la cantidad total descontada

• total_products

  Numero total de elementos en el carro de la compra.

• is_empty?

  Devuelve true si el carro de la compra está vacío. En otro caso, devuelve false.

• empty_cart_url

  Devuelve la url necesario para borrar el contenido del carro de la compra: "/store/cart/empty_cart".

• checkout_url

  Devuelve la url necesario para iniciar el proceso de pago de los productos añadidos en el carro de la compra: "/store/go/checkout".

• ajax_checkout_url

  Devuelve la url necesario para iniciar el proceso de pago mediante el formulario ajax: "/store/go/checkout?ajax=true".

CartItem

El drop CartItem tiene los siguientes atributos:

• product

  Devuelve el producto al que hace referencia. El elemento es un drop de tipo Product.

• name

  Devuelve el nombre del producto.

• url

  Devuelve la url del producto.

• quantity

  Devuelve la cantidad de veces que del mismo tipo añadidos al carro de la compra.

• price_base

  Devuelve el precio del producto.

• price

  Devuelve el precio del producto con descuentos aplicados.

• total_base

  Devuelve el precio total de las unidades del producto.

• total

  Devuelve el precio total de las unidades del producto, con descuentos aplicados

• discount

  En caso de existir algún descuento sobre el producto podremos acceder a los siguientes métodos:

  • item

    Devuelve la cantidad descontada sobre el producto

  • total

    Devuelve la cantidad descontada sobre todas las unidades de producto

  • percentage

    Devuelve el porcentaje de descuento sobre el producto

• main_image_url

  Devuelve la imagen principal del producto. El elemento es un drop de tipo Image.

• delete_url

  Devuelve la url necesaria para eliminar el producto del carro de la compra.

Order

El drop de Order tiene los siguientes atributos:

• number

  Devuelve el número del pedido.

• line_orders

  Devuelve una lista con las lineas de pedido. Cada elemento es un drop de tipo LineOrder.

• total

  Devuelve el importe total del pedido.

• shipping_costs

  Devuelve los costes de envío del pedido.

• state

  Devuelve el estado del pedido.

• article_count

  Devuelve el número de artículos del pedido.

• downloadables

  Devuelve una lista de productos descargables del pedido. Cada elemento es un drop de tipo LineOrder.

• created_at

  Devuelve la fecha de creación del pedido.

LineOrder

El drop LineOrder tiene los siguientes atributos:

• product

  Devuelve el producto al que hace referencia la linea de pedido. El elemento es un drop de tipo Producto.

• product_name

  Devuelve el nombre del producto de la linea de pedido.

• quantity

  Devuelve el numero de productos añadidos.

• option

  Devuelve la opción del producto de la linea de pedido. El elemento es un drop de tipo SellOption.

• client_notes

  Devuelve las notas del cliente de la linea de pedido.

• price

  Devuelve el precio del producto de la linea de pedido.

• remaining_downloads

  Devuelve el numero de descargas restantes del producto de la linea de pedido.

• download_file_url

  Devuelve la url necesaria para descargar el producto de la linea de pedido.

PayType

El drop PayType tiene los siguientes atributos:

• name

  Devuelve el nombre del tipo de pago.

• info

  Devuelve información sobre el tipo de pago.

Link

El drop Link representa un enlace de una agrupación de enlaces. Tiene los siguientes atributos:

• id

  Devuelve el identificador del enlace.

• url

  Devuelve la url del enlace.

• name

  Devuelve el nombre del enlace.

• children

• Devuelve una lista con los subenlaces. Cada elemento de la lista es un drop de tipo Link.

• parent

  Devuelve el enlace padre al que pertenece el enlace. El elemento es un drop de tipo Link.

• root

  Devuelve el enlace raíz del enlace. El elemento es un drop de tipo Link.

• image?

  Devuelve true si el enlace contiene una imagen.

• image

  Devuelve un objeto que representa la imagen del enlace. Podemos convertirlo en una ruta a la imagen con el filtro image_url. Para obtener la ruta al archivo original (no redimensionado) podemos usar el siguiente código liquid: {{ link.image | image_url: 'original' }}. Al filtro image_url podemos pasar el formato de la imagen que queremos. Los formatos disponibles son:

  original

  El archivo original. Usando este estilo también se pueden usar archivos Flash o archivos GIF animados.

  resized

  El archivo redimensionado según las dimensiones especificadas en las propiedades de la plantilla.

  xs

  Con un ancho y alto no mayor a 24px por 24px

  s

  Con un ancho y alto no mayor a 100px por 100px

  m

  Con un ancho y alto no mayor a 180px por 180px

  l

  Con un ancho y alto no mayor a 350px por 350px

  xl

  Con un ancho y alto no mayor a 500px por 500px

   

• image_url

  Devuelve la ruta de la imagen del enlace. La ruta es para la imagen redimensionada según los dimensiones especificadas en las propiedades de la plantilla.

• object

  Devuelve el objeto a que enlaza el enlace o nada si enlaza una dirección web.

• type

  Devuelve el tipo de objeto a que enlaza el enlace. El tipo puede ser una de las siguientes cadenas:

  • page_link para enlaces a páginas
  • category_link para enlaces a categorías
  • product_group_link para enlaces a agrupaciones de productos
  • blog_link para enlaces a blogs
  • http_link para enlaces a direcciones web

Image

El drop Imagen tiene los siguiente atributos:

• id

  Devuelve el identificador de la imagen.

• url

  Devuelve la url de la imagen.

Tag

Los atributos del drop Tag son:

• id

  Devuelve el identificador del tag.

• name

  Devuelve el nombre del tag.

Page

El drop de Página tiene los siguientes atributos:

• id

  Devuelve el identificador de la página.

• human_name

  Devuelve el nombre de la página. Ejemplo: "Página de contacto".

• name

  Devuelve el nombre url de la página. Ejemplo: "pagina-de-contacto".

• html

  Devuelve el contenido de la página.

• url

  Devuelve el link de la página. Ejemplo: /pages/pagina-de-contacto.

• created_at

  Devuelve la fecha de creación de la página.

• updated_at

  Devuelve la fecha de última actualización de la página.

Fields

Algunos drops tienen a atributos de Campos personalizados. Por ahora los Artículos, Categorías, Productos, Agrupaciones de productos y Páginas tienen campos personalizados. Estos drops tienen los siguientes atributos:

• fields

  Devuelve la lista de campos personalizados. Cada elemento es un diccionario indexado de la forma clave-valor.

  Ej: Un producto tiene 2 campos personalizados, altura (clave) = 200 (valor) y anchura (clave) = 100 (valor).

  {% for field in product.fields %}
    {{field[0] - field[1]}}
  {% endfor %}
        

  Tambien se puede acceder a los campos personalizados de la siguiente forma:

  {{product.fields.altura}}
  {{product.fields.anchura}}

  El elemento que devuelve es una lista. Si no se especifica nada Liquid transforma las listas a cadenas de carácteres. Pero en caso de tener varios elementos con la misma clave se puede recorrer la lista:

  {%for referencia in product.fields.referencia%}
    {{referencia}}
  {%endfor%}
        

• field_keys

  Devuelve una lista con las claves de los campos personalizados.

• field_values

  Devuelve una lista con los valores.