From 6f0e72aa06fbca68430e70f71a83e5b7f671e330 Mon Sep 17 00:00:00 2001 From: dzink Date: Wed, 9 Mar 2016 16:38:16 -0500 Subject: [PATCH 01/11] Delete LICENSE --- LICENSE | 339 -------------------------------------------------------- 1 file changed, 339 deletions(-) delete mode 100644 LICENSE diff --git a/LICENSE b/LICENSE deleted file mode 100644 index d7f1051..0000000 --- a/LICENSE +++ /dev/null @@ -1,339 +0,0 @@ -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. - - {description} - Copyright (C) {year} {fullname} - - 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. From 5adf9e68ff30e6a86bc6c9b5aa013d5ce5f0a042 Mon Sep 17 00:00:00 2001 From: dzink Date: Wed, 9 Mar 2016 16:52:46 -0500 Subject: [PATCH 02/11] Update required_for_pub.info Removing extraneous lines from .info file. See issue https://github.com/zivtech/require-to-publish/issues/5 --- required_for_pub.info | 9 --------- 1 file changed, 9 deletions(-) diff --git a/required_for_pub.info b/required_for_pub.info index 228e4ad..da2c671 100755 --- a/required_for_pub.info +++ b/required_for_pub.info @@ -1,12 +1,3 @@ name = Required for Publishing description = Allows node add/edit forms to be "saved as draft" or "published." Fields can be configured to be required before content can be published. -;dependencies[] = field core = 7.x -;configure = admin/config/content/validation - -; Information added by drupal.org packaging script on 2011-03-11 -version = "7.x-dev" -core = "7.x" -project = "required_for_pub" -datestamp = "1299872168" - From 342cbb55e653df72c958a2143d6c77749b49855e Mon Sep 17 00:00:00 2001 From: dzink Date: Wed, 9 Mar 2016 16:56:36 -0500 Subject: [PATCH 03/11] Clean up .install file. --- required_for_pub.install | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/required_for_pub.install b/required_for_pub.install index fff55c3..8245452 100755 --- a/required_for_pub.install +++ b/required_for_pub.install @@ -4,8 +4,8 @@ * @file * Installs the required_for_pub module. * - * Creates a database for use of multi-layered default formats and sets - * default settings. + * Sets the weight the require_for_pub module to 1 in the system module list so that + * other modules will execute first by default. */ /** From 34de24c4b82fdc743182e854297898c364fe9ee0 Mon Sep 17 00:00:00 2001 From: dzink Date: Wed, 9 Mar 2016 17:04:29 -0500 Subject: [PATCH 04/11] Improve css --- css/required_for_pub.css | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/css/required_for_pub.css b/css/required_for_pub.css index c38cff2..bb314e6 100755 --- a/css/required_for_pub.css +++ b/css/required_for_pub.css @@ -1,20 +1,15 @@ span.required-for-pub { - color: #AAA; + color: #F00; font-weight: normal; - font-size: 90%; - } - - .required-for-pub .form-item label:after { - content: '* Required for content to be published'; + content: '*'; color: #AAA; font-weight: normal; - display: block; /* remove this line if you want the asterisk and text to appear inline and to the right of the label. */ } .required-for-pub .form-item .form-item label:after { content: ''; display: none; -} \ No newline at end of file +} From a557d81619a382d3d140775dcab6846e227611b0 Mon Sep 17 00:00:00 2001 From: Daniel Zinkevich Date: Thu, 10 Mar 2016 08:41:55 -0800 Subject: [PATCH 05/11] Basic code review. --- required_for_pub.module | 109 ++++++++++++++++------------------------ 1 file changed, 44 insertions(+), 65 deletions(-) diff --git a/required_for_pub.module b/required_for_pub.module index afe1d92..21763d9 100755 --- a/required_for_pub.module +++ b/required_for_pub.module @@ -1,7 +1,7 @@ &$field_type_info) { $field_type_info += array('instance_settings' => array()); $field_type_info['instance_settings'] += array( - 'required_for_pub' => false, - ); + 'required_for_pub' => false, + ); } } /** - * Implements hook_field_ui_field_edit_form_alter(&$form, &$form_state, $form_id). + * Implements hook_field_ui_field_edit_form_alter(&$form, &$form_state). */ -function required_for_pub_form_field_ui_field_edit_form_alter(&$form, &$form_state, $form_id) { +function required_for_pub_form_field_ui_field_edit_form_alter(&$form, &$form_state) { // omit field_collection if ($form['#field']['type'] == 'field_collection') { @@ -53,7 +53,7 @@ function required_for_pub_form_field_ui_field_edit_form_alter(&$form, &$form_sta } /** - * Custom validation for the field_ui_field_edit_form + * Custom validation for the field_ui_field_edit_form. */ function _required_for_pub_field_settings_validate($form, &$form_state) { @@ -91,11 +91,15 @@ function required_for_pub_permission() { } /** - * Implements hook_field_attach_form() + * Implements hook_field_attach_form(). */ function required_for_pub_field_attach_form($entity_type, $entity, &$form, &$form_state, $langcode = NULL, $options = array()) { - if (!user_access('required_for_pub_save_draft')) { + // Three scenarios when this + if (!user_access('required_for_pub_save_draft') || + $entity_type != 'node' || + $entity_type == 'field_collection_item' + ) { return; } @@ -105,21 +109,12 @@ function required_for_pub_field_attach_form($entity_type, $entity, &$form, &$for // get all fields in the node form_state $fields = $form_state['field']; - - if ($entity_type == 'field_collection_item') { - return; // field collection items trigger for the hook_field_attach_form to be called again. so need need to process it again. - } - - if ($entity_type != 'node') { - return; - } + $form_state['required_for_pub']['#fields_instances'] = array(); - if ($entity_type == 'node') { - $field_info_instances = field_info_instances($entity_type, $entity->type ); - $form_state['required_for_pub']['#fields_instances'][] = $field_info_instances; - } - + $field_info_instances = field_info_instances($entity_type, $entity->type ); + $form_state['required_for_pub']['#fields_instances'][] = $field_info_instances; + $fields_required_for_pub = array(); // important step: this will determine the fields that have been configured to be "required_for_pub" @@ -132,19 +127,14 @@ function required_for_pub_field_attach_form($entity_type, $entity, &$form, &$for if (empty($field_info_instances[$field_name]['required_for_pub'])) { // value can be 0 or NULL continue; } - if ( $field_info_instances[$field_name]['required_for_pub'] == 'required_for_pub' ) { // create an array of fields where required_for_pub is TRUE // TODO: no need for an if . already checked by isset 4 lines above - $fields_required_for_pub[] = $field_name; - $form_state['required_for_pub']['#fields'][] = $field_name; - // add css to the div wrapping the field - $form[$field_name]['#attributes']['class'][] = 'required-for-pub'; - - } - + $fields_required_for_pub[] = $field_name; + $form_state['required_for_pub']['#fields'][] = $field_name; + // add css to the div wrapping the field + $form[$field_name]['#attributes']['class'][] = 'required-for-pub'; } if (!empty($fields_required_for_pub)) { - - // gather all the field instances from the top all the way to the nested fields of type "field collection" + // gather all the field instances from the top all the way to the nested fields of type "field collection" $fields_instances_temp = NULL; foreach ($form_state['required_for_pub']['#fields_instances'] as $key => $field_instance) { if (empty($fields_instances_temp)) { @@ -165,24 +155,22 @@ function required_for_pub_field_attach_form($entity_type, $entity, &$form, &$for '#default_value' => 'Save as draft', '#name' => 'required_for_pub_save_as_draft', '#weight' => 4, - '#submit' => - array ( + '#submit' => array ( 0 => 'node_form_submit', ), ); - $form['actions']['submit']['#value'] = 'Publish'; + $form['actions']['submit']['#value'] = t('Publish'); $form['actions']['submit']['#name'] = 'drupal_core_save'; - //$form['options']['status']['#access'] = FALSE; } } /** - * Custom validation for the entity add or edit forms + * Custom validation for the node add or edit forms */ function required_for_pub_form_validate($form, &$form_state) { - drupal_add_css(drupal_get_path('module', 'required_for_pub') . '/css/required_for_pub.css', array('group' => CSS_DEFAULT, 'every_page' => TRUE)); + drupal_add_css(drupal_get_path('module', 'required_for_pub') . '/css/required_for_pub.css', array('group' => CSS_DEFAULT)); $trigger = $form_state['triggering_element']['#name']; switch ($trigger) { @@ -250,29 +238,24 @@ function required_for_pub_form_validate($form, &$form_state) { } // the most important validation - $field_string = ""; $digit = 1; if ($status == 1 && !empty($empty_fields) ) { - // the form is cached. Hence, the css file must be loaded again in the validate function or the css wonk work. + // The form is cached. Hence, the css file must be loaded again in the + // validate function or the css won't work. drupal_add_css(drupal_get_path('module', 'required_for_pub') . '/css/required_for_pub.css', array('group' => CSS_DEFAULT, 'every_page' => TRUE)); if (module_exists('save_draft')) { form_set_error('required_for_pub', t('You must do "a" or "b":

