WordPoints / hooks-api

src/includes/classes/hierarchy.php

Doc Comments +44 added lines

@@ -9,17 +9,49 @@ 
 
 interface WordPoints_HierarchyI {
 	public function get();
+
+	/**
+	 * @return void
+	 */
 	public function push( $field, $data );
+
+	/**
+	 * @return void
+	 */
 	public function pop();
 	public function set_field( $field, $value );
+
+	/**
+	 * @param string $field
+	 * @param string $sub
+	 * @param string $sub_2
+	 */
 	public function get_field( $field, $sub = null, $sub_2 = null );
 	public function get_id();
 	public function go_to( $id );
+
+	/**
+	 * @param string $field
+	 *
+	 * @return void
+	 */
 	public function push_to( $field, $value );
+
+	/**
+	 * @return boolean
+	 */
 	public function ascend();
+
+	/**
+	 * @return boolean
+	 */
 	public function descend( $to = null );
 	public function is_main();
 	public function next();
+
+	/**
+	 * @return void
+	 */
 	public function reset();
 }
 
@@ -134,6 +166,9 @@ 
 	protected $current = 0;
 	protected $i = 0;
 
+	/**
+	 * @param string $descendant_index
+	 */
 	public function __construct( $descendant_index ) {
 		$this->descendant_index = $descendant_index;
 	}
@@ -196,10 +231,16 @@ 
 		$this->current = 0;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function set_field( $field, $value ) {
 		$this->hierarchy[ $this->current ][ $field ] = $value;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function get_field( $field, $sub = null, $sub_2 = null ) {
 
 		if ( ! isset( $this->hierarchy[ $this->current ][ $field ] ) ) {
@@ -225,6 +266,9 @@ 
 		return $this->hierarchy[ $this->current ][ $field ];
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function push_to( $field, $value ) {
 
 		if ( ! isset( $this->hierarchy[ $this->current ][ $field ] ) ) {

src/includes/classes/hook/retroactive/query.php

Doc Comments +4 added lines

@@ -73,6 +73,10 @@
 
 
 interface WordPoints_Hook_Reactor_RetroactiveI extends WordPoints_Hook_Retroactive_Query_ModifierI {
+
+	/**
+	 * @return void
+	 */
 	public function retroactive_hit( $target, array $records, WordPoints_Hook_Event_RetroactiveI $event, WordPoints_Hook_ReactionI $reaction );
 }
 

src/includes/classes/hook/settings.php

Doc Comments +20 added lines

@@ -8,12 +8,32 @@
  */
 
 interface WordPoints_Hook_Reaction_SettingI {
+
+	/**
+	 * @return void
+	 */
 	public function __construct( $slug );
+
+	/**
+	 * @return string
+	 */
 	public function get_type();
+
+	/**
+	 * @return string
+	 */
 	public function get_label();
+
+	/**
+	 * @return boolean
+	 */
 	public function is_required();
 	public function get( WordPoints_Hook_ReactionI $reaction );
 	public function validate( $value, WordPoints_Hook_Reaction_Validator $validator );
+
+	/**
+	 * @return void
+	 */
 	public function save( $value, WordPoints_Hook_ReactionI $reaction, $is_new );
 }
 

src/includes/classes/query/builder/db/mysql.php

Doc Comments +24 added lines

@@ -9,12 +9,36 @@
 
 
 interface WordPoints_Query_BuilderI {
+
+	/**
+	 * @return void
+	 */
 	public function set_fields( $fields );
+
+	/**
+	 * @return void
+	 */
 	public function add_field( $field );
+
+	/**
+	 * @return void
+	 */
 	public function set_table( $table_name );
 	public function get_table();
+
+	/**
+	 * @return void
+	 */
 	public function enter_join( $join );
+
+	/**
+	 * @return void
+	 */
 	public function exit_join();
+
+	/**
+	 * @return void
+	 */
 	public function where( $condition );
 	public function get_query();
 }

src/includes/classes/spec.php

Doc Comments +3 added lines

@@ -284,6 +284,9 @@
 		return $entities;
 	}
 
+	/**
+	 * @param integer $count
+	 */
 	protected function check_count( $count ) {
 
 		if ( isset( $this->settings['max'] ) && $count > $this->settings['max'] ) {

src/includes/classes/hook/reaction/store.php

Doc Comments +1 added lines, -1 removed lines

@@ -179,7 +179,7 @@
 	 *
 	 * @param string $event_slug The slug of the event this reaction is for.
 	 *
-	 * @return int|false The reaction ID, or false if not created.
+	 * @return integer The reaction ID, or false if not created.
 	 */
 	abstract protected function _create_reaction( $event_slug );
 }

src/includes/classes/hook/event/args.php

Doc Comments +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
 	 *
 	 * @since 1.0.0
 	 *
-	 * @return WordPoints_Hook_Reaction_Validator|null The validator or null if none.
+	 * @return WordPoints_Hook_Reaction_Validator The validator or null if none.
 	 */
 	public function get_validator() {
 		return $this->validator;

src/includes/classes/entity.php

Doc Comments +1 added lines, -1 removed lines

@@ -265,7 +265,7 @@
 	 *
 	 * @param string $child_slug The slug of the child.
 	 *
-	 * @return WordPoints_Entityish|false The child's object, or false if not found.
+	 * @return WordPoints_EntityishI The child's object, or false if not found.
 	 */
 	public function get_child( $child_slug ) {
 

src/includes/classes/entity/change.php

Doc Comments +15 added lines

@@ -58,8 +58,20 @@ 
 
 // this is basically a reactor
 interface WordPoints_Entity_Change_ListenerI {
+
+	/**
+	 * @return void
+	 */
 	public function created( WordPoints_Entity $entity );
+
+	/**
+	 * @return void
+	 */
 	public function updated( WordPoints_Entity $before, WordPoints_Entity $after );
+
+	/**
+	 * @return void
+	 */
 	public function deleted( WordPoints_Entity $entity );
 }
 
@@ -129,6 +141,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $type
+	 */
 	protected function fire_event( $type, WordPoints_Entity $entity ) {
 
 		$args = new WordPoints_Hook_Event_Args( array() );