Implementing the ArrayAccess SPL interface's offsetExists() method - PHP

As you might have guessed, implementing the ArrayAccess interface within the previous "MySQLi_ResultWrapper" class is a straightforward process that can be tackled with minor efforts. Basically, the entire process is reduced to defining the methods declared by this interface and nothing else. It's that simple, really.

However, in this particular case the class will provide a concrete implementation for only two of these methods, as implementing all of them would be a rather pointless task. Having explained that, here's the enhanced version of the "MySQLi_ResultWrapper" class, which now conforms partially to the contract imposed by the ArrayAccess interface:  

class MySQLi_ResultWrapper extends MySQLi_Result implements Iterator, ArrayAccess, Countable

{

    private $_pointer = 0;

   // fetch row as an object

    public function fetchObject()

    {

        if (!$row = $this->fetch_object())

        {

            return NULL;

        }

        return $row;

    }

    // fetch row as an associative array

    public function fetchAssocArray()

    {

        if (!$row = $this->fetch_assoc())

        {

            return NULL;

        }

        return $row;

    }

    // fetch row as an enumerated array

    public function fetchNumArray()

    {

        if (!$row = $this->fetch_row())

        {

            return NULL;

        }

        return $row;

    }

    // fetch all rows

    public function fetchAll($type = MYSQLI_ASSOC)

    {

        if ($type !== MYSQLI_ASSOC AND $type !== MYSQLI_NUM AND $type !== MYSQLI_BOTH)

        {

            $type = MYSQLI_ASSOC;

        }

        if (!$rows = $this->fetch_all($type))

        {

            return NULL;

        }

        return $rows;  

    }

    // get definition information on fields

    public function fetchFieldsInfo()

    {

        if (!$fieldsInfo = $this->fetch_fields())

        {

            throw new Exception('No information available for table fields.');

        }

        return $fieldsInfo;

    }

    // get definition information on next field

    public function fetchFieldInfo()

    {

        if (!$fieldInfo = $this->fetch_field())

        {

            throw new Exception('No information available for current table field.');   

        }

        return $fieldInfo;

    }

    // move pointer in result set to specified offset

    public function movePointer($offset)

    {

        $offset = abs((int)$offset);

        $limit = $this->num_rows - 1;

        if ($limit <= 0 OR $offset > $limit)

        {

            return NULL;

        }

        unset($limit);

        return $this->data_seek($offset);

    }

    // count rows in result set (implementation required by 'count()' method in Countable interface)

    public function count()

    {

        return $this->num_rows;

    }

    // reset result set pointer (implementation required by 'rewind()' method in Iterator interface)

    public function rewind()

    {

        $this->_pointer = 0;

        $this->movePointer($this->_pointer);

        return $this; 

    }

    // get current row set in result set (implementation required by 'current()' method in Iterator interface)

    public function current()

    {

        if (!$this->valid())

        {

            throw new Exception('Unable to retrieve current row.');

        }

        $this->movePointer($this->_pointer);

        return $this->fetchObject();

    }

    // get current result set pointer (implementation required by 'key()' method in Iterator interface)

    public function key()

    {

        return $this->_pointer;

    }

    // move forward result set pointer (implementation required by 'next()' method in Iterator interface)

    public function next()

    {

        ++$this->_pointer;

        $this->movePointer($this->_pointer);

        return $this;

    }

    // determine if result set pointer is valid or not (implementation required by 'valid()' method in Iterator interface)

    public function valid()

    {

        return $this->_pointer < $this->num_rows;

    }

    // determine if the given offset exists (implementation required by 'offsetExists()' method in ArrayAccess interface)

    public function offsetExists($offset)

    {

        $this->movePointer($offset);

        $row = $this->fetchObject();

        return isset($row);

    }

    // free up result set

    public function __destruct()

    {

        $this->close();

    }

}

At this stage, the "MySQLi_ResultWrapper" class only implements one of the four methods declared by the ArrayAccess interface, which turns out to be "offsetExists()." As its name suggests, this method can be used for determining whether or not a specified offset within a given result set is valid, and naturally the resulting Boolean value of this process is returned to client code.

Of course, any attempt to test the class in its current state will raise a fatal error from the PHP engine, so I recommend that you not try to do so for the moment. I'd like to finish this tutorial, though, by adding to the "MySQLi_ResultWrapper" class another method of the ArrayAccess interface -- the one called "offsetSet()."

However, this process will be discussed in detail in the last section. Therefore, to get there click on the link below and keep reading.