Merge branch 'master' into count-conditions

Author: mtrezza

.github/workflows/ci.yml

@@ -26,11 +26,12 @@ jobs:
     strategy:
       matrix:
         include:
-          - name: PHP 8.1
-            PHP_VERSION: 8.1
           - name: PHP 8.2
             PHP_VERSION: 8.2
+          - name: PHP 8.1
+            PHP_VERSION: 8.1
       fail-fast: false
+    name: Test ${{ matrix.name }}
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js
@@ -59,3 +60,6 @@ jobs:
         env:
           CI: true
       - run: bash <(curl -s https://codecov.io/bash)
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true

CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.3.0](https://github.com/parse-community/parse-php-sdk/compare/2.2.0...2.3.0) (2023-05-13)
+
+
+### Features
+
+* Add query methods `fetchWithInclude` and `fetchAllWithInclude` ([#512](https://github.com/parse-community/parse-php-sdk/issues/512)) ([0570f15](https://github.com/parse-community/parse-php-sdk/commit/0570f157a5e4efb2310b7df44c25ff246077589a))
+
+# [2.2.0](https://github.com/parse-community/parse-php-sdk/compare/2.1.0...2.2.0) (2023-05-13)
+
+
+### Features
+
+* Allow http options to be passed into `ParseClient` ([#513](https://github.com/parse-community/parse-php-sdk/issues/513)) ([ee2a5fa](https://github.com/parse-community/parse-php-sdk/commit/ee2a5fa389d553e73e483130647fd93cf187d142))
+
 # [2.1.0](https://github.com/parse-community/parse-php-sdk/compare/2.0.0...2.1.0) (2023-04-29)
 
 

README.md

@@ -24,6 +24,7 @@ A library that gives you access to the powerful Parse Server backend from your P
 
 ## Table of Contents <!-- omit in toc -->
 
+- [Compatibility](#compatibility)
 - [Installation](#installation)
   - [Install with Composer](#install-with-composer)
   - [Install with Git](#install-with-git)
@@ -64,6 +65,15 @@ A library that gives you access to the powerful Parse Server backend from your P
   - [Logs](#logs)
 - [Contributing / Testing](#contributing--testing)
 
+## Compatibility
+
+The Parse PHP SDK is continuously tested with the most recent releases of PHP to ensure compatibility. We follow the [PHP Long Term Support plan](https://www.php.net/supported-versions.php) and only test against versions that are officially supported and have not reached their end-of-life date.
+
+| Version | End-of-Life | Compatible |
+|---------|-------------|------------|
+| PHP 8.2 | Dec 2024    | ✅ Yes      |
+| PHP 8.1 | Nov 2023    | ✅ Yes      |
+
 ## Installation
 There are various ways to install and use this sdk. We'll elaborate on a couple here.
 Note that the Parse PHP SDK requires PHP 5.4 or newer. It can also run on HHVM (recommended 3.0 or newer).

package-lock.json

@@ -32,5 +32,5 @@
     "semantic-release": "21.0.1",
     "winston": "3.2.1"
   },
-  "version": "2.1.0"
+  "version": "2.3.0"
 }

package.json

@@ -306,6 +306,18 @@ public function setCAFile($caFile)
         $this->parseCurl->setOption(CURLOPT_CAINFO, $caFile);
     }
 
+    /**
+     * Sets multiple curl options
+     * https://www.php.net/manual/en/function.curl-setopt.php
+     *
+     * @param array $options    Array of options to set
+     * @throws ParseException
+     */
+    public function setHttpOptions($options)
+    {
+        $this->parseCurl->setOptionsArray($options);
+    }
+
     /**
      * Gets the error code
      *

src/Parse/HttpClients/ParseCurlHttpClient.php

@@ -63,6 +63,13 @@ public function setTimeout($timeout);
      */
     public function setCAFile($caFile);
 
+    /**
+     * Sets http options to pass to the http client
+     *
+     * @param string $httpOptions    Options to set
+     */
+    public function setHttpOptions($httpOptions);
+
     /**
      * Gets the error code
      *

src/Parse/HttpClients/ParseHttpable.php

@@ -78,6 +78,13 @@ class ParseStreamHttpClient implements ParseHttpable
      */
     private $caFile;
 
+    /**
+     * Options to pass to the stream context.
+     *
+     * @var array
+     */
+    private $httpOptions;
+
     /**
      * Optional timeout for this request
      *
@@ -195,6 +202,12 @@ public function send($url, $method = 'GET', $data = array())
             $this->options['ssl']['cafile'] = $this->caFile;
         }
 
+        if (isset($this->httpOptions)) {
+            foreach ($this->httpOptions as $key => $value) {
+                $this->options[$key] = $value;
+            }
+        }
+
         // add additional options for this request
         $this->options['http'] = array(
             'method'        => $method,
@@ -264,6 +277,7 @@ public function send($url, $method = 'GET', $data = array())
 
         // clear options
         $this->options = array();
+        $this->httpOptions = array();
 
         // flush our existing headers
         $this->headers = array();
@@ -348,6 +362,17 @@ public function setCAFile($caFile)
         $this->caFile = $caFile;
     }
 
+    /**
+     * Sets http options to pass to the stream context
+     * https://www.php.net/manual/en/context.php
+     *
+     * @param array $httpOptions    options to set
+     */
+    public function setHttpOptions($httpOptions)
+    {
+        $this->httpOptions = $httpOptions;
+    }
+
     /**
      * Sets the request timeout
      *

src/Parse/HttpClients/ParseStreamHttpClient.php

@@ -103,12 +103,19 @@ final class ParseClient
      */
     private static $caFile;
 
+    /**
+     * Options to pass to the http client.
+     *
+     * @var array
+     */
+    private static $httpOptions;
+
     /**
      * Constant for version string to include with requests.
      *
      * @var string
      */
-    const VERSION_STRING = '2.1.0';
+    const VERSION_STRING = '2.3.0';
 
     /**
      * Parse\Client::initialize, must be called before using Parse features.
@@ -301,6 +308,21 @@ public static function setCAFile($caFile)
         self::$caFile = $caFile;
     }
 
+    /**
+     * Sets http options to pass to the http client
+     * For curl
+     * https://www.php.net/manual/en/function.curl-setopt.php
+     *
+     * For stream context
+     * https://www.php.net/manual/en/context.php
+     *
+     * @param array $httpOptions    options to set
+     */
+    public static function setHttpOptions($httpOptions)
+    {
+        self::$httpOptions = $httpOptions;
+    }
+
     /**
      * ParseClient::_encode, internal method for encoding object values.
      *
@@ -452,6 +474,9 @@ private static function getPreparedHttpClient()
             // set CA file
             $httpClient->setCAFile(self::$caFile);
         }
+        if (isset(self::$httpOptions)) {
+            $httpClient->setHttpOptions(self::$httpOptions);
+        }
 
         return $httpClient;
     }

src/Parse/ParseClient.php

@@ -570,6 +570,33 @@ public function fetch($useMasterKey = false)
         return $this;
     }
 
+    /**
+     * Fetch an array of Parse objects from the server.
+     *
+     * @param array $objects      The ParseObjects to fetch
+     * @param array $includeKeys  The nested ParseObjects to fetch
+     * @param bool  $useMasterKey Whether to override ACLs
+     *
+     * @return ParseObject Returns self, so you can chain this call.
+     */
+    public function fetchWithInclude(array $includeKeys, $useMasterKey = false)
+    {
+        $sessionToken = null;
+        if (ParseUser::getCurrentUser()) {
+            $sessionToken = ParseUser::getCurrentUser()->getSessionToken();
+        }
+        $response = ParseClient::_request(
+            'GET',
+            'classes/'.$this->className.'/'.$this->objectId.'?include='.implode(',', $includeKeys),
+            $sessionToken,
+            null,
+            $useMasterKey
+        );
+        $this->_mergeAfterFetch($response);
+
+        return $this;
+    }
+
     /**
      * Fetch an array of Parse objects from the server.
      *
@@ -593,6 +620,31 @@ public static function fetchAll(array $objects, $useMasterKey = false)
         return static::updateWithFetchedResults($objects, $results);
     }
 
+    /**
+     * Fetch an array of Parse Objects from the server with nested Parse Objects.
+     *
+     * @param array $objects      The ParseObjects to fetch
+     * @param mixed $includeKeys  The nested ParseObjects to fetch
+     * @param bool  $useMasterKey Whether to override ACLs
+     *
+     * @return array
+     */
+    public static function fetchAllWithInclude(array $objects, $includeKeys, $useMasterKey = false)
+    {
+        $objectIds = static::toObjectIdArray($objects);
+        if (!count($objectIds)) {
+            return $objects;
+        }
+        $className = $objects[0]->getClassName();
+        $query = new ParseQuery($className);
+        $query->containedIn('objectId', $objectIds);
+        $query->limit(count($objectIds));
+        $query->includeKey($includeKeys);
+        $results = $query->find($useMasterKey);
+
+        return static::updateWithFetchedResults($objects, $results);
+    }
+
     /**
      * Creates an array of object ids from a given array of ParseObjects
      *