manuelcillero/suitedesk
manuelcillero/suitedesk
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

New module 'Computed Field'

Browse source
This commit is contained in:
Manuel Cillero 2017-07-26 13:20:05 +02:00
parent ba9e434758
commit 881f0335cf
6 changed files with 1094 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

60
sites/all/modules/computed_field/CHANGELOG.txt Normal file
View file

@ -0,0 +1,60 @@
15th May 2007
----------------------------------------------------------------
* Added a longtext option when storing to database, and fixed validation when
data type is text or longtext as per http://drupal.org/node/141340
* Added callbacks to hook_field_settings as per http://drupal.org/node/87619
28th November 2006
----------------------------------------------------------------
* Deleted license in favour of LICENSE.txt
27th November 2006
----------------------------------------------------------------
* Updated to work with 5.0 cvs. Thanks bdragon.
29th September 2006
----------------------------------------------------------------
* Fixed validation of data length
* Made non-stored computed fields compute on load, rather than view.
15th September 2006
----------------------------------------------------------------
* Made default output the raw text, rather than running check_markup over it
12th September 2006
----------------------------------------------------------------
* Moved code, display, and display format from widget to field
* Added hook_field_formatter_info and hook_field_formatter, and filters op in
hook_field to work properly with new views
17th August 2006
----------------------------------------------------------------
* Changed computed_field_field_view_item to computed_field_view_item so that
it works with views
11th August 2006
----------------------------------------------------------------
* Changed display format so that you can enter arbitrary code to display the
field
* Made display format code run even when there isn't any computed code
* Stored fields are now computed at insert time, rather than submit time. This
means that other fields will have more useful values, since they have
already been processed by their widgets.
7th August 2006
----------------------------------------------------------------
* Made $node editable by computed code
3rd August 2006
----------------------------------------------------------------
* Removed a call to check_plain which was more annoying than useful.
* Changed the field to be computed on submit so that the value can be stored
in the database. A consequence of this is that it won't work on preview, but
at least now it is only computed once (per submit).
* Made computed fields visible in views
* Changed the value you need to set in your code from $node_field['value'] to
$node_field[0]['value] so that multiple values can be used.
21st July 2006
----------------------------------------------------------------
* Initial Release

339
sites/all/modules/computed_field/LICENSE.txt Normal file
View 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.

183
sites/all/modules/computed_field/README.txt Normal file
View file

@ -0,0 +1,183 @@
------------------The Computed Field Drupal Module----------------------------
Computed Field is a cck module which lets you add a computed field to custom
content types. You can choose whether to store your computed field in the
database. You can also choose whether to display the field, and how to format
it. The value of the field is set using php code, so it can draw on anything
available to drupal, including other fields, the current user, database
tables, etc. The drawback of this is of course that you need to know some php
to use it.
Computed Field requires the content module (cck).
-------------------------Update-------------------------------
As of 2006-8-11 the 'display format' setting has changed. You'll need to
update any existing computed fields: If your display format was 'This is the
value: %value', then change it to '$display = "This is the value: " .
$node_field_item['value'];'
-------------------------Usage--------------------------------
----------Getting Started-----------------------------------
Before you can use Computed Field, you'll need to get CCK and enable (at the
very least) the 'content' module. You will probably also want to enable the
other cck modules, such as 'text', 'number', 'date', etc.
To add a computed field to a content type, go to administer > content >
content types, select the content type you want to add to, and click on the
'add field' tab. One of the field types available should be 'Computed', and it
should have one bullet point under it, also labelled 'Computed'. If you select
this, give your field a name, and submit the form, you will get to the
configuration page for your new computed field.
--------Configuration---------------------------------------
A Computed Field can be configured with the usual cck field options, as well
as the following extra options:
Computed Code -- This is the code that will assign a value to your computed
field. It should be valid php without the <?php ?> tags.
Display Format -- This is also php code which should assign a string to the
$display variable. It has '$node_field_item['value']' available, which is the
value of the computed field. It also has '$field' available, and you can call
any drupal functions you want to display your field.
Store using the database settings below -- If this is checked then the field
is computed on node save and stored. If it isn't stored then it will be
recomputed every time you view a node containing this field.
Database Storage Settings
Data Type -- This is the sql data type to use to store the field. Let us
know if you need any other storage types, or if you would like an 'other'
option :).
Data Length (varchar/text) -- The length of the field in the database. For
storing usernames or other short text with a varchar field, 32 may be
appropriate. Only valid for varchar or text fields.
Data Size (int/float) -- The size of the field stored in the database.
Only valid for int or float fields.
Data Precision (decimal) -- The total number of digits to store in the
database, including those to the right of the decimal. Only valid for
decimal fields.
Data Scale (decimal) -- The number of digits to the right of the decimal.
Only valid for decimal fields.
Default Value -- Leave this blank if you don't want the database to store
a default value if your computed field's value isn't set.
Not NULL -- Leave unchecked if you want to allow NULL values in the
database field.
Sortable -- Used in Views to allow sorting a column of this field.
--------Examples------------------------------------------
Here are some usage examples to get you started with Computed
Field.
-----Make a node link to itself-----------------
This example isn't very useful, but it demonstrates how to get
hold of the nid.
In your computed field's configuration:
- Computed Code:
// store the nid in our computed field
$node_field[0]['value'] = $node->nid;
- Check 'Display this field'
- Display Format:
$display = l('A link to this node', 'node/'.$node_field_item['value']);
- Uncheck 'Store using the database settings below'. You could store this if
you wanted to, but it's not costly to compute this field and is already
stored in the node table. One reason why you may want to store it is if you
want the value available to Views.
When you display a node of the content type containing this field it should
now have a link to itself.
-----Adding two other fields----------------------
Imagine you have two existing number fields, called field_product_price and
field_postage_price. You want to create a computed field field_total_cost
which adds these two fields. Create a new computed field with the name 'Total
Cost', and in your computed field's configuration set the following:
- Computed Code:
$node_field[0]['value'] =
$node->field_product_price[0]['value'] +
$node->field_postage_price[0]['value'];
- Check 'Display this field'
- Display Format:
$display = '$' . $node_field_item['value'];
- Check 'Store using the database settings below'
- Data Type: decimal
- Decimal Precision: 10
- Decimal Scale: 2
- Default Value: 0.00
- Check 'Not NULL'
- Check 'Sortable'
-----Calculating a Duration given a start and end time-----
This example uses KarenS' date module (http://drupal.org/project/date) to
create two date fields field_start_time and field_end_time which record hours
and minutes. We then create a new computed field to work out the duration as a
decimal number of hours (so 1.5 is 1hour, 30minutes).
Computed field settings:
- Computed Code:
$start = $node->field_start_time[0]['value'];
$end = $node->field_end_time[0]['value'];
$start_decimal = $start['hours'] + ($start['minutes'] / 60);
$end_decimal = $end['hours'] + ($end['minutes'] / 60);
$node_field[0]['value'] = $end_decimal - $start_decimal;
- Check 'Display this field'</li>
- Display Format:</b><code>
$display = $node_field_item['value'] . " hours";
- Check 'Store using the database settings below
- Data Type:</b> float
- Data Size:</b> normal
- Check 'Sortable'
Now if you set the start time field to 9am and the end time to 11:30am, your
computed field will store the value '2.5' and display '2.5 hours'.
-----Send more examples!---------------------------------
If you have another useful (or instructive) example send it to me
(http://drupal.org/user/59132/contact) and I'll add it here for the benefit of
humankind.
-----------------------About Computed Field-----------------------------------
Computed Field was created by Agileware (http://www.agileware.net).

13
sites/all/modules/computed_field/computed_field.info Normal file
View file

@ -0,0 +1,13 @@
name = Computed Field
description = Allows the user to define computed values in custom content types.
core = 6.x
dependencies[] = content
package = CCK
; Information added by drupal.org packaging script on 2012-02-15
version = "6.x-1.0"
core = "6.x"
project = "computed_field"
datestamp = "1329309341"

33
sites/all/modules/computed_field/computed_field.install Normal file
View file

@ -0,0 +1,33 @@
<?php
/**
* Implementation of hook_install().
*/
function computed_field_install() {
drupal_load('module', 'content');
content_notify('install', 'computed_field');
}
/**
* Implementation of hook_uninstall().
*/
function computed_field_uninstall() {
drupal_load('module', 'content');
content_notify('uninstall', 'computed_field');
}
/**
* Implementation of hook_enable().
*/
function computed_field_enable() {
drupal_load('module', 'content');
content_notify('enable', 'computed_field');
}
/**
* Implementation of hook_disable().
*/
function computed_field_disable() {
drupal_load('module', 'content');
content_notify('disable', 'computed_field');
}

466
sites/all/modules/computed_field/computed_field.module Normal file
View file

@ -0,0 +1,466 @@
<?php
/**
* Implementation of cck hook_field_info()
*/
function computed_field_field_info() {
return array(
'computed' => array(
'label' => t('Computed'),
'description' => t('Create field data via PHP code.'),
'callbacks' => array(
'tables' => CONTENT_CALLBACK_DEFAULT,
'arguments' => CONTENT_CALLBACK_DEFAULT,
),
),
);
}
/**
* Implementation of cck hook_field_settings()
*/
function computed_field_field_settings($op, $field) {
switch ($op) {
case 'form':
$form = array();
$compute_func = 'computed_field_'. $field['field_name'] .'_compute';
$display_func = 'computed_field_'. $field['field_name'] .'_display';
// these next 3 have been moved from widget to field, so they copy default values from widget
$form['code'] = array(
'#type' => 'textarea',
'#rows' => 15,
'#title' => t('Computed Code'),
'#description' => '<p>'. t('The variables available to your code are: ') .'<code>&amp;$node, $field, and &amp;$node_field</code>'. t('. To set the value of the field, set ') .'<code>$node_field[0][\'value\']</code>.'. '</p><p>'. t('Here\'s a simple example which sets the computed field\'s value to the value of the sum of the number fields field_a and field_b: ') .'<code>$node_field[0][\'value\'] = $node->field_a[0][\'value\'] + $node->field_b[0][\'value\'];</code>. '. '</p><p>'. t('Alternately, this code can be supplied by your own custom function named @compute_func($node, $field, $node_field). Any code entered above will be ignored if the function is defined.', array('@compute_func' => $compute_func)) .'</p>',
'#default_value' => !empty($field['code']) ? $field['code'] : '$node_field[0][\'value\'] = "";',
'#access' => !function_exists($compute_func),
);
if (function_exists($compute_func)) {
$form['compute_func'] = array(
'#type' => 'item',
'#value' => t('This field is computed using @compute_func().', array('@compute_func' => $compute_func)),
);
}
$form['display_format'] = array(
'#type' => 'textarea',
'#title' => t('Display Format'),
'#description' => '<p>' . t('This code should assign a string to the $display variable, which will be printed as the value of the field.') . '</p><p>'. t('The stored value of the field is in $node_field_item[\'value\']. The node is available at $node') .'</p><p>'. t('Note: this code has no effect if you use the "Computed Value" formatter option.') .'</p><p>'. t('Alternately, this code can be supplied by your own custom function named @display_func($field, $element, $node). Any code entered above will be ignored if the function is defined.', array('@display_func' => $display_func)) .'</p>' ,
'#default_value' => !empty($field['display_format']) ? $field['display_format'] : '$display = $node_field_item[\'value\'];',
'#access' => !function_exists($display_func),
);
if (function_exists($display_func)) {
$form['display_func'] = array(
'#type' => 'item',
'#value' => t('This field is computed using @display_func().', array('@display_func' => $display_func)),
);
}
$form['store'] = array(
'#type' => 'checkbox',
'#title' => t('Store using the database settings below (required for Views use)'),
'#default_value' => is_numeric($field['store']) ? $field['store'] : 1 ,
);
$form['database'] = array('#type' => 'fieldset', '#title' => t('Database Storage Settings'));
$form['database']['data_type'] = array(
'#type' => 'radios',
'#title' => t('Data Type'),
'#description' => t('The SQL datatype to store this field in.'),
'#default_value' => !empty($field['data_type']) ? $field['data_type'] : 'varchar',
'#options' => array('varchar' => 'varchar', 'text' => 'text', 'longtext' => 'longtext', 'int' => 'int', 'float' => 'float', 'numeric' => 'decimal'),
'#required' => FALSE,
);
$form['database']['data_length'] = array(
'#type' => 'textfield',
'#title' => t('Data Length (varchar/text only)'),
'#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($field['data_length']) ? $field['data_length'] : NULL,
'#required' => FALSE,
);
$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($field['data_size']) ? $field['data_size'] : 'normal',
'#options' => array('tiny' => 'tiny', 'small' => 'small', 'medium' => 'medium', 'normal' => 'normal', 'big' => 'big'),
'#required' => FALSE,
);
$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($field['data_precision']) ? $field['data_precision'] : 10,
'#required' => FALSE,
);
$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($field['data_scale']) ? $field['data_scale'] : 2,
'#required' => FALSE,
);
$form['database']['data_default'] = array(
'#type' => 'textfield',
'#title' => t('Default Value'),
'#default_value' => $field['data_default'],
'#required' => FALSE,
);
$form['database']['data_not_NULL'] = array(
'#type' => 'checkbox',
'#title' => t('Not NULL'),
'#default_value' => is_numeric($field['data_not_NULL']) ? $field['data_not_NULL'] : FALSE,
);
$form['database']['data_sortable'] = array(
'#type' => 'checkbox',
'#title' => t('Sortable in Views'),
'#default_value' => is_numeric($field['data_sortable']) ? $field['data_sortable'] : TRUE,
);
return $form;
case 'validate':
if ($field['store']) {
if (empty($field['data_type'])) {
form_set_error('data_type', t('To store this field in the database, please specify a data type.'));
}
if (($field['data_type'] == 'text' || $field['data_type'] == 'varchar') && empty($field['data_length'])) {
form_set_error('data_length', t('To store this field in the database, please specify the data length.'));
}
}
break;
case 'save':
return array('code', 'display_format', 'store', 'data_type', 'data_length', 'data_size', 'data_precision', 'data_scale', 'data_not_NULL', 'data_default', 'data_sortable');
case 'database columns':
if (!is_numeric($field['store'])) {
// Initial field creation! - CCK initially creates the field in the DB before the user is given a chance to configure it.
// Thus we don't know any of the field's data settings for this initial creation. Yet, if we don't set something, CCK will
// return SQL errors when trying to "migrate" the data column after configuration (in several senarios). So, we'll
// give CCK our most basic "default" data column to work with. After the user configures the field, it will be updated by
// CCK to match their chosen field data settings.
$columns = array(
'value' => array(
'type' => 'varchar',
'length' => '32',
),
);
}
elseif ($field['store']) {
// User has decided to store values in the DB, so we'll gather up information on their chosen data type.
$columns = array('value' => array());
if ($field['data_type'] == 'longtext') {
$columns['value']['type'] = 'text';
$columns['value']['size'] = 'big';
}
else {
$columns['value']['type'] = isset($field['data_type']) ? $field['data_type'] : 'varchar';
}
// 'text' and 'varchar' fields get length settings
if ($field['data_type'] == 'text' || $field['data_type'] == 'varchar') {
$columns['value']['length'] = isset($field['data_length']) ? $field['data_length'] : 32;
}
// 'int' and 'float' fields get size settings
if ($field['data_type'] == 'int' || $field['data_type'] == 'float') {
$columns['value']['size'] = isset($field['data_size']) ? $field['data_size'] : 'normal';
}
// 'decimal' fields get precision and scale settings
if ($field['data_type'] == 'numeric') {
$columns['value']['precision'] = isset($field['data_precision']) ? $field['data_precision'] : 10;
$columns['value']['scale'] = isset($field['data_scale']) ? $field['data_scale'] : 2;
}
// Add 'not null' settings
$columns['value']['not null'] = isset($field['data_not_NULL']) ? $field['data_not_NULL'] : TRUE;
// Allow Views sorting if set
$columns['value']['sortable'] = isset($field['data_sortable']) ? $field['data_sortable'] : FALSE;
// Add default values if set
if ($field['data_default'] != '') {
$columns['value']['default'] = $field['data_default'];
}
}
else {
// User has chosen NOT to store values in the DB for their field, yet CCK is NOT comfortable having a field without a data
// column. Without a column, SQL errors will pop up on multi-value fields and other field modification senarios. (Such as the
// user later choosing to store the field in the DB.) To avoid SQL errors we'll create a small dummy field for CCK that is
// never populated with data.
$columns = array(
'value' => array(
'type' => 'int',
'size' => 'tiny',
),
);
}
return $columns;
case 'filters':
return array(
'default' => array(
'name' => t('Default'),
'operator' => 'views_handler_operator_gtlt',
),
);
case 'callbacks':
return array(
'view' => CONTENT_CALLBACK_CUSTOM,
);
case 'views data':
$allowed_values = content_allowed_values($field);
if (count($allowed_values)) {
$data = content_views_field_views_data($field);
$db_info = content_database_info($field);
$table_alias = content_views_tablename($field);
// Swap the filter handler to the 'in' operator.
$data[$table_alias][$field['field_name'] .'_value']['filter']['handler'] = 'content_handler_filter_many_to_one';
return $data;
}
}
}
function _computed_field_compute_value(&$node, $field, &$node_field) {
// 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($node, $field, $node_field);
}
else {
if (isset($field['code'])) {
eval($field['code']);
}
}
}
/**
* Implementation of cck hook_field()
*/
function computed_field_field($op, &$node, $field, &$node_field, $teaser, $page) {
switch ($op) {
case 'load':
// compute field on load if it isn't stored in the database
if (!$field['store']) {
_computed_field_compute_value($node, $field, $node_field);
return array($field['field_name'] => $node_field);
}
break;
case 'sanitize':
// compute field for node previews
if ($node->build_mode == NODE_BUILD_PREVIEW) {
_computed_field_compute_value($node, $field, $node_field);
}
break;
case 'view':
$items = array();
foreach ($node_field as $delta => $item) {
$items[$delta]['view'] = content_format($field, $item, 'default', $node);
}
return theme('field', $node, $field, $items, $teaser, $page);
break;
case 'validate':
break;
case 'insert':
case 'update':
_computed_field_compute_value($node, $field, $node_field);
break;
}
}
/**
* Implementation of cck hook_widget_info()
*/
function computed_field_widget_info() {
return array(
'computed' => array(
'label' => t('Computed'),
'field types' => array('computed'),
'multiple values' => CONTENT_HANDLE_MODULE,
),
);
}
/**
* Implementation of cck hook_widget()
*/
function computed_field_widget(&$form, &$form_state, $field, $items, $delta = 0) {
$elements = array();
foreach($items as $delta => $item) {
$elements[$delta]['value'] = array (
'#type' => 'value',
'#tree' => TRUE,
'#default_value' => isset($item['value']) ? $item['value'] : NULL,
);
}
return $elements;
}
/**
* Implementation of cck hook_view_item (obsolete, retained for backward compatibility with older cck)
*/
function computed_field_view_item($field, $node_field_item, $node = NULL) {
global $base_url;
$display = '';
eval($field['display_format']);
return $display;
}
/**
* Implementation of hook_theme()
*/
function computed_field_theme() {
return array(
'computed_field_formatter_default' => array(
'arguments' => array('element' => NULL),
),
'computed_field_formatter_plain' => array(
'arguments' => array('element' => NULL),
),
'computed_field_formatter_markup' => array(
'arguments' => array('element' => NULL),
),
'computed_field_formatter_computed_value' => array(
'arguments' => array('element' => NULL),
),
);
}
/**
* Implementation of cck hook_field_formatter_info()
*/
function computed_field_field_formatter_info() {
return array(
'default' => array(
'label' => t('Raw text'),
'field types' => array('computed'),
),
'plain' => array(
'label' => t('Plain text'),
'field types' => array('computed'),
),
'markup' => array(
'label' => t('Markup'),
'field types' => array('computed'),
),
'computed_value' => array(
'label' => t('Computed Value'),
'field types' => array('computed'),
),
);
}
/**
* Theme function for 'default' text field formatter.
*/
function theme_computed_field_formatter_default($element) {
// Make $node easily available
$node = $element['#node'];
// Grab the field
$field = content_fields($element['#field_name']);
// For "some" backwards compatibility
$node_field_item['value'] = $element['#item']['value'];
// Allow the value to be formated from code not stored in DB
$display_func = 'computed_field_'. $field['field_name'] .'_display';
if (function_exists($display_func)) {
$display = $display_func($field, $element, $node);
}
else {
eval($field['display_format']);
}
return $display;
}
/**
* Theme function for 'plain' text field formatter.
*/
function theme_computed_field_formatter_plain($element) {
// Make $node easily available
$node = $element['#node'];
// Grab the field
$field = content_fields($element['#field_name']);
// For "some" backwards compatibility
$node_field_item['value'] = $element['#item']['value'];
// Allow the value to be formated from code not stored in DB
$display_func = 'computed_field_'. $field['field_name'] .'_display';
if (function_exists($display_func)) {
$display = $display_func($field, $element);
}
else {
eval($field['display_format']);
}
return check_plain($display);
}
/**
* Theme function for 'markup' text field formatter.
*/
function theme_computed_field_formatter_markup($element) {
// Make $node easily available
$node = $element['#node'];
// Grab the field
$field = content_fields($element['#field_name']);
// For "some" backwards compatibility
$node_field_item['value'] = $element['#item']['value'];
// Allow the value to be formated from code not stored in DB
$display_func = 'computed_field_'. $field['field_name'] .'_display';
if (function_exists($display_func)) {
$display = $display_func($field, $element);
}
else {
eval($field['display_format']);
}
return check_markup($display);
}
/**
* Theme function for 'computed_value' text field formatter.
*/
function theme_computed_field_formatter_computed_value($element) {
return $element['#item']['value'];
}
/**
* Implementation of cck hook_content_is_empty().
*/
function computed_field_content_is_empty($item, $field) {
if ($field['data_type'] == 'int' || $field['data_type'] == 'float') {
return !is_numeric($item['value']);
}
return empty($item['value']);
}
/**
* Implementation of hook_token_list()
*/
function computed_field_token_list($type = 'all') {
if ($type == 'field' || $type == 'all') {
$tokens = array();
$tokens['computed_field']['raw'] = t("Raw, unfiltered text.");
$tokens['computed_field']['formatted'] = t("Formatted and filtered text.");
return $tokens;
}
}
/**
* Implementation of hook_token_values()
*/
function computed_field_token_values($type, $object = NULL, $options = array()) {
if ($type == 'field') {
$item = $object[0];
$tokens['raw'] = $item['value'];
$tokens['formatted'] = $item['view'];
return $tokens;
}
}
/**
* Implementation of hook_content_multigroup_allowed_widgets().
*/
function computed_field_content_multigroup_allowed_widgets() {
return array('computed');
}
/**
+ * Implementation of hook_content_multigroup_no_remove_widgets().
+ */
function computed_field_content_multigroup_no_remove_widgets() {
return array('computed');
}