Cách thích hợp để thực hiện cuộc gọi AJAX trong thành phần là gì?

Đây là một câu trả lời muộn cho câu hỏi được trả lời rất tốt này, nhưng tôi muốn thêm giải pháp cắt xén này cho những người chỉ cần một cách đơn giản để lấy dữ liệu của các thành phần của họ bằng một cuộc gọi AJAX.

Với tất cả các phiên bản Joomla, khả năng của bên thứ 3 và các bản hack mà tôi đã tìm thấy trong nhiều ngày làm việc, đây là cách tiếp cận đơn giản nhất tôi có thể đưa ra - và phản hồi được DEFINATELY đánh giá cao.

1. Đã thêm chức năng execute vào bộ điều khiển chính hiện có của tôi
2. Tạo một bộ điều khiển con với chức năng công khai cho (các) tác vụ mà tôi muốn gọi bằng AJAX
3. Đã sử dụng lớp Joomla JResponseJson tích hợp để xử lý đầu ra ( thật sự rất hay! )

RL để gọi/thực hiện tác vụ :

www.mysite.com/index.php?option=com_example&task=ForAjax.mytaskname

Bộ điều khiển chính đã sửa đổi\com_example\controller.php

class ExampleController extends JControllerLegacy {
    public function display($cachable = false, $urlparams = false) {
        $app = JFactory::getApplication();
        $view = $app->input->getCmd('view', 'default');
        $app->input->set('view', $view);
        parent::display($cachable, $urlparams);
        return $this;
    }

    public function execute()
    {
        // Not technically needed, but a DAMN good idea.  See http://docs.joomla.org/How_to_add_CSRF_anti-spoofing_to_forms
        // JSession::checkToken();
        $task = JFactory::getApplication()->input->get('task');
        try
        {
            parent::execute($task);
        }
        catch(Exception $e)
        {
            echo new JResponseJson($e);
        }
    }
}

Bộ điều khiển mới\com_example\controls\forajax.php

require_once JPATH_COMPONENT.'/controller.php';
class ExampleControllerForAjax extends ExampleController
{
    public function MyTaskName()
    {
        $app = JFactory::getApplication();

        $data['myRequest'] =$_REQUEST;
        $data['myFile'] =__FILE__;
        $data['myLine'] ='Line '.__LINE__;

        $app->enqueueMessage('This part was reached at line ' . __LINE__);
        $app->enqueueMessage('Then this part was reached at line ' . __LINE__);
        $app->enqueueMessage('Here was a small warning at line ' . __LINE__, 'warning');
        $app->enqueueMessage('Here was a big warning at line ' . __LINE__, 'error');

        $task_failed = false;
        echo new JResponseJson($data, 'My main response message',$task_failed);

        $app->close();
    }
}

Kết xuất JSON được kết xuất

{
    success: true,
    message: "My main response message",
    messages: {
        message: [
            "This part was reached at line 26",
            "Then this part was reached at line 27"
        ],
        warning: [
            "Here was a small warning at line 28"
        ],
        error: [
            "Here was a big warning at line 29"
        ]
    },
    data: {
        myRequest: {
            option: "com_example",
            task: "mytaskname",
            Itemid: null
        },
        myFile: "C:\mysite\components\com_example\controllers\forajax.php",
        myLine: "Line 24"
    }
}

Câu trả lời của Valentin là tốt nhưng hơi phức tạp một chút nếu tất cả những gì bạn cần làm là thêm 1 hoặc 2 cuộc gọi ajax vào một thành phần đã được xây dựng. Hoàn toàn có thể thoát khỏi việc không tách rời controller.raw.php hoặc là view.raw.php các tập tin.

Để thực hiện cuộc gọi ajax này

index.php?format=raw&option=com_example&controller=job&task=keep_alive&tokenhash=1

Trong bộ điều khiển con job

public function keep_alive() {
    $this->ajax_check();

    //Do your processing and echo out whatever you want to return to the AJAX call
    header('HTTP/1.1 202 Accepted', true, 202);
    echo 'OK';

    JFactory::getApplication()->close();
}

// Verifies jtoken and does a basic check that this is actually an AJAX call
private function ajax_check() {
    if(!JSession::checkToken('GET') || !isset($_SERVER['HTTP_X_REQUESTED_WITH']) || strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) !== 'xmlhttprequest') {
        header('HTTP/1.1 403 Forbidden', true, 403);
        JFactory::getApplication()->close();
    }
}

Câu trả lời của Valentin là tốt.

Tôi thích một bộ điều khiển json xử lý mã hóa và xử lý lỗi cho việc này Tôi đã tạo một lớp cơ sở json:

class itrControllerJson extends JControllerLegacy {

  /** @var array the response to the client */
  protected $response = array();

  public function addResponse($type, $message, $status=200) {

    array_Push($this->response, array(
      'status' => $status,
      'type' => $type,
      'data' => $message
    ));

  }

  /**
   * Outputs the response
   * @return JControllerLegacy|void
   */
  public function display() {

    $response = array(
      'status' => 200,
      'type' => 'multiple',
      'count' => count($this->response),
      'messages' => $this->response
    );

    echo json_encode($response);
    jexit();
  }

}

Bộ điều khiển này được mở rộng bởi lớp trình điều khiển thực hiện công việc, đại loại như thế này:

require_once __DIR__.'json.php';

class componentControllerAddress extends itrControllerJson {
  public function get() {

    try {
      if (!JSession::checkToken()) {
        throw new Exception(JText::_('JINVALID_TOKEN'), 500);
      }
      $app = JFactory::getApplication();

      $id = $app->input->get('id', null, 'uint');
      if (is_null($id)) {
        throw new Exception('Invalid Parameter', 500);
      }

      $db = JFactory::getDbo();
      $query = $db->getQuery(true);
      $query->select('*');
      $query->from('#__table');
      $query->where('id = '.$db->quote($id));
      $db->setQuery($query);
      $response = $db->loadObject();

      $this->addResponse('message', $response, 200);

    } catch (Exception $e) {
      $this->addResponse('error', $e->getMessage(), 500);
    }

    $this->display();
  }
}

và bạn gọi yêu cầu như thế này:

index.php?option=com_component&task=address.get&format=json&id=1234&tokenhash=1

Hàm băm token được tạo bởi JSession :: getFormToken (). Vì vậy, cuộc gọi hoàn chỉnh hoàn chỉnh có thể giống như thế này:

$link = JRoute::_('index.php?option=com_component&task=address.get&format=json&id=1234&'.JSession::getFormToken().'=1', false);

Tham số thứ hai được đặt thành "false" để chúng tôi có thể sử dụng tham số này trong các cuộc gọi javascript mà không cần viết lại xml.

Nếu bạn chắc chắn 100% không có plugin bên thrid nào thêm bất kỳ đầu ra Javascript nào, thì json_encode thuần hoạt động.

Nhưng ... ví dụ JomSocial thêm "" vào toàn bộ trang.

Vì vậy, ... một mẹo hữu ích, bọc json_encode bằng các thẻ và xử lý nó ở phía Javascript.

echo '@[email protected]' . json_encode(...) . '@[email protected]';

Bạn có thể truy cập bộ điều khiển trực tiếp bằng cách sử dụng tên bộ điều khiển trong tác vụ:

index.php?option=com_similar&task=controller.abc&format=raw

sẽ gọi: control.raw.php (trả về là raw)

index.php?option=com_similar&task=controller.abc

sẽ gọi: controller.php (return là html nếu bạn không sử dụng die;)