AdVideo::create() - Code Metrics - facebook/facebook-php-ads-sdk - Measure and Improve Code Quality continuously with Scrutinizer

AdVideo::create() B
last analyzed 2018-04-03 04:19 UTC

↳ Parent: AdVideo

Complexity

Conditions	4
Paths	8

Size

Total Lines	27
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	27
rs	8.5806
c	0
b	0
f	0
cc	4
eloc	19
nc	8
nop	1

<?php
/**
 * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
 *
 * You are hereby granted a non-exclusive, worldwide, royalty-free license to
 * use, copy, modify, and distribute this software in source code or binary
 * form for use in connection with the web services and APIs provided by
 * Facebook.
 *
 * As with any software that integrates with the Facebook platform, your use
 * of this software is subject to the Facebook Developer Principles and
 * Policies [http://developers.facebook.com/policy/]. This copyright notice
 * shall be included in all copies or substantial portions of the software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 */

namespace FacebookAds\Object;

use FacebookAds\Http\RequestInterface;
use FacebookAds\Object\Fields\AdVideoFields;
use FacebookAds\Object\Traits\CannotDelete;
use FacebookAds\Object\Traits\CannotUpdate;
use FacebookAds\Object\Traits\FieldValidation;

class AdVideo extends AbstractCrudObject {
  use FieldValidation;

  /**
   * @deprecated getEndpoint function is deprecated
   * @return string
   */
  protected function getEndpoint() {
    return 'advideos';
  }

  /**
   * @return AdVideoFields
   */
  public static function getFieldsEnum() {
    return AdVideoFields::getInstance();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
  }

  public function create(array $params = array()) {
    $data = $this->exportData();
    $source = null;
    if (array_key_exists(AdVideoFields::SOURCE, $data)) {
      $source = $data[AdVideoFields::SOURCE];
      unset($data[AdVideoFields::SOURCE]);
    }
    $params = array_merge($data, $params);

    $request = $this->getApi()->prepareRequest(
      '/'.$this->assureParentId().'/'.$this->getEndpoint(),

      RequestInterface::METHOD_POST,
      $params
    );

    $request->setLastLevelDomain('graph-video');
    if ($source) {
      $request->getFileParams()->offsetSet(AdVideoFields::SOURCE, $source);
    }
    $response = $this->getApi()->executeRequest($request);

    $data = $response->getContent();
    $this->data[static::FIELD_ID]
      = is_string($data) ? $data : (string) $data[static::FIELD_ID];

    return $this;
  }

  /**
   * @param array $fields
   * @param array $params
   * @return Cursor
   */
  public function getVideoThumbnails(
    array $fields = array(), array $params = array()) {
    return $this->getManyByConnection(
      VideoThumbnail::className(), $fields, $params, 'thumbnails');
  }

}


1			<?php
2			/**
3			* Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
4			*
5			* You are hereby granted a non-exclusive, worldwide, royalty-free license to
6			* use, copy, modify, and distribute this software in source code or binary
7			* form for use in connection with the web services and APIs provided by
8			* Facebook.
9			*
10			* As with any software that integrates with the Facebook platform, your use
11			* of this software is subject to the Facebook Developer Principles and
12			* Policies [http://developers.facebook.com/policy/]. This copyright notice
13			* shall be included in all copies or substantial portions of the software.
14			*
15			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18			* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20			* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21			* DEALINGS IN THE SOFTWARE.
22			*
23			*/
24
25			namespace FacebookAds\Object;
26
27			use FacebookAds\Http\RequestInterface;
28			use FacebookAds\Object\Fields\AdVideoFields;
29			use FacebookAds\Object\Traits\CannotDelete;
30			use FacebookAds\Object\Traits\CannotUpdate;
31			use FacebookAds\Object\Traits\FieldValidation;
32
33			class AdVideo extends AbstractCrudObject {
34			use FieldValidation;
35
36			/**
37			* @deprecated getEndpoint function is deprecated
38			* @return string
39			*/
40			protected function getEndpoint() {
41			return 'advideos';
42			}
43
44			/**
45			* @return AdVideoFields
46			*/
47			public static function getFieldsEnum() {
48			return AdVideoFields::getInstance();
			0 ignored issues – show Bug Best Practice introduced 2015-11-30 02:21 UTC by Report Bug Copy Issue Report The return type of `return \FacebookAds\Obje...oFields::getInstance();` (`FacebookAds\Object\Fields\AdVideoFields`) is incompatible with the return type of the parent method `FacebookAds\Object\AbstractObject::getFieldsEnum` of type `FacebookAds\Enum\EmptyEnum`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
49			}
50
51			public function create(array $params = array()) {
52			$data = $this->exportData();
53			$source = null;
54			if (array_key_exists(AdVideoFields::SOURCE, $data)) {
55			$source = $data[AdVideoFields::SOURCE];
56			unset($data[AdVideoFields::SOURCE]);
57			}
58			$params = array_merge($data, $params);
59
60			$request = $this->getApi()->prepareRequest(
61			'/'.$this->assureParentId().'/'.$this->getEndpoint(),
			0 ignored issues – show Deprecated Code introduced 2017-04-13 20:50 UTC by Report Bug Copy Issue Report The method `FacebookAds\Object\AdVideo::getEndpoint()` has been deprecated with message: getEndpoint function is deprecated This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
62			RequestInterface::METHOD_POST,
63			$params
64			);
65
66			$request->setLastLevelDomain('graph-video');
67			if ($source) {
68			$request->getFileParams()->offsetSet(AdVideoFields::SOURCE, $source);
69			}
70			$response = $this->getApi()->executeRequest($request);
71
72			$data = $response->getContent();
73			$this->data[static::FIELD_ID]
74			= is_string($data) ? $data : (string) $data[static::FIELD_ID];
75
76			return $this;
77			}
78
79			/**
80			* @param array $fields
81			* @param array $params
82			* @return Cursor
83			*/
84			public function getVideoThumbnails(
85			array $fields = array(), array $params = array()) {
86			return $this->getManyByConnection(
87			VideoThumbnail::className(), $fields, $params, 'thumbnails');
88			}
89
90			}
91

facebook / facebook-php-ads-sdk

AdVideo::create() B last analyzed 2018-04-03 04:19 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AdVideo::create() B
last analyzed 2018-04-03 04:19 UTC