htmlburger / carbon-fields

core/Field/Field.php

Doc Comments +15 added lines, -14 removed lines

@@ -405,8 +405,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() ) {
@@ -420,7 +420,7 @@ 
 	/**
 	 * Return the DataStore instance used by the field
 	 *
-	 * @return object $datastore
+	 * @return Datastore_Interface $datastore
 	 **/
 	public function get_datastore() {
 		return $this->datastore;
@@ -430,7 +430,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;
@@ -467,7 +467,7 @@ 
 	/**
 	 * Return a differently formatted value for end-users
 	 *
-	 * @return mixed
+	 * @return string
 	 **/
 	public function get_formatted_value() {
 		$value = $this->get_value();
@@ -587,7 +587,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;
@@ -598,7 +598,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 );
@@ -607,7 +607,7 @@ 
 	/**
 	 * Return the field help text
 	 *
-	 * @return object $this
+	 * @return string $this
 	 **/
 	public function get_help_text() {
 		return $this->help_text;
@@ -617,7 +617,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;
@@ -637,7 +637,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;
@@ -657,7 +657,7 @@ 
 	 * Set the field width.
 	 *
 	 * @param int $width
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_width( $width ) {
 		$this->width = (int) $width;
@@ -677,7 +677,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 ) ) {
@@ -701,7 +701,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;
@@ -750,6 +750,7 @@ 
 	/**
 	 * Cleans up an object class for usage as HTML class
 	 *
+	 * @param string $type
 	 * @return string
 	 */
 	protected function clean_type( $type ) {
@@ -767,7 +768,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();

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 ) {