FINAL suepr merge step : added all modules to this super repos
This commit is contained in:
Bachir Soussi Chiadmi
339
sites/all/modules/contrib/fields/computed_field/LICENSE.txt
Normal file
339
sites/all/modules/contrib/fields/computed_field/LICENSE.txt
Normal file
@@ -0,0 +1,339 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Lesser General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along
|
||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License.
|
||||
@@ -0,0 +1,13 @@
|
||||
name = Computed Field
|
||||
description = Defines a field type that allows values to be "computed" via PHP code.
|
||||
core = 7.x
|
||||
dependencies[] = field
|
||||
package = Fields
|
||||
files[]=computed_field.install
|
||||
files[]=computed_field.module
|
||||
; Information added by drupal.org packaging script on 2012-02-02
|
||||
version = "7.x-1.0-beta1"
|
||||
core = "7.x"
|
||||
project = "computed_field"
|
||||
datestamp = "1328217338"
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Install, update and uninstall functions for the computed field module.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Implements of hook_field_schema().
|
||||
*/
|
||||
function computed_field_field_schema($field) {
|
||||
if ($field['type'] == 'computed') {
|
||||
$settings = $field['settings'];
|
||||
|
||||
if ($settings['store']) {
|
||||
$columns = array('value' => array());
|
||||
|
||||
// Hardcoded 'longtext' settings
|
||||
if ($settings['database']['data_type'] == 'longtext') {
|
||||
$columns['value']['type'] = 'text';
|
||||
$columns['value']['size'] = 'big';
|
||||
}
|
||||
else {
|
||||
$columns['value']['type'] = isset($settings['database']['data_type']) ? $settings['database']['data_type'] : 'varchar';
|
||||
}
|
||||
// 'text' and 'varchar' fields get length settings
|
||||
if ($settings['database']['data_type'] == 'text' || $settings['database']['data_type'] == 'varchar') {
|
||||
$columns['value']['length'] = isset($settings['database']['data_length']) ? $settings['database']['data_length'] : 32;
|
||||
}
|
||||
// 'int' and 'float' fields get size settings
|
||||
if ($settings['database']['data_type'] == 'int' || $settings['database']['data_type'] == 'float') {
|
||||
$columns['value']['size'] = isset($settings['database']['data_size']) ? $settings['database']['data_size'] : 'normal';
|
||||
}
|
||||
// 'decimal' fields get precision and scale settings
|
||||
if ($settings['database']['data_type'] == 'numeric') {
|
||||
$columns['value']['precision'] = isset($settings['database']['data_precision']) ? $settings['database']['data_precision'] : 10;
|
||||
$columns['value']['scale'] = isset($settings['database']['data_scale']) ? $settings['database']['data_scale'] : 2;
|
||||
}
|
||||
// Add 'not null' settings
|
||||
$columns['value']['not null'] = isset($settings['database']['data_not_NULL']) ? $settings['database']['data_not_NULL'] : TRUE;
|
||||
// Add default values if set
|
||||
if ($settings['database']['data_default'] != '') {
|
||||
$columns['value']['default'] = $settings['database']['data_default'];
|
||||
}
|
||||
// Add a simple index on the data if requested (except 'text' fields)
|
||||
if ($settings['database']['data_index'] && $columns['value']['type'] != 'text') {
|
||||
$indexes = array('value' => array('value'));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($columns) && isset($indexes)) {
|
||||
return array(
|
||||
'columns' => $columns,
|
||||
'indexes' => $indexes,
|
||||
);
|
||||
}
|
||||
elseif (isset($columns)) {
|
||||
return array(
|
||||
'columns' => $columns,
|
||||
);
|
||||
}
|
||||
else return;
|
||||
}
|
||||
@@ -0,0 +1,469 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Implements field hook_field_info().
|
||||
*/
|
||||
function computed_field_field_info() {
|
||||
return array(
|
||||
'computed' => array(
|
||||
'label' => t('Computed'),
|
||||
'description' => t('Create field data via PHP code.'),
|
||||
'settings' => array(
|
||||
'code' => '$entity_field[0][\'value\'] = "";',
|
||||
'display_format' => '$display_output = $entity_field_item[\'value\'];',
|
||||
'store' => 1,
|
||||
'database' => array(
|
||||
'data_type' => 'varchar',
|
||||
'data_length' => 32,
|
||||
'data_size' => 'normal',
|
||||
'data_precision' => 10,
|
||||
'data_scale' => 2,
|
||||
'data_not_NULL' => FALSE,
|
||||
'data_default' => NULL,
|
||||
'data_index' => FALSE,
|
||||
),
|
||||
),
|
||||
'default_widget' => 'computed',
|
||||
'default_formatter' => 'computed_field_plain',
|
||||
// If we followed the core convention of separate fields for each data
|
||||
// type we could make Entity API happy by just setting a property_type.
|
||||
// Instead we have to use our own callback to determine the type then
|
||||
// rerun theirs to setup the rest of the field properties.
|
||||
'property_callbacks' => array('computed_field_entity_property_callback'),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Callback to setup Entity API's field properties.
|
||||
*/
|
||||
function computed_field_entity_property_callback(&$info, $entity_type, $field, $instance, $field_type) {
|
||||
$property_types = array(
|
||||
'int' => 'integer',
|
||||
'float' => 'decimal', 'numeric' => 'decimal',
|
||||
'varchar' => 'text', 'text' => 'text', 'longtext' => 'text',
|
||||
);
|
||||
if (isset($field['columns']['value']) && isset($property_types[$field['columns']['value']['type']])) {
|
||||
// Entity API's defaults are pretty good so set the property_type and let
|
||||
// them do the work for us.
|
||||
$field_type['property_type'] = $property_types[$field['columns']['value']['type']];
|
||||
entity_metadata_field_default_property_callback($info, $entity_type, $field, $instance, $field_type);
|
||||
// The only thing is that a setter doesn't make sense, so let's disable it.
|
||||
$property = &$info[$entity_type]['bundles'][$instance['bundle']]['properties'][$field['field_name']];
|
||||
unset($property['setter callback']);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements of hook_field_settings_form().
|
||||
*/
|
||||
function computed_field_field_settings_form($field, $instance, $has_data) {
|
||||
$form = array();
|
||||
$compute_func = 'computed_field_' . $field['field_name'] . '_compute';
|
||||
$display_func = 'computed_field_' . $field['field_name'] . '_display';
|
||||
$settings = $field['settings'];
|
||||
|
||||
$form['#element_validate'] = array('computed_field_field_settings_form_validate');
|
||||
|
||||
$form['code'] = array(
|
||||
'#type' => 'textarea',
|
||||
'#rows' => 15,
|
||||
'#title' => t('Computed Code (PHP)'),
|
||||
'#description' => t('The variables available to your code include: <code>@fields</code>. To set the value of the field, set <code>@entity_field</code>. For multi-value computed fields continue with <code>@entity_field_multi</code>. Here\'s a simple example which sets the computed field\'s value to the value of the sum of the number fields (<code>@field_a</code> and <code>@field_b</code>) in a node entity:<p><code>@example</code> The first pop fetches the last (or only) item from the field while the second pop fetches its <code>[\'value\']</code> contents (assuming it\'s the only key that\'s set).<p>Alternately, this code can be supplied by your own custom function named: <code>@compute_func(&$entity_field, $entity_type, $entity, $field, $instance, $langcode, $items)</code>',
|
||||
array('@fields' => '&$entity_field, $entity_type, $entity, $field, $instance, $langcode, and $items',
|
||||
'@entity_field' => '$entity_field[0][\'value\']',
|
||||
'@entity_field_multi' => '$entity_field[1][\'value\']',
|
||||
'@field_a' => 'field_a',
|
||||
'@field_b' => 'field_b',
|
||||
'@example' => '$entity_field[0][\'value\'] = array_pop(array_pop(field_get_items($entity_type, $entity, \'field_a\'))) + array_pop(array_pop(field_get_items($entity_type, $entity, \'field_b\')));',
|
||||
'@compute_func' => $compute_func)),
|
||||
'#default_value' => !empty($settings['code']) ? $settings['code'] : '$entity_field[0][\'value\'] = "";',
|
||||
'#access' => !function_exists($compute_func),
|
||||
);
|
||||
if (function_exists($compute_func)) {
|
||||
$form['compute_func'] = array(
|
||||
'#type' => 'item',
|
||||
'#markup' => t('<strong>This field is COMPUTED using <code>@compute_func()</code>.</strong>', array('@compute_func' => $compute_func)),
|
||||
);
|
||||
}
|
||||
$form['display_format'] = array(
|
||||
'#type' => 'textarea',
|
||||
'#title' => t('Display Code (PHP)'),
|
||||
'#description' => t('This code should assign a string to the <code>@display_output</code> variable, which will be printed when the field is displayed. The raw computed value of the field is in <code>@value</code>. <strong>Note:</strong> this code has no effect if you use the "Raw computed value" display formatter.<p> Alternately, this code can be supplied by your own custom function named: <code>@display_func($field, $entity_field_item, $entity_lang, $langcode)</code>. Return the value to be displayed. Original value is in $entity_field_item[\'value\'].',
|
||||
array('@display_output' => '$display_output',
|
||||
'@value' => '$entity_field_item[\'value\']',
|
||||
'@display_func' => $display_func)),
|
||||
'#default_value' => !empty($settings['display_format']) ? $settings['display_format'] : '$display_output = $entity_field_item[\'value\'];',
|
||||
'#access' => !function_exists($display_func),
|
||||
);
|
||||
if (function_exists($display_func)) {
|
||||
$form['display_func'] = array(
|
||||
'#type' => 'item',
|
||||
'#markup' => t('<strong>This field is DISPLAYED using <code>@display_func()</code>.</strong>', array('@display_func' => $display_func)),
|
||||
);
|
||||
}
|
||||
$form['store'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Store value in the database'),
|
||||
'#description' => t('The value will be stored in the database with the settings below. As a result, it will only be recalculated when the entity is updated. This option is required when accessing the field through Views.'),
|
||||
'#default_value' => is_numeric($settings['store']) ? $settings['store'] : 1 ,
|
||||
'#disabled' => $has_data,
|
||||
);
|
||||
$form['database'] = array('#type' => 'fieldset', '#title' => t('Database Storage Settings'));
|
||||
|
||||
if ($has_data) {
|
||||
$form['database']['warning'] = array(
|
||||
'#type' => 'item',
|
||||
'#markup' => t('<strong>**This field currently has stored data, so modifications to its DB settings are not allowed.**</strong>'),
|
||||
);
|
||||
}
|
||||
$form['database']['data_type'] = array(
|
||||
'#type' => 'radios',
|
||||
'#title' => t('Data Type'),
|
||||
'#description' => t('The SQL datatype to store this field in.'),
|
||||
'#default_value' => !empty($settings['database']['data_type']) ? $settings['database']['data_type'] : 'varchar',
|
||||
'#options' => array('varchar' => 'varchar', 'text' => 'text', 'longtext' => 'longtext', 'int' => 'int', 'float' => 'float', 'numeric' => 'decimal'),
|
||||
'#required' => FALSE,
|
||||
'#disabled' => $has_data,
|
||||
);
|
||||
$form['database']['data_length'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => t('Data Length (varchar/text)'),
|
||||
'#description' => t('<strong>Only</strong> valid for <strong>varchar</strong> or <strong>text</strong> fields. The length of the field stored in the database.'),
|
||||
'#default_value' => !empty($settings['database']['data_length']) ? $settings['database']['data_length'] : 32,
|
||||
'#required' => FALSE,
|
||||
'#disabled' => $has_data,
|
||||
);
|
||||
$form['database']['data_size'] = array(
|
||||
'#type' => 'select',
|
||||
'#title' => t('Data Size (int/float)'),
|
||||
'#description' => t('<strong>Only</strong> valid for <strong>int</strong> or <strong>float</strong> fields. The size of the field stored in the database.'),
|
||||
'#default_value' => !empty($settings['database']['data_size']) ? $settings['database']['data_size'] : 'normal',
|
||||
'#options' => array('tiny' => 'tiny', 'small' => 'small', 'medium' => 'medium', 'normal' => 'normal', 'big' => 'big'),
|
||||
'#required' => FALSE,
|
||||
'#disabled' => $has_data,
|
||||
);
|
||||
$form['database']['data_precision'] = array(
|
||||
'#type' => 'select',
|
||||
'#title' => t('Decimal Precision (decimal)'),
|
||||
'#description' => t('<strong>Only</strong> valid for <strong>decimal</strong> fields. The total number of digits to store in the database, including those to the right of the decimal.'),
|
||||
'#options' => drupal_map_assoc(range(10, 32)),
|
||||
'#default_value' => !empty($settings['database']['data_precision']) ? $settings['database']['data_precision'] : 10,
|
||||
'#required' => FALSE,
|
||||
'#disabled' => $has_data,
|
||||
);
|
||||
$form['database']['data_scale'] = array(
|
||||
'#type' => 'select',
|
||||
'#title' => t('Decimal Scale (decimal)'),
|
||||
'#description' => t('<strong>Only</strong> valid for <strong>decimal</strong> fields. The number of digits to the right of the decimal. '),
|
||||
'#options' => drupal_map_assoc(range(0, 10)),
|
||||
'#default_value' => !empty($settings['database']['data_scale']) ? $settings['database']['data_scale'] : 2,
|
||||
'#required' => FALSE,
|
||||
'#disabled' => $has_data,
|
||||
);
|
||||
$form['database']['data_default'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => t('Default Value'),
|
||||
'#default_value' => $settings['database']['data_default'],
|
||||
'#required' => FALSE,
|
||||
'#disabled' => $has_data,
|
||||
);
|
||||
$form['database']['data_not_NULL'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Not NULL'),
|
||||
'#default_value' => is_numeric($settings['database']['data_not_NULL']) ? $settings['database']['data_not_NULL'] : FALSE,
|
||||
'#disabled' => $has_data,
|
||||
);
|
||||
$form['database']['data_index'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Index computed values in the database (Does not apply to text or longtext fields.)'),
|
||||
'#default_value' => is_numeric($settings['database']['data_index']) ? $settings['database']['data_index'] : FALSE,
|
||||
'#disabled' => $has_data,
|
||||
);
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements the #element_validate callback for computed_field_field_settings_form().
|
||||
*/
|
||||
function computed_field_field_settings_form_validate($element, &$form_state) {
|
||||
$settings = $form_state['values']['field']['settings'];
|
||||
if ($settings['store']) {
|
||||
if (empty($settings['database']['data_type'])) {
|
||||
form_set_error('field][settings][data_type', t('To store this field in the database, please specify a data type.'));
|
||||
}
|
||||
if (($settings['database']['data_type'] == 'text' || $settings['database']['data_type'] == 'varchar') && empty($settings['database']['data_length'])) {
|
||||
form_set_error('field][settings][database][data_length', t('To store this field in the database, please specify the data length.'));
|
||||
}
|
||||
if (($settings['database']['data_type'] == 'int' || $settings['database']['data_type'] == 'float') && (!empty($settings['database']['data_default']) && !is_numeric($settings['database']['data_default']))) {
|
||||
form_set_error('field][settings][database][data_default', t('Your default value should be numeric given your data type.'));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements field hook_field_load().
|
||||
*/
|
||||
function computed_field_field_load($entity_type, $entities, $field, $instances, $langcode, &$items, $age) {
|
||||
$settings = $field['settings'];
|
||||
// Compute field values on load if they aren't stored in the database
|
||||
if (!$settings['store']) {
|
||||
foreach ($entities as $etid => $entity) {
|
||||
_computed_field_compute_value($entity_type, $entity, $field, $instances, $langcode, $items[$etid]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements field hook_field_prepare_view().
|
||||
*/
|
||||
function computed_field_field_prepare_view($entity_type, $entities, $field, $instances, $langcode, &$items) {
|
||||
// Compute field values in case user is "previewing" an entity
|
||||
foreach ($entities as $etid => $entity) {
|
||||
if (isset($entity->op) && $entity->op == 'Preview') {
|
||||
_computed_field_compute_value($entity_type, $entity, $field, $instances, $langcode, $items[$etid]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements field hook_field_insert().
|
||||
*/
|
||||
function computed_field_field_insert($entity_type, $entity, $field, $instance, $langcode, &$items) {
|
||||
_computed_field_compute_value($entity_type, $entity, $field, $instance, $langcode, $items);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements field hook_field_update().
|
||||
*/
|
||||
function computed_field_field_update($entity_type, $entity, $field, $instance, $langcode, &$items) {
|
||||
_computed_field_compute_value($entity_type, $entity, $field, $instance, $langcode, $items);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements field hook_field_widget_info().
|
||||
*/
|
||||
function computed_field_field_widget_info() {
|
||||
return array(
|
||||
'computed' => array(
|
||||
'label' => t('Computed'),
|
||||
'field types' => array('computed'),
|
||||
'behaviors' => array(
|
||||
'multiple values' => FIELD_BEHAVIOR_CUSTOM,
|
||||
'default value' => FIELD_BEHAVIOR_NONE,
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements field hook_field_widget_form().
|
||||
*/
|
||||
|
||||
function computed_field_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
|
||||
|
||||
// If there are no items yet, add a null item value to avoid
|
||||
// preview errors when selecting a different language
|
||||
if (empty($items)) $items[0]['value'] = NULL;
|
||||
|
||||
foreach ($items as $item_delta => $item) {
|
||||
$element[$item_delta]['value'] = array(
|
||||
'#type' => 'value',
|
||||
'#tree' => TRUE,
|
||||
'#default_value' => isset($item['value']) ? $item['value'] : NULL,
|
||||
);
|
||||
}
|
||||
return $element;
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_field_formatter_info().
|
||||
*/
|
||||
function computed_field_field_formatter_info() {
|
||||
return array(
|
||||
'computed_field_unsanitized' => array(
|
||||
'label' => t('Unsanitized'),
|
||||
'field types' => array('computed'),
|
||||
),
|
||||
'computed_field_plain' => array(
|
||||
'label' => t('Plain text'),
|
||||
'field types' => array('computed'),
|
||||
),
|
||||
'computed_field_markup' => array(
|
||||
'label' => t('Filtered markup'),
|
||||
'field types' => array('computed'),
|
||||
),
|
||||
'computed_field_computed_value' => array(
|
||||
'label' => t('Raw value, no display code'),
|
||||
'field types' => array('computed'),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_field_formatter_view().
|
||||
*/
|
||||
function computed_field_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
|
||||
$element = array();
|
||||
|
||||
// Special case formatter that returns the raw computed values without any display code processing
|
||||
if ($display['type'] == "computed_field_computed_value") {
|
||||
foreach ($items as $delta => $item) {
|
||||
if (!isset($entity_field_item['value'])) $entity_field_item['value'] = NULL;
|
||||
$element[$delta] = array('#markup' => $item['value']);
|
||||
}
|
||||
return $element;
|
||||
}
|
||||
|
||||
// Other display formatters which run through display code processing
|
||||
// Check if the value is to be formatted by a display function outside the DB
|
||||
$display_func = 'computed_field_' . $field['field_name'] . '_display';
|
||||
if (function_exists($display_func)) $display_in_code = TRUE;
|
||||
else $display_in_code = FALSE;
|
||||
|
||||
// Loop the items to display
|
||||
foreach ($items as $delta => $item) {
|
||||
|
||||
// For "some" backwards compatibility
|
||||
$entity_field_item = $item;
|
||||
|
||||
// Setup a variable with the entity language if available
|
||||
if (isset($entity->language)) $entity_lang = $entity->language;
|
||||
else $entity_lang = LANGUAGE_NONE;
|
||||
|
||||
// If there are value "holes" in the field array let's set the value to NULL
|
||||
// to avoid undefined index errors in typical PHP display code
|
||||
if (!isset($entity_field_item['value'])) $entity_field_item['value'] = NULL;
|
||||
|
||||
// Execute the display code
|
||||
$display_output = NULL;
|
||||
if ($display_in_code) {
|
||||
$display_output = $display_func($field, $entity_field_item, $entity_lang, $langcode);
|
||||
}
|
||||
else {
|
||||
eval($field['settings']['display_format']);
|
||||
}
|
||||
|
||||
// Output the formatted display item
|
||||
switch ($display['type']) {
|
||||
case 'computed_field_unsanitized':
|
||||
$element[$delta] = array('#markup' => $display_output);
|
||||
break;
|
||||
case 'computed_field_plain':
|
||||
$element[$delta] = array('#markup' => check_plain($display_output));
|
||||
break;
|
||||
case 'computed_field_markup':
|
||||
$element[$delta] = array('#markup' => check_markup($display_output));
|
||||
break;
|
||||
}
|
||||
}
|
||||
return $element;
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements field hook_field_is_empty().
|
||||
*/
|
||||
function computed_field_field_is_empty($item, $field) {
|
||||
$data_type = $field['settings']['database']['data_type'];
|
||||
if ($data_type == 'int' || $data_type == 'float') {
|
||||
return !is_numeric($item['value']);
|
||||
}
|
||||
return empty($item['value']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_token_info().
|
||||
*/
|
||||
function computed_field_token_info() {
|
||||
$types['computed'] = array(
|
||||
'name' => t("Computed"),
|
||||
'description' => t("Tokens related to Computed fields."),
|
||||
'needs-data' => 'node',
|
||||
);
|
||||
$fields = field_info_fields();
|
||||
$node = array();
|
||||
$computed = array();
|
||||
foreach ($fields as $field_name => $field) {
|
||||
if ($field['module'] == "computed_field") {
|
||||
$node[str_replace('_', '-', $field_name)] = array(
|
||||
'name' => t("Computed: %field_name", array('%field_name' => $field_name)),
|
||||
'description' => t("Computed field %field_name value.", array('%field_name' => $field_name)),
|
||||
'type' => 'computed',
|
||||
);
|
||||
$computed['rawvalue'] = array(
|
||||
'name' => t("Raw computed value"),
|
||||
'description' => t("Computed field %field_name raw value.", array('%field_name' => $field_name)),
|
||||
);
|
||||
}
|
||||
}
|
||||
if (!empty($computed)) {
|
||||
return array(
|
||||
'types' => $types,
|
||||
'tokens' => array('node' => $node, 'computed' => $computed),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_tokens().
|
||||
*/
|
||||
function computed_field_tokens($type, $tokens, array $data = array(), array $options = array()) {
|
||||
$computed_fields = array();
|
||||
$replacements = array();
|
||||
$sanitize = !empty($options['sanitize']);
|
||||
$lang = isset($options['language']->language) ? $options['language']->language : LANGUAGE_NONE;
|
||||
$fields = field_info_fields();
|
||||
foreach ($fields as $field_name => $field) {
|
||||
if ($field['module'] == "computed_field") {
|
||||
$computed_fields[] = str_replace('_', '-', $field_name);
|
||||
}
|
||||
}
|
||||
foreach ($tokens as $name => $original) {
|
||||
// For normal display output
|
||||
if (in_array($name, $computed_fields)) {
|
||||
$field_name = str_replace('-', '_', $name);
|
||||
$entity_field_item = $data[$type]->{$field_name}[$lang][0];
|
||||
$field = $fields[$field_name];
|
||||
// Check if the value is to be formatted by a display function outside the DB
|
||||
$display_func = 'computed_field_' . $field_name . '_display';
|
||||
if (function_exists($display_func)) {
|
||||
$display_output = $display_func($field, $entity_field_item);
|
||||
}
|
||||
else {
|
||||
eval($field['settings']['display_format']);
|
||||
}
|
||||
$replacements[$original] = $sanitize ? check_plain($display_output) : $display_output;
|
||||
}
|
||||
// For raw value output
|
||||
elseif (in_array(str_replace(':rawvalue', '', $name), $computed_fields)) {
|
||||
$field_name = str_replace('-', '_', str_replace(':rawvalue', '', $name));
|
||||
$replacements[$original] = $sanitize ? check_plain($data[$type]->{$field_name}[$lang][0]['value']) : $data[$type]->{$field_name}[$lang][0]['value'];
|
||||
}
|
||||
}
|
||||
return $replacements;
|
||||
}
|
||||
|
||||
/**
|
||||
* Private function to compute the fields value.
|
||||
*/
|
||||
function _computed_field_compute_value($entity_type, $entity, $field, $instance, $langcode, &$items) {
|
||||
$settings = $field['settings'];
|
||||
|
||||
// Setup a variable with the field values
|
||||
$entity_field =& $items;
|
||||
|
||||
// Setup a variable with the entity language if available
|
||||
if (isset($entity->language)) $entity_lang = $entity->language;
|
||||
else $entity_lang = LANGUAGE_NONE;
|
||||
|
||||
// Allow the value to be computed from code not stored in DB
|
||||
$compute_func = 'computed_field_' . $field['field_name'] . '_compute';
|
||||
if (function_exists($compute_func)) {
|
||||
$compute_func($entity_field, $entity_type, $entity, $field, $instance, $langcode, $items);
|
||||
}
|
||||
else {
|
||||
if (isset($settings['code'])) {
|
||||
eval($settings['code']);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user