Browse Source

Updated read me

Joachim M. Giæver 6 years ago
parent
commit
4a506ba14b
1 changed files with 168 additions and 9 deletions
  1. 168 9
      README.md

+ 168 - 9
README.md

@@ -824,6 +824,7 @@ Collection is a collection of data of one type.
 |[current](#current-gogsapirequestcollection)                    |                                          |public            |                                                        |
 |[reset](#reset-gogsapirequestcollection)                        |mixed                                     |public            |                                                        |
 |[sort](#sort-gogsapirequestcollection)                          |[Collection](#collection-gogslib)         |public            |                                                        |
+|[filter](#filter-gogsapirequestcollection)                      |[Collection](#collection-gogslib)         |public            |                                                        |
 |[limit](#limit-gogsapirequestcollection)                        |[Collection](#collection-gogslib)         |public            |                                                        |
 |[offset](#offset-gogsapirequestcollection)                      |[Collection](#collection-gogslib)         |public            |                                                        |
 |[reverse](#reverse-gogsapirequestcollection)                    |[Collection](#collection-gogslib)         |public            |                                                        |
@@ -997,6 +998,22 @@ Returns: [Collection](#collection-gogslib)
 ---
 
 
+##### filter `Gogs\API\Request\Collection`
+```php
+public function filter(callable $f);
+```
+
+Parameters
+
+| Type   | Variable | Description |
+|---     |---       |---          |
+|callable|$f        |*None*       |
+
+Returns: [Collection](#collection-gogslib)
+
+---
+
+
 ##### limit `Gogs\API\Request\Collection`
 ```php
 public function limit(int $lim);
@@ -1577,15 +1594,23 @@ Repos is a collection of repos.
 
 #### Methods
 
-|Name                                           |Return                           |Access   |Description                      |
-|:---                                           |:---                             |:---     |:---                             |
-|[__construct](#__construct-gogsapirequestrepos)|                                 |public   | Initialize a repos collection   |
-|[set_scope](#set_scope-gogsapirequestrepos)    |bool                             |protected|                                 |
-|[get](#get-gogsapirequestrepos)                |object                           |public   | Get a single repository by name.|
-|[create](#create-gogsapirequestrepos)          |bool                             |public   |                                 |
-|[search](#search-gogsapirequestrepos)          |[true](#true-gogsapirequest)     |public   | Searches for a repo.            |
-|[sort_by](#sort_by-gogsapirequestrepos)        |[Collection](#collection-gogslib)|public   | Sort repos by `method`.         |
-|[add_object](#add_object-gogsapirequestrepos)  |array                            |protected|                                 |
+|Name                                                                 |Return                           |Access   |Description                       |
+|:---                                                                 |:---                             |:---     |:---                              |
+|[__construct](#__construct-gogsapirequestrepos)                      |                                 |public   | Initialize a repos collection    |
+|[set_scope](#set_scope-gogsapirequestrepos)                          |bool                             |protected|                                  |
+|[get](#get-gogsapirequestrepos)                                      |object                           |public   | Get a single repository by name.|
+|[create](#create-gogsapirequestrepos)                                |bool                             |public   |                                  |
+|[search](#search-gogsapirequestrepos)                                |[true](#true-gogsapirequest)     |public   | Searches for a repo.             |
+|[sort_by](#sort_by-gogsapirequestrepos)                              |[Collection](#collection-gogslib)|public   | Sort repos by `method`.          |
+|[add_object](#add_object-gogsapirequestrepos)                        |array                            |protected|                                  |
+|[privates](#privates-gogsapirequestrepos)                            |[Collection](#collection-gogslib)|public   | Get private repositories         |
+|[publics](#publics-gogsapirequestrepos)                              |[Collection](#collection-gogslib)|public   | Get public repositories          |
+|[personals](#personals-gogsapirequestrepos)                          |[Collection](#collection-gogslib)|public   | Get personal repositories        |
+|[contributions](#contributions-gogsapirequestrepos)                  |[Collection](#collection-gogslib)|public   | Get repositories contributed to  |
+|[personals_privates](#personals_privates-gogsapirequestrepos)        |[Collection](#collection-gogslib)|public   | Get personal private repositories|
+|[personals_publics](#personals_publics-gogsapirequestrepos)          |[Collection](#collection-gogslib)|public   | Get personal public repositories|
+|[contributions_privates](#contributions_privates-gogsapirequestrepos)|[Collection](#collection-gogslib)|public   | Get private contributions        |
+|[contributions_publics](#contributions_publics-gogsapirequestrepos)  |[Collection](#collection-gogslib)|public   | Get public contributions         |
 
 #### Method details
 
@@ -1740,6 +1765,102 @@ Returns: array
 ---
 
 
+##### privates `Gogs\API\Request\Repos`
+```php
+public function privates();
+```
+ Get private repositories
+
+
+Returns: [Collection](#collection-gogslib)
+
+---
+
+
+##### publics `Gogs\API\Request\Repos`
+```php
+public function publics();
+```
+ Get public repositories
+
+
+Returns: [Collection](#collection-gogslib)
+
+---
+
+
+##### personals `Gogs\API\Request\Repos`
+```php
+public function personals();
+```
+ Get personal repositories
+
+
+Returns: [Collection](#collection-gogslib)
+
+---
+
+
+##### contributions `Gogs\API\Request\Repos`
+```php
+public function contributions();
+```
+ Get repositories contributed to
+
+
+Returns: [Collection](#collection-gogslib)
+
+---
+
+
+##### personals_privates `Gogs\API\Request\Repos`
+```php
+public function personals_privates();
+```
+ Get personal private repositories
+
+
+Returns: [Collection](#collection-gogslib)
+
+---
+
+
+##### personals_publics `Gogs\API\Request\Repos`
+```php
+public function personals_publics();
+```
+ Get personal public repositories
+
+
+Returns: [Collection](#collection-gogslib)
+
+---
+
+
+##### contributions_privates `Gogs\API\Request\Repos`
+```php
+public function contributions_privates();
+```
+ Get private contributions
+
+
+Returns: [Collection](#collection-gogslib)
+
+---
+
+
+##### contributions_publics `Gogs\API\Request\Repos`
+```php
+public function contributions_publics();
+```
+ Get public contributions
+
+
+Returns: [Collection](#collection-gogslib)
+
+---
+
+
 ### Token `Gogs\API\Request`
 
 
@@ -2515,6 +2636,7 @@ which wont be a part of the "request package"
 |[current](#current-gogslibcollection)        |                                 |public|                                 |
 |[reset](#reset-gogslibcollection)            |mixed                            |public|                                 |
 |[sort](#sort-gogslibcollection)              |[Collection](#collection-gogslib)|public|                                 |
+|[filter](#filter-gogslibcollection)          |[Collection](#collection-gogslib)|public| Filter collection               |
 |[limit](#limit-gogslibcollection)            |[Collection](#collection-gogslib)|public|                                 |
 |[offset](#offset-gogslibcollection)          |[Collection](#collection-gogslib)|public|                                 |
 |[reverse](#reverse-gogslibcollection)        |[Collection](#collection-gogslib)|public|                                 |
@@ -2655,6 +2777,24 @@ Returns: [Collection](#collection-gogslib)
 ---
 
 
+##### filter `Gogs\Lib\Collection`
+```php
+public function filter(callable $f);
+```
+ Filter collection
+
+
+Parameters
+
+| Type   | Variable | Description |
+|---     |---       |---          |
+|callable|$f        |*None*       |
+
+Returns: [Collection](#collection-gogslib)
+
+---
+
+
 ##### limit `Gogs\Lib\Collection`
 ```php
 public function limit(int $lim);
@@ -2744,6 +2884,7 @@ providing an iterator interface.
 |[offset](#offset-gogslibarrayiterator)  |[Collection](#collection-gogslib)|public| Get from offset collection            |
 |[reverse](#reverse-gogslibarrayiterator)|[Collection](#collection-gogslib)|public| Reverse the collection                |
 |[sort](#sort-gogslibarrayiterator)      |[Collection](#collection-gogslib)|public| Sort collection                       |
+|[filter](#filter-gogslibarrayiterator)  |[Collection](#collection-gogslib)|public| Filter collection                     |
 
 #### Method details
 
@@ -2901,6 +3042,24 @@ public function sort(callable $f);
  Sort collection
 
 
+Parameters
+
+| Type   | Variable | Description |
+|---     |---       |---          |
+|callable|$f        |*None*       |
+
+Returns: [Collection](#collection-gogslib)
+
+---
+
+
+##### filter `Gogs\Lib\ArrayIterator`
+```php
+public function filter(callable $f);
+```
+ Filter collection
+
+
 Parameters
 
 | Type   | Variable | Description |