adding @param phpdoc test class TYpe.php

This commit is contained in:
Erik Amaru Ortiz
2013-12-02 17:35:58 -04:00
parent a116d6f596
commit b33d616678

View File

@@ -0,0 +1,179 @@
<?php
namespace Services\Api\ProcessMaker;
class Type
{
/**
* Email validation
*
* @param string $email {@from body}{@type email}
*/
function postEmail($email)
{
return $email;
}
/**
* Date validation
*
* @param string $date {@from body}{@type date}
*/
function postDate($date)
{
return $date;
}
/**
* DateTime validation
*
* @param string $datetime {@from body}{@type datetime}
*/
function postDatetime($datetime)
{
return $datetime;
}
/**
* time validation
*
* @param string $time {@from body}{@type time}
*/
function postTime($time)
{
return $time;
}
/**
* time validation in 12 hour format
*
* @param string $time {@from body}{@type time12}
*/
function postTime12($time12)
{
return $time12;
}
/**
* Timestamp validation
*
* @param string $timestamp {@from body}{@type timestamp}
*/
function postTimestamp($timestamp)
{
return $timestamp;
}
/**
* Integer validation
*
* @param array $integers {@type int}
*/
function postIntegers(array $integers)
{
return $integers;
}
/**
* Array of numbers
*
* @param array $numbers {@type float}
*/
function postNumbers(array $numbers)
{
return $numbers;
}
/**
* Array of time strings
*
* @param array $timestamp {@from body}{@type time}
*/
function postTimes(array $timestamps)
{
return $timestamps;
}
/**
* Array of timestamps
*
* @param array $timestamp {@from body}{@type timestamp}
*/
function postTimestamps(array $timestamps)
{
return $timestamps;
}
/**
* Custom class parameter
*
* @param Author $author
*
* @return Author
*/
function postAuthor(Author $author)
{
return $author;
}
/**
* Array of authors
*
* @param array $authors {@type Author}
*
* @return mixed
*/
function postAuthors(array $authors)
{
return $authors;
}
/**
* An associative array
*
* @param array $object {@type associative}
*
* @return array
*/
function postObject(array $object)
{
return $object;
}
/**
* An indexed array
*
* @param array $array {@type indexed}
*
* @return array
*/
function postArray(array $array)
{
return $array;
}
/**
* An array indexed or associative
*
* @param array $array
*
* @return array
*/
function postArrayOrObject(array $array)
{
return $array;
}
}
class Author
{
/**
* @var string {@from body} {@min 3}{@max 100}
* name of the Author {@required true}
*/
public $name = 'Name';
/**
* @var string {@type email} {@from body}
* email id of the Author
*/
public $email = 'name@domain.com';
}