blog.php ➔ save_blog() - Code Metrics - Inspection of "updated api" - gctools-outilsgc/gcconnex - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — api-test ( c6440b...e52d76 )

unknown
created 2018-05-22 12:32 UTC
blog.php ➔ save_blog() F

↳ Parent: Project
Complexity

Conditions	62
Paths	> 20000
Size

Total Lines	173
Code Lines	115
Duplication

Lines	34
Ratio	19.65 %
Importance

Changes
Metric	Value
cc	62
eloc	115
nc	13471776
nop	10
dl	34
loc	173
rs	2
c	0
b	0
f	0
How to fix Long Method Complexity Many Parameters

<?php
/*
 * Exposes API endpoints for Blog entities
 */

elgg_ws_expose_function(
	"get.blogpost",
	"get_blogpost",
	array(
		"user" => array('type' => 'string', 'required' => true),
		"guid" => array('type' => 'int', 'required' => true),
		"lang" => array('type' => 'string', 'required' => false, 'default' => "en")
	),
	'Retrieves a blog post & all replies based on user id and blog post id',
	'POST',
	true,
	false
);

elgg_ws_expose_function(
	"get.blogposts",
	"get_blogposts",
	array(
		"user" => array('type' => 'string', 'required' => true),
		"limit" => array('type' => 'int', 'required' => false, 'default' => 10),
		"offset" => array('type' => 'int', 'required' => false, 'default' => 0),
		"filters" => array('type' => 'string', 'required' => false, 'default' => ""),
		"lang" => array('type' => 'string', 'required' => false, 'default' => "en")
	),
	'Retrieves blog posts & all replies based on user id',
	'POST',
	true,
	false
);

elgg_ws_expose_function(
	"get.blogpostsbyowner",
	"get_blogposts_by_owner",
	array(
		"user" => array('type' => 'string', 'required' => true),
		"limit" => array('type' => 'int', 'required' => false, 'default' => 10),
		"offset" => array('type' => 'int', 'required' => false, 'default' => 0),
		"lang" => array('type' => 'string', 'required' => false, 'default' => "en"),
		"target" => array('type' => 'string', 'required'=> false, 'default' => '')
	),
	'Retrieves blog posts & all replies based on user id',
	'POST',
	true,
	false
);

elgg_ws_expose_function(
 "get.blogpostsbycolleague",
 "get_blogposts_by_colleague",
 array(
	"user" => array('type' => 'string', 'required' => true),
	"limit" => array('type' => 'int', 'required' => false, 'default' => 10),
	"offset" => array('type' => 'int', 'required' => false, 'default' => 0),
	"lang" => array('type' => 'string', 'required' => false, 'default' => "en")
 ),
 'Retrieves a container\'s blogs based on user id and container guid. Used for groups, as a group\'s blogs have container_id of the group.',
 'POST',
 true,
 false
);

elgg_ws_expose_function(
 "get.blogpostsbycontainer",
 "get_blogposts_by_container",
 array(
	 "user" => array('type' => 'string', 'required' => true),
	 "guid" => array('type' => 'int', 'required' => true),
	 "limit" => array('type' => 'int', 'required' => false, 'default' => 10),
	 "offset" => array('type' => 'int', 'required' => false, 'default' => 0),
	 "lang" => array('type' => 'string', 'required' => false, 'default' => "en")
 ),
 'Retrieves a container\'s blogs based on user id and container guid. Used for groups, as a group\'s blogs have container_id of the group.',
 'POST',
 true,
 false
);

elgg_ws_expose_function(
 "get.blogedit",
 "get_blog_edit",
 array(
	 "user" => array('type' => 'string', 'required' => true),
	 "guid" => array('type' => 'int', 'required' => true),
	 "lang" => array('type' => 'string', 'required' => false, 'default' => "en")
 ),
 'Retrieves a blog post based on user id and blog post id, with only info needed for edit form',
 'POST',
 true,
 false
);

elgg_ws_expose_function(
 "save.blog",
 "save_blog",
 array(
	 "user" => array('type' => 'string', 'required' => true),
	 "title" => array('type' => 'string', 'required' => true),
	 "excerpt" => array('type' =>'string', 'required' => false, 'default' => ''),
	 "body" => array('type' =>'string', 'required' => true),
	 "container_guid" => array('type' =>'string', 'required' => false, 'default' => ''),
	 "blog_guid" => array('type' =>'string', 'required' => false, 'default' => ''),
	 "comments" => array('type' =>'int', 'required' => false, 'default' => 1),
	 "access" => array('type' =>'int', 'required' => false, 'default' => 1),
	 "status" => array('type' =>'int', 'required' => false, 'default' => 0),
	 "lang" => array('type' => 'string', 'required' => false, 'default' => "en")
 ),
 'Posts/Saves a blog post',
 'POST',
 true,
 false
);

function foreach_blogs($blogs, $user_entity, $lang)
{
	foreach ($blogs as $blog_post) {
		$blog_post->title = gc_explode_translation($blog_post->title, $lang);
		$blog_post->description = gc_explode_translation($blog_post->description, $lang);

		$likes = elgg_get_annotations(array(
			'guid' => $blog_post->guid,
			'annotation_name' => 'likes'
		));
		$blog_post->likes = count($likes);

		$liked = elgg_get_annotations(array(
			'guid' => $blog_post->guid,
			'annotation_owner_guid' => $user_entity->guid,
			'annotation_name' => 'likes'
		));
		$blog_post->liked = count($liked) > 0;

		$blog_post->comments = get_entity_comments($blog_post->guid);

		$blog_post->userDetails = get_user_block($blog_post->owner_guid, $lang);

		$group = get_entity($blog_post->container_guid);
		$blog_post->group = gc_explode_translation($group->name, $lang);

		if (is_callable(array($group, 'getURL'))) {
			$blog_post->groupURL = $group->getURL();
		}
	}
	return $blogs;
}

function get_blogpost($user, $guid, $lang)
{
	$user_entity = is_numeric($user) ? get_user($user) : (strpos($user, '@') !== false ? get_user_by_email($user)[0] : get_user_by_username($user));
	if (!$user_entity) {
		return "User was not found. Please try a different GUID, username, or email address";
	}
	if (!$user_entity instanceof ElggUser) {
		return "Invalid user. Please try a different GUID, username, or email address";
	}

	$entity = get_entity($guid);
	if (!isset($entity)) {
		return "Blog was not found. Please try a different GUID";
	}

	if (!elgg_is_logged_in()) {
		login($user_entity);
	}

	$blog_posts = elgg_list_entities(array(
		'type' => 'object',
		'subtype' => 'blog',
		'guid' => $guid
	));
	$blog_post = json_decode($blog_posts)[0];

	$blog_post->title = gc_explode_translation($blog_post->title, $lang);
	$blog_post->description = gc_explode_translation($blog_post->description, $lang);

	$likes = elgg_get_annotations(array(
		'guid' => $blog_post->guid,
		'annotation_name' => 'likes'
	));
	$blog_post->likes = count($likes);

	$liked = elgg_get_annotations(array(
		'guid' => $blog_post->guid,
		'annotation_owner_guid' => $user_entity->guid,
		'annotation_name' => 'likes'
	));
	$blog_post->liked = count($liked) > 0;

	$blog_post->comments = get_entity_comments($blog_post->guid);

	$blog_post->userDetails = get_user_block($blog_post->owner_guid, $lang);

	$group = get_entity($blog_post->container_guid);
	$blog_post->group = gc_explode_translation($group->name, $lang);

	if (is_callable(array($group, 'getURL'))) {
		$blog_post->groupURL = $group->getURL();
	}

	return $blog_post;
}

function get_blogposts($user, $limit, $offset, $filters, $lang)
{
	$user_entity = is_numeric($user) ? get_user($user) : (strpos($user, '@') !== false ? get_user_by_email($user)[0] : get_user_by_username($user));
	if (!$user_entity) {
		return "User was not found. Please try a different GUID, username, or email address";
	}
	if (!$user_entity instanceof ElggUser) {
		return "Invalid user. Please try a different GUID, username, or email address";
	}

	if (!elgg_is_logged_in()) {
		login($user_entity);
	}

	$filter_data = json_decode($filters);
	if (!empty($filter_data)) {
		$params = array(
			'type' => 'object',
			'subtype' => 'blog',
			'limit' => $limit,
			'offset' => $offset
		);

		if ($filter_data->name) {
			$db_prefix = elgg_get_config('dbprefix');
			$params['joins'] = array("JOIN {$db_prefix}objects_entity oe ON e.guid = oe.guid");
			$params['wheres'] = array("(oe.title LIKE '%" . $filter_data->name . "%' OR oe.description LIKE '%" . $filter_data->name . "%')");
		}

		$all_blog_posts = elgg_list_entities_from_metadata($params);
	} else {
		$all_blog_posts = elgg_list_entities(array(
			'type' => 'object',
			'subtype' => 'blog',
			'limit' => $limit,
			'offset' => $offset
		));
	}

	$blog_posts = json_decode($all_blog_posts);

	$blogs = foreach_blogs($blog_posts, $user_entity, $lang);

	return $blogs;
}

