Usage example of the Result class

ResultUsage.php

/**
     * The Result class is the default return format of the APIs
     *
     * When you get a Result object (e.g. $r), the recommended way of checking
     * whether or not it contains any values is like so:
     */

        if ($r->count()) {
            // Do something
        }

   
    /**
     * The Result object also implements the Iterator interface,
     * which means it can be iterated, like so:
     */

        foreach ($r as $k => $v) {
            echo 'Key is '.$k.' <br />';
            echo 'Values is '.$v.' <br />';
            echo '<hr />';
        }

    /**
     * You can also extract the array Result contains by doing
     * any of the following:
     */

        $aExtractedValues = $r->data;
        // or
        $aExtractedValues = $r->getData();

    /**
     * When you are returning anything from the APIs, use the following
     * format:
     */

        $myResult = array( /* ... some result here ... */ );
        return new Result($myResult);

    /**
     * If you are returning a subset of a large set of data,
     * set the counter as well so the data can be paginated,
     * like so:
     */

        $mySubset = array( /* ... some result here ... */ );
        $iCount = $this->fetchOne('SELECT FOUND_ROWS()');
        return new Result($mySubset, $iCount);