آموزش کار با API و دادهای خارجی در php

آموزش کار با API و دادهای خارجی در phpT بسیار خب، در مورد تبدیل داده‌ها به JSON و برعکس در PHP صحبت می‌کنیم. JSON (JavaScript Object Notation) یک فرمت متنی سبک برای تبادل داده‌هاست که به طور گسترده در برنامه‌های وب و APIها استفاده می‌شود. PHP توابع داخلی و قدرتمندی برای کار با JSON فراهم می‌کند که به شما امکان می‌دهد به راحتی داده‌های PHP را به JSON تبدیل کنید و برعکس.

21.JSON  و XML

تبدیل داده‌های PHP به JSON

برای تبدیل یک آرایه یا شی PHP به رشته JSON، از تابع json_encode() استفاده می‌کنیم. این تابع داده‌های PHP را به یک رشته JSON معتبر تبدیل می‌کند.

نحوه استفاده از json_encode():

<?php
// آرایه PHP
$data = [
    'name' => 'John Doe',
    'age' => 30,
    'city' => 'New York',
    'is_active' => true,
    'skills' => ['PHP', 'JavaScript', 'Python']
];

// تبدیل آرایه به JSON
$json_string = json_encode($data);

// نمایش رشته JSON
echo $json_string . "\n";
// خروجی: {"name":"John Doe","age":30,"city":"New York","is_active":true,"skills":["PHP","JavaScript","Python"]}
?>

نکات مهم در مورد json_encode():

1. پشتیبانی از انواع داده: json_encode() از انواع داده‌های زیر در PHP پشتیبانی می‌کند:
   • array (آرایه)
   • object (شیء)
   • string (رشته)
   • int (عدد صحیح)
   • float (عدد اعشاری)
   • bool (مقدار بولی)
   • null (مقدار تهی)
2. گزینه‌های اضافی: تابع json_encode() یک پارامتر دوم اختیاری به نام options دارد که می‌توانید از آن برای تنظیم رفتار تابع استفاده کنید. برخی از گزینه‌های رایج عبارتند از:
   • JSON_PRETTY_PRINT: برای فرمت‌بندی JSON خروجی به صورت خواناتر با فاصله‌گذاری مناسب.
   • JSON_UNESCAPED_UNICODE: برای جلوگیری از تبدیل کاراکترهای یونیکد به \uXXXX.
   • JSON_UNESCAPED_SLASHES: برای جلوگیری از اسکیپ کردن اسلش‌ها (/).
   • JSON_NUMERIC_CHECK: تبدیل رشته‌های عددی به اعداد.

مثال با گزینه‌های اضافی:

<?php
$data = [
    'name' => 'جان',
    'description' => 'این یک توضیح است/با اسلش',
    'count' => '123'
];

// تبدیل به JSON با فرمت‌بندی زیبا و حفظ کاراکترهای یونیکد و عدم اسکیپ کردن اسلش ها
$json_string = json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_NUMERIC_CHECK);

echo $json_string . "\n";

/*
خروجی:
{
    "name": "جان",
    "description": "این یک توضیح است/با اسلش",
    "count": 123
}
*/
?>

تبدیل JSON به داده‌های PHP

برای تبدیل یک رشته JSON به آرایه یا شیء PHP، از تابع json_decode() استفاده می‌کنیم. این تابع رشته JSON را تجزیه کرده و یک آرایه یا شیء PHP معادل را برمی‌گرداند.

نحوه استفاده از json_decode():

<?php
// رشته JSON
$json_string = '{"name":"Jane Doe","age":25,"city":"London","is_active":false,"skills":["C++","Java",".NET"]}';

// تبدیل JSON به آرایه
$php_array = json_decode($json_string, true);

// نمایش آرایه
print_r($php_array);

/*
خروجی:
Array
(
    [name] => Jane Doe
    [age] => 25
    [city] => London
    [is_active] =>
    [skills] => Array
        (
            [0] => C++
            [1] => Java
            [2] => .NET
        )

)
*/


// تبدیل JSON به شیء
$php_object = json_decode($json_string);

// نمایش شیء
var_dump($php_object);

