Import API: Downloads

This API will import product downloads to your shop.

Import Items Structure

$importItems

The array of $importItems should be structured as shown below. This should be passed to $padloper->import() as the first argument:

$importItems = [
  // microwave manual  download
  [
    // title
    'title' => ['default' => 'Smart Inverter Microwave Oven Manual', 'fi' => 'Smart Inverter -mikroaaltouunin käyttöopas', 'de' => 'Smart Inverter Mikrowellenherd Handbuch'],
    // description
    'padloper_description' => [
      // default -> english
      'default' => "The Inverter technology in the LG NeoChef™ enables more precise temperature control to help defrost foods and avoid overcooked and unthawed areas.",
      // finnish
      'fi' => "LG NeoChef™:n inverter-tekniikka mahdollistaa tarkemman lämpötilan hallinnan, joka auttaa sulattamaan ruokia ja välttämään ylikypsytettyjä ja sulamattomia alueita.",
      // german
      'de' => "Die Inverter-Technologie im LG NeoChef™ ermöglicht eine präzisere Temperaturregelung, um Lebensmittel aufzutauen und überkochte und aufgetaute Bereiche zu vermeiden",
    ],
    // download settings
    'padloper_download_settings' => [
      // @note: will be cast to int
      'maximumDownloads' => 33,
      // @note: NOT SET in this example
      // 'timeToDownload' => "+ 365 days"
    ],
    // downloadable file @note: should only be one file!
    // @note: here demonstrating setting multiple even though only one allowed! Last added will persist.
    'padloper_file' => [__DIR__ . "/temp_files/Old_Microwave_Manual.pdf", __DIR__ . "/temp_files/Smart Inverter Microwave Oven Manual.pdf"]
  ],
  // MORE DOWNLOADS ...
];
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

$importType

The expected import type is downloads. This should be passed to $padloper->import() as the second argument.

$importOptions

If required, the following import options can be passed to $padloper->import() as the third argument when importing downloads. This must be an array.

$importOptions = [
   // @note: setting as unpublished!
  'is_unpublished' => true
];
1
2
3
4

Example Import

The following example shows how to import several downloads into your shop. Please inspect the resultant array for import notifications.

