- Removed unused variables.

- Add missed phpdoc params.
- Update constants with locator.
This commit is contained in:
Pereira Ricardo
2015-01-27 23:36:43 +01:00
parent 391f7d3be4
commit f35287cb7a

View File

@@ -93,6 +93,12 @@ class Medium extends Data
*/
protected $linkAttributes = [];
/**
* Construct.
*
* @param array $items
* @param Blueprint $blueprint
*/
public function __construct($items = array(), Blueprint $blueprint = null)
{
parent::__construct($items, $blueprint);
@@ -134,9 +140,6 @@ class Medium extends Data
*/
public function path()
{
/** @var Config $config */
$config = self::$grav['config'];
if ($this->image) {
$output = $this->saveImage();
$this->reset();
@@ -150,6 +153,7 @@ class Medium extends Data
/**
* Return URL to file.
*
* @param bool $reset
* @return string
*/
public function url($reset = true)
@@ -165,11 +169,12 @@ class Medium extends Data
return self::$grav['base_url'] . '/'. $output;
}
/**
* Return srcset string for this Medium and its alternatives
*
* Return srcset string for this Medium and its alternatives.
*
* @param bool $reset
* @return string
*/
public function srcset($reset = true)
@@ -195,6 +200,7 @@ class Medium extends Data
* @param string $class
* @param string $type
* @param int $quality
* @param bool $reset
* @return string
*/
public function img($title = null, $class = null, $type = null, $quality = 80, $reset = true)
@@ -213,8 +219,7 @@ class Medium extends Data
*
* @param string $title
* @param string $class
* @param string $type
* @param int $quality
* @param bool $reset
* @return string
*/
public function html($title = null, $class = null, $reset = true)
@@ -244,6 +249,12 @@ class Medium extends Data
return $output;
}
/**
* Return HTML array from medium.
*
* @param bool $reset
* @return array
*/
public function htmlRaw($reset = true)
{
$output = [];
@@ -256,9 +267,6 @@ class Medium extends Data
}
if ($this->linkTarget) {
/** @var Config $config */
$config = self::$grav['config'];
$output['a_href'] = $this->linkTarget;
$output['a_attributes'] = $this->linkAttributes;
@@ -301,11 +309,9 @@ class Medium extends Data
/**
* Enable link for the medium object
*
* @param int $width
* @param int $height
* @return $this
*/
public function link($width = null, $height = null)
public function link()
{
if ($this->image) {
$this->linkTarget = $this->url(false);
@@ -326,15 +332,13 @@ class Medium extends Data
/**
* Enable lightbox for the medium.
*
* @param int $width
* @param int $height
* @return $this
*/
public function lightbox($width = null, $height = null)
public function lightbox()
{
$this->linkAttributes['rel'] = 'lightbox';
return $this->link($width, $height);
return $this->link();
}
/**
@@ -407,11 +411,15 @@ class Medium extends Data
*/
public function image($variable = 'thumb')
{
$locator = self::$grav['locator'];
$images_dir = $locator->findResource('image://');
// TODO: add default file
$file = $this->get($variable);
$this->image = ImageFile::open($file)
->setCacheDir(basename(IMAGES_DIR))
->setActualCacheDir(IMAGES_DIR)
->setCacheDir(basename($images_dir))
->setActualCacheDir($images_dir)
->setPrettyName(basename($this->get('basename')));
$this->filter();
@@ -419,6 +427,11 @@ class Medium extends Data
return $this;
}
/**
* Save the image with cache.
*
* @return mixed|string
*/
protected function saveImage()
{
if (!$this->image) {
@@ -432,8 +445,9 @@ class Medium extends Data
$ratio = 1;
}
$overlay = SYSTEM_DIR . '/assets/responsive-overlays/' . $ratio . 'x.png';
$overlay = file_exists($overlay) ? $overlay : SYSTEM_DIR . '/assets/responsive-overlays/unknown.png';
$locator = self::$grav['locator'];
$overlay = $locator->findReference("system://assets/responsive-overlays/{$ratio}x.png") ?: $locator->findResource('system://assets/responsive-overlays/unknown.png');
$this->image->merge(ImageFile::open($overlay));
}
@@ -463,11 +477,10 @@ class Medium extends Data
}
/**
* Add alternative Medium to this Medium
* Add alternative Medium to this Medium.
*
* @param $type
* @param $alternative
* @return $this
* @param $ratio
* @param Medium $alternative
*/
public function addAlternative($ratio, Medium $alternative)
{