Dominique.Fournier/DomFramework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Update the PHPDocs to modify the invalid types of parameters

Browse Source 
git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@3272 bf3deb0d-5f1a-0410-827f-c0cc1f45334c
This commit is contained in:
Dominique Fournier
2016-12-08 15:33:26 +00:00
parent 1ddc03dcbb
commit 3a004fbdc0
7 changed files with 61 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
dbjson.php
View File

@@ -61,8 +61,8 @@ class dbjson
}
/** Store one document in database
* @param $collection string The collection name
* @param $document array()
* @param string $collection The collection name
* @param array $document The document to insert
* @return integer return The number of document inserted in the database
*/
public function insertOne ($collection, $document)
@@ -79,8 +79,8 @@ class dbjson
}
/** Store multiple documents in database
* @param $collection string The collection name
* @param $documents array(array ())
* @param string $collection The collection name
* @param array documents array(array ())
* @return integer The number of documents inserted in the database
*/
public function insertMany ($collection, $documents)
@@ -107,11 +107,11 @@ class dbjson
* Then return only the $fields (all by default).
* The field _id is always returned
* Return $limit maximum documents (no limit by default)
* @param $collection string The collection name
* @param $filter array The filter to apply to found the documents
* @param $fields array|string The fields to display (* for all, empty array
* @param string $collection The collection name
* @param array $filter The filter to apply to found the documents
* @param array|string $fields The fields to display (* for all, empty array
* for none)
* @param $limit integer The number of documents to display
* @param integer $limit The number of documents to display
* @return array The documents matching the parameters
*/
public function find ($collection, $filter = array (), $fields = "*",
@@ -152,9 +152,9 @@ class dbjson
}
/** Update some existing documents. Do not change the _id keys
* @param $collection string The collection name
* @param $filter array The filter to apply to found the documents
* @param $document array The data to update
* @param string $collection The collection name
* @param array $filter The filter to apply to found the documents
* @param array $document The data to update
* @return integer The number of modified documents
* To unset a field, add in the document array a "_unset"=>array("field)"
*/
@@ -204,9 +204,9 @@ class dbjson
}
/** Replace some existing documents. Do not change the _id keys
* @param $collection string The collection name
* @param $filter array The filter to apply to found the documents
* @param $document array The data to update
* @param string $collection The collection name
* @param array $filter The filter to apply to found the documents
* @param array $document The data to update
* @return integer The number of modified documents
*/
public function replace ($collection, $filter, $document)
@@ -230,8 +230,8 @@ class dbjson
}
/** Delete the first document matching the filter
* @param $collection string The collection name
* @param $filter array The filter to found the documents
* @param string $collection The collection name
* @param array $filter The filter to found the documents
* @return integer The number of deleted documents
*/
public function deleteOne ($collection, $filter)
@@ -253,8 +253,8 @@ class dbjson
}
/** Delete all the documents matching the filter
* @param $collection string The collection name
* @param $filter array The filter to apply to found the documents
* @param string $collection The collection name
* @param array $filter The filter to apply to found the documents
* @return integer The number of deleted documents
*/
public function deleteMany ($collection, $filter)
@@ -273,8 +273,8 @@ class dbjson
/** Look for the keys corresponding to the filter in the collection
* Don't manage the locks !
* @param $collection string The collection name
* @param $filter array The filter to apply to found the documents
* @param string $collection The collection name
* @param array $filter The filter to apply to found the documents
* - A filter is an array containing the fields and the values to found
* array () <== Look for all the documents (no
* filter)
@@ -414,7 +414,7 @@ class dbjson
}
/** Write the dbfile with the provided data. This function don't do locks !
* @param $data array The database to store
* @param array $data The database to store
* @return bool True if the recording is OK, false if there is a problem
*/
private function writeDB ()