// IMPORT ITEMS
$importItems = [
  // last supper painting download
  [
    // @NOTE: IF MULTILINGUAL FIELD, WE EXPECT VALUE IS ARRAY; ELSE STRING
    // title
    'title' => ['default' => 'The Last Supper by Auma', 'fi' => 'Auma viimeinen ehtoollinen', 'de' => 'Das letzte Abendmahl von Auma'],
    // description
    'padloper_description' => [
      // default -> english
      'default' => "The Last Supper (Italian: Il Cenacolo [il tʃeˈnaːkolo] or L'Ultima Cena [ˈlultima ˈtʃeːna]) is a mural painting by the Italian High Renaissance Leonardo da Vinci, dated to c. 1495–1498. The painting represents the scene of the Last Supper of Jesus with the Twelve Apostles, as it is told in the Gospel of John – specifically the moment after Jesus announces that one of his apostles will betray him.[1] Its handling of space, mastery of perspective, treatment of motion and complex display of human emotion has made it one of the Western world's most recognizable paintings and among Leonardo's most celebrated works.[2] Some commentators consider it pivotal in inaugurating the transition into what is now termed the High Renaissance.[3][4].",
      // finnish
      'fi' => "Viimeinen ehtoollinen (italiaksi: Il Cenacolo [il tʃeˈnaːkolo] tai L'Ultima Cena [ˈlultima ˈtʃeːna]) on italialaisen korkearenessanssin Leonardo da Vincin seinämaalaus, joka on päivätty n. 1495-1498. Maalaus edustaa kohtausta Jeesuksen viimeisestä ehtoollisesta kahdentoista apostolin kanssa, kuten Johanneksen evankeliumissa kerrotaan – erityisesti hetkeä sen jälkeen, kun Jeesus ilmoittaa, että yksi hänen apostoleistaan ​​kavaltaa hänet.[1] Sen tilankäsittely, perspektiivin hallinta, liikkeen käsittely ja monimutkainen inhimillisten tunteiden esitys on tehnyt siitä yhden länsimaailman tunnistetuimmista maalauksista ja Leonardon kuuluisimpien teosten joukossa.[2] Jotkut kommentaattorit pitävät sitä ratkaisevan tärkeänä aloitettaessa siirtyminen siihen, mitä nykyään kutsutaan korkeaksi renessanssiksi.[3][4].",
      // german
      'de' => "Das letzte Abendmahl (italienisch: Il Cenacolo [il tʃeˈnaːkolo] oder L'Ultima Cena [ˈlultima ˈtʃeːna]) ist ein Wandgemälde des italienischen Hochrenaissance Leonardo da Vinci, datiert auf c. 1495–1498. Das Gemälde stellt die Szene des Letzten Abendmahls Jesu mit den Zwölf Aposteln dar, wie es im Johannesevangelium erzählt wird – konkret den Moment, nachdem Jesus ankündigt, dass einer seiner Apostel ihn verraten wird.[1] Sein Umgang mit Raum, die Beherrschung der Perspektive, die Behandlung von Bewegungen und die komplexe Darstellung menschlicher Emotionen haben es zu einem der bekanntesten Gemälde der westlichen Welt und zu Leonardos berühmtesten Werken gemacht.[2] Einige Kommentatoren betrachten es als entscheidend für die Einleitung des Übergangs in das, was heute als Hochrenaissance bezeichnet wird.[3][4].",
    ],
    // download settings
    'padloper_download_settings' => [
      // @note; unlimited download within 3 months
      'maximumDownloads' => 0,
      'timeToDownload' => "+3 months"
    ],
    //
    // downloadable file @note: should only be one file!
    // @note: NOT SETTING!
    // 'padloper_file' => [__DIR__ . "/temp_files/Auma-Leonardo-Last-Supper-Canvas-Painting.jpg"]
  ],
  // microwave manual  download
  [
    // title
    'title' => ['default' => 'Smart Inverter Microwave Oven Manual', 'fi' => 'Smart Inverter -mikroaaltouunin käyttöopas', 'de' => 'Smart Inverter Mikrowellenherd Handbuch'],
    // description
    'padloper_description' => [
      // default -> english
      'default' => "The Inverter technology in the LG NeoChef™ enables more precise temperature control to help defrost foods and avoid overcooked and unthawed areas.",
      // finnish
      'fi' => "LG NeoChef™:n inverter-tekniikka mahdollistaa tarkemman lämpötilan hallinnan, joka auttaa sulattamaan ruokia ja välttämään ylikypsytettyjä ja sulamattomia alueita.",
      // german
      'de' => "Die Inverter-Technologie im LG NeoChef™ ermöglicht eine präzisere Temperaturregelung, um Lebensmittel aufzutauen und überkochte und aufgetaute Bereiche zu vermeiden",
    ],
    // download settings
    'padloper_download_settings' => [
      // @note: will be cast to int
      'maximumDownloads' => 33,
      // @note: NOT SET in this example
      // 'timeToDownload' => "+ 365 days"
    ],
    // downloadable file @note: should only be one file!
    // @note: here demonstrating setting multiple even though only one allowed! Last added will persist
    'padloper_file' => [__DIR__ . "/temp_files/Old_Microwave_Manual.pdf", __DIR__ . "/temp_files/Smart Inverter Microwave Oven Manual.pdf"]
  ],
  // Serif Fonts download
  [
    // title
    'title' => ['default' => 'Serif Fonts', 'fi' => 'Serif-fontit', 'de' => 'Serifenschriften'],
    // description
    'padloper_description' => [
      // default -> english
      'default' => "Serif fonts are typefaces that have serifs, which are extra strokes on the ends of their letterforms. These typefaces evoke feelings of history, tradition, honesty, and integrity. There are many fonts that fall into the serif category containing different shapes, thicknesses, and lengths.",
      // finnish
      'fi' => "Serif-fontit ovat kirjasintyyppejä, joissa on serifit, jotka ovat ylimääräisiä viivoja niiden kirjainmuotojen päissä. Nämä kirjasintyypit herättävät historian, perinteen, rehellisyyden ja eheyden tunteita. On monia fontteja, jotka kuuluvat serif-luokkaan ja sisältävät erilaisia muotoja, paksuuksia ja pituuksia.",
      // german @note: NOT SETTING
      // 'de' => "Serifenschriften sind Schriftarten mit Serifen, die zusätzliche Striche an den Enden ihrer Buchstabenformen sind. Diese Schriftarten wecken Gefühle von Geschichte, Tradition, Ehrlichkeit und Integrität. Es gibt viele Schriftarten, die in die Kategorie Serifen fallen und unterschiedliche Formen, Dicken und Längen enthalten.",
    ],
    // download settings
    'padloper_download_settings' => [
      // @note; 10 downloads within two weeks
      'maximumDownloads' => 10,
      'timeToDownload' => "+2 weeks"
    ],
    // downloadable file @note: should only be one file!
    'padloper_file' => [__DIR__ . "/temp_files/serif_fonts.zip"]
  ]
];

// IMPORT OPTIONS
$importOptions = [
  // @note: HERE WE ARE SETTING as unpublished; we will publish manually
  'is_unpublished' => true
];

/** @var array $importResult */
$importResult = $padloper->import($importItems, 'downloads', $importOptions);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83