Merge pull request mghoneimy#10 from mos3abof/master

Format README.md and Changelog.md

Author: mghoneimy

Changelog.md

@@ -1,6 +1,7 @@
 # Change Log
 
-The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
+The change log describes what is "Added", "Removed", "Changed" or "Fixed"
+between each release.
 
 ## 2019-07-24
 
@@ -26,7 +27,8 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
 
 ### Changed
 
-- `Client::runQuery` method now accepts `QueryBuilderInterface` as well as `Query`
+- `Client::runQuery` method now accepts `QueryBuilderInterface` as well as
+`Query`
 
 
 ## 1.0: 2019-04-19
@@ -47,10 +49,13 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
 
 ### Changed
 
-- Refactored schema class generation mechanism to traverse the API schema from the root queryType
+- Refactored schema class generation mechanism to traverse the API schema from
+the root queryType
 - Refactored QueryObject class to accommodate changes in the schema generation
-    - Removed arguments from QueryObject classes and moved them to ArgumentsObjects
-    - Modified how generation works to accommodate ArgumentsObjects nested within QueryObjects
+    - Removed arguments from QueryObject classes and moved them to
+    ArgumentsObjects
+    - Modified how generation works to accommodate ArgumentsObjects nested
+    within QueryObjects
     - Added ArgumentsObject argument to all field selector methods
 - Refactored Query class
     - Added the ability to set Query object name to 'query'
@@ -162,7 +167,7 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
 
 - Typo in namespace declaration
 
-## 0.1.1: 2018-10-07 
+## 0.1.1: 2018-10-07
 
 
 ### Changed

README.md

@@ -1,36 +1,52 @@
 # PHP GraphQL Client
