rest's Introduction

XP Framework

This is the XP Framework's development checkout for the 5.X-SERIES.

Note: Development now focusses on the 6.X-SERIES, which are maintained in the xp-framework/core repository. Bugfixes may be backported, but new features will usually only go to 6.X

Installation

Clone this repository, e.g. using Git Read-Only:

$ cd [path]
$ git clone git://github.com/xp-framework/xp-framework.git

Directory structure

[path]/xp-framework
`- core
   |- ChangeLog         # Version log
   |- boot.pth          # Bootstrap classpath
   |- tools             # Bootstrapping (lang.base.php, class.php, xar.php, web.php)
   `- src               # Sourcecode, by Maven conventions
      |- main
      |  `- php
      `- test
         |- php
         |- config      # Unittest configuration
         `- resources   # Test resources

Runners

The entry point for software written in the XP Framework is not the PHP interpreter's CLI / web server API but either a command line runner or a specialized web entry point. These runners can be installed by using the following one-liner:

$ cd ~/bin
$ wget 'https://github.com/xp-framework/xp-runners/releases/download/v6.2.0/setup' -O - | php

Using it

To use the the XP Framework development checkout, put the following in your ~/bin/xp.ini file:

use=[path]/xp-framework/core

Enjoy!

Contributing

To contribute, use the GitHub way - fork, hack, and submit a pull request!

rest's People

Contributors

Stargazers

Watchers

rest's Issues

Support streaming results

Instead of gathering all results in an array I'd like to be able to return a traversable or an iterator directly and have the API handle that for me; potentially optimizing by starting direct unbuffered writes to the client.

Current situation

The standard way: Fetch results, gather into array, return:

#[@webmethod(verb= 'GET')]
public function all() {
  $q= $this->conn->query('select * from swarm');
  $result= [];
  while ($record= $q->next()) {
    $result[]= $this->asResult($record);
  }
  return $result;
}

New

Together with xp-framework/rdbms#2 and data sequences, we can now write:

#[@webmethod(verb= 'GET')]
public function all() {
  $q= $this->conn->query('select * from swarm');
  return Sequence::of($q)->map([$this, 'asResult']);
}

PHP 7.2: PHP Fatal error: Declaration must be compatible

See https://travis-ci.org/xp-framework/rest/jobs/234372333

Compile error (Declaration of io\File▒336::in() must be compatible with io\File::in(): io\streams\InputStream)

This is only inside the tests, the main code works fine with PHP 7.2

Segments should be urlencoded

If I omit the urlencode() call in the code below I get an lang.FormatException ("" is not a valid HTTP response [-1]), which is because an invalid HTTP request is sent.

Code

$response= $client->execute((new RestRequest('/kibana-int/dashboard/{dashboard}', 'GET'))
  ->withSegment('dashboard', urlencode($this->dashBoard))
  ->withAccept('application/json')
);

Request

GET /kibana-int/dashboard/My example dashboard HTTP/1.1
Connection: close
Host: elk.example.com:9200
Accept: application/json

Recommend Projects

xp-framework / rest Goto Github PK