htmlburger / carbon-fields

core/Field/Field.php

Doc Comments +18 added lines, -17 removed lines

@@ -323,8 +323,8 @@ 
 	/**
 	 * Assign DataStore instance for use during load, save and delete
 	 *
-	 * @param object $store
-	 * @return object $this
+	 * @param Datastore_Interface $store
+	 * @return Field $this
 	 **/
 	public function set_datastore( Datastore_Interface $store ) {
 		$this->store = $store;
@@ -334,7 +334,7 @@ 
 	/**
 	 * Return the DataStore instance used by the field
 	 *
-	 * @return object $store
+	 * @return Datastore_Interface $store
 	 **/
 	public function get_datastore() {
 		return $this->store;
@@ -344,7 +344,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;
@@ -447,7 +447,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, '~' );
@@ -492,7 +492,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;
@@ -503,7 +503,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 );
@@ -512,7 +512,7 @@ 
 	/**
 	 * Return the field help text
 	 *
-	 * @return object $this
+	 * @return string $this
 	 **/
 	public function get_help_text() {
 		return $this->help_text;
@@ -522,7 +522,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;
@@ -542,7 +542,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;
@@ -562,7 +562,7 @@ 
 	 * Set the field width.
 	 *
 	 * @param int $width
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_width( $width ) {
 		$this->width = (int) $width;
@@ -582,7 +582,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 ) ) {
@@ -606,7 +606,7 @@ 
 	 * Whether this field is mandatory for the user
 	 *
 	 * @param bool $required
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_required( $required ) {
 		$this->required = $required;
@@ -618,7 +618,7 @@ 
 	 *
 	 * @param string $mask
 	 * @param array $options
-	 * @return object $this
+	 * @return Field $this
 	 **/
 	public function set_mask( $mask, $options = array() ) {
 		$this->mask = $mask;
@@ -654,7 +654,7 @@ 
 	/**
 	 * Return mask format on this field
 	 *
-	 * @return string
+	 * @return boolean
 	 **/
 	public function get_mask() {
 		return $this->mask;
@@ -663,7 +663,7 @@ 
 	/**
 	 * Return jQuery mask options
 	 *
-	 * @return array
+	 * @return boolean
 	 **/
 	public function get_mask_options()
 	{
@@ -687,6 +687,7 @@ 
 	/**
 	 * Cleans up an object class for usage as HTML class
 	 *
+	 * @param string $type
 	 * @return string
 	 */
 	protected function clean_type( $type ) {
@@ -704,7 +705,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();