Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Contribute to GitLab
Sign in
Toggle navigation
M
mongo-php-library
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
sinan
mongo-php-library
Commits
087a53d4
Commit
087a53d4
authored
Apr 09, 2018
by
Katherine Walker
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #523
parents
c8e816b8
fc4d261d
Show whitespace changes
Inline
Side-by-side
Showing
15 changed files
with
272 additions
and
0 deletions
+272
-0
MongoDBModelCollectionInfo-getCappedMax.txt
...erence/method/MongoDBModelCollectionInfo-getCappedMax.txt
+22
-0
MongoDBModelCollectionInfo-getCappedSize.txt
...rence/method/MongoDBModelCollectionInfo-getCappedSize.txt
+21
-0
MongoDBModelCollectionInfo-getName.txt
docs/reference/method/MongoDBModelCollectionInfo-getName.txt
+15
-0
MongoDBModelCollectionInfo-getOptions.txt
...eference/method/MongoDBModelCollectionInfo-getOptions.txt
+26
-0
MongoDBModelCollectionInfo-isCapped.txt
.../reference/method/MongoDBModelCollectionInfo-isCapped.txt
+21
-0
MongoDBModelDatabaseInfo-getName.txt
docs/reference/method/MongoDBModelDatabaseInfo-getName.txt
+15
-0
MongoDBModelDatabaseInfo-getSizeOnDisk.txt
...ference/method/MongoDBModelDatabaseInfo-getSizeOnDisk.txt
+15
-0
MongoDBModelDatabaseInfo-isEmpty.txt
docs/reference/method/MongoDBModelDatabaseInfo-isEmpty.txt
+15
-0
MongoDBModelIndexInfo-getKey.txt
docs/reference/method/MongoDBModelIndexInfo-getKey.txt
+20
-0
MongoDBModelIndexInfo-getName.txt
docs/reference/method/MongoDBModelIndexInfo-getName.txt
+17
-0
MongoDBModelIndexInfo-getNamespace.txt
docs/reference/method/MongoDBModelIndexInfo-getNamespace.txt
+17
-0
MongoDBModelIndexInfo-getVersion.txt
docs/reference/method/MongoDBModelIndexInfo-getVersion.txt
+17
-0
MongoDBModelIndexInfo-isSparse.txt
docs/reference/method/MongoDBModelIndexInfo-isSparse.txt
+17
-0
MongoDBModelIndexInfo-isTtl.txt
docs/reference/method/MongoDBModelIndexInfo-isTtl.txt
+17
-0
MongoDBModelIndexInfo-isUnique.txt
docs/reference/method/MongoDBModelIndexInfo-isUnique.txt
+17
-0
No files found.
docs/reference/method/MongoDBModelCollectionInfo-getCappedMax.txt
View file @
087a53d4
...
@@ -28,6 +28,28 @@ Return Values
...
@@ -28,6 +28,28 @@ Return Values
The document limit for the capped collection. If the collection is not capped,
The document limit for the capped collection. If the collection is not capped,
``null`` will be returned.
``null`` will be returned.
Examples
--------
.. code-block:: php
<?php
$info = new CollectionInfo([
'name' => 'foo',
'options' => [
'capped' => true,
'size' => 1048576,
'max' => 100,
]
]);
var_dump($info->getCappedMax());
The output would then resemble::
int(100)
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelCollectionInfo-getCappedSize.txt
View file @
087a53d4
...
@@ -29,6 +29,27 @@ Return Values
...
@@ -29,6 +29,27 @@ Return Values
The size limit for the capped collection in bytes. If the collection is not
The size limit for the capped collection in bytes. If the collection is not
capped, ``null`` will be returned.
capped, ``null`` will be returned.
Examples
--------
.. code-block:: php
<?php
$info = new CollectionInfo([
'name' => 'foo',
'options' => [
'capped' => true,
'size' => 1048576,
]
]);
var_dump($info->getCappedSize());
The output would then resemble::
int(1048576)
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelCollectionInfo-getName.txt
View file @
087a53d4
...
@@ -26,6 +26,21 @@ Return Values
...
@@ -26,6 +26,21 @@ Return Values
The collection name.
The collection name.
Examples
--------
.. code-block:: php
<?php
$info = new CollectionInfo(['name' => 'foo']);
echo $info->getName();
The output would then resemble::
foo
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelCollectionInfo-getOptions.txt
View file @
087a53d4
...
@@ -28,6 +28,32 @@ Return Values
...
@@ -28,6 +28,32 @@ Return Values
The collection options.
The collection options.
Examples
--------
.. code-block:: php
<?php
$info = new CollectionInfo([
'name' => 'foo',
'options' => [
'capped' => true,
'size' => 1048576,
]
]);
var_dump($info->getOptions());
The output would then resemble::
array(2) {
["capped"]=>
bool(true)
["size"]=>
int(1048576)
}
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelCollectionInfo-isCapped.txt
View file @
087a53d4
...
@@ -27,6 +27,27 @@ Return Values
...
@@ -27,6 +27,27 @@ Return Values
A boolean indicating whether the collection is a capped collection.
A boolean indicating whether the collection is a capped collection.
Examples
--------
.. code-block:: php
<?php
$info = new CollectionInfo([
'name' => 'foo',
'options' => [
'capped' => true,
'size' => 1048576,
]
]);
var_dump($info->isCapped());
The output would then resemble::
bool(true)
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelDatabaseInfo-getName.txt
View file @
087a53d4
...
@@ -26,6 +26,21 @@ Return Values
...
@@ -26,6 +26,21 @@ Return Values
The database name.
The database name.
Examples
--------
.. code-block:: php
<?php
$info = new DatabaseInfo(['name' => 'foo']);
echo $info->getName();
The output would then resemble::
foo
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelDatabaseInfo-getSizeOnDisk.txt
View file @
087a53d4
...
@@ -26,6 +26,21 @@ Return Values
...
@@ -26,6 +26,21 @@ Return Values
The total size of the database file on disk in bytes.
The total size of the database file on disk in bytes.
Examples
--------
.. code-block:: php
<?php
$info = new DatabaseInfo(['sizeOnDisk' => 1048576]);
var_dump($info->getSizeOnDisk());
The output would then resemble::
int(1048576)
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelDatabaseInfo-isEmpty.txt
View file @
087a53d4
...
@@ -26,6 +26,21 @@ Return Values
...
@@ -26,6 +26,21 @@ Return Values
A boolean indicating whether the database has any data.
A boolean indicating whether the database has any data.
Examples
--------
.. code-block:: php
<?php
$info = new DatabaseInfo(['empty' => true]);
var_dump($info->isEmpty());
The output would then resemble::
bool(true)
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelIndexInfo-getKey.txt
View file @
087a53d4
...
@@ -28,6 +28,26 @@ Return Values
...
@@ -28,6 +28,26 @@ Return Values
The index specification as an associative array.
The index specification as an associative array.
Examples
--------
.. code-block:: php
<?php
$info = new IndexInfo([
'key' => ['x' => 1],
]);
var_dump($info->getKey());
The output would then resemble::
array(1) {
["x"]=>
int(1)
}
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelIndexInfo-getName.txt
View file @
087a53d4
...
@@ -29,6 +29,23 @@ Return Values
...
@@ -29,6 +29,23 @@ Return Values
The index name.
The index name.
Examples
--------
.. code-block:: php
<?php
$info = new IndexInfo([
'name' => 'x_1',
]);
echo $info->getName();
The output would then resemble::
x_1
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelIndexInfo-getNamespace.txt
View file @
087a53d4
...
@@ -27,6 +27,23 @@ Return Values
...
@@ -27,6 +27,23 @@ Return Values
The index namespace.
The index namespace.
Examples
--------
.. code-block:: php
<?php
$info = new IndexInfo([
'ns' => 'foo.bar',
]);
echo $info->getNamespace();
The output would then resemble::
foo.bar
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelIndexInfo-getVersion.txt
View file @
087a53d4
...
@@ -26,6 +26,23 @@ Return Values
...
@@ -26,6 +26,23 @@ Return Values
The index version.
The index version.
Examples
--------
.. code-block:: php
<?php
$info = new IndexInfo([
'v' => 1,
]);
var_dump($info->getVersion());
The output would then resemble::
int(1)
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelIndexInfo-isSparse.txt
View file @
087a53d4
...
@@ -28,6 +28,23 @@ Return Values
...
@@ -28,6 +28,23 @@ Return Values
A boolean indicating whether the index is a sparse index.
A boolean indicating whether the index is a sparse index.
Examples
--------
.. code-block:: php
<?php
$info = new IndexInfo([
'sparse' => true,
]);
var_dump($info->isSparse());
The output would then resemble::
bool(true)
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelIndexInfo-isTtl.txt
View file @
087a53d4
...
@@ -28,6 +28,23 @@ Return Values
...
@@ -28,6 +28,23 @@ Return Values
A boolean indicating whether the index is a TTL index.
A boolean indicating whether the index is a TTL index.
Examples
--------
.. code-block:: php
<?php
$info = new IndexInfo([
'expireAfterSeconds' => 100,
]);
var_dump($info->isTtl());
The output would then resemble::
bool(true)
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBModelIndexInfo-isUnique.txt
View file @
087a53d4
...
@@ -28,6 +28,23 @@ Return Values
...
@@ -28,6 +28,23 @@ Return Values
A boolean indicating whether the index is a unique index.
A boolean indicating whether the index is a unique index.
Examples
--------
.. code-block:: php
<?php
$info = new IndexInfo([
'unique' => true,
]);
var_dump($info->isUnique());
The output would then resemble::
bool(true)
See Also
See Also
--------
--------
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment