Hi,

I decided to go with a completely different approach for the module. What was bothering me was that the module would work fine with images, but what if I wanted to link e.g. a Youtube video image to a youtube embedded video ?

So I completely rewrote the module so it uses the file_entity API and uses files display modes to decide what to show in the field and what to show on colorbox. So you can decide to use the "Small" view mode for the field and the "Large" view mode for colorbox, using your defined file types formatters. It also takes care of gallery settings.

This makes the whole thing much more powerful and flexible.

A patch is attached, as well as a full module zip.

CommentFileSizeAuthor
#41 colorbox_file.tar_.gz86.95 KBsamsterlin
#24 colorbox_file_caption_setting.png27.09 KBkmadel
#8 Capture d’écran 2011-10-19 à 14.33.08.png79.53 KBcamdarley
#6 Capture d’écran 2011-10-16 à 15.56.47.png22.07 KBjide
#6 Capture d’écran 2011-10-16 à 15.58.22.png63.13 KBjide
#6 Capture d’écran 2011-10-16 à 15.57.40.png57.03 KBjide
#5 Screenshot at 2011-10-13 14:31:05.png76.5 KBgaele
#4 colorbox_file.zip4.99 KBjide
#4 colorbox_file_overhaul-2.patch17.29 KBjide
#1 colorbox_file_overhaul.patch13.62 KBjide
colorbox_file.zip3.92 KBjide
colorbox_file_overhaul.patch13.46 KBjide

Comments

jide’s picture

jide commented
StatusFileSize
new colorbox_file_overhaul.patch13.62 KB

Just added some access verifications.

murz’s picture

murz
Primary language English
Location Yerevan, Armenia
commented

Thanks, I'll try to test this in several days and report here if find some problems.

gaele’s picture

gaele commented

Hi jide,

I tried the patch from #1. It didn't work.

Settings (on tab "Field display"):
- View mode "Small" set as Image thumbnail.
- View mode "Large" set as colorbox media small to original; I left the other setting (Image large).
- Added an image in the wysiwyg editor, using "Large".
Result: a fixed, large image.

Also: it seems by default this module creates a circular dependency. In view mode Preview using colorbox media the field view mode is Preview as well.

jide’s picture

jide commented
StatusFileSize
new colorbox_file_overhaul-2.patch17.29 KB
new colorbox_file.zip4.99 KB

@gaele : Since there was no documentation, it was unclear how to use the module. I added a README file explaining how to install and configure the module. However, I did not test this with inline images inserted using WYSIWYG.

Here is an updated patch and zip.

gaele’s picture

gaele commented
Status: Needs review » Needs work
StatusFileSize
new Screenshot at 2011-10-13 14:31:05.png76.5 KB

Thank you for the update. I'm using the media module.

From the README:

2. If you are using the Media module to display fields, configure the chosen
view modes by navigating to:

Administration » Configuration » Media » File types » Manage display

At "Manage display" there's nothing to configure. "Manage file display" however contains the option shown in the attached screenshot, including the circular dependency I mentioned.

I didn't try with it an image field. However Media + Wysiwyg still doesn't work.

jide’s picture

jide commented
StatusFileSize
new Capture d’écran 2011-10-16 à 15.57.40.png57.03 KB
new Capture d’écran 2011-10-16 à 15.58.22.png63.13 KB
new Capture d’écran 2011-10-16 à 15.56.47.png22.07 KB

You should do the opposite : Use the "Colorbox file" display mode for your content type, and in File types, configure the chosen view modes with e.g. "Image".
With screenshots :
In your content type, choose "Colorbox file", and choose "Small" and "Large" view modes :
Screenshot
In File types, in "Manage display" ensure "Small" is displayed :
Screenshot
Finally, in "Manage file display", configure the view modes, e.g. we use "Image", and set "thumbnail" for the "Small" view mode, and "large" for the "Large" view mode :
Screenshot

jide’s picture

jide commented
Status: Needs work » Needs review

Status.

camdarley’s picture

camdarley commented
StatusFileSize
new Capture d’écran 2011-10-19 à 14.33.08.png79.53 KB

Hi,
I did exactly as you said, the thumbnails are showing well, but i have no image in my colorbox... all i have is an access denied error.
The log report this:
Type access denied
Date Wednesday, October 19, 2011 - 14:31
User admin
Location http://mysite.net/colorbox_file/414/media_large/und
Referrer http://mysite.net/article/my-article
Message colorbox_file/414/media_large/und
Severity warning
Hostname 127.0.0.1

