Skip to content
This repository has been archived by the owner on Sep 21, 2022. It is now read-only.

Commit

Permalink
Update Docblock comments
Browse files Browse the repository at this point in the history
  • Loading branch information
perruche committed Jan 19, 2022
1 parent 8c02846 commit 0abde0d
Showing 1 changed file with 8 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php
/**
* Parent repository class. Provides a very basic, fluent interface for interacting
* with PostCollection/PostQuery classes.
* Parent repository class. Provides a very basic, fluent interface to interact
* with query
*
* @package Studiometa
*/
Expand All @@ -13,14 +13,14 @@ abstract class Repository {
/**
* List of posts.
*
* @var array|PostCollection
* @var array
*/
private $result_set = array();

/**
* Returns a list or collection of posts.
* Returns an array of posts.
*
* @return array|PostCollection
* @return array
*/
public function get() {
return $this->result_set;
Expand Down Expand Up @@ -73,6 +73,8 @@ protected function query( array $params ) {
*
* @param array $params Query params.
* @return mixed
*
* @example ./app/Repositories/PostRepository.php How to implement do_query().
*/
abstract protected function do_query( $params );

Expand All @@ -89,7 +91,7 @@ protected function reset() {
/**
* Returns current result set
*
* @param array|PostCollection $result_set Result set.
* @param array $result_set Result set.
*
* @return Repository
*/
Expand Down

0 comments on commit 0abde0d

Please sign in to comment.