MO References: mo_references.admin.inc File Reference
Definition of the MO References administrative forms. More...
Functions | |
| mo_references_settings () | |
| Generate the administration form. | |
| mo_references_edit ($form_state, $document_name) | |
| Generate the settings form for a document. | |
| mo_references_edit_submit ($form, &$form_state) | |
| Submit the references of a document. | |
| mo_references_get_formats () | |
| Generate an option list of formats. | |
| mo_references_content () | |
| Form letting users select options for their documents. | |
| theme_mo_references_content ($form) | |
| Theme the list of documents. | |
Detailed Description
This file includes the administration of the MO References module. It will show you the forms used to define what needs to be done with such and such reference and global settings.
Copyright (c) 2009-2011 Made to Order Software Corp.
http://www.m2osw.com/mo_references contact@m2osw.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Function Documentation
| mo_references_content | ( | ) |
For each document, it is possible to define a set of options such as whether a link should be generated so people can download that document tarball for local perusal.
- Returns:
- An array representing the form.
| mo_references_edit | ( | $ | form_state, | |
| $ | document_name | |||
| ) |
This function generates a form used to edit the default parameters for a specific document.
- Parameters:
-
[in] $form_state The current state of this form [in] $document_name The name of the document being editing
- Returns:
- An array representing the MO References document form.
References mo_references_get_formats(), and mo_references_load().
| mo_references_edit_submit | ( | $ | form, | |
| &$ | form_state | |||
| ) |
This function saves the data from the submitted form.
The data is saved in the mo_references_documents table.
- Parameters:
-
[in] $form The form being submitted [in] $form_state The current state of this form
References mo_references_save().
| mo_references_get_formats | ( | ) |
This function generates an array from the list of available formats.
- Returns:
- An array of formats that can be used in a 'select' widget.
Referenced by mo_references_edit().
| mo_references_settings | ( | ) |
This function generates the MO References administration form. It is used for the end users to enter a set of global settings such as the folder where the documentation tarballs are stored.
- Returns:
- An array representing the MO References administration form.
| theme_mo_references_content | ( | $ | form | ) |
This function generates a table with the list of documents available on your web server.
- Parameters:
-
[in] $form The form with the list of documents to be themed
- Returns:
- The HTML formatted output
on Sat Mar 12 16:05:37 2011