Tagien tulostuksen muotoilu helper-attribuutin avulla

Useimmin helper-attribuuttia käytetään erilaisten listojen muotoiluun. Joillakin ei-listatageilla on kuitenkin myös helper-attribuutti; eräs esimerkki on {CheckoutShippingMethod}, joka tulostaa tilaukselle valitun toimitustavan tietoja.

helper-attribuutti on MyCashflow-teeman suunnittelijan tärkeimpiä työkaluja. Esimerkiksi tuotelistojen ja navigaatioiden luominen on hyvin vaikeaa, ellei muotoilussa käytä apuna helper-attribuuttia.

Sallitut arvot

helper-attribuutin arvoksi annetaan sisältö ja merkkaus, jota tagin halutaan tulostavan. Joillakin tageilla on oletustulostus, jota käytetään, kun helper-attribuutin arvoa ei ole asetettu. Jotkut tagit taas eivät tulosta mitään ilman helper-attribuutissa määritettyä sisältöä.

helper-attribuutin arvoksi voidaan antaa joko 1) suoraa HTML/Interface-merkkausta tai 2) viittauksen tiedostoon, joka sisältää tulostettavan merkkauksen.

Syntaksi

helper-attribuutin syntaksi ja sallitut arvot eroavat jonkin verran tagien yleisestä syntaksista.

Jos attribuutin arvoksi halutaan antaa Interface-merkkausta, arvo on suljettava kokonaisuudessaan kaksinkertaisiin aaltosulkeisiin {{ ... }}:

{Products(
    category: 1,
    helper: {{
        {ProductName}
    }}
)}

Lisäksi attribuutin arvoksi voidaan antaa tiedostoviittauksia. Nämä määritellään antamalla arvoksi halutun tiedoston sijainti suhteessa teeman juurikansioon:

{Products(
    category: 1,
    helper: 'helpers/3-col-list-product'
)}

Näkymä helper-attribuutissa

Useimmiten helper-attribuuttia käyttävät tagit asettavat attribuutin sisällä jonkin toisen näkymän, kuin missä tagi itse toimii. Näin voidaan esimerkiksi tuoteryhmä-näkymässä tulostaa sisältöä, joka vaatii tuote-näkymän.

Esimerkiksi tuoteryhmäsivulla käytetään useimmiten {CategoryProducts}-tuotelistaa, jonka listaelementeissä on voitava tulostaa tuotteiden tageja. Koska tuotelistatagin helper-attribuutissa on asetettuna näkymäksi tuote, listalle haluttu sisältö ja merkkaus voidaan määritellä attribuutin arvossa:

{CategoryProducts(
    before: '<ul>', 
    helper: {{
        <li>
            <a href="{ProductURL}">
                {ProductListImage(
                    link: false
                )}
                <h3>{ProductName}</h3>
            </a>
            {ProductPrice}
        </li>
    }},
    after: '</ul>'
)}

Tämän artikkelin tarkoitus oli antaa kaikki tarvittavat perustiedot helper-attribuutin käyttötarkoituksesta ja käyttämisestä. Jos sinulle jäi kysymyksiä, ota asiasi puheeksi MyCashflow'n asiakaspalvelun kanssa.