File::get_short_hash() - Code Metrics - Inspection of "Added 'short_path' column to the 'files' model" - Icybee/module-files - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.0 ( 50b99c...306061 )

by Olivier

created 2016-07-09 16:29 UTC

File::get_short_hash() A

↳ Parent: File

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
rs	10
cc	2
eloc	2
nc	2
nop	0

<?php

/*
 * This file is part of the Icybee package.
*
* (c) Olivier Laviale <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Icybee\Modules\Files;

use ICanBoogie\HTTP\File as HTTPFile;

use Icybee\Binding\Core\PrototypedBindings;
use Icybee\Modules\Files\Storage\Pathname;
use Icybee\Modules\Nodes\Node;

/**
 * Representation of a managed file.
 *
 * @property-read \ICanBoogie\Core|\Icybee\Binding\Core\CoreBindings|Binding\CoreBindings $app
 * @property-read Storage\FileStorage $file_storage
 * @property-read Pathname $pathname Absolute path to the file.
 * @property-read string $short_hash
 */
class File extends Node
{
	use PrototypedBindings;

	const MODEL_ID = 'files';

	const MIME = 'mime';
	const SIZE = 'size';
	const EXTENSION = 'extension';
	const DESCRIPTION = 'description';
	const HTTP_FILE = 'file';

	/**
	 * Size of the file.
	 *
	 * @var int
	 */
	public $size;

	/**
	 * MIME type of the file.
	 *
	 * @var string
	 */
	public $mime;

	/**
	 * File extension, including the dot ".".
	 *
	 * @var string
	 */
	public $extension = '';

	/**
	 * Description of the file.
	 *
	 * @var string
	 */
	public $description = '';

	/**
	 * @return Pathname|null
	 */
	protected function get_pathname()
	{
		if (!$this->nid && !$this->uuid)
		{
			return null;
		}

		$pathname = $this->file_storage->find($this->uuid);

		if (!$pathname)
		{
			throw new \LogicException("Unable to retrieve pathname for {$this->uuid}.");
		}

		return $pathname;
	}

	/**
	 * @var string
	 */
	protected $short_hash;

	/**
	 * Returns the short hash of the file.
	 *
	 * @return string
	 */
	protected function get_short_hash()
	{
		return $this->short_hash ?: $this->pathname->short_hash;
	}

	/**
	 * @return Storage\FileStorage
	 */
	protected function get_file_storage()
	{
		return $this->app->file_storage;
	}

	/**
	 * If {@link HTTP_FILE} is defined, the {@link HTTPFile} instance is used to
	 * set the {@link $mime}, {@link $size} and {@link $extension} properties.
	 * The {@link $title} property is updated as well if it is empty.
	 *
	 * After the record is saved, the {@link HTTP_FILE} property is removed.
	 *
	 * @inheritdoc
	 */
	public function save(array $options = [])
	{
		/* @var $file HTTPFile */

		$file = null;

		if (isset($this->{ self::HTTP_FILE }))
		{
			$file = $this->{ self::HTTP_FILE };
			$this->save_file_before($file);
		}

		$rc = parent::save($options);

		if ($rc && $file)
		{
			unset($this->{ self::HTTP_FILE });

			$this->save_file_after($file);
		}

		return $rc;
	}

	public function delete()
	{
		$rc = parent::delete();

		if ($rc)
		{
			$this->file_storage->release($this->uuid);
		}

		return $rc;
	}

	/**
	 * Begins saving the HTTP file.
	 *
	 * @param HTTPFile $file
	 */
	protected function save_file_before(HTTPFile $file)
	{
		$this->mime = $file->type;
		$this->size = $file->size;
		$this->extension = $file->extension;
		$this->short_hash = Pathname::short_hash($file->pathname);

		if (!$this->title)
		{
			$this->title = $file->unsuffixed_name;
		}
	}

	/**
	 * Finishes saving the HTTP file.
	 *
	 * @param HTTPFile $file
	 */
	protected function save_file_after(HTTPFile $file)
	{
		$storage = $this->file_storage;
		$pathname = $storage->create_pathname($file->pathname);

		if (!file_exists($pathname))
		{
			$file->move($pathname);
		}

		$storage->index($this->nid, $this->uuid, $pathname->hash);
	}

	/**
	 * Returns a URL for this record.
	 *
	 * @param string $type
	 *
	 * @return \ICanBoogie\Routing\FormattedRoute|string
	 */
	public function url($type = 'view')
	{
		$routes = $this->app->routes;
		$route_id = "{$this->constructor}/$type";

		if (isset($routes[$route_id]))
		{
			return $routes[$route_id]->format($this);
		}

		$route_id = "{$this->constructor}:$type";

		if (isset($routes[$route_id]))
		{
			return $routes[$route_id]->format($this);
		}

		$route_id = "files:$type";

		if (isset($routes[$route_id]))
		{
			return $routes[$route_id]->format($this);
		}

		return parent::url($type);
	}
}


