Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a missing '@' and docs for magic methods #104

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,14 @@ foreach ($tweets as $tweet) {
Changelog
---------

#### 1.5.6 - released 2014-10-01

* Added @method tags for magic methods [[stellis](https://github.com/stellis)]

#### 1.5.5 - released 2014-10-01

* Added missing '@' for a @return tag for create() method [[stellis](https://github.com/stellis)]

#### 1.5.4 - released 2014-09-23

* Corrects return value in docblock for 2 Model functions [[michaelward82](https://github.com/michaelward82)] - [issue #99](https://github.com/j4mie/paris/pull/99)
Expand Down
22 changes: 21 additions & 1 deletion paris.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,16 @@
* You shouldn't need to interact with this class
* directly. It is used internally by the Model base
* class.
*
*
* The methods documented below are magic methods that conform to PSR-1.
* This documentation exposes these methods to doc generators and IDEs.
* @see http://www.php-fig.org/psr/psr-1/
*
* @method void setClassName($class_name)
* @method static \ORMWrapper forTable($table_name, $connection_name = parent::DEFAULT_CONNECTION)
* @method \Model findOne($id=null)
* @method Array findMany()
*/
class ORMWrapper extends ORM {

Expand Down Expand Up @@ -155,7 +165,7 @@ public function find_many() {
* empty instance of the class associated with
* this wrapper instead of the raw ORM class.
*
* return ORMWrapper|bool
* @return ORMWrapper|bool
*/
public function create($data=null) {
return $this->_create_model_instance(parent::create($data));
Expand All @@ -169,6 +179,16 @@ public function create($data=null) {
* class Widget extends Model {
* }
*
*
* The methods documented below are magic methods that conform to PSR-1.
* This documentation exposes these methods to doc generators and IDEs.
* @see http://www.php-fig.org/psr/psr-1/
*
* @method void setOrm($orm)
* @method $this setExpr($property, $value = null)
* @method bool isDirty($property)
* @method bool isNew()
* @method Array asArray()
*/
class Model {

Expand Down