function get_blogposts_by_owner($user, $limit, $offset, $lang, $target)
{
	$user_entity = is_numeric($user) ? get_user($user) : (strpos($user, '@') !== false ? get_user_by_email($user)[0] : get_user_by_username($user));
	if (!$user_entity) {
		return "User was not found. Please try a different GUID, username, or email address";
	}
	if (!$user_entity instanceof ElggUser) {
		return "Invalid user. Please try a different GUID, username, or email address";
	}

	$target_entity = $user_entity;
	if (!empty($target)){
		$target_entity =  is_numeric($target) ? get_user($target) : (strpos($target, '@') !== false ? get_user_by_email($target)[0] : get_user_by_username($target));
		if (!$target_entity) {
			return "Target user was not found. Please try a different GUID, username, or email address";
		}
		if (!$target_entity instanceof ElggUser) {
			return "Invalid target user. Please try a different GUID, username, or email address";
		}
	}

	if (!elgg_is_logged_in()) {
		login($user_entity);
	}

	$all_blog_posts = elgg_list_entities(array(
		'type' => 'object',
		'subtype' => 'blog',
		'owner_guid' => $target_entity->guid,
		'limit' => $limit,
		'offset' => $offset
	));

	$blog_posts = json_decode($all_blog_posts);

	$blogs = foreach_blogs($blog_posts, $user_entity, $lang);

	return $blogs;
}

function get_blogposts_by_colleague($user, $limit, $offset, $lang, $target)
{
 $user_entity = is_numeric($user) ? get_user($user) : (strpos($user, '@') !== false ? get_user_by_email($user)[0] : get_user_by_username($user));
 if (!$user_entity) {
	 return "User was not found. Please try a different GUID, username, or email address";
 }
 if (!$user_entity instanceof ElggUser) {
	 return "Invalid user. Please try a different GUID, username, or email address";
 }

 if (!elgg_is_logged_in()) {
	 login($user_entity);
 }

 $all_blog_posts = elgg_list_entities_from_relationship(array(
	 'type' => 'object',
	 'subtype' => 'blog',
	 'relationship' => 'friend',
	 'relationship_guid' => $user_entity->guid,
	 'relationship_join_on' => 'container_guid',
	 'limit' => $limit,
	 'offset' => $offset
 ));

 $blog_posts = json_decode($all_blog_posts);

 $blogs = foreach_blogs($blog_posts, $user_entity, $lang);

 return $blogs;
}


function get_blogposts_by_container($user, $guid, $limit, $offset, $lang)
{
 $user_entity = is_numeric($user) ? get_user($user) : (strpos($user, '@') !== false ? get_user_by_email($user)[0] : get_user_by_username($user));
 if (!$user_entity) {
	 return "User was not found. Please try a different GUID, username, or email address";
 }
 if (!$user_entity instanceof ElggUser) {
	 return "Invalid user. Please try a different GUID, username, or email address";
 }
 if (!elgg_is_logged_in()) {
	 login($user_entity);
 }

 $group = get_entity($guid);
 if (!$group) {
	 return "Group was not found. Please try a different GUID";
 }
 if (!$group instanceof ElggGroup) {
	 return "Invalid group. Please try a different GUID";
 }

 $all_blog_posts = elgg_list_entities(array(
	 'type' => 'object',
	 'subtype' => 'blog',
	 'container_guid' => $guid,
	 'limit' => $limit,
	 'offset' => $offset,
	 'order_by' => 'e.last_action desc'
 ));

 $blog_posts = json_decode($all_blog_posts);

 $blogs_final = foreach_blogs($blog_posts, $user_entity, $lang);

 return $blogs_final;
}

