Projet

Général

Profil

Révision e6d32a8d

Ajouté par Florent Torregrosa il y a environ 7 ans

Add block_class module.

Voir les différences:

drupal7/sites/all/modules/block_class/LICENSE.txt
1
                    GNU GENERAL PUBLIC LICENSE
2
                       Version 2, June 1991
3

  
4
 Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
 Everyone is permitted to copy and distribute verbatim copies
7
 of this license document, but changing it is not allowed.
8

  
9
                            Preamble
10

  
11
  The licenses for most software are designed to take away your
12
freedom to share and change it.  By contrast, the GNU General Public
13
License is intended to guarantee your freedom to share and change free
14
software--to make sure the software is free for all its users.  This
15
General Public License applies to most of the Free Software
16
Foundation's software and to any other program whose authors commit to
17
using it.  (Some other Free Software Foundation software is covered by
18
the GNU Lesser General Public License instead.)  You can apply it to
19
your programs, too.
20

  
21
  When we speak of free software, we are referring to freedom, not
22
price.  Our General Public Licenses are designed to make sure that you
23
have the freedom to distribute copies of free software (and charge for
24
this service if you wish), that you receive source code or can get it
25
if you want it, that you can change the software or use pieces of it
26
in new free programs; and that you know you can do these things.
27

  
28
  To protect your rights, we need to make restrictions that forbid
29
anyone to deny you these rights or to ask you to surrender the rights.
30
These restrictions translate to certain responsibilities for you if you
31
distribute copies of the software, or if you modify it.
32

  
33
  For example, if you distribute copies of such a program, whether
34
gratis or for a fee, you must give the recipients all the rights that
35
you have.  You must make sure that they, too, receive or can get the
36
source code.  And you must show them these terms so they know their
37
rights.
38

  
39
  We protect your rights with two steps: (1) copyright the software, and
40
(2) offer you this license which gives you legal permission to copy,
41
distribute and/or modify the software.
42

  
43
  Also, for each author's protection and ours, we want to make certain
44
that everyone understands that there is no warranty for this free
45
software.  If the software is modified by someone else and passed on, we
46
want its recipients to know that what they have is not the original, so
47
that any problems introduced by others will not reflect on the original
48
authors' reputations.
49

  
50
  Finally, any free program is threatened constantly by software
51
patents.  We wish to avoid the danger that redistributors of a free
52
program will individually obtain patent licenses, in effect making the
53
program proprietary.  To prevent this, we have made it clear that any
54
patent must be licensed for everyone's free use or not licensed at all.
55

  
56
  The precise terms and conditions for copying, distribution and
57
modification follow.
58

  
59
                    GNU GENERAL PUBLIC LICENSE
60
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61

  
62
  0. This License applies to any program or other work which contains
63
a notice placed by the copyright holder saying it may be distributed
64
under the terms of this General Public License.  The "Program", below,
65
refers to any such program or work, and a "work based on the Program"
66
means either the Program or any derivative work under copyright law:
67
that is to say, a work containing the Program or a portion of it,
68
either verbatim or with modifications and/or translated into another
69
language.  (Hereinafter, translation is included without limitation in
70
the term "modification".)  Each licensee is addressed as "you".
71

  
72
Activities other than copying, distribution and modification are not
73
covered by this License; they are outside its scope.  The act of
74
running the Program is not restricted, and the output from the Program
75
is covered only if its contents constitute a work based on the
76
Program (independent of having been made by running the Program).
77
Whether that is true depends on what the Program does.
78

  
79
  1. You may copy and distribute verbatim copies of the Program's
80
source code as you receive it, in any medium, provided that you
81
conspicuously and appropriately publish on each copy an appropriate
82
copyright notice and disclaimer of warranty; keep intact all the
83
notices that refer to this License and to the absence of any warranty;
84
and give any other recipients of the Program a copy of this License
85
along with the Program.
86

  
87
You may charge a fee for the physical act of transferring a copy, and
88
you may at your option offer warranty protection in exchange for a fee.
89

  
90
  2. You may modify your copy or copies of the Program or any portion
91
of it, thus forming a work based on the Program, and copy and
92
distribute such modifications or work under the terms of Section 1
93
above, provided that you also meet all of these conditions:
94

  
95
    a) You must cause the modified files to carry prominent notices
96
    stating that you changed the files and the date of any change.
97

  
98
    b) You must cause any work that you distribute or publish, that in
99
    whole or in part contains or is derived from the Program or any
100
    part thereof, to be licensed as a whole at no charge to all third
101
    parties under the terms of this License.
102

  
103
    c) If the modified program normally reads commands interactively
104
    when run, you must cause it, when started running for such
105
    interactive use in the most ordinary way, to print or display an
106
    announcement including an appropriate copyright notice and a
107
    notice that there is no warranty (or else, saying that you provide
108
    a warranty) and that users may redistribute the program under
