Skip to content

Functions

Jump to bottom
ricardoon edited this page Oct 23, 2014 · 6 revisions

template_navigator()

Navegação para edição de Templates.
Um helper que retorna a navegação para ajudar a desenvolver o template.


{{ template_navigator() }}

social_link()

Links para Social Media.
Retorna um link para as redes sociais cadastradas no administrador.
Valores: facebook, twitter, pinterest, instagram, google, youtube


{{ social_link("facebook") }}

logo_url()

Retorna a url da logo da loja.
Aceita o valor dark para a versão para fundo branco.


{{ logo_url() }} ou {{ logo_url("dark") }}

validation_errors()

Erros na validação.
Imprime erros na validação de um formulário.


{{ validation_errors() }}

global_js()

Arquivo de javascript global.
Existem os seguintes arquivos disponíveis para o uso no template:
bootstrap.js, bootstrap.min.js, custom.js, filters.js, imgLiquid-min.js, jquery-migrate.min.js, jquery.equalheights.js, jquery.jqzoom-core.js, jquery.jqzoom-core.original.js, jquery.js, jquery.maskedinput.js, jquery.raty.js, product-variants-v2.js, product-variants.js, sharer.js, shop-v2.js, shop.js, squard.js, tinyvalidation.js, view_cart.js


# Somente URL
{{ global_js("jquery.js") }}

# Com tag
{{ global_js("jquery.js", true) }}

global_css()

Arquivo de stylesheets global.
Exsistem seguintes arquivos disponiveis para o uso no template:
bootstrap.css, bootstrap.min.css, custom.css, filters.css, jquery.jqzoom.css, sharer.css, view_cart.css, widgets.css


# Somente URL
{{ global_css("sharer.css") }}

# Com tag
{{ global_css("sharer.css", true) }}

global_asset()

Retorna o caminho para um arquivo global.


{{ global_asset("img/zoomloader.gif") }}

cart()

Função para receber o conteúdo do carrinho.
Retorna valores do pedido atual e os produtos.


# Lista de produtos
{{ cart("contents") }}

# Valor total do pedido
{{ cart("total") }}

# Valor subtotal do pedido
{{ cart("subtotal") }}

pagination()

Retorna a paginação nas páginas de listagem de produtos.


{{ pagination() }}

form_input()

Retorna uma tag input.
Aceita um array de opções, sendo text o type padrão.


{{ form_input({"name": "firstname", "value": set_value("firstname", customer.firstname)}) }}

form_dropdown()

Retorna um dropdown select.
@param string *name*
@param array *option*
@param string *value*


{{ form_dropdown("sex", {0: "Masculino", 1: "Feminino"}, set_value("sex", customer.sex)) }}

form_hidden()

Retorna hidden tag.


{{ form_dropdown("shipping_method", "PAC") }}

form_textarea()

Retorna textarea tag.


{{ form_textarea({"name": "nome", "value": "Max"}) }}

set_value()

Retorna o POST do formulário.


# Exemplo 1
{{ set_value("sex", customer.sex) }}

# Exemplo 2
{{ form_dropdown("Genêro", {0: "Masculino", 1: "Feminino"}, set_value("sex", customer.sex)) }}

set_radio()

Retorna o POST do formulário.


# Exemplo 1
{{ set_radio("sex", customer.sex) }}

form_close()

Retorna o tag form


# Retorna </form>
{{ form_close() }}

format_payment_desc()

Retorna a descrição formatada da informações de pagamento.


# Exemplo usado na pagina order_detail.html
{{ format_payment_desc(payment) }}

site_url()

Retorna a URL absoluta de um caminho


# Exemplo usado na pagina product.html
{{ site_url(product.slug) }}

base_url()

Retorna a URL absoluta de um caminho para arquivos como imagens, javascripts e stylesheets


{{ base_url("assets/img/zoomloader.gif") }}

current_url()

Retorna a URL atual


{{ current_url() }}

uri_string()

Retorna a caminho atual


{{ site_url(uri_string()) }}

customer_name()

Retorna o nome do cliente ou se é uma empresa o nome da empresa


{{ customer_name(customer.firstname, customer.lastname, customer.company) }}

banner_img()

Retorna o img tag do banner


{% for banner in banners %}
	{{ banner_img(banner) }}
{% endfor %}

linked_banner()

Retorna o link e img tag do banner


{% for banner in banners %}
	{{ linked_banner(banner) }}
{% endfor %}

product_img()

Retorna o img tag do produto


# Exemplo 1
<img src="{{ product_img(product, "small", {"only_link": true}) }}" alt="{{ product.name }}" />

# Exemplo 2
{{ product_img(product, "thumbnails") }}

product_img()

