Fixing base store docblocks.

This commit is contained in:
Dan Cryer 2015-02-16 11:20:18 +00:00
commit 5dc0f181cf
4 changed files with 99 additions and 0 deletions

View file

@ -20,11 +20,24 @@ class BuildMetaStoreBase extends Store
protected $modelName = '\PHPCI\Model\BuildMeta';
protected $primaryKey = 'id';
/**
* Returns a BuildMeta model by primary key.
* @param mixed $value
* @param string $useConnection
* @return \@appNamespace\Model\BuildMeta|null
*/
public function getByPrimaryKey($value, $useConnection = 'read')
{
return $this->getById($value, $useConnection);
}
/**
* Returns a BuildMeta model by Id.
* @param mixed $value
* @param string $useConnection
* @throws HttpException
* @return \@appNamespace\Model\BuildMeta|null
*/
public function getById($value, $useConnection = 'read')
{
if (is_null($value)) {
@ -44,6 +57,14 @@ class BuildMetaStoreBase extends Store
return null;
}
/**
* Returns an array of BuildMeta models by ProjectId.
* @param mixed $value
* @param int $limit
* @param string $useConnection
* @throws HttpException
* @return array
*/
public function getByProjectId($value, $limit = 1000, $useConnection = 'read')
{
if (is_null($value)) {
@ -72,6 +93,14 @@ class BuildMetaStoreBase extends Store
}
}
/**
* Returns an array of BuildMeta models by BuildId.
* @param mixed $value
* @param int $limit
* @param string $useConnection
* @throws HttpException
* @return array
*/
public function getByBuildId($value, $limit = 1000, $useConnection = 'read')
{
if (is_null($value)) {

View file

@ -20,11 +20,24 @@ class BuildStoreBase extends Store
protected $modelName = '\PHPCI\Model\Build';
protected $primaryKey = 'id';
/**
* Returns a Build model by primary key.
* @param mixed $value
* @param string $useConnection
* @return \@appNamespace\Model\Build|null
*/
public function getByPrimaryKey($value, $useConnection = 'read')
{
return $this->getById($value, $useConnection);
}
/**
* Returns a Build model by Id.
* @param mixed $value
* @param string $useConnection
* @throws HttpException
* @return \@appNamespace\Model\Build|null
*/
public function getById($value, $useConnection = 'read')
{
if (is_null($value)) {
@ -44,6 +57,14 @@ class BuildStoreBase extends Store
return null;
}
/**
* Returns an array of Build models by ProjectId.
* @param mixed $value
* @param int $limit
* @param string $useConnection
* @throws HttpException
* @return array
*/
public function getByProjectId($value, $limit = 1000, $useConnection = 'read')
{
if (is_null($value)) {
@ -72,6 +93,14 @@ class BuildStoreBase extends Store
}
}
/**
* Returns an array of Build models by Status.
* @param mixed $value
* @param int $limit
* @param string $useConnection
* @throws HttpException
* @return array
*/
public function getByStatus($value, $limit = 1000, $useConnection = 'read')
{
if (is_null($value)) {

View file

@ -20,11 +20,24 @@ class ProjectStoreBase extends Store
protected $modelName = '\PHPCI\Model\Project';
protected $primaryKey = 'id';
/**
* Returns a Project model by primary key.
* @param mixed $value
* @param string $useConnection
* @return \@appNamespace\Model\Project|null
*/
public function getByPrimaryKey($value, $useConnection = 'read')
{
return $this->getById($value, $useConnection);
}
/**
* Returns a Project model by Id.
* @param mixed $value
* @param string $useConnection
* @throws HttpException
* @return \@appNamespace\Model\Project|null
*/
public function getById($value, $useConnection = 'read')
{
if (is_null($value)) {
@ -44,6 +57,14 @@ class ProjectStoreBase extends Store
return null;
}
/**
* Returns an array of Project models by Title.
* @param mixed $value
* @param int $limit
* @param string $useConnection
* @throws HttpException
* @return array
*/
public function getByTitle($value, $limit = 1000, $useConnection = 'read')
{
if (is_null($value)) {

View file

@ -20,11 +20,24 @@ class UserStoreBase extends Store
protected $modelName = '\PHPCI\Model\User';
protected $primaryKey = 'id';
/**
* Returns a User model by primary key.
* @param mixed $value
* @param string $useConnection
* @return \@appNamespace\Model\User|null
*/
public function getByPrimaryKey($value, $useConnection = 'read')
{
return $this->getById($value, $useConnection);
}
/**
* Returns a User model by Id.
* @param mixed $value
* @param string $useConnection
* @throws HttpException
* @return \@appNamespace\Model\User|null
*/
public function getById($value, $useConnection = 'read')
{
if (is_null($value)) {
@ -44,6 +57,13 @@ class UserStoreBase extends Store
return null;
}
/**
* Returns a User model by Email.
* @param mixed $value
* @param string $useConnection
* @throws HttpException
* @return \@appNamespace\Model\User|null
*/
public function getByEmail($value, $useConnection = 'read')
{
if (is_null($value)) {