Elgg / Elgg

engine/classes/Elgg/ActionsService.php

Doc Comments +8 added lines

@@ -29,6 +29,7 @@ 
 	/**
 	 * @see action
 	 * @access private
+	 * @param string $action
 	 */
 	public function execute($action, $forwarder = "") {
 		$action = rtrim($action, '/');
@@ -91,6 +92,7 @@ 
 	/**
 	 * @see elgg_register_action
 	 * @access private
+	 * @param string $action
 	 */
 	public function register($action, $filename = "", $access = 'logged_in') {
 		// plugins are encouraged to call actions with a trailing / to prevent 301
@@ -117,6 +119,7 @@ 
 	/**
 	 * @see elgg_unregister_action
 	 * @access private
+	 * @param string $action
 	 */
 	public function unregister($action) {
 		if (isset($this->actions[$action])) {
@@ -225,6 +228,7 @@ 
 	/**
 	 * @see action_gatekeeper
 	 * @access private
+	 * @param string $action
 	 */
 	public function gatekeeper($action) {
 		if ($action === 'login') {
@@ -294,6 +298,7 @@ 
 	/**
 	 * @see elgg_action_exists
 	 * @access private
+	 * @param string $action
 	 */
 	public function exists($action) {
 		return (isset($this->actions[$action]) && file_exists($this->actions[$action]['file']));
@@ -302,6 +307,9 @@ 
 	/**
 	 * @see ajax_forward_hook
 	 * @access private
+	 * @param string $hook
+	 * @param string $reason
+	 * @param string $return
 	 */
 	public function ajaxForwardHook($hook, $reason, $return, $params) {
 		if (elgg_is_xhr()) {

engine/classes/Elgg/AttributeLoader.php

Doc Comments +2 added lines, -2 removed lines

@@ -131,7 +131,7 @@ 
 	 * Get primary attributes missing that are missing
 	 *
 	 * @param \stdClass $row Database row
-	 * @return array
+	 * @return boolean
 	 */
 	protected function isMissingPrimaries($row) {
 		return array_diff(self::$primary_attr_names, array_keys($row)) !== array();
@@ -141,7 +141,7 @@ 
 	 * Get secondary attributes that are missing
 	 *
 	 * @param \stdClass $row Database row
-	 * @return array
+	 * @return boolean
 	 */
 	protected function isMissingSecondaries($row) {
 		return array_diff($this->secondary_attr_names, array_keys($row)) !== array();

engine/classes/Elgg/Database.php

Doc Comments +3 added lines, -3 removed lines

@@ -186,7 +186,7 @@ 
 	 * @param mixed  $query    The query to execute.
 	 * @param string $callback A callback function
 	 *
-	 * @return mixed A single database result object or the result of the callback function.
+	 * @return \stdClass A single database result object or the result of the callback function.
 	 * @throws \DatabaseException
 	 */
 	public function getDataRow($query, $callback = '') {
@@ -200,7 +200,7 @@ 
 	 *
 	 * @param mixed $query The query to execute.
 	 *
-	 * @return int|false The database id of the inserted row if a AUTO_INCREMENT field is
+	 * @return integer The database id of the inserted row if a AUTO_INCREMENT field is
 	 *                   defined, 0 if not, and false on failure.
 	 * @throws \DatabaseException
 	 */
@@ -384,7 +384,7 @@ 
 	 * @param string   $query  The query
 	 * @param resource $dblink The DB link
 	 *
-	 * @return resource|bool The result of mysql_query()
+	 * @return resource The result of mysql_query()
 	 * @throws \DatabaseException
 	 * @todo should this be public?
 	 */

engine/classes/Elgg/Database/Annotations.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 	 *
 	 * @param int $id The id of the annotation object being retrieved.
 	 *
-	 * @return \ElggAnnotation|false
+	 * @return \ElggExtender
 	 */
 	function get($id) {
 		return _elgg_get_metastring_based_object_from_id($id, 'annotation');

engine/classes/Elgg/Database/Datalist.php

Doc Comments +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
 	 * @tip Use datalists to store information common to a full installation.
 	 *
 	 * @param string $name The name of the datalist
-	 * @return string|null|false String if value exists, null if doesn't, false on error
+	 * @return string String if value exists, null if doesn't, false on error
 	 * @access private
 	 */
 	function get($name) {

engine/classes/Elgg/Database/MetadataTable.php

Doc Comments +3 added lines, -3 removed lines

@@ -76,7 +76,7 @@ 
 	 *
 	 * @param int $id The id of the metadata object being retrieved.
 	 *
-	 * @return \ElggMetadata|false  false if not found
+	 * @return \ElggExtender  false if not found
 	 */
 	function get($id) {
 		return _elgg_get_metastring_based_object_from_id($id, 'metadata');
@@ -767,7 +767,7 @@ 
 	 *
 	 * @param int $id Metadata ID
 	 *
-	 * @return mixed
+	 * @return string|false
 	 */
 	function getUrl($id) {
 		$extender = $this->get($id);
@@ -817,7 +817,7 @@ 
 	 * @param string      $object_type The type of object
 	 * @param \ElggEntity $object      The entity itself
 	 *
-	 * @return true
+	 * @return boolean
 	 * @access private Set as private in 1.9.0
 	 */
 	function handleUpdate($event, $object_type, $object) {

engine/classes/Elgg/Database/SiteSecret.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
 	 *
 	 * Note: Old secrets were hex encoded.
 	 *
-	 * @return mixed The site secret hash or false
+	 * @return string|false The site secret hash or false
 	 * @access private
 	 */
 	function init() {

engine/classes/Elgg/EventsService.php

Doc Comments +1 added lines

@@ -23,6 +23,7 @@
 	 * @see elgg_trigger_event
 	 * @see elgg_trigger_after_event
 	 * @access private
+	 * @param string $type
 	 */
 	public function trigger($event, $type, $object = null, array $options = array()) {
 		$options = array_merge(array(

engine/classes/Elgg/Filesystem/GaufretteDirectory.php

Doc Comments +2 added lines, -2 removed lines

@@ -138,7 +138,7 @@ 
 	 * 
 	 * @param string $path absolute path to directory on local filesystem.
 	 * 
-	 * @return Filesystem
+	 * @return GaufretteDirectory
 	 */
 	public static function createLocal($path) {
 		return new self(new Gaufrette(new Local($path)), $path);
@@ -147,7 +147,7 @@ 
 	/**
 	 * Shorthand for generating a new in-memory-only filesystem.
 	 * 
-	 * @return Filesystem
+	 * @return GaufretteDirectory
 	 */
 	public static function createInMemory() {
 		return new self(new Gaufrette(new InMemory()));