Any idea?
Thanks for your work by the way!

jide’s picture

jide commented

Hmmm... odd. Did you try with user 1 ?
Otherwise ensure :

  1. You emptied the cache
  2. User has the "View files" permission
  3. Used files are public
camdarley’s picture

camdarley commented

- cache emptied
- logged as admin
Warning keep displays...
I can see the image at http://mysite.net/media/414/view, without access warning.
I keep investigate on this issue, but you're right, that's odd.

camdarley’s picture

camdarley commented

Ok, i found it.
Comenting 'access callback' => 'file_entity_access', in colorbox_file.module solve the issue.
It must be because i use media 7.x-1, i didn't see the dependencies.
Anyway, i have another issue, not critical, but as image style is not generated, the colorbox is empty. I had to load http://mysite.net/colorbox_file/414/media_large/und to generate media_large version of the image, then it worked well.
That's sound logical but it could be confusing for regular user.

jide’s picture

jide commented

Oh, yes, the module requires the 2.x version of file_entity, which is a dependency of the media 2.x module. Maybe it could be version agnostic.
About the image generation problem, that is most probably an issue with the image_style module, you should not have to visit the url first to generate the image of course. Using a simple image style formatter, do the image show correctly on the first time it is displayed ?

camdarley’s picture

camdarley commented

My apologies, i used a simple image style formatter and its working well. Sorry for wasting your time ;)

neurojavi’s picture

neurojavi commented
Status: Needs review » Needs work

Hello:

Thanks for this module!

I've managed to make it work but with the following issue, similar to #12:

The first time I click on an image belonging to a gallery, a empty white box appears, then I press esc key and click again in the same image and the image appears in the colorbox. I have to do this for each image in the gallery.

If I use a simple formater it works (or if I use the url with /styles/....)

And other question:

Would it be toot much difficulto to make the module show media entities and no file entities?
I have added some fields to my media bundles (like author, licence, etc.). I have created some view modes that show this fields and others that not. It would be very useful to be able to show this view modes in a colorbox a not only the file ones... This would make this module much more powerful.

PD: I'm using media 2.x-unstable2

Thanks.-

Javi.-

neurojavi’s picture

neurojavi commented

Hello again:

The problem related to getting empty white boxes is wore than what I thought. It seems to show white boxes randomly (I cannot imagine why sometimes it show the picture and sometimes not). You can see an example here: http://buscando.waslala.org/galeria/una-semana-en-delhi

It's a production site about my 2 years travel and educational project arround the world. Please any help will be very valuable to me since is difficult form me resolve this problem while traveling...

Thank you!

gaele’s picture

gaele commented

@neurojavi: This is the same problem as #11/#12. The first time you click the image is not generated yet.

camdarley’s picture

camdarley commented

@gaele: I don't think so, #11/#12 is a permission problem, and in this case the image is replaced by "access forbidden:..."
@neurojavi: it seems that your image is loading well, but your colorbox have a 0px width... have you checked your colorbox settings?

camdarley’s picture

camdarley commented

Also, have you downloaded the latest version of colorbox?

jide’s picture

jide commented

See the README :

KNOWN ISSUES
------------

The default theme implementation of theme_image_style() does not include "width"
and "height" attributes on the IMG tag. This causes colorbox to resize to zero.
Override the theme_image_style() to include image dimensions, e.g. with : 

/**
 * Override theme_image_style().
 */
function THEME_image_style($variables) {
  $style_name = $variables['style_name'];
  $path = $variables['path'];

  $style_path = image_style_path($style_name, $path);
  if (!file_exists($style_path)) {
    $style_path = image_style_url($style_name, $path);
  }
  $variables['path'] = $style_path;

  if (is_file($style_path)) {
    if (list($width, $height, $type, $attributes) = @getimagesize($style_path)) {
      $variables['width'] = $width;
      $variables['height'] = $height;
    }
  }
  
  return theme('image', $variables);
}
neurojavi’s picture

neurojavi commented

Oh! #19 was the solution! I remeber I read this some days ago but didn't notice taht was the reason :-(

I get the same white little square the first time a picture is loaded but thats another issue and is not critical.

