htmlburger / carbon-fields

core/Container/User_Meta_Container.php

Doc Comments +3 added lines, -3 removed lines

@@ -58,7 +58,7 @@ 
 	/**
 	 * Checks whether the current request is valid
 	 *
-	 * @return bool
+	 * @return null|boolean
 	 **/
 	function is_valid_save($user_id = 0) {
 		if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE ) {
@@ -76,7 +76,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
 	 **/
 	function is_valid_save_conditions($user_id) {
 		$valid = true;
@@ -106,7 +106,7 @@ 
 	 * Show the container only on users who have the $role role.
 	 *
 	 * @param string $role
-	 * @return object $this
+	 * @return User_Meta_Container $this
 	 **/
 	function show_on_user_role($role) {
 		$this->settings['show_on']['role'] = (array) $role;

core/Container/Post_Meta_Container.php

Doc Comments +10 added lines, -10 removed lines

@@ -439,7 +439,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 );
@@ -458,7 +458,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 ) {
 		if ( is_int( $page ) ) {
@@ -483,7 +483,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;
@@ -495,7 +495,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 ) {
 		$this->show_on_post_type( 'page' );
@@ -517,7 +517,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 ) ) {
@@ -537,7 +537,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 ) {
@@ -554,7 +554,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 );
@@ -571,7 +571,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 ) ) {
@@ -593,8 +593,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/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/Container.php

Doc Comments +4 added lines, -4 removed lines

@@ -302,7 +302,7 @@ 
 	 *
 	 * @see init()
 	 * @param array $settings
-	 * @return object $this
+	 * @return Container $this
 	 **/
 	public function setup( $settings = array() ) {
 		if ( $this->setup_ready ) {
@@ -467,7 +467,7 @@ 
 	 * assigned to them instead.
 	 *
 	 * @param array $fields
-	 * @return object $this
+	 * @return Container $this
 	 **/
 	public function add_fields( $fields ) {
 		foreach ( $fields as $field ) {
@@ -493,7 +493,7 @@ 
 	 *
 	 * @param string $tab_name
 	 * @param array $fields
-	 * @return object $this
+	 * @return Container $this
 	 */
 	public function add_tab( $tab_name, $fields ) {
 		$this->add_template( 'tabs', array( $this, 'template_tabs' ) );
@@ -691,7 +691,7 @@ 
 	 * Assign datastore instance for use by the container fields
 	 *
 	 * @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() ) {

core/Field/Field.php

Doc Comments +15 added lines, -14 removed lines

@@ -326,8 +326,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() ) {
@@ -341,7 +341,7 @@ 
 	/**
 	 * Return the DataStore instance used by the field
 	 *
-	 * @return object $datastore
+	 * @return Datastore_Interface $datastore
 	 **/
 	public function get_datastore() {
 		return $this->datastore;
@@ -351,7 +351,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;
@@ -454,7 +454,7 @@ 
 	 * name and the conditional logic fields.
 	 *
 	 * @param string $prefix
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_prefix( $prefix ) {
 		$escaped_prefix = preg_quote( $this->name_prefix, '~' );
@@ -499,7 +499,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;
@@ -510,7 +510,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 );
@@ -519,7 +519,7 @@ 
 	/**
 	 * Return the field help text
 	 *
-	 * @return object $this
+	 * @return string $this
 	 **/
 	public function get_help_text() {
 		return $this->help_text;
@@ -529,7 +529,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;
@@ -549,7 +549,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;
@@ -569,7 +569,7 @@ 
 	 * Set the field width.
 	 *
 	 * @param int $width
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_width( $width ) {
 		$this->width = (int) $width;
@@ -589,7 +589,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 ) ) {
@@ -613,7 +613,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;
@@ -662,6 +662,7 @@ 
 	/**
 	 * Cleans up an object class for usage as HTML class
 	 *
+	 * @param string $type
 	 * @return string
 	 */
 	protected function clean_type( $type ) {
@@ -679,7 +680,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();