-[![Build Status](https://travis-ci.org/mghoneimy/php-graphql-client.svg?branch=master)](https://travis-ci.org/mghoneimy/php-graphql-client)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cb5e0708c4244c1a848be668dbcda8b0)](https://app.codacy.com/app/mghoneimy/php-graphql-client?utm_source=github.com&utm_medium=referral&utm_content=mghoneimy/php-graphql-client&utm_campaign=Badge_Grade_Dashboard)
-[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/c2b0ae3a556547c38e1247d63228adde)](https://www.codacy.com/app/mghoneimy/php-graphql-client?utm_source=github.com&utm_medium=referral&utm_content=mghoneimy/php-graphql-client&utm_campaign=Badge_Coverage)
-[![Total Downloads](https://poser.pugx.org/gmostafa/php-graphql-client/downloads)](https://packagist.org/packages/gmostafa/php-graphql-client)
-[![Latest Stable Version](https://poser.pugx.org/gmostafa/php-graphql-client/v/stable)](https://packagist.org/packages/gmostafa/php-graphql-client)
+[![Build
+Status](https://travis-ci.org/mghoneimy/php-graphql-client.svg?branch=master)](https://travis-ci.org/mghoneimy/php-graphql-client)
+[![Codacy
+Badge](https://api.codacy.com/project/badge/Grade/cb5e0708c4244c1a848be668dbcda8b0)](https://app.codacy.com/app/mghoneimy/php-graphql-client?utm_source=github.com&utm_medium=referral&utm_content=mghoneimy/php-graphql-client&utm_campaign=Badge_Grade_Dashboard)
+[![Codacy
+Badge](https://api.codacy.com/project/badge/Coverage/c2b0ae3a556547c38e1247d63228adde)](https://www.codacy.com/app/mghoneimy/php-graphql-client?utm_source=github.com&utm_medium=referral&utm_content=mghoneimy/php-graphql-client&utm_campaign=Badge_Coverage)
+[![Total
+Downloads](https://poser.pugx.org/gmostafa/php-graphql-client/downloads)](https://packagist.org/packages/gmostafa/php-graphql-client)
+[![Latest Stable
+Version](https://poser.pugx.org/gmostafa/php-graphql-client/v/stable)](https://packagist.org/packages/gmostafa/php-graphql-client)
 [![License](https://poser.pugx.org/gmostafa/php-graphql-client/license)](https://packagist.org/packages/gmostafa/php-graphql-client)
 
-A GraphQL client written in PHP which provides very simple, yet powerful, query generator classes that make the process
-of interacting with a GraphQL server a very simple one. 
+A GraphQL client written in PHP which provides very simple, yet powerful, query
+generator classes that make the process of interacting with a GraphQL server a
+very simple one.
 
 # Usage
+
 There are 3 primary ways to use this package to generate your GraphQL queries:
-1. Query Class: Simple class that maps to GraphQL queries. It's designed to manipulate queries with ease and speed.
-2. QueryBuilder Class: Builder class that can be used to generate `Query` objects dynamically. It's design to be used in
-cases where a query is being build in a dynamic fashion.  
-3. PHP GraphQL-OQM: An extension to this package. It Eliminates the need to write any GraphQL queries or refer to the
-API documentation or syntax. It generates query objects from the API schema, declaration exposed through GraphQL's
-introspection, which can then be simply interacted with.
+
+1. Query Class: Simple class that maps to GraphQL queries. It's designed to
+   manipulate queries with ease and speed.
+2. QueryBuilder Class: Builder class that can be used to generate `Query`
+   objects dynamically. It's design to be used in cases where a query is being
+   build in a dynamic fashion.
+3. PHP GraphQL-OQM: An extension to this package. It Eliminates the need to
+   write any GraphQL queries or refer to the API documentation or syntax. It
+   generates query objects from the API schema, declaration exposed through
+   GraphQL's introspection, which can then be simply interacted with.
 
 # Installation
+
 Run the following command to install the package using composer:
+
 ```
-composer require gmostafa/php-graphql-client
+$ composer require gmostafa/php-graphql-client
 ```
 
 # Object-to-Query-Mapper Extension
-To avoid the hassle of having to write _any_ queries and just interact with PHP objects generated from your API schema
-visit PHP GraphQL OQM repository at:
-https://github.com/mghoneimy/php-graphql-oqm
+
+To avoid the hassle of having to write _any_ queries and just interact with PHP
+objects generated from your API schema visit [PHP GraphQL OQM repository](
+https://github.com/mghoneimy/php-graphql-oqm)
 
 # Query Examples
+
 ## Simple Query
+
 ```
 $gql = (new Query('companies'))
     ->setSelectionSet(
@@ -40,7 +56,9 @@ $gql = (new Query('companies'))
         ]
     );
 ```
-This simple query will retrieve all companies displaying their names and serial numbers.
+
+This simple query will retrieve all companies displaying their names and serial
+numbers.
 
 ## Nested Queries
 ```
@@ -60,11 +78,15 @@ $gql = (new Query('companies'))
         ]
     );
 ```
-This query is a more complex one, retrieving not just scalar fields, but object fields as well. This query returns all
-companies, displaying their names, serial numbers, and for each company, all its branches, displaying the branch address,
-and for each address, it retrieves all contracts bound to this address, displaying their dates.
+
+This query is a more complex one, retrieving not just scalar fields, but object
+fields as well. This query returns all companies, displaying their names, serial
+numbers, and for each company, all its branches, displaying the branch address,
+and for each address, it retrieves all contracts bound to this address,
+displaying their dates.
 
 ## Query With Arguments
+
 ```
 $gql = (new Query('companies'))
     ->setArguments(['name' => 'Tech Co.', 'first' => 3])
@@ -75,10 +97,13 @@ $gql = (new Query('companies'))
         ]
     );
 ```
-This query does not retrieve all companies by adding arguments. This query will retrieve the first 3 companies with the
-name "Tech Co.", displaying their names and serial numbers. 
+
+This query does not retrieve all companies by adding arguments. This query will
+retrieve the first 3 companies with the name "Tech Co.", displaying their names
+and serial numbers.
 
 ## Query With Array Argument
+
 ```
 $gql = (new Query('companies'))
     ->setArguments(['serialNumbers' => [159, 260, 371]])
@@ -89,10 +114,13 @@ $gql = (new Query('companies'))
         ]
     );
 ```
-This query is a special case of the arguments query. In this example, the query will retrieve only the companies with
-serial number in one of 159, 260, and 371, displaying the name and serial number.
+
+This query is a special case of the arguments query. In this example, the query
+will retrieve only the companies with serial number in one of 159, 260, and 371,
+displaying the name and serial number.
 
 ## Query With Input Object Argument
+
 ```
 $gql = (new Query('companies'))
     ->setArguments(['filter' => new RawObject('{name_starts_with: "Face"}')])
@@ -103,15 +131,20 @@ $gql = (new Query('companies'))
         ]
     );
 ```
-This query is another special case of the arguments query. In this example, we're setting a custom input object "filter"
-with some values to limit the companies being returned. We're setting the filter "name_starts_with" with value "Face".
-This query will retrieve only the companies whose names start with the phrase "Face".
 
-The RawObject class being constructed is used for injecting the string into the query as it is. Whatever string is input
-into the RawObject constructor will be put in the query as it is without any custom formatting normally done by the
+This query is another special case of the arguments query. In this example,
+we're setting a custom input object "filter" with some values to limit the
+companies being returned. We're setting the filter "name_starts_with" with
+value "Face".  This query will retrieve only the companies whose names
+start with the phrase "Face".
+
+The RawObject class being constructed is used for injecting the string into the
+query as it is. Whatever string is input into the RawObject constructor will be
+put in the query as it is without any custom formatting normally done by the
 query class.
 
 ## Query With Variables
+
 ```
 $gql = (new Query('companies'))
     ->setVariables(
@@ -128,23 +161,32 @@ $gql = (new Query('companies'))
         ]
     );
 ```
-This query shows how variables can be used in this package to allow for dynamic requests enabled by GraphQL standards.
+
+This query shows how variables can be used in this package to allow for dynamic
+requests enabled by GraphQL standards.
 
 ### The Variable Class
-The Variable class is an immutable class that represents a variable in GraphQL standards. Its constructor receives 4
-arguments:
+
+The Variable class is an immutable class that represents a variable in GraphQL
+standards. Its constructor receives 4 arguments:
+
 - name: Represents the variable name
 - type: Represents the variable type according to the GraphQL server schema
-- isRequired (Optional): Represents if the variable is required or not, it's false by default
-- defaultValue (Optional): Represents the default value to be assigned to the variable. The default value will only be
-considered if the isRequired argument is set to false.
+- isRequired (Optional): Represents if the variable is required or not, it's
+false by default
+- defaultValue (Optional): Represents the default value to be assigned to the
+variable. The default value will only be considered
+if the isRequired argument is set to false.
 
 # The Query Builder
-The QueryBuilder class can be used to construct Query objects dynamically, which can be useful in some cases. It works
-very similarly to the Query class, but the Query building is divided into steps.
 
-That's how the "Query With Input Object Argument" example can be created using the
-QueryBuilder:
+The QueryBuilder class can be used to construct Query objects dynamically, which
+can be useful in some cases. It works very similarly to the Query class, but the
+Query building is divided into steps.
+
+That's how the "Query With Input Object Argument" example can be created using
+the QueryBuilder:
+
 ```
 $builder = (new QueryBuilder('companies'))
     ->setVariable('namePrefix', 'String', true)
@@ -155,11 +197,14 @@ $gql = $builder->getQuery();
 ```
 
 # Constructing The Client
-A Client object can easily be instantiated by providing the GraphQL endpoint URL. The Client constructor also receives
-an optional "authorizationHeaders" array, which can be used to add authorization headers to all requests being sent to
-the GraphQL server.
+
+A Client object can easily be instantiated by providing the GraphQL endpoint
+URL. The Client constructor also receives an optional "authorizationHeaders"
+array, which can be used to add authorization headers to all requests being sent
+to the GraphQL server.
 
 Example:
+
 ```
 $client = new Client(
     'http://api.graphql.com',
@@ -168,21 +213,29 @@ $client = new Client(
 ```
 
 # Running Queries
+
 ## Result Formatting
-Running query with the GraphQL client and getting the results in object structure:
+
+Running query with the GraphQL client and getting the results in object
+structure:
+
 ```
 $results = $client->runQuery($gql);
 $results->getData()->Company[0]->branches;
 ```
 Or getting results in array structure:
+
 ```
 $results = $client->runQuery($gql, true);
 $results->getData()['Company'][1]['branches']['address']
 ```
 
 ## Passing Variables to Queries
-Running queries containing variables requires passing an associative array which maps variable names (keys) to variable
-values (values) to the `runQuery` method. Here's an example:
+
+Running queries containing variables requires passing an associative array which
+maps variable names (keys) to variable values (values) to the `runQuery` method.
+Here's an example:
+
 ```
 $gql = (new Query('companies'))
     ->setVariables(
@@ -203,10 +256,12 @@ $results = $client->runQuery($gql, true, $variablesArray);
 ```
 
 # Mutations
-Mutations follow the same rules of queries in GraphQL, they select fields on returned objects, receive arguments, and
-can have sub-fields.
+
+Mutations follow the same rules of queries in GraphQL, they select fields on
+returned objects, receive arguments, and can have sub-fields.
 
 Here's a sample example on how to construct and run mutations:
+
 ```
 $mutation = (new Mutation('createCompany'))
     ->setArguments(['companyObject' => new RawObject('{name: "Trial Company", employees: 200}')])
@@ -219,11 +274,15 @@ $mutation = (new Mutation('createCompany'))
     );
 $results = $client->runQuery($mutation);
 ```
+
 Mutations can be run by the client the same way queries are run.
 
 ## Mutations With Variables Example
-Mutations can utilize the variables in the same way Queries can. Here's an example on how to use the variables to pass
-input objects to the GraphQL server dynamically:
+
+Mutations can utilize the variables in the same way Queries can. Here's an
+example on how to use the variables to pass input objects to the GraphQL server
+dynamically:
+
 ```
 $mutation = (new Mutation('createCompany'))
     ->setVariables([new Variable('company', 'CompanyInputObject', true)])
@@ -234,22 +293,28 @@ $client->runQuery(
     $mutation, true, $variables
 );
 ```
+
 These are the resulting mutation and the variables passed with it:
+
 ```
 mutation($company: CompanyInputObject!) {
   createCompany(companyObject: $company)
 }
 {"company":{"name":"Tech Company","type":"Testing","size":"Medium"}}
 ```
+
 # Live API Example
-GraphQL Pokemon is a very cool public GraphQL API available to retrieve Pokemon data. The API is available publicly on
-the web, we'll use it to demo the capabilities of this client.
+
+GraphQL Pokemon is a very cool public GraphQL API available to retrieve Pokemon
+data. The API is available publicly on the web, we'll use it to demo the
+capabilities of this client.
 
 Github Repo link: https://github.com/lucasbento/graphql-pokemon
- 
+
 API link: https://graphql-pokemon.now.sh/
 
 This query retrieves any pokemon's evolutions and their attacks:
+
 ```
 query($name: String!) {
   pokemon(name: $name) {
@@ -277,7 +342,9 @@ query($name: String!) {
 
 ```
 
-That's how this query can be written using the query class and run using the client:
+That's how this query can be written using the query class and run using the
+client:
+
 ```
 $client = new Client(
     'https://graphql-pokemon.now.sh/'
@@ -323,7 +390,10 @@ catch (QueryError $exception) {
 }
 print_r($results->getData()['pokemon']);
 ```
-Or alternatively, That's how this query can be generated using the QueryBuilder class:
+
+Or alternatively, That's how this query can be generated using the QueryBuilder
+class:
+
 ```
 $client = new Client(
     'https://graphql-pokemon.now.sh/'
@@ -361,8 +431,11 @@ print_r($results->getData()['pokemon']);
 ```
 
 # Running Raw Queries
-Although not the primary goal of this package, but it supports running raw string queries, just like any other client
-using the `runRawQuery` method in the `Client` class. Here's an example on how to use it:
+
+Although not the primary goal of this package, but it supports running raw
+string queries, just like any other client using the `runRawQuery` method in the
+`Client` class. Here's an example on how to use it:
+
 ```
 $gql = <<<QUERY
 query {