Another question: Any plans to be able to use this module with wysiwyg and to make a public release of the module?

Thanks again!

neurojavi’s picture

neurojavi commented

Hello again:

I want to open a debate about the future of this module.
What is kmadel's opinion about this? has he any intention of make this rewrited version of the module the oficial one?

I thinks that we have to decide about this in order to make the module go further...
I want to open issues for some new features or bugs so this issue doesn't get overloaded but its not posible since this is a patch inside a sandbox project.

My opinion: I like this version and will be happy if it is the official one. It works fine for me and seems more user friendly. It would be perfect if it allows using it in WYSIWYG editors and if it allows to display full media entities and not only file entities. This will allow to show pictures or videos with descriptions and license information in a colorbox (if you add this fields to your media entities, of course). In fact this are the two feature request I'm willing to open...

Thanks.-

kmadel’s picture

kmadel commented

I just applied this patch locally a couple of days ago and everything appears to be work well against the latest dev release of the the Media module. I also took a crack at making the caption that shows up in the Colorbox overlay be based on a configurable field on a File type entity - so you could use a different field depending on the type of file entity - Image, Video, Audio, etc.

I still have some testing to do and need to run everything through the coder module. Then I will push it into the repository. At that point, I will wait to get some feedback on the changes, and if things are stable enough I will promote this to be a full project and create an official release.

Also, I would like to point out that I am working against Media 7.x-2.x-dev and don't plan on supporting the -1.x version of Media.

neurojavi’s picture

neurojavi commented

Ok! This sound great... I'll test it as soon as available!

. I also took a crack at making the caption that shows up in the Colorbox overlay be based on a configurable field on a File type entity - so you could use a different field depending on the type of file entity - Image, Video, Audio, etc.

How are you planning to do this? Will we have to select a caption field for any type of files in colorbox formatter settings? It would mean one selectbox for audio, one for video, etc. Wouldn't it?
It seems a little comlicated UI and code...

I was thinking about another approach:
Change colorbox_file to render in the colorbox the file entity using the view mode selected in field configuration. I mean display the main file (image) and its fields according to the selected view mode. Currently it seems that only displays the file associated with the file entity and not its fields.
With this approach I can create and configure a "Colorbox test" view mode and show a large image with description and license fields for image media, the audio player, album name and license fields for audio files, etc.

The caption text could be managed and selected in view mode configuration (perhaps this task belongs to another module, like media or DS?)

This are only some thoughts. I'm sorry if I've said anything too much stupid! :-)

kmadel’s picture

kmadel commented
StatusFileSize
new colorbox_file_caption_setting.png27.09 KB

The 'caption' to use as the Colorbox caption would be a setting that is available on all text fields of a given file type. Remember, the updated code already supports the use of Field entity display modes to display the media item on the page and in then possibly a different one or the same display mode (if you want?) to show the media item in the colorbox overlay. So any fields that you add and select to show will be displayed in the colorbox overlay. However, the colorbox module uses the title attribute of the image being displayed as the 'caption', so my approach is to allow you to choose a text field on one of you file field types via the manage fields configurate for File types.

Colorbox Caption Setting

Then, for the colorbox file formatter settings, you will just specify if you want to use this field approach, the approach that was in the re-written code (basically uses the label of your media field for the node type, or have no caption be displayed.

jide’s picture

jide commented
Assigned: jide » Unassigned
Status: Needs work » Needs review

It would be great to see the this committed as a real module.

Concerning the file displayed with its fields, since the function used is
file_view($file, $view_mode, $langcode)
It should display file fields I think (did not try this though, but seems obvious).

if it allows to display full media entities and not only file entities

I'm not sure I follow you here, what do you mean ? Media module displays file entities, right ?

@kmedal: What do you think about committing this as is first, and then make changes ?

I put status back to "needs review" and change "assigned to" in the meanwhile (could be RTBC according to your reviews though).

neurojavi’s picture

neurojavi commented

@kmadel
OK! It seems a good approach for the UI to select the caption text. One question related with this:
Do you know if there is some way to make that the field selected as caption for colorbox view mode gets used as title and/or alt tag in File view mode? Could this be implemented as part of this module?

@jide
Yes, you're right! I was a little confused. And it is true, I can see fields configured in my view modes in the colorbox overlay. I had a problem but it seems to be related to Display Suite (it seems to not work with file entity view modes).

Thanks.-

kmadel’s picture

kmadel commented

@neurojavi I have thought about the image alt/title attributes quite a bit. For the Colorbox module, the title attribute is actually what is being leveraged to to uses File entity field as a Colorbox caption. There is an interesting discussion about the title/alt attributes as an issue on the Media modoue: http://drupal.org/node/1343022.

Now, the Colorbox File module is really trying to be a formatter for any other situation than when you want to display a Media Field entity in a Colorbox. As you can see if you read through the post above - what if you want to have the title/alt text be specific that the Media item is being displayed with - @jide's approach handles this somewhat, but the same field label would be used across all items of a multi-valued media field. What if you have a multi-valued Media field on your content type and would like to have a node specific title attribute for each that is different? I would rather have another module take care of this sort of scenario, and then with the Colorbox File you would be able to configure the formatter settings to use the title or alt text - that would actually be being set based on some field widget setting or something node specific like that.

jide’s picture

jide commented

Just noticed I left a typo on line 53 :
'file_view_mode' => 'smalll',
should be :
'file_view_mode' => 'small',
;)