109
    these conditions, and telling the user how to view a copy of this
110
    License.  (Exception: if the Program itself is interactive but
111
    does not normally print such an announcement, your work based on
112
    the Program is not required to print an announcement.)
113

  
114
These requirements apply to the modified work as a whole.  If
115
identifiable sections of that work are not derived from the Program,
116
and can be reasonably considered independent and separate works in
117
themselves, then this License, and its terms, do not apply to those
118
sections when you distribute them as separate works.  But when you
119
distribute the same sections as part of a whole which is a work based
120
on the Program, the distribution of the whole must be on the terms of
121
this License, whose permissions for other licensees extend to the
122
entire whole, and thus to each and every part regardless of who wrote it.
123

  
124
Thus, it is not the intent of this section to claim rights or contest
125
your rights to work written entirely by you; rather, the intent is to
126
exercise the right to control the distribution of derivative or
127
collective works based on the Program.
128

  
129
In addition, mere aggregation of another work not based on the Program
130
with the Program (or with a work based on the Program) on a volume of
131
a storage or distribution medium does not bring the other work under
132
the scope of this License.
133

  
134
  3. You may copy and distribute the Program (or a work based on it,
135
under Section 2) in object code or executable form under the terms of
136
Sections 1 and 2 above provided that you also do one of the following:
137

  
138
    a) Accompany it with the complete corresponding machine-readable
139
    source code, which must be distributed under the terms of Sections
140
    1 and 2 above on a medium customarily used for software interchange; or,
141

  
142
    b) Accompany it with a written offer, valid for at least three
143
    years, to give any third party, for a charge no more than your
144
    cost of physically performing source distribution, a complete
145
    machine-readable copy of the corresponding source code, to be
146
    distributed under the terms of Sections 1 and 2 above on a medium
147
    customarily used for software interchange; or,
148

  
149
    c) Accompany it with the information you received as to the offer
150
    to distribute corresponding source code.  (This alternative is
151
    allowed only for noncommercial distribution and only if you
152
    received the program in object code or executable form with such
153
    an offer, in accord with Subsection b above.)
154

  
155
The source code for a work means the preferred form of the work for
156
making modifications to it.  For an executable work, complete source
157
code means all the source code for all modules it contains, plus any
158
associated interface definition files, plus the scripts used to
159
control compilation and installation of the executable.  However, as a
160
special exception, the source code distributed need not include
161
anything that is normally distributed (in either source or binary
162
form) with the major components (compiler, kernel, and so on) of the
163
operating system on which the executable runs, unless that component
164
itself accompanies the executable.
165

  
166
If distribution of executable or object code is made by offering
167
access to copy from a designated place, then offering equivalent
168
access to copy the source code from the same place counts as
169
distribution of the source code, even though third parties are not
170
compelled to copy the source along with the object code.
171

  
172
  4. You may not copy, modify, sublicense, or distribute the Program
173
except as expressly provided under this License.  Any attempt
174
otherwise to copy, modify, sublicense or distribute the Program is
175
void, and will automatically terminate your rights under this License.
176
However, parties who have received copies, or rights, from you under
177
this License will not have their licenses terminated so long as such
178
parties remain in full compliance.
179

  
180
  5. You are not required to accept this License, since you have not
181
signed it.  However, nothing else grants you permission to modify or
182
distribute the Program or its derivative works.  These actions are
183
prohibited by law if you do not accept this License.  Therefore, by
184
modifying or distributing the Program (or any work based on the
185
Program), you indicate your acceptance of this License to do so, and
186
all its terms and conditions for copying, distributing or modifying
187
the Program or works based on it.
188

  
189
  6. Each time you redistribute the Program (or any work based on the
190
Program), the recipient automatically receives a license from the
191
original licensor to copy, distribute or modify the Program subject to
192
these terms and conditions.  You may not impose any further
193
restrictions on the recipients' exercise of the rights granted herein.
194
You are not responsible for enforcing compliance by third parties to
195
this License.
196

  
197
  7. If, as a consequence of a court judgment or allegation of patent
198
infringement or for any other reason (not limited to patent issues),
199
conditions are imposed on you (whether by court order, agreement or
200
otherwise) that contradict the conditions of this License, they do not
201
excuse you from the conditions of this License.  If you cannot
202
distribute so as to satisfy simultaneously your obligations under this
203
License and any other pertinent obligations, then as a consequence you
204
may not distribute the Program at all.  For example, if a patent
205
license would not permit royalty-free redistribution of the Program by
206
all those who receive copies directly or indirectly through you, then
207
the only way you could satisfy both it and this License would be to
208
refrain entirely from distribution of the Program.
209

  
210
If any portion of this section is held invalid or unenforceable under
211
any particular circumstance, the balance of the section is intended to
212
apply and the section as a whole is intended to apply in other
213
circumstances.
214

  
215
It is not the purpose of this section to induce you to infringe any
216
patents or other property right claims or to contest validity of any
217
such claims; this section has the sole purpose of protecting the
218
integrity of the free software distribution system, which is
219
implemented by public license practices.  Many people have made
220
generous contributions to the wide range of software distributed
221
through that system in reliance on consistent application of that
222
system; it is up to the author/donor to decide if he or she is willing
223
to distribute software through any other system and a licensee cannot
224
impose that choice.
225

  
226
This section is intended to make thoroughly clear what is believed to
227
be a consequence of the rest of this License.
228

  
229
  8. If the distribution and/or use of the Program is restricted in
