regionhalland/region-halland-plugin-acf-options-page-top-links

v1.3.0 2023-11-24 13:57 UTC

Requires (Dev)

• squizlabs/php_codesniffer: 3.*

GPL-3.0

• Region Halland

README

Hur man använder Region Hallands plugin "RhAcfOptionsPageTopLinks"

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

Användningsområde

Denna plugin skapar arrayer() med all formulärdata för funktioner

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/RhAcfOptionsPageTopLinks?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 https://regionhalland.visualstudio.com/public.RhWpPlugIns/_git/RhAcfOptionsPageTopLinks

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/RhAcfOptionsPageTopLinks"
  },
],

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-acf-options-page-top-links": "1.0.0"
},

Visa "funktioner" via "Blade"

@php($myFunction = get_region_halland_acf_options_page_top_links_function())

@if($myFunction['show_listen'] == 1)
  Kod ovanför
  Namn på lyssna-funktionen = {{ $myFunction['name_listen'] }}
  Kod nedanför
@endif

@if($myFunction['show_translate'] == 1)
  Kod ovanför
  Namn på översätt-funktionen = {{ $myFunction['name_translate'] }}
  Kod nedanför
@endif

Namn på cookie-funktionen = {{ $myFunction['name_cookie'] }}

Exempel på hur arrayen kan se ut

array (size=5)
  'show_listen' => int 1
  'name_listen' => string 'Lyssna' (length=6)
  'show_translate' => int 1
  'name_translate' => string 'Översätt' (length=10)
  'name_cookie' => string 'Cookie-inställningar' (length=21)

Visa "js" via "Blade"

@php($myJs = get_region_halland_acf_options_page_top_links_js())

@if($myJs['show_listen'] == 1)
  Inkludera javascript-fil
@endif

@if($myFunction['show_translate'] == 1)
  Inkludera javascript-fil
@endif

Exempel på hur arrayen kan se ut

array (size=2)
  'show_listen' => int 1
  'show_translate' => int 1

Loopa ut "links" via "Blade" från en array

@php($myLinks = get_region_halland_acf_options_page_top_links())
@if($myLinks)
  @foreach($myLinks as $link)
    <a href="{{ $link['link_url'] }}" target="{{ $link['link_target'] }}">{{ $link['link_title'] }}</a><br>
  @endforeach
@endif

Exempel på hur arrayen kan se ut

array (size=2)
  0 =>
    array (size=3)
      'link_title' => string 'Cirkus' (length=6)
      'link_url' => string 'http://dev-regionhalland.local/kulturprogram/nycirkus-a/' (length=56)
      'link_target' => string '' (length=0)
  1 =>
    array (size=3)
      'link_title' => string 'Studiehjälp' (length=12)
      'link_url' => string 'http://dev-regionhalland.local/vara-skolor/munkagard/elevinformation/studiehjalp/' (length=81)
      'link_target' => string '_blank' (length=6)

Exempel på hur json kan se ut

[{"link_title":"Cirkus","link_url":"http:\/\/dev-regionhalland.local\/kulturprogram\/nycirkus-a\/","link_target":""},{"link_title":"Studiehj\u00e4lp","link_url":"http:\/\/dev-regionhalland.local\/vara-skolor\/munkagard\/elevinformation\/studiehjalp\/","link_target":"_blank"}]

Hämta ut "färdig html" via "Blade"

@php($myHtml = get_region_halland_acf_options_page_top_links_html())
{!! $myHtml !!}

Hämta ut data via WPs REST API

Plugginet registrerar en endpoint i WP JSON för att enkelt kunna hämta ut data:

Endpoint	Användning	Svarsexempel
/wp-json/rh/v1/toplinks/	Returnerar en array med alla toplinks	Exempel på svar

Exempel svarsdata för REST

{
	"functions": {
		"show_listen": 0,
		"name_listen": "Lyssna",
		"show_translate": 0,
		"name_translate": "Översätt",
		"name_cookie": "Cookie-inställningar"
	},
	"links": [
		{
			"link_title": "Sample Page",
			"link_url": "http://api.hitta.test/sample-page/",
			"link_target": ""
		},
		{
			"link_title": "Hello world!",
			"link_url": "http://api.hitta.test/2021/02/01/hello-world/",
			"link_target": ""
		}
	]
}

ENV-variabler lokalt

TOPLINKS_PATH=app\datafiler\links\top-links.txt
TOPLINKS_FUNCTION_PATH=app\datafiler\links\toplinks-funktioner.txt
TOPLINKS_JS_PATH=app\datafiler\links\toplinks-js.txt
TOPLINKS_HTML_PATH=app\datafiler\links\toplinks-html.txt
TOPLINKS_DIVIDER=app

ENV-variabler på server

TOPLINKS_PATH=datafiler/links/top-links.txt
TOPLINKS_FUNCTION_PATH=/datafiler/links/toplinks-funktioner.txt
TOPLINKS_JS_PATH=/datafiler/links/toplinks-js.txt
TOPLINKS_HTML_PATH=/datafiler/links/toplinks-html.txt
TOPLINKS_DIVIDER=public_html

Versionhistorik

1.2.1

• Deklarerat variabler i constructor

1.2.0

• Lagt till endpoint WP REST

1.1.3

• Rättat felstavning

1.1.2

• Uppdaterade checkar för toplink divider

1.1.1

• Checkar för toplink divider

1.1.0

• Justera path till filer

1.0.2

• Checkar för att säkerställa att filer finns

1.0.1

• Ändra till muplugin

1.0.0

• Första version