function.renderDocument.php ➔ renderDocument() - Code Metrics - Inspection of "Minor tweaks to readme and license" - jenskooij/cloudcontrol - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 9c6499...a5e1bf )

by Jens

created 2017-08-23 14:45 UTC

function.renderDocument.php ➔ renderDocument() C

↳ Parent: Project

Complexity

Conditions	7
Paths	16

Size

Total Lines	49
Code Lines	41

Duplication

Lines	15
Ratio	30.61 %

Importance

Changes

Metric	Value
cc	7
eloc	41
nc	16
nop	4
dl	15
loc	49
rs	6.7272
c	0
b	0
f	0

<?
/**
 * @param CloudControl\Cms\storage\Document $document
 * @param string $cmsPrefix
 * @param string $slugPrefix
 * @param \CloudControl\Cms\cc\Request $request
 */
function renderDocument($document, $cmsPrefix, $slugPrefix = '', $request)
{ ?>
  <div class="grid-box-10">
    <h3>
      <a class="btn documentTitle" href="<?= $request::$subfolders ?><?= $cmsPrefix ?>/documents/edit-document?slug=<?= $slugPrefix . $document->slug ?>" title="Edit">
        <i class="fa fa-file-text-o"></i>
        <small class="state <?= strtolower($document->state) ?>">
          <i class="fa <?= $document->state == 'published' ? 'fa-check-circle-o' : 'fa-times-circle-o' ?>"></i></small>
          <?= $document->title ?>
      </a>
        <? if ($document->unpublishedChanges) : ?>
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
          <small class="small unpublished-changes">Unpublished Changes</small><? endif ?>
      <small class="small documentType"><?= $document->documentType ?></small>
      <small class="small lastModified" title="<?= date('r', $document->lastModificationDate) ?>">
        <span class="label">Modified:</span>
          <?= \CloudControl\Cms\cc\StringUtil::timeElapsedString($document->lastModificationDate) ?>
      </small>
      <small class="small lastModifiedBy">
        <span class="label">By:</span>
          <?= $document->lastModifiedBy ?>
      </small>
    </h3>
  </div>
  <div class="documentActions grid-box-2">
      <? if ($document->state == 'unpublished' || $document->unpublishedChanges) : ?>
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
          <? renderAction('Publish',
              'publish',
              $request::$subfolders . $cmsPrefix . '/documents/publish-document?slug=' . $slugPrefix . $document->slug,
              'check'); ?>
      <? endif ?>
      <? if ($document->state == 'published') : ?>
          <? renderAction('Unpublish',
              'unpublish',
              $request::$subfolders . $cmsPrefix . '/documents/unpublish-document?slug=' . $slugPrefix . $document->slug,
              'times'); ?>
      <? endif ?>
      <? renderAction('Edit',
          '',
          $request::$subfolders . $cmsPrefix . '/documents/edit-document?slug=' . $slugPrefix . $document->slug,
          'pencil'); ?>
      <? if ($document->state == 'unpublished') : ?>

          <? renderAction('Delete',
              'error',
              $request::$subfolders . $cmsPrefix . '/documents/delete-document?slug=' . $slugPrefix . $document->slug,
              'trash',
              'return confirm(\'Are you sure you want to delete this document?\');'); ?>
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
      <? endif ?>
  </div>
<? } ?>


1		<?
2		/**
3		* @param CloudControl\Cms\storage\Document $document
4		* @param string $cmsPrefix
5		* @param string $slugPrefix
6		* @param \CloudControl\Cms\cc\Request $request
7		*/
8		function renderDocument($document, $cmsPrefix, $slugPrefix = '', $request)
9		{ ?>
10		<div class="grid-box-10">
11		<h3>
12		<a class="btn documentTitle" href="<?= $request::$subfolders ?><?= $cmsPrefix ?>/documents/edit-document?slug=<?= $slugPrefix . $document->slug ?>" title="Edit">
13		<i class="fa fa-file-text-o"></i>
14		<small class="state <?= strtolower($document->state) ?>">
15		<i class="fa <?= $document->state == 'published' ? 'fa-check-circle-o' : 'fa-times-circle-o' ?>"></i></small>
16		<?= $document->title ?>
17		</a>
18		<? if ($document->unpublishedChanges) : ?>
		0 ignored issues – show Documentation introduced 2017-08-23 14:48 UTC by Report Bug Copy Issue Report The property `unpublishedChanges` does not exist on `object<CloudControl\Cms\storage\Document>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
19		<small class="small unpublished-changes">Unpublished Changes</small><? endif ?>
20		<small class="small documentType"><?= $document->documentType ?></small>
21		<small class="small lastModified" title="<?= date('r', $document->lastModificationDate) ?>">
22		<span class="label">Modified:</span>
23		<?= \CloudControl\Cms\cc\StringUtil::timeElapsedString($document->lastModificationDate) ?>
24		</small>
25		<small class="small lastModifiedBy">
26		<span class="label">By:</span>
27		<?= $document->lastModifiedBy ?>
28		</small>
29		</h3>
30		</div>
31		<div class="documentActions grid-box-2">
32	View Code Duplication	<? if ($document->state == 'unpublished' \|\| $document->unpublishedChanges) : ?>
		0 ignored issues – show Documentation introduced 2017-08-23 14:48 UTC by Report Bug Copy Issue Report The property `unpublishedChanges` does not exist on `object<CloudControl\Cms\storage\Document>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Duplication introduced 2017-03-27 13:41 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
33		<? renderAction('Publish',
34		'publish',
35		$request::$subfolders . $cmsPrefix . '/documents/publish-document?slug=' . $slugPrefix . $document->slug,
36		'check'); ?>
37		<? endif ?>
38		<? if ($document->state == 'published') : ?>
39		<? renderAction('Unpublish',
40		'unpublish',
41		$request::$subfolders . $cmsPrefix . '/documents/unpublish-document?slug=' . $slugPrefix . $document->slug,
42		'times'); ?>
43		<? endif ?>
44		<? renderAction('Edit',
45		'',
46		$request::$subfolders . $cmsPrefix . '/documents/edit-document?slug=' . $slugPrefix . $document->slug,
47		'pencil'); ?>
48	View Code Duplication	<? if ($document->state == 'unpublished') : ?>
		0 ignored issues – show Duplication introduced 2017-03-23 10:40 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
49		<? renderAction('Delete',
50		'error',
51		$request::$subfolders . $cmsPrefix . '/documents/delete-document?slug=' . $slugPrefix . $document->slug,
52		'trash',
53		'return confirm(\'Are you sure you want to delete this document?\');'); ?>
		1 ignored issue – show Documentation introduced 2017-03-31 10:26 UTC by Report Bug Copy Issue Report `'return confirm(\'Are yo...ete this document?\');'` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
54		<? endif ?>
55		</div>
56		<? } ?>
57

jenskooij / cloudcontrol

Push — develop ( 9c6499...a5e1bf )

function.renderDocument.php ➔ renderDocument() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like