Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/cache/stores/mongodb/MongoDB/ -> UpdateResult.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

(no description)

File Size: 138 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

UpdateResult:: (6 methods):
  __construct()
  getMatchedCount()
  getModifiedCount()
  getUpsertedCount()
  getUpsertedId()
  isAcknowledged()


Class: UpdateResult  - X-Ref

Result class for an update operation.

__construct(WriteResult $writeResult)   X-Ref
No description

getMatchedCount()   X-Ref
Return the number of documents that were matched by the filter.

This method should only be called if the write was acknowledged.

return: integer|null

getModifiedCount()   X-Ref
Return the number of documents that were modified.

This value is undefined (i.e. null) if the write executed as a legacy
operation instead of command.

This method should only be called if the write was acknowledged.

return: integer|null

getUpsertedCount()   X-Ref
Return the number of documents that were upserted.

This method should only be called if the write was acknowledged.

return: integer|null

getUpsertedId()   X-Ref
Return the ID of the document inserted by an upsert operation.

If the document had an ID prior to upserting (i.e. the server did not
need to generate an ID), this will contain its "_id". Any
server-generated ID will be a MongoDB\BSON\ObjectId instance.

This value is undefined (i.e. null) if an upsert did not take place.

This method should only be called if the write was acknowledged.

return: mixed|null

isAcknowledged()   X-Ref
Return whether this update was acknowledged by the server.

If the update was not acknowledged, other fields from the WriteResult
(e.g. matchedCount) will be undefined and their getter methods should not
be invoked.

return: boolean