Images 
The Images module (images) manages the images uploaded by the users of the
CMS Icybee., (*1)
Rendering Image records
Image active records render as string:, (*2)
<?php
echo $core->models['images']->one;
Will produce something like:, (*3)
<img src="/repository/files/image/140-porte-verre-blanc.jpeg" alt="Porte verre" width="484" height="518" data-nid="140" />
Thumbnail versions
The following thumbnail versions are created when the module is installed:, (*4)
-
$icon: Represents an image or the image assigned to a record. It's a 24Ă24 image,
usually used in the manage view (the index of a module in the admin)., (*5)
-
$icon-m: A bigger icon usually used by the AdjustImage element to display available images
in a grid., (*6)
-
$popimage: Represents a preview of an image in a PopImage element., (*7)
-
$popover: Represents a preview of an image that appears as a popover when the cursor
hovers an $icon image., (*8)
-
$gallery: Represents images when they are displayed in a gallery., (*9)
Assigning images to content records
The module provides to ability to assign images to content recordsâsuch as news or articlesâto
illustrate them. The Thumbnailer
module is used to provide thumbnails through a fluent API., (*10)
<?php
echo $core->models['images']->one->thumbnail;
echo $core->models['images']->one->thumbnail('news-list');
echo $core->models['news']->one->image->thumbnail('news-list');
# or
echo $core->models['news']->one->image->thumbnail(':list');
echo $core->models['news']->one->image->thumbnail('news-view');
# or
echo $core->models['news']->one->image->thumbnail;
Configuring the assigning
An option to enable the association is injected in all the modules extending the Contents module.
When the option is enabled the following things can be specified:, (*11)
- Whether or not the assigning is required.
- The image to use by default if the association is not required.
- The title and description of the injected image control.
These settings are stored in the global registry:, (*12)
-
images.inject.<flat_module_id>: (bool|null) true if enabled, undefined otherwise.
-
images.inject.<flat_module_id>.required: (bool) true if the association is required,
false otherwise.
-
images.inject.<flat_module_id>.default: (int) Identifier of a default image to use
when no image is associated to a record. This only apply when the association is not required.
-
images.inject.<flat_module_id>.title: (string) The label of the image control injected
in the edit form of the record.
-
images.inject.<flat_module_id>.description: (string) The description of the image
control injected in the edit form of the record.
Additional controls specify the thumbnail options to use for the different views of the record,
usually home, list and view. The thumbnail version name is created according to the following
pattern: <module>-<view>, where <module> is the normalized identifier of the module, and
<view> is the normalized identifier of the view., (*13)
Edit control
The edit block of the target modules is altered to provide a control allowing the user to select
the image to associate with the record being edited., (*14)
The identifier of the selected image is recorded in the image_id meta property of the record., (*15)
Obtaining the image associated with a record
The image associated with a record is obtained through the image magic property:, (*16)
<?php
$core->models['articles']->one->image;
Note that it's not an Image instance that is obtained but a NodeRelation instance. Because
all calls are forwarded, the NodeRelation instance can be used just like an Image instance,
although set throws a PropertyNotWritable
exception., (*17)
The NodeRelation instance makes it possible to use short thumbnail versions. For instance, one
can use ":list" instead of "article-list" to obtain the thumbnail to use in a list view of
articles:, (*18)
<?php
$core->models['articles']->one->image->thumbnail(':list');
The magic property thumbnail returns the view thumbnail:, (*19)
<?php
$core->models['articles']->one->image->thumbnail(':view');
// or
$core->models['articles']->one->image->thumbnail;
Thumbnail decorator
Components can be easily decorated with a thumbnail using a ThumbnailDecorator instance:, (*20)
<?php
use Icybee\Modules\Images\ThumbnailDecorator;
echo new ThumbnailDecorator($record->title, $record->image);
The previous code will produce something like:, (*21)
<a href="/repository/files/image/140-porte-verre-blanc.jpeg" rel="lightbox[thumbnail-decorator]"><img width="24" height="24" data-popover-image="/api/images/140/thumbnails/$popover" class="thumbnail thumbnail--icon" alt="" src="/api/images/140/thumbnails/$icon"></a> My record title
Requirement
The package requires PHP 5.4 or later., (*22)
Installation
The recommended way to install this package is through Composer.
Create a composer.json file and run php composer.phar install command to install it:, (*23)
{
"minimum-stability": "dev",
"require":
{
"icybee/module-images": "2.1.x"
}
}
Note: This module is part of the modules required by Icybee., (*24)
Cloning the repository
The package is available on GitHub, its repository can be
cloned with the following command line:, (*25)
$ git clone git://github.com/Icybee/module-images.git images
Testing
The test suite is ran with the make test command. Composer is
automatically installed as well as all the dependencies required to run the suite. The package
directory can later be cleaned with the make clean command., (*26)
The package is continuously tested by Travis CI., (*27)
, (*28)
Documentation
The package is documented as part of the Icybee CMS
documentation. The documentation for the package and its
dependencies can be generated with the make doc command. The documentation is generated in
the docs directory using ApiGen. The package directory can later by
cleaned with the make clean command., (*29)
License
The package is licensed under the New BSD License - See the (LICENSE)[LICENSE] file for details., (*30)
Wallogit.com
