htmlburger / carbon-fields

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/Container/Term_Meta_Container.php

Doc Comments +2 added lines, -2 removed lines

@@ -210,7 +210,7 @@ 
 	 *
 	 * @deprecated
 	 * @param string|array $taxonomies
-	 * @return object $this
+	 * @return Term_Meta_Container $this
 	 **/
 	public function show_on_taxonomy( $taxonomies ) {
 		$taxonomies = is_array( $taxonomies ) ? $taxonomies : array( $taxonomies );
@@ -223,7 +223,7 @@ 
 	 *
 	 * @deprecated
 	 * @param int $term_level
-	 * @return object $this
+	 * @return Term_Meta_Container $this
 	 */
 	public function show_on_level( $term_level ) {
 		$this->and_when( 'term_level', '=', intval( $term_level ) );

core/Container/User_Meta_Container.php

Doc Comments +1 added lines, -1 removed lines

@@ -206,7 +206,7 @@
 	 *
 	 * @deprecated
 	 * @param string|array $role
-	 * @return object $this
+	 * @return User_Meta_Container $this
 	 **/
 	public function show_on_user_role( $role ) {
 		$roles = is_array( $role ) ? $role : array( $role );

core/Field/Field.php

Doc Comments +10 added lines, -10 removed lines

@@ -448,7 +448,7 @@ 
 	 * Set datastore instance
 	 *
 	 * @param Datastore_Interface $datastore
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_datastore( Datastore_Interface $datastore, $set_as_default = false ) {
 		if ( $set_as_default && ! $this->has_default_datastore() ) {
@@ -472,7 +472,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;
@@ -664,7 +664,7 @@ 
 	/**
 	 * Return the field help text
 	 *
-	 * @return object $this
+	 * @return string $this
 	 **/
 	public function get_help_text() {
 		return $this->help_text;
@@ -674,7 +674,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;
@@ -685,7 +685,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 );
@@ -704,7 +704,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;
@@ -724,7 +724,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;
@@ -744,7 +744,7 @@ 
 	 * Set the field width.
 	 *
 	 * @param int $width
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_width( $width ) {
 		$this->width = (int) $width;
@@ -764,7 +764,7 @@ 
 	 * Set CSS classes that the container should use.
 	 *
 	 * @param string|array $classes
-	 * @return object $this
+	 * @return Field $this
 	 */
 	public function set_classes( $classes ) {
 		$this->classes = Helper::sanitize_classes( $classes );
@@ -775,7 +775,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;

core/Container/Container.php

Doc Comments +5 added lines, -4 removed lines

@@ -371,6 +371,7 @@ 
 	/**
 	 * Check if all conditions pass for object
 	 *
+	 * @param integer $object_id
 	 * @return bool
 	 */
 	protected function all_conditions_pass( $object_id ) {
@@ -538,7 +539,7 @@ 
 	 * Set datastore instance
 	 *
 	 * @param Datastore_Interface $datastore
-	 * @return object $this
+	 * @return Container $this
 	 */
 	public function set_datastore( Datastore_Interface $datastore, $set_as_default = false ) {
 		if ( $set_as_default && ! $this->has_default_datastore() ) {
@@ -705,7 +706,7 @@ 
 	 * Set CSS classes that the container should use.
 	 *
 	 * @param string|array $classes
-	 * @return object $this
+	 * @return Container $this
 	 */
 	public function set_classes( $classes ) {
 		$this->classes = Helper::sanitize_classes( $classes );
@@ -765,7 +766,7 @@ 
 	 * assigned to them instead.
 	 *
 	 * @param array $fields
-	 * @return object $this
+	 * @return Container $this
 	 */
 	public function add_fields( $fields ) {
 		foreach ( $fields as $field ) {
@@ -791,7 +792,7 @@ 
 	 *
 	 * @param string $tab_name
 	 * @param array $fields
-	 * @return object $this
+	 * @return Container $this
 	 */
 	public function add_tab( $tab_name, $fields ) {
 		$this->add_fields( $fields );

core/Installer/Container_Condition_Installer.php

Doc Comments +6 added lines, -6 removed lines

@@ -190,7 +190,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public static function filter_post_meta_container_static_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -204,7 +204,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public static function filter_post_meta_container_dynamic_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -218,7 +218,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public static function filter_term_meta_container_static_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -232,7 +232,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public static function filter_term_meta_container_dynamic_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -246,7 +246,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public static function filter_user_meta_container_static_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -260,7 +260,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public static function filter_user_meta_container_dynamic_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(

core/Container/Fulfillable/Fulfillable_Collection.php

Doc Comments +1 added lines, -1 removed lines

@@ -298,7 +298,7 @@
 	 * 
 	 * @param  array<string>          $condition_types
 	 * @param  array|boolean          $environment Environment array or a boolean value to force on conditions
-	 * @param  array                  $comparison_operators Array of comparison operators to evaluate regardless of condition type
+	 * @param  string[]                  $comparison_operators Array of comparison operators to evaluate regardless of condition type
 	 * @return Fulfillable_Collection
 	 */
 	public function evaluate( $condition_types, $environment, $comparison_operators = array() ) {

core/Container/Post_Meta_Container.php

Doc Comments +10 added lines, -11 removed lines

@@ -69,7 +69,6 @@ 
 	 * Possible errors are triggering save() for autosave requests
 	 * or performing post save outside of the post edit page (like Quick Edit)
 	 *
-	 * @param int $post_id ID of the post against which save() is ran
 	 * @return bool
 	 **/
 	public function is_valid_save() {
@@ -269,7 +268,7 @@ 
 	 *
 	 * @deprecated
 	 * @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 );
@@ -291,7 +290,7 @@ 
 	 *
 	 * @deprecated
 	 * @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 );
@@ -305,7 +304,7 @@ 
 	 *
 	 * @deprecated
 	 * @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
@@ -323,7 +322,7 @@ 
 	 *
 	 * @deprecated
 	 * @param string|array $template_path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function hide_on_template( $template_path ) {
 		$template_paths = is_array( $template_path ) ? $template_path : array( $template_path );
@@ -337,7 +336,7 @@ 
 	 *
 	 * @deprecated
 	 * @param int $level
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_level( $level ) {
 		$this->and_when( 'post_level', '=', intval( $level ) );
@@ -350,7 +349,7 @@ 
 	 *
 	 * @deprecated
 	 * @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 ) {
 		$post_formats = is_array( $post_format ) ? $post_format : array( $post_format );
@@ -362,8 +361,8 @@ 
 	 * Show the container only on posts from the specified type(s).
 	 *
 	 * @deprecated
-	 * @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 = is_array( $post_types ) ? $post_types : array( $post_types );
@@ -378,7 +377,7 @@ 
 	 *
 	 * @deprecated
 	 * @param string $category_slug
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_category( $category_slug ) {
 		$this->and_when( 'post_term', '=', array(
@@ -395,7 +394,7 @@ 
 	 * @deprecated
 	 * @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 ) {
 		$this->and_when( 'post_term', '=', array(