regionhalland/region-halland-plugin-navigation

Front-end-plugin som returnerar data kring panel navigation

v1.8.0 2020-11-05 10:30 UTC

This package is auto-updated.

Last update: 2020-11-05 10:32:52 UTC


README

Hur man använder Region Hallands plugin "RhNavigation"

Nedan följer instruktioner hur du kan använda pluginet "RhNavigation".

Användningsområde

Denna plugin returnerar data kring panel navigation

Licensmodell

Denna plugin använder licensmodell GPL-3.0. Du kan läsa mer om denna licensmodell via den medföljande filen:

LICENSE (https://regionhalland.visualstudio.com/public.RhWpPlugIns/_git/RhNavigation?path=%2FLICENSE&version=GBmaster)

Installation och aktivering

A) Hämta pluginen via Git eller läs in det med Composer
B) Installera Region Hallands plugin i Wordpress plugin folder
C) Aktivera pluginet inifrån Wordpress admin

Hämta hem pluginet via Git

git clone https://regionhalland.visualstudio.com/public.RhWpPlugIns/_git/RhNavigation

Läs in pluginen via composer

Dessa två delar behöver du lägga in i din composer-fil

Repositories = var pluginen är lagrad, i detta fall på github

"repositories": [
  {
    "type": "vcs",
    "url": "https://regionhalland.visualstudio.com/public.RhWpPlugIns/_git/RhNavigation"
  },
],

Require = anger vilken version av pluginen du vill använda, i detta fall version 1.0.0

OBS! Justera så att du hämtar aktuell version.

"require": {
  "regionhalland/region-halland-plugin-navigation": "1.0.0"
},

Mapp för cache

Skapa en mapp med namn "navigation" i "web/app/datafiler"

ENV-variabler

NAVIGATION_PATH=app\datafiler\navigation\
NAVIGATION_DIVIDER=app

Bra att veta om cache

A) Pluginen hämtar i första hand cachad data
B) Finns det ingen cachad data skapas denna vid uthämtning av data
C) När man uppdaterar en post skapas cachad data

Hämta data via plugin

@php($myData = get_region_halland_navigation(get_region_halland_navigation_id(), ""))

Det finns tre parametrar

A) ID (default = 0)
B) Vilka som ska visas (default = "visible"). Vill man se alla så anropa med "all"
C) Output är default satt som "array", men man kan lägga till en tredje parameter med värde "json"

OBS! För anrop av data från partial är det lämpligast med default "array"

Hämta data via api endpoint

http://[SITE_NAME]/app/plugins/region-halland-plugin-navigation
/ajax/region_halland_navigation.php?id=611&&show=visible

Det finns två parametrar

A) ID (default = 0)
B) Vilka som ska visas (default = "visible")
C) Vill man se alla så anropa med "all"

OBS! Det finns ingen output-parameter för api. Man får alltid tillbaka data som "json"

Exempel på array

OBS! Notera att man får tillbaka en multi-array med "parent_post", "current_post", "current_child_section_pages" och "current_child_posts"

array (size=3)
  'parent_post' => 
    array (size=12)
      'has_parent_post' => int 0
      'post_id' => string '' (length=0)
      'post_title' => string '' (length=0)
      'post_url' => string '' (length=0)
      'post_type' => string '' (length=0)
      'post_parent' => int 0
      'post_slug' => string '' (length=0)
      'featured_image' => string '' (length=0)
      'featured_image_url' => string '' (length=0)
      'ingress' => string '' (length=0)
      'hide_in_menu' => string '' (length=0)
      'int_hide_in_menu' => int 0
  'current_post' => 
    array (size=16)
      'has_current_post' => int 1
      'post_id' => int 202
      'post_title' => string 'Kultur' (length=6)
      'post_url' => string 'http://dev-regionhalland-nytt-tema.local/kultur/' (length=48)
      'post_type' => string 'page' (length=4)
      'post_parent' => int 0
      'post_slug' => string 'kultur' (length=6)
      'featured_image' => string '' (length=0)
      'featured_image_url' => boolean false
      'ingress' => string 'Kulturen lockar! Kulturupplevelser, kreativitet och konstnärlig utveckling gör Halland mer attraktivt för kulturskapare, invånare och besökare.

