htmlburger / carbon-fields

core/Container/Container.php

Doc Comments +1 added lines, -1 removed lines

@@ -632,7 +632,7 @@
 	/**
 	 * Assign DataStore instance for use by the container fields
 	 *
-	 * @param object $store
+	 * @param Datastore_Interface $store
 	 **/
 	function set_datastore(Datastore_Interface $store) {
 		$this->store = $store;

core/Container/Nav_Menu_Container.php

Doc Comments -1 removed lines

@@ -18,7 +18,6 @@
 	/**
 	 * Create a new nav menu item fields container
 	 *
-	 * @param string $title Unique title of the container
 	 **/
 	function __construct($id) {
 		// Reset the registered fields array, this is required so we can have fields with same names

core/Container/Post_Meta_Container.php

Doc Comments +11 added lines, -12 removed lines

@@ -433,8 +433,8 @@ 
 	/**
 	 * Show the container only on pages whose parent is referenced by $parent_page_path.
 	 *
-	 * @param string $page_path
-	 * @return object $this
+	 * @param string $parent_page_path
+	 * @return Post_Meta_Container $this
 	 **/
 	function show_on_page_children($parent_page_path) {
 		$page = get_page_by_path($parent_page_path);
@@ -452,7 +452,7 @@ 
 	 * Show the container only on particular page referenced by it's path.
 	 *
 	 * @param int|string $page page ID or page path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	function show_on_page($page) {
 		if ( is_int($page) ) {
@@ -476,7 +476,7 @@ 
 	 * @see show_on_taxonomy_term()
 	 *
 	 * @param string $category_slug
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	function show_on_category($category_slug) {
 		$this->settings['show_on']['category'] = $category_slug;
@@ -488,7 +488,7 @@ 
 	 * Show the container only on pages whose template has filename $template_path.
 	 *
 	 * @param string|array $template_path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	function show_on_template($template_path) {
 		if ( is_array($template_path) ) {
@@ -507,7 +507,7 @@ 
 	 * Hide the container from pages whose template has filename $template_path.
 	 *
 	 * @param string|array $template_path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	function hide_on_template($template_path) {
 		if ( is_array($template_path) ) {
@@ -527,7 +527,7 @@ 
 	 * Levels start from 1 (top level post)
 	 *
 	 * @param int $level
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	function show_on_level($level) {
 		if ($level < 0 ) {
@@ -544,7 +544,7 @@ 
 	 *
 	 * @param string $taxonomy_slug
 	 * @param string $term_slug
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	function show_on_taxonomy_term($term_slug, $taxonomy_slug) {
 		$term = get_term_by('slug', $term_slug, $taxonomy_slug);
@@ -561,7 +561,7 @@ 
 	 * Learn more about {@link http://codex.wordpress.org/Post_Formats Post Formats (Codex)}
 	 *
 	 * @param string|array $post_format Name of the format as listed on Codex
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	function show_on_post_format($post_format) {
 		if ( is_array($post_format) ) {
@@ -583,8 +583,8 @@ 
 	/**
 	 * Show the container only on posts from the specified type(s).
 	 *
-	 * @param string|array $post_type
-	 * @return object $this
+	 * @param string|array $post_types
+	 * @return Post_Meta_Container $this
 	 **/
 	function show_on_post_type($post_types) {
 		$post_types = (array)$post_types;
@@ -610,7 +610,6 @@ 
 	 * Sets the meta box container priority
 	 *
 	 * @see https://codex.wordpress.org/Function_Reference/add_meta_box
-	 * @param string $context ('high', 'core', 'default' or 'low')
 	 */
 	function set_priority($priority) {
 		$this->settings['panel_priority'] = $priority;

core/Container/Term_Meta_Container.php

Doc Comments +2 added lines, -3 removed lines

@@ -187,8 +187,7 @@ 
 	/**
 	 * Show the container only on terms from the specified taxonomies.
 	 *
-	 * @param string|array $post_type
-	 * @return object $this
+	 * @return Term_Meta_Container $this
 	 **/
 	function show_on_taxonomy($taxonomies) {
 		$taxonomies = (array)$taxonomies;
@@ -202,7 +201,7 @@ 
 	 * Show the container only on particular term level. 
 	 *
 	 * @param int $term_level 
-	 * @return object $this 
+	 * @return Term_Meta_Container $this 
 	 */ 
 	function show_on_level($term_level) {                    
 		$this->settings['show_on_level'] = $term_level; 

core/Field/Field.php

Doc Comments +16 added lines, -17 removed lines

@@ -304,8 +304,8 @@ 
 	/**
 	 * Assign DataStore instance for use during load, save and delete
 	 *
-	 * @param object $store
-	 * @return object $this
+	 * @param Datastore_Interface $store
+	 * @return Field $this
 	 **/
 	function set_datastore(Datastore_Interface $store) {
 		$this->store = $store;
@@ -325,7 +325,7 @@ 
 	 * Assign the type of the container this field is in
 	 *
 	 * @param string
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	function set_context($context) {
 		$this->context = $context;
@@ -353,7 +353,6 @@ 
 	/**
 	 * Set default field value
 	 *
-	 * @param mixed $value
 	 **/
 	function set_default_value($default_value) {
 		$this->default_value = $default_value;
@@ -423,7 +422,7 @@ 
 	 * Set field name prefix. Calling this method will update the current field name and the conditional logic fields.
 	 *
 	 * @param string $prefix
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	function set_prefix($prefix) {
 		$this->name = preg_replace('~^' . preg_quote($this->name_prefix, '~') . '~', '', $this->name);
@@ -467,7 +466,7 @@ 
 	 * Set additional text to be displayed during field render,
 	 * containing information and guidance for the user
 	 *
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	function set_help_text($help_text) {
 		$this->help_text = $help_text;
@@ -478,7 +477,7 @@ 
 	 * Alias for set_help_text()
 	 *
 	 * @see set_help_text()
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	function help_text($help_text) {
 		return $this->set_help_text($help_text);
@@ -487,7 +486,7 @@ 
 	/**
 	 * Return the field help text
 	 *
-	 * @return object $this
+	 * @return string $this
 	 **/
 	function get_help_text() {
 		return $this->help_text;
@@ -497,7 +496,7 @@ 
 	 * Whether or not this value should be auto loaded. Applicable to theme options only.
 	 *
 	 * @param bool $autoload
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	function set_autoload($autoload) {
 		$this->autoload = $autoload;
@@ -516,8 +515,7 @@ 
 	/**
 	 * Whether or not this field will be initialized when the field is in the viewport (visible).
 	 * 
-	 * @param bool $autoload
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	function set_lazyload($lazyload) {
 		$this->lazyload = $lazyload;
@@ -537,7 +535,7 @@ 
 	 * Set the field width.
 	 * 
 	 * @param int $width
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	function set_width($width) {
 		$this->width = (int) $width;
@@ -557,7 +555,7 @@ 
 	 *  Add custom CSS class to the field html container.
 	 * 
 	 * @param string|array $classes
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	function add_class($classes) {
 		if (!is_array($classes)) {
@@ -581,7 +579,7 @@ 
 	 * Whether this field is mandatory for the user
 	 *
 	 * @param bool $required
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	function set_required($required) {
 		$this->required = $required;
@@ -590,7 +588,7 @@ 
 
 	/**
 	 * HTML id attribute getter.
-	 * @return string
+	 * @return integer
 	 */
 	function get_id() {
 		return $this->id;
@@ -630,6 +628,7 @@ 
 	/**
 	 * Cleans up an object class for usage as HTML class
 	 *
+	 * @param string $type
 	 * @return string
 	 */
 	protected function clean_type($type) {
@@ -647,7 +646,7 @@ 
 	/**
 	 * Return an array of html classes to be used for the field container
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function get_html_class() {
 		$html_classes = array();
@@ -833,7 +832,7 @@ 
 	/**
 	 * Changes the options array structure. This is needed to keep the array items order when it is JSON encoded.
 	 *
-	 * @param array $options
+	 * @param string $options
 	 * @return array
 	 */
 	public function parse_options($options) {

core/Helper/Helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -547,7 +547,7 @@
 	 * Recursive sorting function by array key.
 	 * @param  array  &$array     The input array.
 	 * @param  int    $sort_flags Flags for controlling sorting behavior.
-	 * @return array              Sorted array.
+	 * @return boolean              Sorted array.
 	 */
 	public static function ksort_recursive( &$array, $sort_flags = SORT_REGULAR ) {
 		if (!is_array($array)) {