function get_blog_edit($user, $guid, $lang)
{
 $user_entity = is_numeric($user) ? get_user($user) : (strpos($user, '@') !== false ? get_user_by_email($user)[0] : get_user_by_username($user));
 if (!$user_entity) {
	 return "User was not found. Please try a different GUID, username, or email address";
 }
 if (!$user_entity instanceof ElggUser) {
	 return "Invalid user. Please try a different GUID, username, or email address";
 }

 $entity = get_entity($guid);
 if (!isset($entity)) {
	 return "Blog was not found. Please try a different GUID";
 }

 if (!elgg_is_logged_in()) {
	 login($user_entity);
 }

 $blog_posts = elgg_list_entities(array(
	 'type' => 'object',
	 'subtype' => 'blog',
	 'guid' => $guid
 ));
 $blog_post = json_decode($blog_posts)[0];

 $blog_post->title = json_decode($blog_post->title);
 //$blog_post->excerpt = json_decode($blog_post->excerpt); //not correct
 $blog_post->description = json_decode($blog_post->description);

 $container = get_entity($blog_post->container_guid);
 if ($container instanceof ElggGroup){
	 $blog_post->group->public = $container->isPublicMembership();
	 if (!$blog_post->group->public && !$container->isMember($user_entity)){
		return elgg_echo('discussion:error:permissions');
	 }
 }

 if (is_callable(array($group, 'getURL'))) {
	 $blog_post->groupURL = $group->getURL();

 }

 return $blog_post;
}