' (length=152)
      'hide_in_menu' => string '' (length=0)
      'int_hide_in_menu' => int 0
      'number_of_posts_all' => int 5
      'number_of_posts_visible' => int 5
      'number_of_section_pages' => int 1
      'number_of_posts_with_childs' => int 6
  'child_posts' => 
    array (size=6)
      0 => 
        array (size=13)
          'post_id' => int 498
          'post_title' => string 'Kulturområden' (length=14)
          'post_url' => string 'http://dev-regionhalland-nytt-tema.local/kultur/kulturomraden/' (length=62)
          'post_type' => string 'page' (length=4)
          'post_parent_id' => int 202
          'post_slug' => string 'kulturomraden' (length=13)
          'post_ingress' => string 'Region Halland arbetar med kultur inom ett antal olika områden. Arbetet sker genom verksamhet i egen regi, i överenskommelser med andra verksamheter, genom aktivt ägande i bolag samt genom stöd till organisationer och medfinansiering av projekt.' (length=249)
          'page_type' => string 'page' (length=4)
          'featured_image' => string '' (length=0)
          'featured_image_url' => boolean false
          'hide_in_menu' => int 0
          'is_section_page' => int 0
          'child_count' => int 14
      1 => 
        array (size=13)
          'post_id' => int 234
          'post_title' => string 'Regionalt kulturstöd' (length=21)
          'post_url' => string 'http://dev-regionhalland-nytt-tema.local/kultur/regionalt-kulturstod/' (length=69)
          'post_type' => string 'page' (length=4)
          'post_parent_id' => int 202
          'post_slug' => string 'regionalt-kulturstod' (length=20)
          'post_ingress' => string 'Den regionala kulturpolitiken genomförs dels genom långsiktiga överenskommelser, kopplade till årliga anslag, med kulturinstitutioner, organisationer och kommuner, dels genom regelverk för fördelning av stöd till civilsamhällets organisationer, och dels genom fria medel som fördelas utifrån inkomna ansökningar.' (length=323)
          'page_type' => string 'page' (length=4)
          'featured_image' => string '' (length=0)
          'featured_image_url' => boolean false
          'hide_in_menu' => int 0
          'is_section_page' => int 0
          'child_count' => int 10
      2 => 
        array (size=13)
          'post_id' => int 405
          'post_title' => string 'Kulturutveckling och samverkan' (length=30)
          'post_url' => string 'http://dev-regionhalland-nytt-tema.local/kultur/kulturutveckling/' (length=65)
          'post_type' => string 'page' (length=4)
          'post_parent_id' => int 202
          'post_slug' => string 'kulturutveckling' (length=16)
          'post_ingress' => string 'Region Halland ansvarar för kulturpolitiken på regional nivå. I detta arbete samverkar vi med statlig och kommunal kulturpolitik. Hallands kulturplan har tagits fram i samverkan med de halländska kommunerna och i samråd med civilsamhället och professionella kulturskapare. Dessutom har kulturdialoger förts med invånarna i Halland.' (length=339)
          'page_type' => string 'page' (length=4)
          'featured_image' => string '' (length=0)
          'featured_image_url' => boolean false
          'hide_in_menu' => int 0
          'is_section_page' => int 0
          'child_count' => int 10
      3 => 
        array (size=13)
          'post_id' => int 1577
          'post_title' => string 'Kultur för barn och unga' (length=25)
          'post_url' => string 'http://dev-regionhalland-nytt-tema.local/kultur/kulturbarnunga/' (length=63)
          'post_type' => string 'page' (length=4)
          'post_parent_id' => int 202
          'post_slug' => string 'kulturbarnunga' (length=14)
          'post_ingress' => string 'Alla barn och unga i Halland ska ha tillgång till ett rikt kulturliv, med möjlighet till upplevelser och eget skapande. Kultur ska vara en självklar del av deras vardag i såväl skola som på fritiden - oavsett var de bor eller vem de är.' (length=243)
          'page_type' => string 'page' (length=4)
          'featured_image' => string '' (length=0)
          'featured_image_url' => boolean false
          'hide_in_menu' => int 0
          'is_section_page' => int 0
          'child_count' => int 9
      4 => 
        array (size=13)
          'post_id' => int 1571
          'post_title' => string 'Kulturarrangemang' (length=17)
          'post_url' => string 'http://dev-regionhalland-nytt-tema.local/kultur/konst-och-kulturupplevelser/' (length=76)
          'post_type' => string 'page' (length=4)
          'post_parent_id' => int 202
          'post_slug' => string 'konst-och-kulturupplevelser' (length=27)
          'post_ingress' => string 'Kultur i Halland arrangerar föreställningar, konserter och samtal, liksom workshoppar, kompetensutveckling och andra aktiviteter. En del arrangemang är öppna för publik och alla som är intresserade medan andra riktar sig till olika professioner eller kulturskapare.' (length=271)
          'page_type' => string 'page' (length=4)
          'featured_image' => string '' (length=0)
          'featured_image_url' => boolean false
          'hide_in_menu' => int 0
          'is_section_page' => int 0
          'child_count' => int 0
      5 => 
        array (size=13)
          'post_id' => int 3272
          'post_title' => string 'Kontakta oss som jobbar med kultur' (length=34)
          'post_url' => string 'http://dev-regionhalland-nytt-tema.local/kultur/kontakta-oss-som-jobbar-med-kultur/' (length=83)
          'post_type' => string 'page' (length=4)
          'post_parent_id' => int 202
          'post_slug' => string 'kontakta-oss-som-jobbar-med-kultur' (length=34)
          'post_ingress' => string 'Kontakta oss som jobbar med kulturutveckling på Region Halland.' (length=64)
          'page_type' => string 'section' (length=7)
          'featured_image' => string '' (length=0)
          'featured_image_url' => boolean false
          'hide_in_menu' => int 0
          'is_section_page' => int 1
          'child_count' => int 0

Exempel på json

OBS! Notera att man får tillbaka en multi-json med "parent_post", "current_post", "current_child_section_pages" och "current_child_posts"

https://test-www.regionhalland.se/app/plugins/region-halland-plugin-navigation/ajax/region_halland_navigation.php?show=all&

Hämta aktuellt id oavsett om det är startsidan eller någon annan sida

get_region_halland_navigation_id()

Versionhistorik

1.8.0

  • Lagt till funktion för att hämta ut aktuellt id

1.7.1

  • Lagt till defaultvärde visible när man hämtar via plugin

1.7.0

  • Lagt till så att även länkar hämtas ut

1.6.0

  • Justerat logik kring parent_page om förälder är 0

1.5.0

  • Lagt till en array med alla barn + flaggor för page_type

1.4.0

  • lagt till arrayerna "current_child_posts_with_childs" och "current_child_posts_with_no_childs"

1.3.1

  • Korrigerat bugg i valideringen där man inte kunde spara sidor i toppnivå

1.3.0

  • Ändrat så att parent page 0 returnerar startsidan

1.2.2

  • Ändrat så att current page 0 returnerar startsidan
  • Lagt till validering av sid ID

1.2.1

  • Lagt till content type header för JSON i endpointen

1.2.0

  • Tog bort "parent" och "current" prefixen för varje menypost

1.1.0

  • Sorterar ut sektionssidor

1.0.0

  • Första version