/*
خروجی:
object(stdClass)#1 (5) {
  ["name"]=>
  string(8) "Jane Doe"
  ["age"]=>
  int(25)
  ["city"]=>
  string(6) "London"
  ["is_active"]=>
  bool(false)
  ["skills"]=>
  array(3) {
    [0]=>
    string(3) "C++"
    [1]=>
    string(4) "Java"
    [2]=>
    string(4) ".NET"
  }
}
*/
?>

نکات مهم در مورد json_decode():

1. پارامتر دوم: تابع json_decode() یک پارامتر دوم اختیاری دارد که اگر مقدار آن true باشد، یک آرایه انجمنی (associative array) به جای شیء برمی‌گرداند. اگر پارامتر دوم حذف شود یا مقدار آن false باشد، یک شیء از نوع stdClass برمی‌گرداند.
2. گزینه‌های اضافی: تابع json_decode() همچنین می‌تواند گزینه‌های اضافی را از طریق پارامتر سوم (options) بپذیرد. برخی از این گزینه‌ها شامل JSON_BIGINT_AS_STRING است که باعث می شود اعداد بزرگ به صورت رشته تفسیر شوند.
3. خطاها: اگر رشته JSON معتبر نباشد، تابع json_decode() مقدار null را برمی‌گرداند و می‌توانید از json_last_error() برای بررسی کد خطا استفاده کنید.

بررسی خطاها

<?php
$json_string = '{"name":"Invalid JSON"'; // JSON نامعتبر
$decoded_data = json_decode($json_string);

if ($decoded_data === null) {
    echo "Error decoding JSON: " . json_last_error_msg() . "\n";
}
?>

مثال استفاده در API

فرض کنید می‌خواهیم یک API ساده داشته باشیم که یک درخواست POST با داده‌های JSON دریافت می‌کند و یک پاسخ JSON برمی‌گرداند:

<?php
// بررسی نوع درخواست (می‌تواند POST باشد)
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
    // دریافت داده‌های خام از بدنه درخواست
    $json_data = file_get_contents('php://input');

    // تبدیل JSON به آرایه PHP
    $data = json_decode($json_data, true);

    // بررسی وجود خطا در تجزیه JSON
    if ($data === null) {
        http_response_code(400);
        echo json_encode(['error' => 'Invalid JSON data']);
        exit;
    }

    // پردازش داده‌ها (مثال)
    $response = [
        'message' => 'Data received successfully',
        'received_data' => $data
    ];

    // تنظیم هدر برای پاسخ JSON
    header('Content-Type: application/json');
    echo json_encode($response, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
} else {
    // در صورت درخواست GET یا غیر POST
    http_response_code(405);
    echo json_encode(['error' => 'Method Not Allowed']);
}
?>

خلاصه

تبدیل داده‌ها به JSON و برعکس یکی از عملیات‌های رایج در برنامه‌نویسی وب است. در PHP توابع json_encode() برای تبدیل داده‌های PHP به JSON و json_decode() برای تبدیل JSON به داده‌های PHP وجود دارد. با استفاده از گزینه‌های مختلف این توابع می‌توانید نحوه تبدیل داده‌ها را کنترل کنید.

بسیار خب، بیایید در مورد پردازش داده‌های XML در PHP صحبت کنیم. XML (Extensible Markup Language) یک فرمت متنی برای ذخیره و انتقال داده‌هاست که به دلیل ساختار سلسله مراتبی و قابلیت انعطاف‌پذیری بالایی که دارد، در بسیاری از کاربردها مورد استفاده قرار می‌گیرد. PHP ابزارها و توابع مختلفی برای کار با XML ارائه می‌دهد که به شما امکان می‌دهد به راحتی داده‌های XML را تجزیه، ویرایش و ایجاد کنید.

روش‌های پردازش XML در PHP

در PHP، دو روش اصلی برای پردازش XML وجود دارد:

1. SimpleXML: این روش ساده و شهودی است و برای اکثر موارد کاربردی مناسب است. SimpleXML ساختار XML را به یک شیء PHP تبدیل می‌کند که می‌توانید به راحتی با آن کار کنید.
2. DOM (Document Object Model): این روش پیچیده‌تر است اما امکان کنترل دقیق‌تر و بیشتری بر روی ساختار XML فراهم می‌کند. DOM یک نمایش درختی از سند XML ایجاد می‌کند که می‌توانید با استفاده از توابع و متدهای مختلف به اجزای آن دسترسی پیدا کنید.

