East-Kent-Partnership / Intranet

dashboard/application/libraries/Grocery_CRUD.php

Doc Comments +55 added lines, -20 removed lines

@@ -883,6 +883,9 @@ 
 		return $validation_result;
 	}
 
+	/**
+	 * @return boolean
+	 */
 	protected function db_insert($state_info)
 	{
 		$validation_result = $this->db_insert_validation();
@@ -1351,6 +1354,9 @@ 
 		return $this->basic_model->get_relation_n_n_unselected_array($field_info, $selected_values);
 	}
 
+	/**
+	 * @param string $table_name
+	 */
 	protected function set_basic_db_table($table_name = null)
 	{
 		$this->basic_model->set_basic_table($table_name);
@@ -1997,6 +2003,9 @@ 
 		$this->set_echo_and_die();
 	}
 
+	/**
+	 * @param boolean $upload_result
+	 */
 	protected function delete_file_layout($upload_result)
 	{
 		@ob_end_clean();
@@ -2012,6 +2021,9 @@ 
 		$this->set_echo_and_die();
 	}
 
+	/**
+	 * @param string $css_file
+	 */
 	public function set_css($css_file)
 	{
 		$this->css_files[sha1($css_file)] = base_url().$css_file;
@@ -2022,12 +2034,18 @@ 
 		$this->js_files[sha1($js_file)] = base_url().$js_file;
 	}
 
+	/**
+	 * @param string $js_file
+	 */
 	public function set_js_lib($js_file)
 	{
 		$this->js_lib_files[sha1($js_file)] = base_url().$js_file;
 		$this->js_files[sha1($js_file)] = base_url().$js_file;
 	}
 
+	/**
+	 * @param string $js_file
+	 */
 	public function set_js_config($js_file)
 	{
 		$this->js_config_files[sha1($js_file)] = base_url().$js_file;
@@ -2892,6 +2910,9 @@ 
 		return array_key_exists('is_ajax', $_POST) && $_POST['is_ajax'] == 'true' ? true: false;
 	}
 
+	/**
+	 * @param string $view
+	 */
 	protected function _theme_view($view, $vars = array(), $return = FALSE)
 	{
 		$vars = (is_object($vars)) ? get_object_vars($vars) : $vars;
@@ -3551,7 +3572,7 @@ 
 	 * @access	public
 	 * @param	string
 	 * @param	array
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function columns()
 	{
@@ -3576,7 +3597,7 @@ 
 	 * @access	public
 	 * @param	mixed
 	 * @param	string
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	function set_rules($field, $label = '', $rules = '')
 	{
@@ -3643,7 +3664,7 @@ 
 	 * @access	public
 	 * @param	string
 	 * @param	array
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_texteditor()
 	{
@@ -3665,7 +3686,7 @@ 
 	 * Unsets just the jquery library from the js. This function can be used if there is already a jquery included
 	 * in the main template. This will avoid all jquery conflicts.
 	 *
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_jquery()
 	{
@@ -3679,7 +3700,7 @@ 
 	 * when the jquery UI JavaScript and CSS are already included in the main template.
 	 * This will avoid all jquery UI conflicts.
 	 *
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_jquery_ui()
 	{
@@ -3692,7 +3713,7 @@ 
 	 * Unsets just the twitter bootstrap libraries from the js and css. This function can be used if there is already twitter bootstrap files included
 	 * in the main template. If you are already using a bootstrap template then it's not necessary to load the files again.
 	 *
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_bootstrap()
 	{
@@ -3704,7 +3725,7 @@ 
 	/**
 	 * Unsets the add operation from the list
 	 *
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_add()
 	{
@@ -3716,7 +3737,7 @@ 
 	/**
 	 * Unsets the edit operation from the list
 	 *
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_edit()
 	{
@@ -3728,7 +3749,7 @@ 
 	/**
 	 * Unsets the delete operation from the list
 	 *
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_delete()
 	{
@@ -3740,7 +3761,7 @@ 
 	/**
 	 * Unsets the read operation from the list
 	 *
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_read()
 	{
@@ -3762,7 +3783,7 @@ 
 	/**
 	 * Unsets the export button and functionality from the list
 	 *
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_export()
 	{
@@ -3775,7 +3796,7 @@ 
 	/**
 	 * Unsets the print button and functionality from the list
 	 *
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_print()
 	{
@@ -3787,7 +3808,7 @@ 
 	/**
 	 * Unsets all the operations from the list
 	 *
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_operations()
 	{
@@ -3889,7 +3910,7 @@ 
 	/**
 	 * Unsets everything that has to do with buttons or links with go back to list message
 	 * @access	public
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function unset_back_to_list()
 	{
@@ -3905,7 +3926,7 @@ 
 	 * @access	public
 	 * @param	string
 	 * @param	array
-	 * @return	void
+	 * @return	Grocery_CRUD
 	 */
 	public function fields()
 	{
@@ -3974,9 +3995,9 @@ 
 	/**
 	 *
 	 * Changes the displaying label of the field
-	 * @param $field_name
-	 * @param $display_as
-	 * @return void
+	 * @param string $field_name
+	 * @param string $display_as
+	 * @return Grocery_CRUD
 	 */
 	public function display_as($field_name, $display_as = null)
 	{
@@ -4048,7 +4069,7 @@ 
 	 *
 	 * Set a language string directly
 	 * @param string $handle
-	 * @param string $string
+	 * @param string $lang_string
 	 */
 	public function set_lang_string($handle, $lang_string){
 		$this->lang_strings[$handle] = $lang_string;
@@ -5157,7 +5178,6 @@ 
 	 * Transform a field to an upload field
 	 *
 	 * @param string $field_name
-	 * @param string $upload_path
      * @return Grocery_CRUD
 	 */
 	public function set_field_upload($field_name, $upload_dir = '', $allowed_file_types = '')
@@ -5273,6 +5293,9 @@ 
         		substr($_SERVER['SCRIPT_NAME'],0, strrpos($_SERVER['SCRIPT_NAME'], '/'));
     }
 
+    /**
+     * @param string $file_name
+     */
     private function get_file_object($file_name) {
         $file_path = $this->options['upload_dir'].$file_name;
         if (is_file($file_path) && $file_name[0] !== '.') {
@@ -5301,6 +5324,9 @@ 
         )));
     }
 
+    /**
+     * @param string $file_name
+     */
     private function create_scaled_image($file_name, $options) {
         $file_path = $this->options['upload_dir'].$file_name;
         $new_file_path = $options['upload_dir'].$file_name;
@@ -5354,6 +5380,9 @@ 
         return $success;
     }
 
+    /**
+     * @param stdClass $file
+     */
     private function has_error($uploaded_file, $file, $error) {
         if ($error) {
 			switch($error) {
@@ -5424,6 +5453,9 @@ 
         return $file_name;
     }
 
+    /**
+     * @param string $file_name
+     */
     private function _transliterate_characters($file_name)
 	{
 		include($this->default_config_path.'/translit_chars.php');
@@ -5438,6 +5470,9 @@ 
 		return preg_replace('/\-+/', '-', trim($file_name, '-'));
 	}
 
+    /**
+     * @param string $file_path
+     */
     private function orient_image($file_path) {
       	$exif = exif_read_data($file_path);
       	$orientation = intval(@$exif['Orientation']);

dashboard/assets/grocery_crud/texteditor/ckeditor/ckeditor_php4.php

Doc Comments +1 added lines

@@ -483,6 +483,7 @@
 	/**

 	 * Return path to ckeditor.js.

 	 * \private

+	 * @return string
 	 */

 	function ckeditorPath()

 	{