gctools-outilsgc / gcconnex

engine/classes/ElggBatch.php

Doc Comments +1 added lines, -1 removed lines

@@ -174,7 +174,7 @@
 	 * @param array  $options    The options array to pass to the getter function. If limit is
 	 *                           not set, 10 is used as the default. In most cases that is not
 	 *                           what you want.
-	 * @param mixed  $callback   An optional callback function that all results will be passed
+	 * @param null|string  $callback   An optional callback function that all results will be passed
 	 *                           to upon load.  The callback needs to accept $result, $getter,
 	 *                           $options.
 	 * @param int    $chunk_size The number of entities to pull in before requesting more.

engine/classes/ElggData.php

Doc Comments +1 added lines, -1 removed lines

@@ -285,7 +285,7 @@
 	 *
 	 * @param int $offset Offset
 	 *
-	 * @return int
+	 * @return boolean
 	 */
 	public function offsetExists($offset) {
 		return array_key_exists($offset, $this->attributes);

engine/classes/ElggDiskFilestore.php

Doc Comments +5 added lines, -5 removed lines

@@ -107,7 +107,7 @@ 
 	 * @param resource $f    File pointer resource
 	 * @param mixed    $data The data to write.
 	 *
-	 * @return bool
+	 * @return integer
 	 */
 	public function write($f, $data) {
 		return fwrite($f, $data);
@@ -120,7 +120,7 @@ 
 	 * @param int      $length The number of bytes to read
 	 * @param int      $offset The number of bytes to start after
 	 *
-	 * @return mixed Contents of file or false on fail.
+	 * @return string Contents of file or false on fail.
 	 */
 	public function read($f, $length, $offset = 0) {
 		if ($offset) {
@@ -163,7 +163,7 @@ 
 	 * @param resource $f        File resource
 	 * @param int      $position Position in bytes
 	 *
-	 * @return bool
+	 * @return integer
 	 */
 	public function seek($f, $position) {
 		return fseek($f, $position);
@@ -282,7 +282,7 @@ 
 	 * @param string $dirroot The full path of the directory to create
 	 *
 	 * @throws IOException
-	 * @return true
+	 * @return boolean
 	 * @deprecated 1.8 Use \ElggDiskFilestore::makeDirectoryRoot()
 	 */
 	protected function make_directory_root($dirroot) {
@@ -298,7 +298,7 @@ 
 	 * @param string $dirroot The full path of the directory to create
 	 *
 	 * @throws IOException
-	 * @return true
+	 * @return boolean
 	 */
 	protected function makeDirectoryRoot($dirroot) {
 		if (!file_exists($dirroot)) {

engine/classes/ElggEntity.php

Doc Comments +18 added lines, -18 removed lines

@@ -462,7 +462,7 @@ 
 	 * @warning Calling this with no $name will clear all metadata on the entity.
 	 *
 	 * @param null|string $name The name of the metadata to remove.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function deleteMetadata($name = null) {
@@ -487,7 +487,7 @@ 
 	 * If you pass a name, only metadata matching that name will be deleted.
 	 *
 	 * @param null|string $name The name of metadata to delete.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function deleteOwnedMetadata($name = null) {
@@ -513,7 +513,7 @@ 
 	 * @warning Calling this with no or empty arguments will clear all metadata on the entity.
 	 *
 	 * @param string $name The name of the metadata to clear
-	 * @return mixed bool
+	 * @return boolean|null bool
 	 * @deprecated 1.8 Use deleteMetadata()
 	 */
 	public function clearMetadata($name = '') {
@@ -525,7 +525,7 @@ 
 	 * Disables metadata for this entity, optionally based on name.
 	 *
 	 * @param string $name An options name of metadata to disable.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function disableMetadata($name = '') {
@@ -546,7 +546,7 @@ 
 	 * @warning Before calling this, you must use {@link access_show_hidden_entities()}
 	 *
 	 * @param string $name An options name of metadata to enable.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function enableMetadata($name = '') {
@@ -714,7 +714,7 @@ 
 	 * @warning Calling this with no or empty arguments will clear all annotations on the entity.
 	 *
 	 * @param null|string $name The annotations name to remove.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function deleteAnnotations($name = null) {
@@ -734,7 +734,7 @@ 
 	 * If you pass a name, only annotations matching that name will be deleted.
 	 *
 	 * @param null|string $name The name of annotations to delete.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function deleteOwnedAnnotations($name = null) {
@@ -758,7 +758,7 @@ 
 	 * Disables annotations for this entity, optionally based on name.
 	 *
 	 * @param string $name An options name of annotations to disable.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function disableAnnotations($name = '') {
@@ -779,7 +779,7 @@ 
 	 * @warning Before calling this, you must use {@link access_show_hidden_entities()}
 	 *
 	 * @param string $name An options name of annotations to enable.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function enableAnnotations($name = '') {
@@ -896,7 +896,7 @@ 
 	 * all annotations on the entity.
 	 *
 	 * @param string $name Annotation name
-	 * @return bool
+	 * @return boolean|null
 	 * @deprecated 1.8 Use ->deleteAnnotations()
 	 */
 	public function clearAnnotations($name = "") {
@@ -1309,7 +1309,7 @@ 
 	 *
 	 * @param int $container_guid The ID of the container.
 	 *
-	 * @return bool
+	 * @return integer
 	 */
 	public function setContainerGUID($container_guid) {
 		return $this->container_guid = (int)$container_guid;
@@ -1320,7 +1320,7 @@ 
 	 *
 	 * @param int $container_guid The ID of the container.
 	 *
-	 * @return bool
+	 * @return integer
 	 * @deprecated 1.8 use setContainerGUID()
 	 */
 	public function setContainer($container_guid) {
@@ -1438,7 +1438,7 @@ 
 	 * Plugins can register for the 'entity:icon:url', <type> plugin hook
 	 * to customize the icon for an entity.
 	 *
-	 * @param mixed $params A string defining the size of the icon (e.g. tiny, small, medium, large)
+	 * @param string $params A string defining the size of the icon (e.g. tiny, small, medium, large)
 	 *                      or an array of parameters including 'size'
 	 * @return string The URL
 	 * @since 1.8.0
@@ -1822,7 +1822,7 @@ 
 	/**
 	 * Loads attributes from the entities table into the object.
 	 *
-	 * @param mixed $guid GUID of entity or \stdClass object from entities table
+	 * @param stdClass $guid GUID of entity or \stdClass object from entities table
 	 *
 	 * @return bool
 	 */
@@ -2295,7 +2295,7 @@ 
 	 * @param int $year     If ommitted, now is assumed.
 	 * @param int $duration Duration of event, remainder of the day is assumed.
 	 *
-	 * @return true
+	 * @return boolean
 	 * @deprecated 1.9
 	 */
 	public function setCalendarTimeAndDuration($hour = null, $minute = null, $second = null,
@@ -2343,7 +2343,7 @@ 
 	/**
 	 * Returns an array of fields which can be exported.
 	 *
-	 * @return array
+	 * @return string[]
 	 * @deprecated 1.9 Use toObject()
 	 */
 	public function getExportableValues() {
@@ -2455,7 +2455,7 @@ 
 	 *
 	 * @param ODD $data XML data
 	 *
-	 * @return true
+	 * @return boolean
 	 *
 	 * @throws InvalidParameterException
 	 * @deprecated 1.9 Use toObject()
@@ -2499,7 +2499,7 @@ 
 	 * This is used by the system log. It can be called on any Loggable object.
 	 *
 	 * @param int $id GUID.
-	 * @return int GUID
+	 * @return ElggEntity GUID
 	 */
 	public function getObjectFromID($id) {
 		return get_entity($id);

engine/classes/ElggExtender.php

Doc Comments +2 added lines, -2 removed lines

@@ -204,7 +204,7 @@ 
 	/**
 	 * Return an array of fields which can be exported.
 	 *
-	 * @return array
+	 * @return string[]
 	 * @deprecated 1.9 Use toObject()
 	 */
 	public function getExportableValues() {
@@ -223,7 +223,7 @@ 
 	/**
 	 * Export this object
 	 *
-	 * @return array
+	 * @return ODDMetaData
 	 * @deprecated 1.9 Use toObject()
 	 */
 	public function export() {

engine/classes/ElggFile.php

Doc Comments +6 added lines, -6 removed lines

@@ -114,7 +114,7 @@ 
 	 *
 	 * @param string $mimetype The mimetype
 	 *
-	 * @return bool
+	 * @return string
 	 */
 	public function setMimeType($mimetype) {
 		return $this->mimetype = $mimetype;
@@ -125,7 +125,7 @@ 
 	 *
 	 * @note This method can be called both dynamically and statically
 	 *
-	 * @param mixed $file    The full path of the file to check. For uploaded files, use tmp_name.
+	 * @param string $file    The full path of the file to check. For uploaded files, use tmp_name.
 	 * @param mixed $default A default. Useful to pass what the browser thinks it is.
 	 * @since 1.7.12
 	 *
@@ -171,7 +171,7 @@ 
 	 *
 	 * @param string $description The description.
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function setDescription($description) {
 		$this->description = $description;
@@ -221,7 +221,7 @@ 
 	 *
 	 * @param string $data The data
 	 *
-	 * @return bool
+	 * @return integer
 	 */
 	public function write($data) {
 		$fs = $this->getFilestore();
@@ -246,7 +246,7 @@ 
 	/**
 	 * Gets the full contents of this file.
 	 *
-	 * @return mixed The file contents.
+	 * @return string The file contents.
 	 */
 	public function grabFile() {
 		$fs = $this->getFilestore();
@@ -292,7 +292,7 @@ 
 	 *
 	 * @param int $position Position in bytes
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function seek($position) {
 		$fs = $this->getFilestore();

engine/classes/ElggGroup.php

Doc Comments +1 added lines, -1 removed lines

@@ -561,7 +561,7 @@
 	/**
 	 * Return an array of fields which can be exported.
 	 *
-	 * @return array
+	 * @return string[]
 	 * @deprecated 1.9 Use toObject()
 	 */
 	public function getExportableValues() {

engine/classes/ElggMemcache.php

Doc Comments +1 added lines, -1 removed lines

@@ -205,7 +205,7 @@
 	/**
 	 * Clears the entire cache
 	 *
-	 * @return true
+	 * @return boolean
 	 */
 	public function clear() {
 		$result = $this->memcache->flush();

engine/classes/ElggMenuBuilder.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
 	 * Get a prepared menu array
 	 *
 	 * @param mixed $sort_by Method to sort the menu by. @see \ElggMenuBuilder::sort()
-	 * @return array
+	 * @return ElggMenuItem[]
 	 */
 	public function getMenu($sort_by = 'text') {