dd/evolutioncms-snippets-ddmakehttprequest

There is no license information available for the latest version (2.3.2) of this package.

Makes HTTP request to a given URL.

Maintainers

Details

github.com/DivanDesign/EvolutionCMS.snippets.ddMakeHttpRequest

Homepage

Source

Issues

Chat

Installs: 3

Dependents: 2

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

Type:modxevo-snippet

2.3.2 2022-05-25 03:23 UTC

Requires

Unknown License 1a74b818f68bac00c1a1f6a63589aedbbb5a2f01

curlhttp requestHTTPRequestmodxMODX Evoevomodx evolutionevo cmsevolutioncmsevolution cmsddmakehttprequestmakehttprequestmake http request

This package is auto-updated.

Last update: 2024-04-25 07:33:55 UTC

README

Makes HTTP request to a given URL.

Supports redirects even if native CURL redirects is unavailable.

Requires

Documentation

Installation

1. Elements → Snippets: Create a new snippet with the following data

  1. Snippet name: ddMakeHttpRequest.
  2. Description: <b>2.3.2</b> Makes HTTP request to a given URL..
  3. Category: Core.
  4. Parse DocBlock: no.
  5. Snippet code (php): Insert content of the ddMakeHttpRequest_snippet file from the archive.

2. Elements → Manage Files

  1. Create a new folder assets/snippets/ddMakeHttpRequest/.
  2. Extract the archive to the folder (except ddMakeHttpRequest_snippet.php).

Parameters description

  • url

    • Desctription: The URL to fetch.
    • Valid values: string
    • Required

  • method

    • Desctription: Request type.
    • Valid values:
      • 'get'
      • 'post'
    • Default value: 'get'

  • postData

    • Desctription: The full data to post in a HTTP “POST” operation.
    • Valid values:
      • stringJsonObject — as JSON object
      • stringHjsonObject — as HJSON
      • stringQueryFormated — as Query string
      • string
      • It can also be set as a native PHP object or array (e. g. for calls through \DDTools\Snippet::runSnippet):
        • arrayAssociative
        • object
    • Default value: —

  • sendRawPostData

    • Desctription: Send raw postData. E. g. if you need JSON in request payload.
    • Valid values:
      • 0
      • 1
    • Default value: 0

  • headers

    • Desctription: An array of HTTP header fields to set.
    • Valid values:
      • stringJsonArray — as JSON
      • stringHjsonArray — as HJSON
      • stringQueryFormated — as Query string
      • It can also be set as a native PHP array (e. g. for calls through \DDTools\Snippet::runSnippet):
        • array
    • Default value: —

  • userAgent

    • Desctription: The contents of the User-Agent: header to be used in a HTTP request.
    • Valid values: string
    • Default value: —

  • timeout

    • Desctription: The maximum number of seconds for execute request.
    • Valid values: integer
    • Default value: 60

  • proxy

    • Desctription: Proxy server in format [+protocol+]://[+user+]:[+password+]@[+ip+]:[+port+]. E. g. http://user:password@11.22.33.44:5555 or socks5://user:password@11.22.33.44:5555.
    • Valid values: string
    • Default value: —

  • useCookie

    • Desctription: Enagle cookies. The assets/cache/ddMakeHttpRequest_cookie.txt file is used.
    • Valid values:
      • 0
      • 1
    • Default value: 0

Examples

Simple GET request

[[ddMakeHttpRequest?
	&url=`http://www.example.com?name=John&surname=Doe`
]]

Simple POST request

Set data as JSON:

[[ddMakeHttpRequest?
	&url=`http://www.example.com/`
	&postData=`{
		"name": "John",
		"surname": "Doe"
	}`
]]

Or Query string:

[[ddMakeHttpRequest?
	&url=`http://www.example.com/`
	&postData=`name=John&surname=Doe`
]]

Run the snippet through \DDTools\Snippet::runSnippet without DB and eval

\DDTools\Snippet::runSnippet([
	'name' => 'ddMakeHttpRequest',
	'params' => [
		'url' => 'https://www.example.com/',
		'postData' => [
			'name' => 'John',
			'surname' => 'Doe'
		],
		'headers' => [
			'Accept: application/vnd.api+json',
			'Content-Type: application/vnd.api+json'
		],
		'proxy' => 'socks5://user:password@11.22.33.44:5555'
	]
]);

Links