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/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') {
 

engine/classes/ElggPlugin.php

Doc Comments +7 added lines, -7 removed lines

@@ -89,7 +89,7 @@ 
 	 * Save the plugin object.  Make sure required values exist.
 	 *
 	 * @see \ElggObject::save()
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function save() {
 		// own by the current site so users can be deleted without affecting plugins
@@ -149,7 +149,7 @@ 
 	 * Sets the location of this plugin.
 	 *
 	 * @param string $id The path to the plugin's dir.
-	 * @return bool
+	 * @return string
 	 */
 	public function setID($id) {
 		return $this->attributes['title'] = $id;
@@ -188,7 +188,7 @@ 
 	/**
 	 * Sets the priority of the plugin
 	 *
-	 * @param mixed $priority  The priority to set. One of +1, -1, first, last, or a number.
+	 * @param string $priority  The priority to set. One of +1, -1, first, last, or a number.
 	 *                         If given a number, this will displace all plugins at that number
 	 *                         and set their priorities +1
 	 * @param mixed $site_guid Optional site GUID.
@@ -458,7 +458,7 @@ 
 	 * @param string $value     The setting value
 	 * @param int    $user_guid The user GUID
 	 *
-	 * @return mixed The new setting ID or false
+	 * @return boolean The new setting ID or false
 	 */
 	public function setUserSetting($name, $value, $user_guid = 0) {
 		$user_guid = (int)$user_guid;
@@ -722,7 +722,7 @@ 
 	 * Start the plugin.
 	 *
 	 * @param int $flags Start flags for the plugin. See the constants in lib/plugins.php for details.
-	 * @return true
+	 * @return boolean
 	 * @throws PluginException
 	 */
 	public function start($flags) {
@@ -825,7 +825,7 @@ 
 	 * Registers the plugin's languages
 	 *
 	 * @throws PluginException
-	 * @return true
+	 * @return boolean
 	 */
 	protected function registerLanguages() {
 		$languages_path = "$this->path/languages";
@@ -849,7 +849,7 @@ 
 	 * Registers the plugin's classes
 	 *
 	 * @throws PluginException
-	 * @return true
+	 * @return boolean
 	 */
 	protected function registerClasses() {
 		$classes_path = "$this->path/classes";