gctools-outilsgc / gcconnex

mod/gc_mobile_api/inc/functions.php

Doc Comments +3 added lines

@@ -136,6 +136,9 @@
 	return $text;
 }
 
+/**
+ * @param string $text
+ */
 function clean_text($text)
 {
 	return trim(preg_replace('/ +/', ' ', preg_replace('/[^A-Za-z0-9 ]/', ' ', urldecode(html_entity_decode(strip_tags($text))))));

engine/classes/ElggEntity.php

Doc Comments +19 added lines, -19 removed lines

@@ -269,7 +269,7 @@ 
 	 * Return the value of an attribute or metadata
 	 *
 	 * @param string $name Name
-	 * @return mixed Returns the value of a given value, or null.
+	 * @return string Returns the value of a given value, or null.
 	 * @deprecated 1.9
 	 */
 	public function get($name) {
@@ -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);