230
certain countries either by patents or by copyrighted interfaces, the
231
original copyright holder who places the Program under this License
232
may add an explicit geographical distribution limitation excluding
233
those countries, so that distribution is permitted only in or among
234
countries not thus excluded.  In such case, this License incorporates
235
the limitation as if written in the body of this License.
236

  
237
  9. The Free Software Foundation may publish revised and/or new versions
238
of the General Public License from time to time.  Such new versions will
239
be similar in spirit to the present version, but may differ in detail to
240
address new problems or concerns.
241

  
242
Each version is given a distinguishing version number.  If the Program
243
specifies a version number of this License which applies to it and "any
244
later version", you have the option of following the terms and conditions
245
either of that version or of any later version published by the Free
246
Software Foundation.  If the Program does not specify a version number of
247
this License, you may choose any version ever published by the Free Software
248
Foundation.
249

  
250
  10. If you wish to incorporate parts of the Program into other free
251
programs whose distribution conditions are different, write to the author
252
to ask for permission.  For software which is copyrighted by the Free
253
Software Foundation, write to the Free Software Foundation; we sometimes
254
make exceptions for this.  Our decision will be guided by the two goals
255
of preserving the free status of all derivatives of our free software and
256
of promoting the sharing and reuse of software generally.
257

  
258
                            NO WARRANTY
259

  
260
  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
262
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
266
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
267
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
REPAIR OR CORRECTION.
269

  
270
  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
POSSIBILITY OF SUCH DAMAGES.
279

  
280
                     END OF TERMS AND CONDITIONS
281

  
282
            How to Apply These Terms to Your New Programs
283

  
284
  If you develop a new program, and you want it to be of the greatest
285
possible use to the public, the best way to achieve this is to make it
286
free software which everyone can redistribute and change under these terms.
287

  
288
  To do so, attach the following notices to the program.  It is safest
289
to attach them to the start of each source file to most effectively
290
convey the exclusion of warranty; and each file should have at least
291
the "copyright" line and a pointer to where the full notice is found.
292

  
293
    <one line to give the program's name and a brief idea of what it does.>
294
    Copyright (C) <year>  <name of author>
295

  
296
    This program is free software; you can redistribute it and/or modify
297
    it under the terms of the GNU General Public License as published by
298
    the Free Software Foundation; either version 2 of the License, or
299
    (at your option) any later version.
300

  
301
    This program is distributed in the hope that it will be useful,
302
    but WITHOUT ANY WARRANTY; without even the implied warranty of
303
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
304
    GNU General Public License for more details.
305

  
306
    You should have received a copy of the GNU General Public License along
307
    with this program; if not, write to the Free Software Foundation, Inc.,
308
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309

  
310
Also add information on how to contact you by electronic and paper mail.
311

  
312
If the program is interactive, make it output a short notice like this
313
when it starts in an interactive mode:
314

  
315
    Gnomovision version 69, Copyright (C) year name of author
316
    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317
    This is free software, and you are welcome to redistribute it
