htmlburger / carbon-fields

core/Container/Term_Meta_Container.php

Doc Comments +2 added lines, -2 removed lines

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

core/Container/Post_Meta_Container.php

Doc Comments +10 added lines, -10 removed lines

@@ -342,7 +342,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
 	 **/
 	public function show_on_page( $page ) {
 		$page_id = absint( $page );
@@ -368,7 +368,7 @@ 
 	 * Show the container only on pages whose parent is referenced by $parent_page_path.
 	 *
 	 * @param string $parent_page_path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_page_children( $parent_page_path ) {
 		$page = get_page_by_path( $parent_page_path );
@@ -390,7 +390,7 @@ 
 	 * @see show_on_taxonomy_term()
 	 *
 	 * @param string $category_slug
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_category( $category_slug ) {
 		$this->settings['show_on']['category'] = $category_slug;
@@ -402,7 +402,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
 	 **/
 	public function show_on_template( $template_path ) {
 		// Backwards compatibility where only pages support templates
@@ -427,7 +427,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
 	 **/
 	public function hide_on_template( $template_path ) {
 		if ( is_array( $template_path ) ) {
@@ -447,7 +447,7 @@ 
 	 * Levels start from 1 (top level post)
 	 *
 	 * @param int $level
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_level( $level ) {
 		if ( $level < 0 ) {
@@ -464,7 +464,7 @@ 
 	 *
 	 * @param string $taxonomy_slug
 	 * @param string $term_slug
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_taxonomy_term( $term_slug, $taxonomy_slug ) {
 		$term = get_term_by( 'slug', $term_slug, $taxonomy_slug );
@@ -481,7 +481,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
 	 **/
 	public function show_on_post_format( $post_format ) {
 		if ( is_array( $post_format ) ) {
@@ -503,8 +503,8 @@ 
 	/**
 	 * Show the container only on posts from the specified type(s).
 	 *
-	 * @param string|array $post_types
-	 * @return object $this
+	 * @param string $post_types
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_post_type( $post_types ) {
 		$post_types = (array) $post_types;

core/Container/User_Meta_Container.php

Doc Comments +4 added lines, -5 removed lines

@@ -45,7 +45,7 @@ 
 	/**
 	 * Checks whether the current request is valid
 	 *
-	 * @return bool
+	 * @return null|boolean
 	 **/
 	public function is_valid_save( $user_id = 0 ) {
 		if ( ! isset( $_REQUEST[ $this->get_nonce_name() ] ) || ! wp_verify_nonce( $_REQUEST[ $this->get_nonce_name() ], $this->get_nonce_name() ) ) {
@@ -63,7 +63,7 @@ 
 	 * Perform checks whether the current save() request is valid
 	 *
 	 * @param int $user_id ID of the user against which save() is ran
-	 * @return bool
+	 * @return null|boolean
 	 **/
 	public function is_valid_save_conditions( $user_id ) {
 		$valid = true;
@@ -198,7 +198,6 @@ 
 	/**
 	 * Validate and parse the show_for logic rules.
 	 *
-	 * @param array $rules
 	 * @return array
 	 */
 	protected function parse_show_for( $show_for ) {
@@ -246,7 +245,7 @@ 
 	 * Show the container only on users who have the $role role.
 	 *
 	 * @param string $role
-	 * @return object $this
+	 * @return User_Meta_Container $this
 	 **/
 	public function show_on_user_role( $role ) {
 		$this->settings['show_on']['role'] = (array) $role;
@@ -258,7 +257,7 @@ 
 	 * Show the container only for users who have either capabilities or roles setup
 	 *
 	 * @param array $show_for
-	 * @return object $this
+	 * @return User_Meta_Container $this
 	 **/
 	public function show_for( $show_for ) {
 		$this->settings['show_for'] = $this->parse_show_for( $show_for );

core/Datastore/Key_Value_Datastore.php

Doc Comments +1 added lines

@@ -225,6 +225,7 @@
 	/**
 	 * Convert an array of storage key patterns to a parentheses-enclosed sql comparison
 	 *
+	 * @param string $column
 	 * @return string
 	 **/
 	protected function storage_key_patterns_to_sql( $column, $patterns ) {

core/Field/Checkbox_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 	/**
 	 * Return a differently formatted value for end-users
 	 *
-	 * @return mixed
+	 * @return boolean
 	 **/
 	public function get_formatted_value() {
 		return ( $this->get_value() === $this->option_value );

core/Field/Complex_Field.php

Doc Comments +1 added lines

@@ -200,6 +200,7 @@
 	/**
 	 * Return a clone of a field with hierarchy settings applied
 	 *
+	 * @param Complex_Field $parent_field
 	 * @return bool
 	 **/
 	public function get_clone_under_field_in_hierarchy( $field, $parent_field, $entry_index = 0 ) {

core/Service/Legacy_Storage_Service.php

Doc Comments +1 added lines, -1 removed lines

@@ -345,7 +345,7 @@
 	/**
 	 * Convert field data to a new storage key
 	 * 
-	 * @param  array  $hierarchy
+	 * @param  array  $full_hierarchy
 	 * @param  array  $hierarchy_index
 	 * @param  integer $value_index
 	 * @param  string  $value_key

core/Service/Meta_Query_Service.php

Doc Comments +1 added lines

@@ -54,6 +54,7 @@
 	/**
 	 * Recursive function to replace meta keys in meta_query arrays
 	 *
+	 * @param string $container_type
 	 * @return array
 	 */
 	protected function filter_meta_query_array( $condition, $container_type ) {

core/Field/Field.php

Doc Comments +15 added lines, -14 removed lines

@@ -406,8 +406,8 @@ 
 	/**
 	 * Assign DataStore instance for use during load, save and delete
 	 *
-	 * @param object $datastore
-	 * @return object $this
+	 * @param Datastore_Interface $datastore
+	 * @return Field $this
 	 **/
 	public function set_datastore( Datastore_Interface $datastore, $set_as_default = false ) {
 		if ( $set_as_default && ! $this->has_default_datastore() ) {
@@ -421,7 +421,7 @@ 
 	/**
 	 * Return the DataStore instance used by the field
 	 *
-	 * @return object $datastore
+	 * @return Datastore_Interface $datastore
 	 **/
 	public function get_datastore() {
 		return $this->datastore;
@@ -431,7 +431,7 @@ 
 	 * Assign the type of the container this field is in
 	 *
 	 * @param string
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_context( $context ) {
 		$this->context = $context;
@@ -468,7 +468,7 @@ 
 	/**
 	 * Return a differently formatted value for end-users
 	 *
-	 * @return mixed
+	 * @return string
 	 **/
 	public function get_formatted_value() {
 		$value = $this->get_value();
@@ -588,7 +588,7 @@ 
 	 * Set additional text to be displayed during field render,
 	 * containing information and guidance for the user
 	 *
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_help_text( $help_text ) {
 		$this->help_text = $help_text;
@@ -599,7 +599,7 @@ 
 	 * Alias for set_help_text()
 	 *
 	 * @see set_help_text()
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function help_text( $help_text ) {
 		return $this->set_help_text( $help_text );
@@ -608,7 +608,7 @@ 
 	/**
 	 * Return the field help text
 	 *
-	 * @return object $this
+	 * @return string $this
 	 **/
 	public function get_help_text() {
 		return $this->help_text;
@@ -618,7 +618,7 @@ 
 	 * Whether or not this value should be auto loaded. Applicable to theme options only.
 	 *
 	 * @param bool $autoload
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_autoload( $autoload ) {
 		$this->autoload = $autoload;
@@ -638,7 +638,7 @@ 
 	 * Whether or not this field will be initialized when the field is in the viewport (visible).
 	 *
 	 * @param bool $lazyload
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_lazyload( $lazyload ) {
 		$this->lazyload = $lazyload;
@@ -658,7 +658,7 @@ 
 	 * Set the field width.
 	 *
 	 * @param int $width
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_width( $width ) {
 		$this->width = (int) $width;
@@ -678,7 +678,7 @@ 
 	 *  Add custom CSS class to the field html container.
 	 *
 	 * @param string|array $classes
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function add_class( $classes ) {
 		if ( ! is_array( $classes ) ) {
@@ -702,7 +702,7 @@ 
 	 * Whether this field is mandatory for the user
 	 *
 	 * @param bool $required
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_required( $required = true ) {
 		$this->required = $required;
@@ -751,6 +751,7 @@ 
 	/**
 	 * Cleans up an object class for usage as HTML class
 	 *
+	 * @param string $type
 	 * @return string
 	 */
 	protected function clean_type( $type ) {
@@ -768,7 +769,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();