1			<?php
2
3			/*
4			* This file is part of the Icybee package.
5			*
6			* (c) Olivier Laviale <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Icybee\Modules\Files;
13
14			use ICanBoogie\HTTP\File as HTTPFile;
15
16			use Icybee\Binding\Core\PrototypedBindings;
17			use Icybee\Modules\Files\Storage\Pathname;
18			use Icybee\Modules\Nodes\Node;
19
20			/**
21			* Representation of a managed file.
22			*
23			* @property-read \ICanBoogie\Core\|\Icybee\Binding\Core\CoreBindings\|Binding\CoreBindings $app
24			* @property-read Storage\FileStorage $file_storage
25			* @property-read Pathname $pathname Absolute path to the file.
26			* @property-read string $short_hash
27			*/
28			class File extends Node
29			{
30			use PrototypedBindings;
31
32			const MODEL_ID = 'files';
33
34			const MIME = 'mime';
35			const SIZE = 'size';
36			const EXTENSION = 'extension';
37			const DESCRIPTION = 'description';
38			const HTTP_FILE = 'file';
39
40			/**
41			* Size of the file.
42			*
43			* @var int
44			*/
45			public $size;
46
47			/**
48			* MIME type of the file.
49			*
50			* @var string
51			*/
52			public $mime;
53
54			/**
55			* File extension, including the dot ".".
56			*
57			* @var string
58			*/
59			public $extension = '';
60
61			/**
62			* Description of the file.
63			*
64			* @var string
65			*/
66			public $description = '';
67
68			/**
69			* @return Pathname\|null
70			*/
71			protected function get_pathname()
72			{
73			if (!$this->nid && !$this->uuid)
74			{
75			return null;
76			}
77
78			$pathname = $this->file_storage->find($this->uuid);
79
80			if (!$pathname)
81			{
82			throw new \LogicException("Unable to retrieve pathname for {$this->uuid}.");
83			}
84
85			return $pathname;
86			}
87
88			/**
89			* @var string
90			*/
91			protected $short_hash;
92
93			/**
94			* Returns the short hash of the file.
95			*
96			* @return string
97			*/
98			protected function get_short_hash()
99			{
100			return $this->short_hash ?: $this->pathname->short_hash;
101			}
102
103			/**
104			* @return Storage\FileStorage
105			*/
106			protected function get_file_storage()
107			{
108			return $this->app->file_storage;
109			}
110
111			/**
112			* If {@link HTTP_FILE} is defined, the {@link HTTPFile} instance is used to
113			* set the {@link $mime}, {@link $size} and {@link $extension} properties.
114			* The {@link $title} property is updated as well if it is empty.
115			*
116			* After the record is saved, the {@link HTTP_FILE} property is removed.
117			*
118			* @inheritdoc
119			*/
120			public function save(array $options = [])
121			{
122			/* @var $file HTTPFile */
123
124			$file = null;
125
126			if (isset($this->{ self::HTTP_FILE }))
127			{
128			$file = $this->{ self::HTTP_FILE };
129			$this->save_file_before($file);
130			}
131
132			$rc = parent::save($options);
133
134			if ($rc && $file)
135			{
136			unset($this->{ self::HTTP_FILE });
137
138			$this->save_file_after($file);
139			}
140
141			return $rc;
142			}
143
144			public function delete()
145			{
146			$rc = parent::delete();
147
148			if ($rc)
149			{
150			$this->file_storage->release($this->uuid);
151			}
152
153			return $rc;
154			}
155
156			/**
157			* Begins saving the HTTP file.
158			*
159			* @param HTTPFile $file
160			*/
161			protected function save_file_before(HTTPFile $file)
162			{
163			$this->mime = $file->type;
164			$this->size = $file->size;
165			$this->extension = $file->extension;
166			$this->short_hash = Pathname::short_hash($file->pathname);
167
168			if (!$this->title)
169			{
170			$this->title = $file->unsuffixed_name;
171			}
172			}
173
174			/**
175			* Finishes saving the HTTP file.
176			*
177			* @param HTTPFile $file
178			*/
179			protected function save_file_after(HTTPFile $file)
180			{
181			$storage = $this->file_storage;
182			$pathname = $storage->create_pathname($file->pathname);
183
184			if (!file_exists($pathname))
185			{
186			$file->move($pathname);
187			}
188
189			$storage->index($this->nid, $this->uuid, $pathname->hash);
190			}
191
192			/**
193			* Returns a URL for this record.
194			*
195			* @param string $type
196			*
197			* @return \ICanBoogie\Routing\FormattedRoute\|string
198			*/
199			public function url($type = 'view')
200			{
201			$routes = $this->app->routes;
202			$route_id = "{$this->constructor}/$type";
203
204			if (isset($routes[$route_id]))
205			{
206			return $routes[$route_id]->format($this);
207			}
208
209			$route_id = "{$this->constructor}:$type";
210
211			if (isset($routes[$route_id]))
212			{
213			return $routes[$route_id]->format($this);
214			}
215
216			$route_id = "files:$type";
217
218			if (isset($routes[$route_id]))
219			{
220			return $routes[$route_id]->format($this);
221			}
222
223			return parent::url($type);
224			}
225			}
226

Icybee / module-files

Push — 3.0 ( 50b99c...306061 )

File::get_short_hash() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like