Toktik’s picture

Toktik commented

This definitely should be commited and converted to real project.

kmadel’s picture

kmadel commented

I am close to being ready to commit the changes that include some new caption handling support, and after a short review by the few that our using it, I will promote it to a full project.

marco_cruz’s picture

marco_cruz commented

I'm using the version from your last submission, and I'm getting this error

Fatal error: Cannot access empty property in C:\xamp174\htdocs\media\sites\all\modules\colorbox_file_6jan\colorbox_file.module on line 230

and can't figure it out...

kmadel’s picture

kmadel commented
Status: Needs review » Fixed

This fix has been pushed into the repository - to include a fix for #28. Once this is tested a bit, I will create a full project and a dev release.

neurojavi’s picture

neurojavi commented

I've tried last git version and this is my review:

- A minor problem: When you are configuring a media field with colorbox_file formatter and you change to File type text field it gets saved when you press update and save (in the summary it appear "File type text field" but when you edit formatters setting the combo box is allways in "Title text".
- A major problem: I've created a new field for a image field type (field_test) and when I check the checkbox to make this field the source to colorbox caption and press save, I get a white screen and this setting is not being saved (it says that settings have been saved if I load another page, bur colobox caption setting is unchecked again). I also get a white (empty) page when I try to view a node that uses this file type.
- A comment: This only works for text fields, not long text ones, Am I right? Could it be useful if we can use lng text too? Or this makes no sense becouse of the supposed length.

Thanks!

Note: I'm using last dev 2.x media version

kmadel’s picture

kmadel commented
Status: Fixed » Needs work

Will update code with fixes

kmadel’s picture

kmadel commented
Version: » 7.x-1.x-dev
Status: Needs work » Fixed

Issues from #33 have been fixed. Also a big change is that this module was renamed to Media Colorbox. The primary reason for this module in the first place was to make it easy to use Colorbox with Media module based field, so it seemed like Media Colorbox made more sense than Colorbox File.

andes1’s picture

andes1 commented
Version: 7.x-1.x-dev » 7.x-1.0-beta2
Status: Fixed » Active

Hi kmadel,

I have used Media Colorbox latest released (7.x-1.0-beta2) module along with Colorbox and Media module. This works fine for images, but not when file type is Media asset. I did all settings inside configuration-> File Types -> Image Manage Display. The exactly same as describe in previous posts. Still this not working. Is it required to add any patch or something to work with it ??

kmadel’s picture

kmadel commented
Status: Active » Postponed (maintainer needs more info)

@andes1, you may want to create a new issue for this. Also, what is the actual file type(s) that you are working with - PDF, video of some sort, MS Office files? You will have to manage the display for whatever File type the Media asset falls under.

kmadel’s picture

kmadel commented
Version: 7.x-1.0-beta2 » 7.x-1.0-rc1
Status: Postponed (maintainer needs more info) » Fixed

Please test with rc1.

frixos12’s picture

frixos12 commented

Same issue with me.

I am using video file along with the latest dev versions of all the required modules.

What file display should i use for the colorbox view mode (Configuration » Media » File types » Manage file display)

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

samsterlin’s picture

samsterlin commented
StatusFileSize
new colorbox_file.tar_.gz86.95 KB

Just added some access verifications.