SimpleXML

SimpleXML یک روش ساده برای خواندن و کار با داده‌های XML است. این روش به شما اجازه می‌دهد تا سند XML را به یک شیء PHP تبدیل کنید و با استفاده از ویژگی‌ها و متدهای شیء به اطلاعات موجود در XML دسترسی پیدا کنید.

نحوه استفاده از SimpleXML:

1. بارگذاری XML: برای بارگذاری یک سند XML، از تابع simplexml_load_file() برای بارگذاری از یک فایل یا simplexml_load_string() برای بارگذاری از یک رشته استفاده می‌کنید.
2. دسترسی به داده‌ها: بعد از بارگذاری XML، می‌توانید به عناصر و ویژگی‌های XML از طریق نام تگ‌ها به عنوان ویژگی‌های شیء دسترسی پیدا کنید.

مثال:

فرض کنید یک فایل XML به نام books.xml داریم:

<?xml version="1.0" encoding="UTF-8"?>
<books>
    <book id="1">
        <title>The Lord of the Rings</title>
        <author>J.R.R. Tolkien</author>
        <price>25.99</price>
    </book>
    <book id="2">
        <title>Pride and Prejudice</title>
        <author>Jane Austen</author>
        <price>15.50</price>
    </book>
</books>

حالا کد PHP برای خواندن این فایل با SimpleXML:

<?php
// بارگذاری فایل XML
$xml = simplexml_load_file('books.xml');

// بررسی وجود خطا در بارگذاری
if ($xml === false) {
    echo "Error loading XML.\n";
    exit;
}

// دسترسی به داده‌ها
foreach ($xml->book as $book) {
    echo "ID: " . $book['id'] . "\n";
    echo "Title: " . $book->title . "\n";
    echo "Author: " . $book->author . "\n";
    echo "Price: " . $book->price . "\n";
    echo "------\n";
}

// دسترسی به یک عنصر خاص
echo "First Book Title:" . $xml->book[0]->title . "\n";
/*
خروجی:
ID: 1
Title: The Lord of the Rings
Author: J.R.R. Tolkien
Price: 25.99
------
ID: 2
Title: Pride and Prejudice
Author: Jane Austen
Price: 15.50
------
First Book Title:The Lord of the Rings
*/
?>

مزایا و معایب SimpleXML:

• مزایا:
  • ساده و آسان برای یادگیری و استفاده.
  • مناسب برای اکثر موارد استفاده روزمره.
  • عملکرد خوب برای فایل‌های XML با ساختار ساده.
• معایب:
  • محدودیت در کنترل دقیق بر روی ساختار XML.
  • مناسب نبودن برای فایل‌های XML بسیار پیچیده و بزرگ.
  • دشواری در کار با عناصر تکراری با نام یکسان.

DOM (Document Object Model)

DOM یک روش قدرتمندتر و انعطاف‌پذیرتر برای پردازش XML است. DOM سند XML را به یک درخت DOM تبدیل می‌کند که هر گره در این درخت نشان دهنده یک بخش از سند XML است. با استفاده از این درخت می‌توانید با دقت و کنترل بیشتری با سند XML کار کنید.

نحوه استفاده از DOM:

1. ایجاد یک شیء DOMDocument: برای شروع، یک شیء از کلاس DOMDocument ایجاد می‌کنید.
2. بارگذاری XML: با استفاده از متد load() برای بارگذاری از فایل یا loadXML() برای بارگذاری از رشته، سند XML را بارگذاری می‌کنید.
3. دسترسی به گره‌ها: می‌توانید با استفاده از متدهایی مانند getElementsByTagName(), getElementById(), childNodes و غیره به گره‌های مختلف در سند XML دسترسی پیدا کنید.

مثال:

با استفاده از همان فایل books.xml، کد PHP برای خواندن آن با DOM:

<?php
// ایجاد یک شیء DOMDocument
$dom = new DOMDocument();

// بارگذاری فایل XML
$dom->load('books.xml');

// بررسی وجود خطا در بارگذاری
if ($dom === false) {
    echo "Error loading XML.\n";
    exit;
}
// دسترسی به تگ‌های book
$books = $dom->getElementsByTagName('book');