a. Save this content as DRAFT

b. Or PULBISH it but FILL UP "required fields for content to be published" listed below:

')); } else { - - form_set_error('required_for_pub', t('You must do "a" or "b":

a. Save this content as DRAFT.

b. Or PUBLISH it but FILL UP the "required fields for content to be published" listed below:

')); + form_set_error('required_for_pub', t('You must do "a" or "b":

a. Save this content as DRAFT.

b. Or PUBLISH it but FILL UP the "required fields for content to be published" listed below:

')); } foreach ($empty_fields as $key => $field_name) { - $field_string = $field_name; - $label = $form_state['required_for_pub']['#fields_instances'][$field_name]['label']; form_set_error($field_name, t('%digit. %field_name', array('%field_name' => $label, '%digit' => $digit))); $digit = $digit + 1; } - return FALSE; - } else { return TRUE; @@ -283,42 +266,38 @@ function required_for_pub_form_validate($form, &$form_state) { /** - * special handler for fields of type "field collection" - * For now: support is only for field collection fields up tp 1 level deep. - * TODO: support for unlimited nesting of fields of type "field collection" + * Special handler for fields of type "field collection." + * For now: support is only for field collection fields up to 1 level deep. + * TODO: support for unlimited nesting of fields of type "field collection." */ function required_for_pub_fc_special_handler_form_alter(&$form, &$form_state, $field_name_fc = NULL, $field_tree = NULL) { $form['#rebuild'] = TRUE; $lang = $form[$field_name_fc]['#language']; $items = $form[$field_name_fc][$lang]; - $fields_fc = field_info_instances('field_collection_item', $field_name_fc); - - $form_state['required_for_pub']['#fields_instances'][] = $fields_fc; - $fields_configured_as_req_for_pub = array(); - foreach ($fields_fc as $field_name2 => $field_arr) { + $fields_fc = field_info_instances('field_collection_item', $field_name_fc); - if ($field_arr['required_for_pub'] == 'required_for_pub') { - $fields_required_for_pub[] = $field_name2; - - $form_state['required_for_pub']['#fields'][] = $field_name2; - $fields_configured_as_req_for_pub[$field_name2] = $field_name2; - } - } + $form_state['required_for_pub']['#fields_instances'][] = $fields_fc; + $fields_configured_as_req_for_pub = array(); + foreach ($fields_fc as $field_name2 => $field_arr) { + + if ($field_arr['required_for_pub'] == 'required_for_pub') { + $fields_required_for_pub[] = $field_name2; + + $form_state['required_for_pub']['#fields'][] = $field_name2; + $fields_configured_as_req_for_pub[$field_name2] = $field_name2; + } + } $elements = element_children($items); foreach ($elements as $key => $item) { - - foreach(element_children($items[$key]) as $key2 => $field_name_fc2) { + foreach (element_children($items[$key]) as $key2 => $field_name_fc2) { // if the field is not configured to be "required for pub", ignore if (!array_key_exists($field_name_fc2, $fields_configured_as_req_for_pub)) { continue; } - $form_element = $items[$key][$field_name_fc2][$lang][0]; - $title = $form_element['#title']; - if (empty($items[$key][$field_name_fc2][$lang][0]['value']) ) { $form[$field_name_fc][$lang][$key][$field_name_fc2][$lang][0]['#title'] = $title.'
*Required for content to be published.
'; } From 1774aebff2ad465fed09631892a0fea66f469dcf Mon Sep 17 00:00:00 2001 From: Daniel Zinkevich Date: Thu, 10 Mar 2016 08:48:20 -0800 Subject: [PATCH 06/11] Coder-review changes. --- required_for_pub.module | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/required_for_pub.module b/required_for_pub.module index 21763d9..55c8aa5 100755 --- a/required_for_pub.module +++ b/required_for_pub.module @@ -17,9 +17,9 @@ function required_for_pub_field_info_alter(&$info) { // Add a setting to all field types. foreach ($info as $field_type => &$field_type_info) { $field_type_info += array('instance_settings' => array()); - $field_type_info['instance_settings'] += array( - 'required_for_pub' => false, - ); + $field_type_info['instance_settings'] += array( + 'required_for_pub' => FALSE, + ); } } @@ -95,15 +95,15 @@ function required_for_pub_permission() { */ function required_for_pub_field_attach_form($entity_type, $entity, &$form, &$form_state, $langcode = NULL, $options = array()) { - // Three scenarios when this + // Two scenarios to end this function: + // 1) The user doesn't have required_for_pub_save_draft permission. + // 2) The entity is not a node if (!user_access('required_for_pub_save_draft') || - $entity_type != 'node' || - $entity_type == 'field_collection_item' - ) { + $entity_type != 'node') { return; } - $form['#tree'] = false; + $form['#tree'] = FALSE; drupal_add_css(drupal_get_path('module', 'required_for_pub') . '/css/required_for_pub.css', array('group' => CSS_DEFAULT, 'every_page' => TRUE)); $form['#validate'][] = 'required_for_pub_form_validate'; @@ -151,11 +151,11 @@ function required_for_pub_field_attach_form($entity_type, $entity, &$form, &$for if ($entity_type == 'node' && !module_exists('save_draft') && !empty($fields_required_for_pub)) { $form['actions']['required_for_pub_save_as_draft'] = array( '#type' => 'submit', - '#access' => true, + '#access' => TRUE, '#default_value' => 'Save as draft', '#name' => 'required_for_pub_save_as_draft', '#weight' => 4, - '#submit' => array ( + '#submit' => array( 0 => 'node_form_submit', ), ); @@ -209,7 +209,7 @@ function required_for_pub_form_validate($form, &$form_state) { $field_type = $field['type']; // get the function name which is in this format: called module_field_is_empty(), where module is the module that defined the field - $func = $module.'_field_is_empty'; + $func = $module . '_field_is_empty'; // special handling for booleans // NOTE: the list.module's hook_field_is_empty specifies this: @@ -299,10 +299,10 @@ function required_for_pub_fc_special_handler_form_alter(&$form, &$form_state, $f $form_element = $items[$key][$field_name_fc2][$lang][0]; $title = $form_element['#title']; if (empty($items[$key][$field_name_fc2][$lang][0]['value']) ) { - $form[$field_name_fc][$lang][$key][$field_name_fc2][$lang][0]['#title'] = $title.'
*Required for content to be published.
'; + $form[$field_name_fc][$lang][$key][$field_name_fc2][$lang][0]['#title'] = $title . '
*Required for content to be published.
'; } else { - $form[$field_name_fc][$lang][$key][$field_name_fc2][$lang][0]['value']['#title'] = $title.'
*Required for content to be published.
'; + $form[$field_name_fc][$lang][$key][$field_name_fc2][$lang][0]['value']['#title'] = $title . '
*Required for content to be published.
'; } $form[$field_name_fc][$lang][$key][$field_name_fc2][$lang][0]['value']['#attributes']['class'][] = 'required-for-pub'; } From 6ce3d5d33101c5837ad4357da0943b66f3da2afb Mon Sep 17 00:00:00 2001 From: Daniel Zinkevich Date: Thu, 10 Mar 2016 09:14:31 -0800 Subject: [PATCH 07/11] Improving logic flow for validation and removing redundant checks. --- required_for_pub.module | 85 +++++++++++++++++++---------------------- 1 file changed, 40 insertions(+), 45 deletions(-) diff --git a/required_for_pub.module b/required_for_pub.module index 55c8aa5..7efdaca 100755 --- a/required_for_pub.module +++ b/required_for_pub.module @@ -188,58 +188,18 @@ function required_for_pub_form_validate($form, &$form_state) { return TRUE; } - $status = $form_state['values']['status']; - $lang = $form_state['values']['language']; + $lang = $form_state['values']['language']; $empty_fields = array(); - foreach ($form_state['required_for_pub']['#fields'] as $key => $field_name) { - if (empty($form_state['values'][$field_name][$lang][0])) { - $item = $form_state['values'][$field_name][$lang]; // some fields do not use any delta or the 0 offset. example: term reference does not use the 0 offset when the field is empty - } - else { - $item = $form_state['values'][$field_name][$lang][0]; - } - // get the field info. Do not use field_get_fields -- it will harder to traverse the array for those fields nested in field collection - $field = field_info_field($field_name); - - // get the module that defined the hook_field_is_empty - $module = $field['module']; - - // get the field type - $field_type = $field['type']; - - // get the function name which is in this format: called module_field_is_empty(), where module is the module that defined the field - $func = $module . '_field_is_empty'; - - // special handling for booleans - // NOTE: the list.module's hook_field_is_empty specifies this: - // if (empty($item['value']) && (string) $item['value'] !== '0') { return TRUE; } - // paramter $item passed is array('value' => 0) -- if user has not clicked the wdiget form - // which means that the boolean field will always return hook_field_is_empty to be FALSE -- that is, the field contains data. when in fact, it should be treated as EMPTY. - // hence, we convert the value from 0 to NULL or set $item to NULL - if ($field_type == 'list_boolean') { - if ($item['value'] == 0) { - $item = NULL; - } - } - - // special handling for fields that do no use delta or the 0 offset. - if (empty($item)) { - $field_is_empty = TRUE; - } - else { - $field_is_empty = call_user_func($func, $item, $field); - } - - // TO CHECK if field is empty -- this will account for all field types - if ($field_is_empty) { + foreach ($form_state['required_for_pub']['#fields'] as $field_name) { + if (_required_for_pub_field_is_empty($form_State, $field_name, $lang)) { $empty_fields[] = $field_name; } } // the most important validation $digit = 1; - if ($status == 1 && !empty($empty_fields) ) { + if (!empty($empty_fields) ) { // The form is cached. Hence, the css file must be loaded again in the // validate function or the css won't work. drupal_add_css(drupal_get_path('module', 'required_for_pub') . '/css/required_for_pub.css', array('group' => CSS_DEFAULT, 'every_page' => TRUE)); @@ -260,10 +220,45 @@ function required_for_pub_form_validate($form, &$form_state) { else { return TRUE; } - return FALSE; } +/** + * Check if a field is empty. + * @param $form_state - The current form_state in which to check field presence. + * @param $field_name - The machine name of the field to check for. + * @param $lang - The language to check in. + * @return bool - TRUE is the field is empty. + */ +function _required_for_pub_field_is_empty($form_state, $field_name, $lang) { + if (empty($form_state['values'][$field_name][$lang][0])) { + // Some fields do not use any delta or the 0 offset. Example: term + // reference does not use the 0 offset when the field is empty. + $item = $form_state['values'][$field_name][$lang]; + } + else { + $item = $form_state['values'][$field_name][$lang][0]; + } + $field = field_info_field($field_name); + $module = $field['module']; + $field_type = $field['type']; + $func = $module . '_field_is_empty'; + // special handling for booleans + if ($field_type == 'list_boolean') { + if ($item['value'] == 0) { + $item = NULL; + } + } + + // special handling for fields that do no use delta or the 0 offset. + if (empty($item)) { + $field_is_empty = TRUE; + } + else { + $field_is_empty = call_user_func($func, $item, $field); + } + return $field_is_empty; +} /** * Special handler for fields of type "field collection." From 11c5555265d6eef8822078add5e479e0215d821d Mon Sep 17 00:00:00 2001 From: Daniel Zinkevich Date: Thu, 10 Mar 2016 09:49:33 -0800 Subject: [PATCH 08/11] Fixing typo and doc lines. --- required_for_pub.module | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/required_for_pub.module b/required_for_pub.module index 7efdaca..7dbb36a 100755 --- a/required_for_pub.module +++ b/required_for_pub.module @@ -182,7 +182,7 @@ function required_for_pub_form_validate($form, &$form_state) { $form_state['values']['status'] = 1; break; } - + // if there are no fields that have been configured as required for publish if (empty($form_state['required_for_pub']['#fields'])) { return TRUE; @@ -192,7 +192,7 @@ function required_for_pub_form_validate($form, &$form_state) { $empty_fields = array(); foreach ($form_state['required_for_pub']['#fields'] as $field_name) { - if (_required_for_pub_field_is_empty($form_State, $field_name, $lang)) { + if (_required_for_pub_field_is_empty($form_state, $field_name, $lang)) { $empty_fields[] = $field_name; } } @@ -230,9 +230,9 @@ function required_for_pub_form_validate($form, &$form_state) { * @return bool - TRUE is the field is empty. */ function _required_for_pub_field_is_empty($form_state, $field_name, $lang) { + // Some fields do not use any delta or the 0 offset. Example: term + // reference does not use the 0 offset when the field is empty. if (empty($form_state['values'][$field_name][$lang][0])) { - // Some fields do not use any delta or the 0 offset. Example: term - // reference does not use the 0 offset when the field is empty. $item = $form_state['values'][$field_name][$lang]; } else { From caf8eff77fa3a1e0728ce9c9cd0ff17183e8140d Mon Sep 17 00:00:00 2001 From: Jody Hamilton Date: Fri, 11 Mar 2016 15:11:28 -0500 Subject: [PATCH 09/11] Update required_for_pub.install --- required_for_pub.install | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/required_for_pub.install b/required_for_pub.install index 8245452..02d0b46 100755 --- a/required_for_pub.install +++ b/required_for_pub.install @@ -4,7 +4,7 @@ * @file * Installs the required_for_pub module. * - * Sets the weight the require_for_pub module to 1 in the system module list so that + * Sets the weight of the require_for_pub module to 1 in the system module list so that * other modules will execute first by default. */ From 546d95c8d16af7ffbf5e98db38f5e4670e23236e Mon Sep 17 00:00:00 2001 From: dzink Date: Fri, 11 Mar 2016 15:57:16 -0500 Subject: [PATCH 10/11] Making asterisk red. --- css/required_for_pub.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/css/required_for_pub.css b/css/required_for_pub.css index bb314e6..791320f 100755 --- a/css/required_for_pub.css +++ b/css/required_for_pub.css @@ -5,7 +5,7 @@ span.required-for-pub { .required-for-pub .form-item label:after { content: '*'; - color: #AAA; + color: #F00; font-weight: normal; } From c069a2b38cd6091c7cf737e8e50625e747b65386 Mon Sep 17 00:00:00 2001 From: dzink Date: Fri, 11 Mar 2016 16:00:21 -0500 Subject: [PATCH 11/11] Remove else in favor of TRUE as a fallback. --- required_for_pub.module | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/required_for_pub.module b/required_for_pub.module index 7dbb36a..511c04b 100755 --- a/required_for_pub.module +++ b/required_for_pub.module @@ -217,9 +217,7 @@ function required_for_pub_form_validate($form, &$form_state) { } return FALSE; } - else { - return TRUE; - } + return TRUE; } /** @@ -302,4 +300,4 @@ function required_for_pub_fc_special_handler_form_alter(&$form, &$form_state, $f $form[$field_name_fc][$lang][$key][$field_name_fc2][$lang][0]['value']['#attributes']['class'][] = 'required-for-pub'; } } -} \ No newline at end of file +}