OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	08/12/2024 10:34:12 AM	rwxr-xr-x
📄 Makefile	7.68 KB	08/12/2024 10:33:24 AM	rw-r--r--
📁 _static	-	08/12/2024 10:34:12 AM	rwxr-xr-x
📁 _templates	-	08/12/2024 10:34:12 AM	rwxr-xr-x
📄 authentication.rst	13.82 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 cloud-firestore.rst	2.37 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 cloud-messaging.rst	26.18 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 cloud-storage.rst	2.5 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 conf.py	1.17 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 dynamic-links.rst	11.35 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 framework-integrations.rst	505 bytes	08/12/2024 10:33:24 AM	rw-r--r--
📄 index.rst	2.31 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 overview.rst	4.51 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 realtime-database.rst	20.11 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 remote-config.rst	7.96 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 requirements.txt	40 bytes	08/12/2024 10:33:24 AM	rw-r--r--
📄 setup.rst	8.29 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 troubleshooting.rst	10.57 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 tutorials.rst	1.71 KB	08/12/2024 10:33:24 AM	rw-r--r--
📄 user-management.rst	18.32 KB	08/12/2024 10:33:24 AM	rw-r--r--

Editing: cloud-firestore.rst

###############
Cloud Firestore
###############

This SDK provides a bridge to the `google/cloud-firestore <https://packagist.org/packages/google/cloud-firestore>`_
package. You can enable the component in the SDK by adding the package to your project dependencies:

.. code-block:: bash

composer require google/cloud-firestore

.. note::
    The ``google/cloud-firestore`` package requires the gRPC PHP extension to be installed. You can find installation
    instructions for gRPC at `github.com/grpc/grpc <https://github.com/grpc/grpc/tree/master/src/php>`_. The following
    projects aim to provide support for Firestore without the need to install the gRPC PHP extension, but have to
    be set up separately:

- `ahsankhatri/firestore-php <https://github.com/ahsankhatri/firestore-php>`_
    - `morrislaptop/firestore-php <https://github.com/morrislaptop/firestore-php>`_

Before you start, please read about Firestore in the official documentation:

- `Official Documentation <https://firebase.google.com/docs/firestore/>`_
- `google/cloud-firestore on GitHub <https://github.com/googleapis/google-cloud-php-firestore>`_
- `PHP API Documentation <https://googleapis.github.io/google-cloud-php/#/docs/cloud-firestore>`_
- `PHP Usage Examples <https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/firestore>`_

************************************
Initializing the Firestore component
************************************

**With the SDK**

.. code-block:: php

$firestore = $factory->createFirestore();

**With Dependency Injection** (`Symfony Bundle <https://github.com/kreait/firebase-bundle>`_/`Laravel/Lumen Package <https://github.com/kreait/laravel-firebase>`_)

.. code-block:: php

use Kreait\Firebase\Firestore;

class MyService
    {
        public function __construct(Firestore $firestore)
        {
            $this->firestore = $firestore;
        }
    }

**With the Laravel** ``app()`` **helper** (`Laravel/Lumen Package <https://github.com/kreait/laravel-firebase>`_)

.. code-block:: php

$firestore = app('firebase.firestore');

***************
Getting started
***************

.. code-block:: php

$database = $firestore->database();

``$database`` is an instance of ``Google\Cloud\Firestore\FirestoreClient``. Please refer to the links above for
guidance on how to proceed from here.