Requesting specific fields in property collections

In order to speed specific requests up, it is useful to limit the fields you are getting back from the api. This reduces the work done by the api and reduces the memory footprint of objects in your local instance.

To do this you need to use the setFields method on any collection class and supported routes will limit the output according to what you specify.

All field keys can be found from the root endpoint.

    try {

        // Get all the fields for the property endpoint that you can get
        $root = tabs\apiclient\Root::fetch();
        $fields = $root->getScalarfields()['property'];

        // Search for all live properties on the first branding found
        $collection = tabs\apiclient\Collection::factory(
            'property',
            new \tabs\apiclient\Property
        );
        $collection->addFilter('brandingstatusid', 1)
            ->setFields($fields)

            // You can set a large limit when using fields
            ->setLimit(500);
        $collection->fetch();

        echo '<p>' . $collection->getTotal() . ' found</p>';

        // Output the fields from first response.
        foreach ($fields as $field) {
            echo '<p>' . $field . ': ' . $collection->first()->getDataFromResponse($field) . '</p>';
        }

    } catch (Exception $e) {
        echo $e->getMessage();
    }