// پیمایش گره‌های کتاب
foreach ($books as $book) {
    // دسترسی به ویژگی id
    $id = $book->getAttribute('id');
    echo "ID: " . $id . "\n";

    // دسترسی به عنوان
    $titleElements = $book->getElementsByTagName('title');
    $title = $titleElements->item(0)->textContent;
    echo "Title: " . $title . "\n";

    // دسترسی به نویسنده
    $authorElements = $book->getElementsByTagName('author');
    $author = $authorElements->item(0)->textContent;
    echo "Author: " . $author . "\n";

    // دسترسی به قیمت
    $priceElements = $book->getElementsByTagName('price');
    $price = $priceElements->item(0)->textContent;
    echo "Price: " . $price . "\n";
    echo "------\n";
}


// دسترسی به عنوان اولین کتاب
$firstBookTitle = $dom->getElementsByTagName('book')->item(0)->getElementsByTagName('title')->item(0)->textContent;
echo "First Book Title: " . $firstBookTitle;


/*
خروجی:
ID: 1
Title: The Lord of the Rings
Author: J.R.R. Tolkien
Price: 25.99
------
ID: 2
Title: Pride and Prejudice
Author: Jane Austen
Price: 15.50
------
First Book Title: The Lord of the Rings
*/
?>

مزایا و معایب DOM:

• مزایا:
  • کنترل دقیق و کامل بر روی ساختار XML.
  • قابلیت ویرایش و ایجاد سند XML.
  • مناسب برای فایل‌های XML پیچیده و بزرگ.
  • امکان استفاده از XPath برای انتخاب گره‌ها.
• معایب:
  • پیچیده‌تر از SimpleXML و یادگیری آن دشوارتر است.
  • نوشتن کد با DOM معمولاً طولانی‌تر و پیچیده‌تر است.

ایجاد XML با DOM

DOM نه تنها برای خواندن بلکه برای ایجاد و ویرایش XML نیز بسیار قدرتمند است.

مثال ایجاد یک سند XML:

<?php
// ایجاد یک شیء DOMDocument
$dom = new DOMDocument('1.0', 'UTF-8');

// ایجاد گره ریشه
$root = $dom->createElement('books');
$dom->appendChild($root);

// ایجاد گره کتاب 1
$book1 = $dom->createElement('book');
$book1->setAttribute('id', '1');
$root->appendChild($book1);

$title1 = $dom->createElement('title', 'The Hitchhiker\'s Guide to the Galaxy');
$book1->appendChild($title1);
$author1 = $dom->createElement('author', 'Douglas Adams');
$book1->appendChild($author1);
$price1 = $dom->createElement('price', '10.00');
$book1->appendChild($price1);

// ایجاد گره کتاب 2
$book2 = $dom->createElement('book');
$book2->setAttribute('id', '2');
$root->appendChild($book2);

$title2 = $dom->createElement('title', 'Dune');
$book2->appendChild($title2);
$author2 = $dom->createElement('author', 'Frank Herbert');
$book2->appendChild($author2);
$price2 = $dom->createElement('price', '12.50');
$book2->appendChild($price2);


// فرمت‌بندی خروجی XML برای خوانایی
$dom->formatOutput = true;
// نمایش XML خروجی
echo '<pre>' . htmlspecialchars($dom->saveXML()) . '</pre>';

// ذخیره در فایل
$dom->save('new_books.xml');
?>

انتخاب بین SimpleXML و DOM

• اگر با فایل‌های XML ساده و کوچک کار می‌کنید و نیاز به کنترل دقیق ندارید، SimpleXML انتخاب مناسبی است.
• اگر با فایل‌های XML پیچیده و بزرگ کار می‌کنید یا نیاز به ویرایش و ایجاد XML دارید، DOM انتخاب بهتری است.

خلاصه

پردازش XML در PHP با استفاده از SimpleXML و DOM امکان‌پذیر است. SimpleXML ساده و برای کارهای روزمره مناسب است، در حالی که DOM قدرتمندتر است و امکان کنترل دقیق‌تر بر روی سند XML را فراهم می‌کند. بسته به نیاز پروژه خود می‌توانید از یکی از این دو روش استفاده کنید.