function save_blog($user, $title, $excerpt, $body, $container_guid, $blog_guid, $comments, $access, $status, $lang)
{
 $user_entity = is_numeric($user) ? get_user($user) : (strpos($user, '@') !== false ? get_user_by_email($user)[0] : get_user_by_username($user));
	 if (!$user_entity) {
		 return "User was not found. Please try a different GUID, username, or email address";
	 }
	 if (!$user_entity instanceof ElggUser) {
		 return "Invalid user. Please try a different GUID, username, or email address";
	 }
	 if (!elgg_is_logged_in()) {
		 login($user_entity);
	 }
	 $error = FALSE;
	 //check required fields being not empty
	 $titles = json_decode($title);
	 $bodies = json_decode($body);
	 $excerpts = json_decode($excerpt);
	 //Check Required
	 if (!$titles->en && !$titles->fr) { return elgg_echo("blog:error:missing:title"); }
	 if (!$bodies->en && !$bodies->fr) { return elgg_echo("blog:error:missing:description");  }
	 if (!($titles->en && $bodies->en) && !($titles->fr && $bodies->fr)) { return "require-same-lang"; }
	 //Default any Missing or faulty
	 if (!$titles->en) { $titles->en = ''; }
	 if (!$titles->fr) { $titles->fr = ''; }
	 if (!$bodies->en) { $bodies->en = ''; }
	 if (!$bodies->fr) { $bodies->fr = ''; }
	 if (!$excerpts->en) { $excerpts->en = ''; }
	 if (!$excerpts->fr) { $excerpts->fr = ''; }
	 if ($comments != 0 && $comments != 1) { $comments = 1; }
	 if ($access != 0 && $access != 1 && $access != -2 && $access !=2 ) { $access = 1; }
	 if ($status != 0 && $status != 1) { $status = 0; }

	 // if there is a container_guid, .: group, and access is set to group only, set access to proper group only
	 if (!empty($container_guid) && $access == 2){
		 $container = get_entity($container_guid);
		 //validate container and ability to write to it
		 if (!$container || !$container->canWriteToContainer(0, 'object', 'blog')) {
 			return elgg_echo('blog:error:cannot_write_to_container');
 		} else {
			$access = $container->group_acl;
		}
		 //If no group container, use user guid.
	 } else if ($container_guid=='') { $container_guid = $user_entity->guid; }

	 //Set int variables to correct
	 if ($status == 1) { $status = 'published'; } else { $status = 'draft'; }
	 if ($comments == 1) { $comments = 'On'; } else { $comments = 'Off'; }
	 if ($status == 'draft') { $access = 0; }
	 $titles->en = htmlspecialchars($titles->en, ENT_QUOTES, 'UTF-8');
	 $titles->fr = htmlspecialchars($titles->fr, ENT_QUOTES, 'UTF-8');
	 $excerpts->en = elgg_get_excerpt($excerpts->en);
	 $excerpts->fr = elgg_get_excerpt($excerpts->fr);

	 $values = array(
		 'title' => JSON_encode($titles),
		 'title2' => '',
		 //'title3' => '',
		 'description' => JSON_encode($bodies),
		 'description2' => '',
		 'description3' => '',
		 'status' => $status,
		 'access_id' => $access,
		 'comments_on' => $comments,
		 'excerpt' => JSON_encode($excerpts),
		 'excerpt2' => '',
		 'excerpt3' => '',
		 'tags' => '',
		 'publication_date' => '',
		 'expiration_date' => '',
		 'show_owner' => 'no'
	 );

	 $blog = new stdClass();
	 $revision_text = '';
	 if ($blog_guid){
		 $entity = get_entity($blog_guid);
		 if (elgg_instanceof($entity, 'object', 'blog') && $entity->canEdit()) {
			 	$blog = $entity;
		 } else {
			 return elgg_echo('blog:error:post_not_found');
		 }
		 $revision_text = $blog->description;
		 $new_post = $blog->new_post; //what?
	 } else {
		 //Create blog
		 $blog = new ElggBlog();
		 $blog->subtype = 'blog';
		 $blog->container_guid = $container_guid;
		 $new_post = TRUE;
	 }

	 $old_status = $blog->status;

	 // assign values to the entity, stopping on error.
	 if (!$error) {
		 foreach ($values as $name => $value) {
			 if (($name != 'title2') && ($name != 'description2') &&  ($name != 'excerpt2')){ // remove input 2 in metastring table
			 $blog->$name = $value;
			 }
		 }
	 }

	 if (!$error){
		 if ($blog->save()){

				 $icon_file = get_resized_image_from_uploaded_file("icon", 100, 100);
				 $icon_sizes = elgg_get_config("icon_sizes");

				 if (!empty($icon_file) && !empty($icon_sizes)) {
					 // create icon
					 $prefix = "blogs/" . $blog->getGUID();

					 $fh = new ElggFile();
					 $fh->owner_guid = $blog->getOwnerGUID();

					 foreach ($icon_sizes as $icon_name => $icon_info) {
						 $icon_file = get_resized_image_from_uploaded_file("icon", $icon_info["w"], $icon_info["h"], $icon_info["square"], $icon_info["upscale"]);
						 if (!empty($icon_file)) {
							 $fh->setFilename($prefix . $icon_name . ".jpg");

							 if ($fh->open("write")) {
								 $fh->write($icon_file);
								 $fh->close();
							 }
						 }
					 }

					 $blog->icontime = time();
			 }

			 // remove autosave draft if exists
			 $blog->deleteAnnotations('blog_auto_save');
			 // no longer a brand new post.
			 $blog->deleteMetadata('new_post');
			 if (!$new_post && $revision_text) {
				 $blog->annotate('blog_revision', $revision_text);
			 }

			 $status = $blog->status;
				 // add to river if changing status or published, regardless of new post
				 // because we remove it for drafts.
				 if (($new_post || $old_status == 'draft' ||  $old_status == 'published') && $status == 'published') {
					 elgg_create_river_item(array(
						 'view' => 'river/object/blog/create',
						 'action_type' => 'create',
						 'subject_guid' => $blog->owner_guid,
						 'object_guid' => $blog->getGUID(),
					 ));
					 // we only want notifications sent when post published
					 elgg_trigger_event('publish', 'object', $blog);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

					 // reset the creation time for posts that move from draft to published
					 if ($guid) {

						 $blog->time_created = time();
						 $blog->save();
					 }
				 } elseif ($old_status == 'published' && $status == 'draft') {
					 elgg_delete_river(array(
						 'object_guid' => $blog->guid,
						 'action_type' => 'create',
					 ));
				 }
				 if ($blog->status == 'published' || $save == false) {

					 return ($blog->getURL());
				 } else {
					 return ("blog/edit/$blog->guid");
				 }

		 } else {
			 return elgg_echo('blog:error:cannot_save');
		 }
	 }
}

gctools-outilsgc / gcconnex

Push — api-test ( c6440b...e52d76 )

blog.php ➔ save_blog() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity Many Parameters

Long Method

Many Parameters

Duplication Side-by-Side

Filter issues like