318
    under certain conditions; type `show c' for details.
319

  
320
The hypothetical commands `show w' and `show c' should show the appropriate
321
parts of the General Public License.  Of course, the commands you use may
322
be called something other than `show w' and `show c'; they could even be
323
mouse-clicks or menu items--whatever suits your program.
324

  
325
You should also get your employer (if you work as a programmer) or your
326
school, if any, to sign a "copyright disclaimer" for the program, if
327
necessary.  Here is a sample; alter the names:
328

  
329
  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330
  `Gnomovision' (which makes passes at compilers) written by James Hacker.
331

  
332
  <signature of Ty Coon>, 1 April 1989
333
  Ty Coon, President of Vice
334

  
335
This General Public License does not permit incorporating your program into
336
proprietary programs.  If your program is a subroutine library, you may
337
consider it more useful to permit linking proprietary applications with the
338
library.  If this is what you want to do, use the GNU Lesser General
339
Public License instead of this License.
drupal7/sites/all/modules/block_class/README.txt
1
=====
2
Block Class
3
http://drupal.org/project/block_class
4
-----
5
Block Class was developed and is maintained by Four Kitchens
6
<http://fourkitchens.com>.
7

  
8

  
9
=====
10
Installation
11
-----
12

  
13
1. Enable the module
14
2. To add a class to a block, simply visit that block's configuration page at
15
Administration > Structure > Blocks
drupal7/sites/all/modules/block_class/block_class.info
1
name = Block Class
2
description = Allows assigning CSS classes to blocks.
3
core = 7.x
4

  
5
dependencies[] = block
6
files[] = block_class.test
7
test_dependencies[] = context
8
test_dependencies[] = features (2.x)
9
test_dependencies[] = features_extra
10

  
11
; Information added by Drupal.org packaging script on 2015-12-18
12
version = "7.x-2.3"
13
core = "7.x"
14
project = "block_class"
15
datestamp = "1450415951"
16

  
drupal7/sites/all/modules/block_class/block_class.install
1
<?php
2

  
3
/**
4
 * @file
5
 * Install, update and uninstall functions for the block_class module.
6
 */
7

  
8
/**
9
 * Implements hook_install().
10
 */
11
function block_class_install() {
12
  $schema['block'] = array();
13
  block_class_schema_alter($schema);
14
  foreach ($schema['block']['fields'] as $field => $spec) {
15
    if (db_field_exists('block', $field)) {
16
      watchdog('system', 'Module install: Attempt to recreate field: "%field", when it already exists.', array('%field' => $field), WATCHDOG_WARNING);
17
    }
18
    else {
19
      db_add_field('block', $field, $spec);
20
    }
21
  }
22
}
23

  
24
/**
25
 * Implements hook_uninstall().
26
 */
27
function block_class_uninstall() {
28
  $schema['block'] = array();
29
  block_class_schema_alter($schema);
30
  foreach ($schema['block']['fields'] as $field => $specs) {
31
    db_drop_field('block', $field);
32
  }
33
}
34

  
35
/**
36
 * Implements hook_schema_alter().
37
 *
38
 * Other modules, such as i18n_block also modify the block database table.
39
 */
40
function block_class_schema_alter(&$schema) {
41
  if (isset($schema['block'])) {
42
    $schema['block']['fields']['css_class'] = array(
43
      'type' => 'varchar',
44
      'length' => 255,
45
      'not null' => TRUE,
46
      'default' => '',
47
      'description' => 'String containing the classes for the block.',
48
    );
49
  }
50
}
51

  
52
/**
53
 * Alters the structure of {block_class} schema.
54
 */
55
function block_class_update_7100() {
56
  // Check if the block_class table exists to prevent installation profiles
57
  // from running this update for versions without the block_class table.
58
  if (db_table_exists('block_class')) {
59
    // Update the schema.
60
    db_drop_primary_key('block_class');
61

  
62
    db_change_field('block_class', 'module', 'module',
63
      array(
64
        'type' => 'varchar',
65
        'length' => '64',
66
        'not null' => TRUE,
67
        'default' => '',
68
        'description' => 'The module to which the block belongs.',
69
      )
70
    );
71

  
72
    db_change_field('block_class', 'delta', 'delta',
73
      array(
74
        'type' => 'varchar',
75
        'length' => '32',
76
        'not null' => TRUE,
77
        'default' => '',
78
        'description' => "The ID of the module's block.",
79
      )
80
    );
81

  
82
    db_change_field('block_class', 'css_class', 'css_class',
83
      array(
84
        'type' => 'varchar',
85
        'length' => '255',
86
        'not null' => TRUE,
87
        'default' => '',
88
        'description' => 'String containing the classes for the block.',
89
      )
90
    );
91

  
92
    // Restore the primary key.
93
    db_add_primary_key('block_class', array('module', 'delta'));
94
  }
95
}
96

  
97
/**
98
 * Fix too long primary key length in {block_class}.
99
 */
100
function block_class_update_7101() {
101
  // Ensure the block_class table exists, which is not true for all versions.
102
  if (db_table_exists('block_class')) {
103
    // Drop current primary key.
104
    db_drop_primary_key('block_class');
105

  
106
    db_change_field('block_class', 'module', 'module', array(
107
      'type' => 'varchar',
108
      'length' => 64,
109
      'not null' => TRUE,
110
      'default' => '',
111
      'description' => 'The module to which the block belongs.',
112
    ));
113
    db_change_field('block_class', 'delta', 'delta', array(
114
      'type' => 'varchar',
115
      'length' => 32,
116
      'not null' => TRUE,
117
      'default' => '',
118
      'description' => "The ID of the module's block.",
119
    ));
120

  
121
    // Create new primary key.
122
    db_add_primary_key('block_class', array('module', 'delta'));
123
  }
124
}
125

  
126
/**
127
 * Migration from block_class table to new field css_class in core block table.
128
 */
129
function block_class_update_7103() {
130
  if (!db_field_exists('block', 'block_class')) {
131
    $schema['block'] = array();
132
    block_class_schema_alter($schema);
133
    foreach ($schema['block']['fields'] as $field => $specs) {
134
      db_add_field('block', $field, $specs);
135
    }
136
  }
137

  
138
  if (db_table_exists('block_class')) {
139
    // Migrate all existing records from block_class table to block table.
140
    $result = db_query('SELECT css_class, module, delta FROM {block_class}');
141
    while ($record = $result->fetchObject()) {
142
      db_update('block')
143
        ->fields(array('css_class' => $record->css_class))
144
        ->condition('module', $record->module)
145
        ->condition('delta', $record->delta)
146
        ->execute();
147
    }
148
    // Remove the block_class table.
149
    db_drop_table('block_class');
150
  }
151
}
drupal7/sites/all/modules/block_class/block_class.module
1
<?php
2

  
3
/**
4
 * @file
5
 * Enhanced control over the CSS Classes of any Block.
6
 *
7
 * Block Class allows users to add classes to any block through the block's
8
 * configuration interface. This implementation is based on an alteration of
9
 * the Core block database table to leverage the Core Block API functions,
10
 * objects and structure.
11
 */
12

  
13
/**
14
 * Implements hook_permission().
15
 */
16
function block_class_permission() {
17
  return array(
18
    'administer block classes' => array(
19
      'title' => t('Administer block classes'),
20
      'description' => t('Set CSS classes for blocks.'),
21
    ),
22
  );
23
}
24

  
25
/**
26
 * Implements theme_preprocess_block().
27
 *
28
 * Extend block's classes with any user defined classes.
29
 */
30
function block_class_preprocess_block(&$vars) {
31
  $block = $vars['block'];
32
  if (!empty($block->css_class)) {
33
    $classes_array = explode(' ', $block->css_class);
34
    foreach ($classes_array as $class) {
35
      $vars['classes_array'][] = drupal_clean_css_identifier($class, array());
36
    }
37
  }
38
}
39

  
40
/**
41
 * Implements hook_preprocess_HOOK().
42
 *
43
 * Extend panel block's classes with any user defined classes.
44
 */
45
function block_class_preprocess_panels_pane(&$vars) {
46
  if ($vars['pane']->type != 'block') {
47
    return;
48
  }
49
  // Infer the block's $module and $delta from the pane subtype.
50
  $block_parts = explode('-', $vars['pane']->subtype);
51
  // Load the block based on the block parts.
52
  $block = block_load($block_parts[0], $block_parts[1]);
53
  // Add a generic 'module type' pane class.
54
  $vars['classes_array'][] = drupal_html_class('pane-' . $block->module);
55
  // Add $css_class to the $classes_array.
56
  if (!empty($block->css_class)) {
57
    $classes_array = explode(' ', $block->css_class);
58
    foreach ($classes_array as $class) {
59
      $vars['classes_array'][] = drupal_clean_css_identifier($class, array());
60
    }
61
  }
62
}
63

  
64
/**
65
 * Implements hook_form_alter().
66
 *
67
 * Alter block edit form to add configuration field.
68
 */
69
function block_class_form_alter(&$form, &$form_state, $form_id) {
70
  if (user_access('administer block classes') && ($form_id == 'block_admin_configure' || $form_id == 'block_add_block_form')) {
71
    // Load statically cached block object used to display the form.
72
    $block = block_load($form['module']['#value'], $form['delta']['#value']);
73

  
74
    $form['settings']['css_class'] = array(
75
      '#type' => 'textfield',
76
      '#title' => t('CSS class(es)'),
77
      '#default_value' => isset($block->css_class) ? $block->css_class : '',
78
      '#description' => t('Customize the styling of this block by adding CSS classes. Separate multiple classes by spaces.'),
79
      '#maxlength' => 255,
80
    );
81

  
82
    $form['#submit'][] = 'block_class_form_submit';
83
  }
84
}
85

  
86
/**
87
 * Helper function: additional submit callback for block configuration pages.
88
 *
89
 * Save supplied CSS classes.
90
 */
91
function block_class_form_submit($form, &$form_state) {
92
  if ($form_state['values']['form_id'] == 'block_admin_configure' || $form_state['values']['form_id'] == 'block_add_block_form') {
93
    // Only save if value has changed.
94
    if (isset($form_state['values']['css_class']) && $form['settings']['css_class']['#default_value'] != $form_state['values']['css_class'] && user_access('administer blocks')) {
95
      db_update('block')
96
        ->fields(array('css_class' => $form_state['values']['css_class']))
97
        ->condition('module', $form_state['values']['module'])
98
        ->condition('delta', $form_state['values']['delta'])
99
        ->execute();
100
      // Flush all context module cache to use the updated css_class.
101
      if (module_exists('context')) {
102
        cache_clear_all('context', 'cache', TRUE);
103
      }
104
    }
105
  }
106
}
drupal7/sites/all/modules/block_class/block_class.test
1
<?php
2

  
3
/**
4
 * @file
5
 * Test the Block Class module.
6
 */
7

  
8
/**
9
 * Provides common functionality for the Block Class test classes.
10
 */
11
class BlockClassTestCase extends DrupalWebTestCase {
12

  
13
  /**
14
   * User object to perform site browsing
15
   * @var object
16
   */
17
  protected $privilegedUser;
18

  
19
  /**
20
   * Machine name of the module providing the block coupled with delta.
21
   * @var string
22
   */
23
  protected $module = 'system';
24

  
25
  /**
26
   * Block delta as provided by its module.
27
   * @var string
28
   */
29
  protected $delta = 'main';
30

  
31
  /**
32
   * Permissions required by the user to perform the tests.
33
   * @var array
34
   */
35
  protected $permissions = array(
36
    'administer blocks',
37
    'administer block classes',
38
  );
39

  
40
  /**
41
   * Enable modules and create user with specific permissions.
42
   *
43
   * By default Test Cases are carried on the "Main page content" Block.
44
   */
45
  public function setUp() {
46
    // Merge inherited classes modules, see FieldUITestCase for an example.
47
    $modules = func_get_args();
48
    if (isset($modules[0]) && is_array($modules[0])) {
49
      $modules = $modules[0];
50
    }
51
    $modules[] = 'block_class';
52
    parent::setUp($modules);
53

  
54
    // Authenticate test user.
55
    $this->privilegedUser = $this->drupalCreateUser($this->permissions);
56
    $this->drupalLogin($this->privilegedUser);
57
  }
58

  
59
  /**
60
   * Update Block CSS class and assert whether it is found when displayed.
61
   *
62
   * @param bool $anon
63
   *   (optional) Set to TRUE to view block with anon user, defaults to TRUE.
64
   * @param string $module
65
   *   (optional) Machine name of the module Defaults to
66
   *   $this->module if set to NULL.
67
   * @param string $delta
68
   *   (optional) Block delta as provided by its module. Defaults to
69
   *   $this->delta if set to NULL.
70
   */
71
  public function assertUpdateBlockClass($anon = FALSE, $module = NULL, $delta = NULL) {
72
    // Initialize $module and $delta by default if no value is provided.
73
    if (!isset($module)) {
74
      $module = $this->module;
75
    }
76
    if (!isset($delta)) {
77
      $delta = $this->delta;
78
    }
79
    // Test with three random class names.
80
    $css_classes = implode(' ', array(
81
      $this->randomName(8),
82
      $this->randomName(8),
83
      $this->randomName(8),
84
    ));
85
    // Update Block CSS class field.
86
    $this->drupalPost("admin/structure/block/manage/$module/$delta/configure", array('css_class' => $css_classes), t('Save block'));
87
    // Check Block configuration was saved successfully.
88
    $this->assertText(t('The block configuration has been saved.'));
89
    // Browse to the homepage.
90
    $this->drupalGet('');
91
    // Log out if the test is for anonymous user.
92
    if ($anon) {
93
      $this->drupalLogout();
94
      // Browse back to the homepage.
95
      $this->drupalGet('');
96
    }
97
    // Check if the Block CSS classes could be found.
98
    $this->assertPattern('/class=\"(.*?)' . $css_classes . '(.*?)\"/', format_string('The CSS classes were found: @css_classes', array('@css_classes' => $css_classes)));
99
    // Login again after testing with the anonumous user.
100
    if ($anon) {
101
      $this->drupalLogin($this->privilegedUser);
102
    }
103
  }
104
}
105

  
106
/**
107
 * Test the update and display of the CSS class for a Block.
108
 */
109
class BlockClassUpdateDisplayTestCase extends BlockClassTestCase {
110

  
111
  /**
112
   * Implements DrupalWebTestCase::getInfo().
113
   */
114
  public static function getInfo() {
115
    return array(
116
      'name' => 'Block CSS class update and display',
117
      'description' => 'Test the update of a Block CSS class field and the display for the Main Page Content Block.',
118
      'group' => 'Block Class',
119
    );
120
  }
121

  
122
  /**
123
   * Update and display a Block multiple times to ensure CSS class is found.
124
   *
125
   * A Block is updated and displayed several times and with logged in or
126
   * anonymous user, with Block cache turned enabled or disabled.
127
   */
128
  public function testUpdateDisplayClass() {
129
    // Edit the block, change the class and check if the CSS classes are found.
130
    $this->assertUpdateBlockClass();
131

  
132
    // Now, turn on caching programmatically and set it to 15 min expiry.
133
    variable_set('block_cache', TRUE);
134
    variable_set('cache_lifetime', 900);
135
    variable_set('page_cache_maximum_age', 900);
136

  
137
    // Edit the block, change the class and check with the anonymous user.
138
    $this->assertUpdateBlockClass(TRUE);
139

  
140
    // Edit the block, change the class and check with the anonymous user.
141
    $this->assertUpdateBlockClass(TRUE);
142
  }
143
}
144

  
145
/**
146
 * Test Block Class permissions.
147
 */
148
class BlockClassPermissionTestCase extends BlockClassTestCase {
149

  
150
  /**
151
   * Implements DrupalWebTestCase::getInfo().
152
   */
153
  public static function getInfo() {
154
    return array(
155
      'name' => 'Administer block classes permission',
156
      'description' => 'Test the permission added by the module to administer block classes.',
157
      'group' => 'Block Class',
158
    );
159
  }
160

  
161
  /**
162
   * Enable modules and create user with specific permissions.
163
   */
164
  public function setUp() {
165
    // Remove the 'administer block classes' permission from the base class.
166
    $this->permissions = array('administer blocks');
167
    parent::setUp();
168
  }
169

  
170
  /**
171
   * Ensure Block CSS classes field is only visible with the right permissions.
172
   *
173
   * Test if a user without 'administer block classes' permission has access to
174
   * the Block CSS classes field on the block configuration page.
175
   */
176
  public function testPermission() {
177
    // Browse to the "Main page content" block editing form page.
178
    $this->drupalGet("admin/structure/block/manage/{$this->module}/{$this->delta}/configure");
179
    // Check that the css_class field couldn't be found.
180
    // If the field is not found, it can't be submitted through drupalPost.
181
    $this->assertNoFieldById('css_class', 'The Css classes field was not found on the page.');
182
  }
183
}
184

  
185
/**
186
 * Test Block Class integration with Context.
187
 */
188
class BlockClassContextTestCase extends BlockClassUpdateDisplayTestCase {
189

  
190
  /**
191
   * Implements DrupalWebTestCase::getInfo().
192
   */
193
  public static function getInfo() {
194
    return array(
195
      'name' => 'Integration with Context',
196
      'description' => 'Test the integration of Block Class with the Context module and the update/display of a Block CSS class.',
197
      // Include required contributed modules context and ctools for the test.
198
      'dependencies' => array('context', 'ctools'),
199
      'group' => 'Block Class',
200
    );
201
  }
202

  
203
  /**
204
   * Enable modules and create user with specific permissions.
205
   */
206
  public function setUp() {
207
    // Override default module and delta to test with the "Who's online" block.
208
    $this->module = 'user';
209
    $this->delta = 'online';
210
    // Include the Context module and its dependencies to be loaded.
211
    parent::setUp('context');
212
    // Initialize a test context with the test block.
213
    $this->initializeContext();
214
  }
215

  
216
  /**
217
   * Helper function to initialize a test Context with a test block.
218
   */
219
  public function initializeContext() {
220
    // Import a basic context exported through the admin interface.
221
    $context = new stdClass();
222
    $context->disabled = FALSE;
223
    $context->api_version = 3;
224
    $context->name = 'front';
225
    $context->description = 'Frontpage Context';
226
    $context->tag = '';
227
    $context->conditions = array(
228
      'path' => array(
229
        'values' => array(
230
          '<front>' => '<front>',
231
        ),
232
      ),
233
    );
234
    $context->reactions = array(
235
      'block' => array(
236
        'blocks' => array(
237
          $this->module . '-' . $this->delta => array(
238
            'module' => $this->module,
239
            'delta' => $this->delta,
240
            'region' => 'content',
241
            'weight' => '-10',
242
          ),
243
        ),
244
      ),
245
    );
246
    $context->condition_mode = 0;
247

  
248
    // Translatables
249
    // Included for use with string extractors like potx.
250
    t('Frontpage Context');
251

  
252
    // Save the context.
253
    context_save($context);
254
  }
255
}
256

  
257
/**
258
 * Test Block Class integration with Features through FE Block.
259
 */
260
class BlockClassFeaturesTestCase extends BlockClassTestCase {
261

  
262
  /**
263
   * Implements DrupalWebTestCase::getInfo().
264
   */
265
  public static function getInfo() {
266
    return array(
267
      'name' => 'Integration with Features',
268
      'description' => 'Test the integration of Block Class with Features through the FE Block module and the update/display of a Block CSS class.',
269
      // Include Features related modules required for this Test Case.
270
      'dependencies' => array('features', 'ctools', 'fe_block'),
271
      'group' => 'Block Class',
272
    );
273
  }
274

  
275
  /**
276
   * Enable modules and create user with specific permissions.
277
   */
278
  public function setUp() {
279
    // Override default module and delta to test with the "Who's online" block.
280
    $this->module = 'user';
281
    $this->delta = 'online';
282
    // Include all Features related modules and Test Helper feature.
283
	parent::setUp('block_class_fe_block_test');
284
  }
285

  
286
  /**
287
   * Test how Block Class reacts when exported to a Feature with FE Block.
288
   *
289
   * Helper Feature's Block configuration settings are imported, updated and
290
   * the display is tested several times, before reverting the feature.
291
   */
292
  public function testFeatureDisplayClass() {
293
    // Block classes exported to the Test Feature module.
294
    $test_classes = 'fe_block-class1 fe_block-class2 fe_block-class3';
295
    // Test helper feature machine name.
296
    $test_feature = 'block_class_fe_block_test';
297

  
298
    // Browse to the front page and check Block's CSS classes configuration.
299
    $this->drupalGet('');
300
    // Check if feature's Block CSS classes could be found.
301
    $this->assertPattern('/class=\"(.*?)' . $test_classes . '(.*?)\"/', format_string('The CSS classes from exported feature were found: @css_classes', array('@css_classes' => $test_classes)));
302

  
303
    // Check Block's configuration form css_class field value.
304
    $this->drupalGet("admin/structure/block/manage/{$this->module}/{$this->delta}/configure");
305
    $this->assertFieldByName('css_class', $test_classes, format_string('The CSS classes from exported feature were found for the field <em>css_class</em> in the Block\'s configuration page: @css_classes', array('@css_classes' => $test_classes)));
306

  
307
    // Run a standard Update/Display Test check with Anon.
308
    $this->assertUpdateBlockClass(TRUE);
309

  
310
    // Ensure Feature's state is overriden for 'fe_block_settings' component.
311
    module_load_include('inc', 'features', 'features.export');
312
    $test_feature_state = features_get_storage($test_feature);
313
    $this->assertFalse(empty($test_feature_state), 'The state of the <em>Block Class FE Block Integration Test Helper</em> feature is <strong>Overridden</strong>.');
314
    $test_feature_states = features_get_component_states(array($test_feature));
315
    $this->assertFalse(empty($test_feature_states[$test_feature]['fe_block_settings']), 'The state of the <em>fe_block_settings</em> component of the <em>Block Class FE Block Integration Test Helper</em> feature is <strong>Overridden</strong>.');
316

  
317
    // Revert feature and check again.
318
    features_revert_module($test_feature);
319

  
320
    // Browse to the front page and check Block's CSS classes configuration.
321
    $this->drupalGet('');
322
    // Check if feature's Block CSS classes could be found.
323
    $this->assertPattern('/class=\"(.*?)' . $test_classes . '(.*?)\"/', format_string('After reverting the feature, the CSS classes from exported feature were found: @css_classes', array('@css_classes' => $test_classes)));
324

  
325
    // Check Block's configuration form css_class field value.
326
    $this->drupalGet("admin/structure/block/manage/{$this->module}/{$this->delta}/configure");
327
    $this->assertFieldByName('css_class', $test_classes, format_string('After reverting the feature, the CSS classes from exported feature were found for the field <em>css_class</em> in the Block\'s configuration page: @css_classes', array('@css_classes' => $test_classes)));
328
  }
329
}
drupal7/sites/all/modules/block_class/tests/block_class_fe_block_test.features.fe_block_settings.inc
1
<?php
2
/**
3
 * @file
4
 * block_class_fe_block_test.features.fe_block_settings.inc
5
 */
6

  
7
/**
8
 * Implements hook_default_fe_block_settings().
9
 */
10
function block_class_fe_block_test_default_fe_block_settings() {
11
  $export = array();
12

  
13
  $export['version'] = '2.0';
14

  
15
  $export['user-online'] = array(
16
    'cache' => -1,
17
    'css_class' => 'fe_block-class1 fe_block-class2 fe_block-class3',
18
    'custom' => 0,
19
    'delta' => 'online',
20
    'module' => 'user',
21
    'node_types' => array(),
22
    'pages' => '<front>',
23
    'roles' => array(),
24
    'themes' => array(
25
      'bartik' => array(
26
        'region' => 'content',
27
        'status' => 1,
28
        'theme' => 'bartik',
29
        'weight' => -7,
30
      ),
31
    ),
32
    'title' => 'Block Class Test Who\'s Online with FE Block',
33
    'visibility' => 1,
34
  );
35

  
36
  return $export;
37
}
drupal7/sites/all/modules/block_class/tests/block_class_fe_block_test.info
1
name = Block Class FE Block Integration Test Helper
2
description = Helper module for testing the integration of Block Class with Features through the FE Block module.
3
core = 7.x
4
package = Features
5
dependencies[] = fe_block
6
features[fe_block_settings][] = user-online
7
features[features_api][] = api:2
8
hidden = TRUE
9

  
10
; Information added by Drupal.org packaging script on 2015-12-18
11
version = "7.x-2.3"
12
core = "7.x"
13
project = "block_class"
14
datestamp = "1450415951"
15

  
drupal7/sites/all/modules/block_class/tests/block_class_fe_block_test.module
1
<?php
2
/**
3
 * @file
4
 * Drupal needs this blank file.
5
 */

Formats disponibles : Unified diff