Retorna o img tag do produto com os seguintes opções de tamanhos:
thumbnails = 192x192
small = 350x350
medium = 1000x1000
full = 1500x1500


# Exemplo 1
<img src="{{ product_img(product, "small", {"only_link": true}) }}" alt="{{ product.name }}" />

# Exemplo 2
{{ product_img(product, "thumbnails") }}

category_img()

Retorna o img tag da categoria com os seguintes opções de tamanhos:
thumbnails = 192x192
small = 350x350
medium = 1000x1000
original = 1500x1500


{{ category_img(category, "thumbnails") }}

host_url()

Retorna o a url de uma imagen do produto, categoria ou banner


<img src="{{ host_url("uploads/images/small/" ~ image.filename) }}" />

theme_url()

Retorna o a url de um arquivo do template


<img src="{{ theme_url("assets/img/logo.png") }}" />

theme_img()

Retorna o img tag de uma imagen do template


{{ theme_img("compra-segura.png", "Compra segura") }}

theme_img()

Retorna o img tag de uma imagen do template


{{ theme_img("compra-segura.png", "Compra segura", {"class": "float-right"}) }}

theme_js()

Retorna o javascript tag do template
O segundo atributo define a criação do tag (true/false).


# Exemplo 1
{{ theme_js("application.js", true) }}

# Exemplo 2
<script type="text/javascript" src="{{ theme_js("application.js") }}"></script>

theme_css()

Retorna o javascript tag do template
O segundo atributo define a criação do tag (true/false).


# Exemplo 1
{{ theme_css("application.js", true) }}

# Exemplo 2
<link href="{{ theme_css("application.js") }}" type="text/css" rel="stylesheet" />

buy_button()

Retorna o formulario e botão para adicionar um produto no carrinho


{{ buy_button() }}

variation_select()

Retorna a seleção de variações de produtos


Exemplo 1 com javascript para usar botões inves de selects
<div class="hide">{{ variation_select(product, {button_selects: "true"}) }}</div>

Exemplo 2
{{ variation_select(product) }}

onepage_checkout()

Retorna o Xtech onepage-checkout na pagina view_cart.html


{{ onepage_checkout() }}

testimonials_widget()

Retorna o widget dos depoimentos na pagina product.html


{{ testimonials_widget() }}

breadcrumbs_widget()

Retorna o widget de breadcrumbs nas listagens de produtos


{{ breadcrumbs_widget() }}

get_children_of_page()

Retorna um array com os sub-paginas de uma pagina com o slug definido


{% for page in get_children_of_page("institucional") %}
<a href="{{ site_url(page.slug) }}">{{ page.title }}</a>
{% endfor %}

get_page()

Retorna uma pagina


{{ get_page("contato") }}

logged_in()

Retorna o status do login


{% if logged_in() %}
Logged in
{% endif %}

form_open()

Retorna o inicio de um formulario


{{ form_open("secure/my_account", "class='form-horizontal'") }}
...
{{ form_close() }}

format_properties()

Retorna o as carateristicas de um produto na pagina product.html


{{ format_properties(properties, product.properties) }}

product_properties()

Retorna as carateristicas de um produto na pagina product.html


{{ product_properties(product.properties, "<dt class='detail'>{key}:</dt><dd>{value}</dd>") }}

header_code()

Retorna meta tags e codigo importantes para funcionamento do sistema Xtech Commerce no header do arquivo _layout.html


{{ header_code() }}

register_widget()

Retorna o formulario do cadastro do cliente na pagina register.html


{{ register_widget() }}

account_managment()

Retorna o widget da "minha conta" para gerenciar a conta do cliente na pagina my_account.html


{{ account_managment() }}

order_detail_widget()

Retorna o detalhe do pedido na pagina order_detail.html


{{ order_detail_widget() }}

order_placed_widget()

Retorna o resumo do pedido na pagina order_placed.html


{{ order_placed_widget() }}

forgot_password_widget()

Retorna o widget de recuperar a senha na pagina forgot_password.html


{{ forgot_password_widget() }}

login_widget()

Retorna o widget de login na pagina login.html


{{ login_widget() }}

shop_config()

Retorna um iten da configuração da loja.
Possiveis valores:
cnpj, company_registration, company_name, domain, address1, address2, district, city, state, social_facebook, social_twitter, social_pinterest, social_instagram, social_google, social_youtube, max_installments, default_title, default_metadescription, default_keywords, site_logo, site_logo_dark, google_analytics, email, base_http


{{ shop_config("company_name") }}

document_title()

Retorna o titulo de seo


<title>{{ shop_config("company_name") }} | {{ document_title(seo_title) }}</title>

get_product_category()

Retorna o noma da primeira categoria de um produto


{{ get_product_category(product.id) }}
Clone this wiki locally