From a67d15089ac2b2728751b2c6819ae54f2c31d951 Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Thu, 11 Jan 2018 14:16:19 +0100 Subject: [PATCH 01/12] Base of the framework with settings --- .gitignore | 2 ++ bin/generate-password | 17 ++++++++++ composer.json | 9 ++++++ etc/security/users.json-dist | 1 + src/App/Application.php | 61 ++++++++++++++++++++++++++++++++++++ web/index.php | 15 +++++++++ 6 files changed, 105 insertions(+) create mode 100644 .gitignore create mode 100755 bin/generate-password create mode 100644 composer.json create mode 100644 etc/security/users.json-dist create mode 100644 src/App/Application.php create mode 100644 web/index.php diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..819b16d --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/etc/security/users.json +/vendor diff --git a/bin/generate-password b/bin/generate-password new file mode 100755 index 0000000..f19dc34 --- /dev/null +++ b/bin/generate-password @@ -0,0 +1,17 @@ +#!/usr/bin/env php +encodePassword($password, ''); + +echo "$hash\n"; diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..73a2329 --- /dev/null +++ b/composer.json @@ -0,0 +1,9 @@ +{ + "require": { + "silex/silex": "2.*", + "symfony/security": "^3.4" + }, + "autoload": { + "psr-4": {"App\\": "src/App"} + } +} diff --git a/etc/security/users.json-dist b/etc/security/users.json-dist new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/etc/security/users.json-dist @@ -0,0 +1 @@ +{} diff --git a/src/App/Application.php b/src/App/Application.php new file mode 100644 index 0000000..19f365f --- /dev/null +++ b/src/App/Application.php @@ -0,0 +1,61 @@ + + */ +class Application extends SilexApplication +{ + /** + * @var string + */ + protected $rootDir; + + /* + * Configures the application. + */ + public function configure() + { + $users = json_decode(file_get_contents($this->getRootDir().'/etc/security/users.json'), true); + + $this->register(new SecurityServiceProvider(), [ + 'security.firewalls' => [ + 'api' => [ + 'pattern' => '^/api', + 'http' => true, + 'users' => $users, + ], + ], + ]); + } + + /* + * Set the value of "rootDir". + * + * @param string $rootDir + * + * @return + */ + public function setRootDir($rootDir) + { + $this->rootDir = $rootDir; + + return $this; + } + + /* + * Get the value of "rootDir". + * + * @return string + */ + public function getRootDir() + { + return $this->rootDir; + } +} diff --git a/web/index.php b/web/index.php new file mode 100644 index 0000000..49e51db --- /dev/null +++ b/web/index.php @@ -0,0 +1,15 @@ +setRootDir(__DIR__.'/../')->configure(); + +$app->get('/api/sms', function () use ($app) { + return new JsonResponse(['status' => 'ok']); +}); + +$app->run(); From 7bacb3474c5e34c488dffd356ce44c069cb9f239 Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Fri, 12 Jan 2018 16:40:18 +0100 Subject: [PATCH 02/12] Base of actions with POC of validation --- src/App/Application.php | 13 +++++++++ src/App/Validator/Helper/RequestValidator.php | 25 +++++++++++++++++ src/App/Validator/SmsValidator.php | 25 +++++++++++++++++ src/App/Validator/Validator.php | 20 ++++++++++++++ web/index.php | 27 ++++++++++++++++--- 5 files changed, 106 insertions(+), 4 deletions(-) create mode 100644 src/App/Validator/Helper/RequestValidator.php create mode 100644 src/App/Validator/SmsValidator.php create mode 100644 src/App/Validator/Validator.php diff --git a/src/App/Application.php b/src/App/Application.php index 19f365f..b8ccd90 100644 --- a/src/App/Application.php +++ b/src/App/Application.php @@ -4,6 +4,9 @@ namespace App; use Silex\Application as SilexApplication; use Silex\Provider\SecurityServiceProvider; +use Symfony\Component\HttpFoundation\Request; +use Symfony\Component\HttpFoundation\JsonResponse; +use App\Validator\SmsValidator; /** * class Application. @@ -33,6 +36,16 @@ class Application extends SilexApplication ], ], ]); + + $this['validator.sms'] = new SmsValidator(); + + $this->error(function (\Exception $e, Request $request, $code) { + return $this->json([ + 'status' => false, + 'code' => $code, + 'message' => $e->getMessage(), + ]); + }); } /* diff --git a/src/App/Validator/Helper/RequestValidator.php b/src/App/Validator/Helper/RequestValidator.php new file mode 100644 index 0000000..c8f0781 --- /dev/null +++ b/src/App/Validator/Helper/RequestValidator.php @@ -0,0 +1,25 @@ + + */ +trait RequestValidator +{ + /** + * Validates a Request + * + * @param Request $request + * + * @return bool + */ + public function validateRequest(Request $request) + { + return $this->validate(json_decode($request->getContent(), true)); + } +} diff --git a/src/App/Validator/SmsValidator.php b/src/App/Validator/SmsValidator.php new file mode 100644 index 0000000..c1a9b64 --- /dev/null +++ b/src/App/Validator/SmsValidator.php @@ -0,0 +1,25 @@ + + */ +class SmsValidator implements Validator +{ + use Helper\RequestValidator; + + /** + * {@inheritdoc} + */ + public function validate($data) + { + if (!is_array($data)) { + return false; + } + + return isset($data['sender'], $data['message'], $data['time']); + } +} diff --git a/src/App/Validator/Validator.php b/src/App/Validator/Validator.php new file mode 100644 index 0000000..28fa205 --- /dev/null +++ b/src/App/Validator/Validator.php @@ -0,0 +1,20 @@ + + */ +interface Validator +{ + /* + * Validates data. + * + * @param mixed $data + * + * @return bool + */ + public function validate($data); +} diff --git a/web/index.php b/web/index.php index 49e51db..5c67da0 100644 --- a/web/index.php +++ b/web/index.php @@ -1,15 +1,34 @@ setRootDir(__DIR__.'/../')->configure(); -$app->get('/api/sms', function () use ($app) { - return new JsonResponse(['status' => 'ok']); -}); +$app + // ->post('/api/sms/create', function (Request $request) use ($app) { + ->get('/api/sms/create', function (Request $request) use ($app) { + if (!$app['validator.sms']->validateRequest($request)) { + return $app->abort(422, 'Invalid request.'); + } + }) + ->bind('api_sms_create'); + +$app + ->delete('/api/sms/delete/{id}', function (Request $request, $id) use ($app) { + }) + ->bind('api_sms_delete') + ->assert('id', '\d+') + ->convert('id', function ($value) { + return (int) $value; + }); + +$app + ->get('/api/sms/list', function (Request $request) use ($app) { + }) + ->bind('api_sms_list'); $app->run(); From ceafee41ec2088160da887ea6cfa58e110b652ac Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Mon, 15 Jan 2018 13:24:54 +0100 Subject: [PATCH 03/12] Init of propel for SMS database --- .gitignore | 3 +++ bin/propel | 1 + composer.json | 7 +++++-- propel-dist.yaml | 32 +++++++++++++++++++++++++++++ src/App/Resources/propel/schema.xml | 11 ++++++++++ 5 files changed, 52 insertions(+), 2 deletions(-) create mode 120000 bin/propel create mode 100644 propel-dist.yaml create mode 100644 src/App/Resources/propel/schema.xml diff --git a/.gitignore b/.gitignore index 819b16d..66972cb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ +/propel.yaml /etc/security/users.json /vendor +/var +!/var/.gitkeep diff --git a/bin/propel b/bin/propel new file mode 120000 index 0000000..9a8fd6d --- /dev/null +++ b/bin/propel @@ -0,0 +1 @@ +../vendor/propel/propel/bin/propel \ No newline at end of file diff --git a/composer.json b/composer.json index 73a2329..9835bda 100644 --- a/composer.json +++ b/composer.json @@ -1,9 +1,12 @@ { "require": { "silex/silex": "2.*", - "symfony/security": "^3.4" + "symfony/security": "^3.4", + "propel/propel": "~2.0@dev" }, "autoload": { - "psr-4": {"App\\": "src/App"} + "psr-4": { + "App\\": "src/App" + } } } diff --git a/propel-dist.yaml b/propel-dist.yaml new file mode 100644 index 0000000..6722272 --- /dev/null +++ b/propel-dist.yaml @@ -0,0 +1,32 @@ +propel: + database: + connections: + default: + adapter: mysql + classname: Propel\Runtime\Connection\ConnectionWrapper + dsn: "mysql:host=localhost;dbname=androidapi" + user: root + password: root + settings: + charset: utf8 + queries: + utf8: "SET NAMES utf8 COLLATE utf8_unicode_ci, COLLATION_CONNECTION = utf8_unicode_ci, COLLATION_DATABASE = utf8_unicode_ci, COLLATION_SERVER = utf8_unicode_ci" + + paths: + projectDir: src/ + schemaDir: src/ + outputDir: src/ + phpDir: src/ + phpConfDir: etc/propel + sqlDir: var/propel/sql + migrationDir: var/propel/migration + + runtime: + defaultConnection: default + connections: [default] + + generator: + defaultConnection: default + connections: [default] + objectModel: + addClassLevelComment: false diff --git a/src/App/Resources/propel/schema.xml b/src/App/Resources/propel/schema.xml new file mode 100644 index 0000000..e95b4ab --- /dev/null +++ b/src/App/Resources/propel/schema.xml @@ -0,0 +1,11 @@ + + + + + + + + + +
+ From 32f43c74e59baa49e2037d314f7ffc1bb56d0fb1 Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Mon, 15 Jan 2018 13:26:33 +0100 Subject: [PATCH 04/12] Git ignore for propel --- .gitignore | 2 +- var/.gitkeep | 0 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 var/.gitkeep diff --git a/.gitignore b/.gitignore index 66972cb..3b48fc6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ /propel.yaml /etc/security/users.json /vendor -/var +/var/* !/var/.gitkeep diff --git a/var/.gitkeep b/var/.gitkeep new file mode 100644 index 0000000..e69de29 From e36ccbfcf418092e905cce2de2388c1f4556f929 Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Mon, 15 Jan 2018 13:42:48 +0100 Subject: [PATCH 05/12] Git ignore for propel --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 3b48fc6..d6f5932 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ /propel.yaml +/etc/propel/ /etc/security/users.json /vendor /var/* From 9dccf0fffb8a42ac18f5521a5135887fec634905 Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Mon, 15 Jan 2018 16:36:15 +0100 Subject: [PATCH 06/12] SMS API --- .gitignore | 2 + src/App/Application.php | 7 +- src/App/Factory/Factory.php | 23 + src/App/Factory/SmsFactory.php | 82 ++ src/App/Model/Base/Sms.php | 1476 +++++++++++++++++++++++++++ src/App/Model/Base/SmsQuery.php | 609 +++++++++++ src/App/Model/Sms.php | 20 + src/App/Model/SmsQuery.php | 10 + src/App/Resources/propel/schema.xml | 2 +- web/index.php | 45 +- 10 files changed, 2270 insertions(+), 6 deletions(-) create mode 100644 src/App/Factory/Factory.php create mode 100644 src/App/Factory/SmsFactory.php create mode 100644 src/App/Model/Base/Sms.php create mode 100644 src/App/Model/Base/SmsQuery.php create mode 100644 src/App/Model/Sms.php create mode 100644 src/App/Model/SmsQuery.php diff --git a/.gitignore b/.gitignore index d6f5932..568e0c3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,8 @@ /propel.yaml /etc/propel/ /etc/security/users.json +/**/**/Om/ +/**/**/Map/ /vendor /var/* !/var/.gitkeep diff --git a/src/App/Application.php b/src/App/Application.php index b8ccd90..d9e6b02 100644 --- a/src/App/Application.php +++ b/src/App/Application.php @@ -5,8 +5,9 @@ namespace App; use Silex\Application as SilexApplication; use Silex\Provider\SecurityServiceProvider; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\HttpFoundation\JsonResponse; use App\Validator\SmsValidator; +use App\Factory\SmsFactory; +use Propel\Runtime\Propel; /** * class Application. @@ -25,6 +26,7 @@ class Application extends SilexApplication */ public function configure() { + Propel::init($this->getRootDir().'etc/propel/config.php'); $users = json_decode(file_get_contents($this->getRootDir().'/etc/security/users.json'), true); $this->register(new SecurityServiceProvider(), [ @@ -37,7 +39,8 @@ class Application extends SilexApplication ], ]); - $this['validator.sms'] = new SmsValidator(); + $this['sms.validator'] = new SmsValidator(); + $this['sms.factory'] = new SmsFactory(); $this->error(function (\Exception $e, Request $request, $code) { return $this->json([ diff --git a/src/App/Factory/Factory.php b/src/App/Factory/Factory.php new file mode 100644 index 0000000..75d104d --- /dev/null +++ b/src/App/Factory/Factory.php @@ -0,0 +1,23 @@ + + */ +interface Factory +{ + /* + * Validates data. + * + * @param mixed $data + * + * @return bool + */ + public function createByRequest(Request $request); +} diff --git a/src/App/Factory/SmsFactory.php b/src/App/Factory/SmsFactory.php new file mode 100644 index 0000000..7530121 --- /dev/null +++ b/src/App/Factory/SmsFactory.php @@ -0,0 +1,82 @@ + + */ +class SmsFactory implements Factory +{ + /** + * Creates a SMS. + * + * @param mixed $sender + * @param mixed $message + * @param mixed $time + * + * @return bool + */ + public function create($sender, $message, $time) + { + return (new Sms()) + ->setSender($sender) + ->setMessage($message) + ->setTime((int) $time) + ->save() > 0; + } + + /* + * Finds SMS. + * + * @return ObjectCollection + */ + public function getAll() + { + return SmsQuery::create()->find(); + } + + /* + * Get a SMS. + * + * @param int $id + * + * @return Sms|null + */ + public function get($id) + { + return SmsQuery::create() + ->filterById($id) + ->findOne(); + } + + /* + * Removes a SMS. + * + * @return bool + */ + public function remove(Sms $object) + { + return $object->delete(); + } + + /** + * Creates a SMS with a Request content. + * + * @param Request $request + * + * @return bool + */ + public function createByRequest(Request $request) + { + $content = json_decode($request->getContent(), true); + + return $this->create($content['sender'], $content['message'], $content['time']); + } +} diff --git a/src/App/Model/Base/Sms.php b/src/App/Model/Base/Sms.php new file mode 100644 index 0000000..4fc6fc5 --- /dev/null +++ b/src/App/Model/Base/Sms.php @@ -0,0 +1,1476 @@ +modifiedColumns; + } + + /** + * Has specified column been modified? + * + * @param string $col column fully qualified name (TableMap::TYPE_COLNAME), e.g. Book::AUTHOR_ID + * @return boolean True if $col has been modified. + */ + public function isColumnModified($col) + { + return $this->modifiedColumns && isset($this->modifiedColumns[$col]); + } + + /** + * Get the columns that have been modified in this object. + * @return array A unique list of the modified column names for this object. + */ + public function getModifiedColumns() + { + return $this->modifiedColumns ? array_keys($this->modifiedColumns) : []; + } + + /** + * Returns whether the object has ever been saved. This will + * be false, if the object was retrieved from storage or was created + * and then saved. + * + * @return boolean true, if the object has never been persisted. + */ + public function isNew() + { + return $this->new; + } + + /** + * Setter for the isNew attribute. This method will be called + * by Propel-generated children and objects. + * + * @param boolean $b the state of the object. + */ + public function setNew($b) + { + $this->new = (boolean) $b; + } + + /** + * Whether this object has been deleted. + * @return boolean The deleted state of this object. + */ + public function isDeleted() + { + return $this->deleted; + } + + /** + * Specify whether this object has been deleted. + * @param boolean $b The deleted state of this object. + * @return void + */ + public function setDeleted($b) + { + $this->deleted = (boolean) $b; + } + + /** + * Sets the modified state for the object to be false. + * @param string $col If supplied, only the specified column is reset. + * @return void + */ + public function resetModified($col = null) + { + if (null !== $col) { + if (isset($this->modifiedColumns[$col])) { + unset($this->modifiedColumns[$col]); + } + } else { + $this->modifiedColumns = array(); + } + } + + /** + * Compares this with another Sms instance. If + * obj is an instance of Sms, delegates to + * equals(Sms). Otherwise, returns false. + * + * @param mixed $obj The object to compare to. + * @return boolean Whether equal to the object specified. + */ + public function equals($obj) + { + if (!$obj instanceof static) { + return false; + } + + if ($this === $obj) { + return true; + } + + if (null === $this->getPrimaryKey() || null === $obj->getPrimaryKey()) { + return false; + } + + return $this->getPrimaryKey() === $obj->getPrimaryKey(); + } + + /** + * Get the associative array of the virtual columns in this object + * + * @return array + */ + public function getVirtualColumns() + { + return $this->virtualColumns; + } + + /** + * Checks the existence of a virtual column in this object + * + * @param string $name The virtual column name + * @return boolean + */ + public function hasVirtualColumn($name) + { + return array_key_exists($name, $this->virtualColumns); + } + + /** + * Get the value of a virtual column in this object + * + * @param string $name The virtual column name + * @return mixed + * + * @throws PropelException + */ + public function getVirtualColumn($name) + { + if (!$this->hasVirtualColumn($name)) { + throw new PropelException(sprintf('Cannot get value of inexistent virtual column %s.', $name)); + } + + return $this->virtualColumns[$name]; + } + + /** + * Set the value of a virtual column in this object + * + * @param string $name The virtual column name + * @param mixed $value The value to give to the virtual column + * + * @return $this|Sms The current object, for fluid interface + */ + public function setVirtualColumn($name, $value) + { + $this->virtualColumns[$name] = $value; + + return $this; + } + + /** + * Logs a message using Propel::log(). + * + * @param string $msg + * @param int $priority One of the Propel::LOG_* logging levels + * @return boolean + */ + protected function log($msg, $priority = Propel::LOG_INFO) + { + return Propel::log(get_class($this) . ': ' . $msg, $priority); + } + + /** + * Export the current object properties to a string, using a given parser format + * + * $book = BookQuery::create()->findPk(9012); + * echo $book->exportTo('JSON'); + * => {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}'); + * + * + * @param mixed $parser A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV') + * @param boolean $includeLazyLoadColumns (optional) Whether to include lazy load(ed) columns. Defaults to TRUE. + * @return string The exported data + */ + public function exportTo($parser, $includeLazyLoadColumns = true) + { + if (!$parser instanceof AbstractParser) { + $parser = AbstractParser::getParser($parser); + } + + return $parser->fromArray($this->toArray(TableMap::TYPE_PHPNAME, $includeLazyLoadColumns, array(), true)); + } + + /** + * Clean up internal collections prior to serializing + * Avoids recursive loops that turn into segmentation faults when serializing + */ + public function __sleep() + { + $this->clearAllReferences(); + + $cls = new \ReflectionClass($this); + $propertyNames = []; + $serializableProperties = array_diff($cls->getProperties(), $cls->getProperties(\ReflectionProperty::IS_STATIC)); + + foreach($serializableProperties as $property) { + $propertyNames[] = $property->getName(); + } + + return $propertyNames; + } + + /** + * Get the [id] column value. + * + * @return int + */ + public function getId() + { + return $this->id; + } + + /** + * Get the [sender] column value. + * + * @return string + */ + public function getSender() + { + return $this->sender; + } + + /** + * Get the [message] column value. + * + * @return resource + */ + public function getMessage() + { + return $this->message; + } + + /** + * Get the [time] column value. + * + * @return string + */ + public function getTime() + { + return $this->time; + } + + /** + * Get the [optionally formatted] temporal [created_at] column value. + * + * + * @param string $format The date/time format string (either date()-style or strftime()-style). + * If format is NULL, then the raw DateTime object will be returned. + * + * @return string|DateTime Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL, and 0 if column value is 0000-00-00 00:00:00 + * + * @throws PropelException - if unable to parse/validate the date/time value. + */ + public function getCreatedAt($format = NULL) + { + if ($format === null) { + return $this->created_at; + } else { + return $this->created_at instanceof \DateTimeInterface ? $this->created_at->format($format) : null; + } + } + + /** + * Get the [optionally formatted] temporal [updated_at] column value. + * + * + * @param string $format The date/time format string (either date()-style or strftime()-style). + * If format is NULL, then the raw DateTime object will be returned. + * + * @return string|DateTime Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL, and 0 if column value is 0000-00-00 00:00:00 + * + * @throws PropelException - if unable to parse/validate the date/time value. + */ + public function getUpdatedAt($format = NULL) + { + if ($format === null) { + return $this->updated_at; + } else { + return $this->updated_at instanceof \DateTimeInterface ? $this->updated_at->format($format) : null; + } + } + + /** + * Set the value of [id] column. + * + * @param int $v new value + * @return $this|\App\Model\Sms The current object (for fluent API support) + */ + public function setId($v) + { + if ($v !== null) { + $v = (int) $v; + } + + if ($this->id !== $v) { + $this->id = $v; + $this->modifiedColumns[SmsTableMap::COL_ID] = true; + } + + return $this; + } // setId() + + /** + * Set the value of [sender] column. + * + * @param string $v new value + * @return $this|\App\Model\Sms The current object (for fluent API support) + */ + public function setSender($v) + { + if ($v !== null) { + $v = (string) $v; + } + + if ($this->sender !== $v) { + $this->sender = $v; + $this->modifiedColumns[SmsTableMap::COL_SENDER] = true; + } + + return $this; + } // setSender() + + /** + * Set the value of [message] column. + * + * @param resource $v new value + * @return $this|\App\Model\Sms The current object (for fluent API support) + */ + public function setMessage($v) + { + // Because BLOB columns are streams in PDO we have to assume that they are + // always modified when a new value is passed in. For example, the contents + // of the stream itself may have changed externally. + if (!is_resource($v) && $v !== null) { + $this->message = fopen('php://memory', 'r+'); + fwrite($this->message, $v); + rewind($this->message); + } else { // it's already a stream + $this->message = $v; + } + $this->modifiedColumns[SmsTableMap::COL_MESSAGE] = true; + + return $this; + } // setMessage() + + /** + * Set the value of [time] column. + * + * @param string $v new value + * @return $this|\App\Model\Sms The current object (for fluent API support) + */ + public function setTime($v) + { + if ($v !== null) { + $v = (string) $v; + } + + if ($this->time !== $v) { + $this->time = $v; + $this->modifiedColumns[SmsTableMap::COL_TIME] = true; + } + + return $this; + } // setTime() + + /** + * Sets the value of [created_at] column to a normalized version of the date/time value specified. + * + * @param mixed $v string, integer (timestamp), or \DateTimeInterface value. + * Empty strings are treated as NULL. + * @return $this|\App\Model\Sms The current object (for fluent API support) + */ + public function setCreatedAt($v) + { + $dt = PropelDateTime::newInstance($v, null, 'DateTime'); + if ($this->created_at !== null || $dt !== null) { + if ($this->created_at === null || $dt === null || $dt->format("Y-m-d H:i:s.u") !== $this->created_at->format("Y-m-d H:i:s.u")) { + $this->created_at = $dt === null ? null : clone $dt; + $this->modifiedColumns[SmsTableMap::COL_CREATED_AT] = true; + } + } // if either are not null + + return $this; + } // setCreatedAt() + + /** + * Sets the value of [updated_at] column to a normalized version of the date/time value specified. + * + * @param mixed $v string, integer (timestamp), or \DateTimeInterface value. + * Empty strings are treated as NULL. + * @return $this|\App\Model\Sms The current object (for fluent API support) + */ + public function setUpdatedAt($v) + { + $dt = PropelDateTime::newInstance($v, null, 'DateTime'); + if ($this->updated_at !== null || $dt !== null) { + if ($this->updated_at === null || $dt === null || $dt->format("Y-m-d H:i:s.u") !== $this->updated_at->format("Y-m-d H:i:s.u")) { + $this->updated_at = $dt === null ? null : clone $dt; + $this->modifiedColumns[SmsTableMap::COL_UPDATED_AT] = true; + } + } // if either are not null + + return $this; + } // setUpdatedAt() + + /** + * Indicates whether the columns in this object are only set to default values. + * + * This method can be used in conjunction with isModified() to indicate whether an object is both + * modified _and_ has some values set which are non-default. + * + * @return boolean Whether the columns in this object are only been set with default values. + */ + public function hasOnlyDefaultValues() + { + // otherwise, everything was equal, so return TRUE + return true; + } // hasOnlyDefaultValues() + + /** + * Hydrates (populates) the object variables with values from the database resultset. + * + * An offset (0-based "start column") is specified so that objects can be hydrated + * with a subset of the columns in the resultset rows. This is needed, for example, + * for results of JOIN queries where the resultset row includes columns from two or + * more tables. + * + * @param array $row The row returned by DataFetcher->fetch(). + * @param int $startcol 0-based offset column which indicates which restultset column to start with. + * @param boolean $rehydrate Whether this object is being re-hydrated from the database. + * @param string $indexType The index type of $row. Mostly DataFetcher->getIndexType(). + One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_CAMELNAME + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * + * @return int next starting column + * @throws PropelException - Any caught Exception will be rewrapped as a PropelException. + */ + public function hydrate($row, $startcol = 0, $rehydrate = false, $indexType = TableMap::TYPE_NUM) + { + try { + + $col = $row[TableMap::TYPE_NUM == $indexType ? 0 + $startcol : SmsTableMap::translateFieldName('Id', TableMap::TYPE_PHPNAME, $indexType)]; + $this->id = (null !== $col) ? (int) $col : null; + + $col = $row[TableMap::TYPE_NUM == $indexType ? 1 + $startcol : SmsTableMap::translateFieldName('Sender', TableMap::TYPE_PHPNAME, $indexType)]; + $this->sender = (null !== $col) ? (string) $col : null; + + $col = $row[TableMap::TYPE_NUM == $indexType ? 2 + $startcol : SmsTableMap::translateFieldName('Message', TableMap::TYPE_PHPNAME, $indexType)]; + if (null !== $col) { + $this->message = fopen('php://memory', 'r+'); + fwrite($this->message, $col); + rewind($this->message); + } else { + $this->message = null; + } + + $col = $row[TableMap::TYPE_NUM == $indexType ? 3 + $startcol : SmsTableMap::translateFieldName('Time', TableMap::TYPE_PHPNAME, $indexType)]; + $this->time = (null !== $col) ? (string) $col : null; + + $col = $row[TableMap::TYPE_NUM == $indexType ? 4 + $startcol : SmsTableMap::translateFieldName('CreatedAt', TableMap::TYPE_PHPNAME, $indexType)]; + if ($col === '0000-00-00 00:00:00') { + $col = null; + } + $this->created_at = (null !== $col) ? PropelDateTime::newInstance($col, null, 'DateTime') : null; + + $col = $row[TableMap::TYPE_NUM == $indexType ? 5 + $startcol : SmsTableMap::translateFieldName('UpdatedAt', TableMap::TYPE_PHPNAME, $indexType)]; + if ($col === '0000-00-00 00:00:00') { + $col = null; + } + $this->updated_at = (null !== $col) ? PropelDateTime::newInstance($col, null, 'DateTime') : null; + $this->resetModified(); + + $this->setNew(false); + + if ($rehydrate) { + $this->ensureConsistency(); + } + + return $startcol + 6; // 6 = SmsTableMap::NUM_HYDRATE_COLUMNS. + + } catch (Exception $e) { + throw new PropelException(sprintf('Error populating %s object', '\\App\\Model\\Sms'), 0, $e); + } + } + + /** + * Checks and repairs the internal consistency of the object. + * + * This method is executed after an already-instantiated object is re-hydrated + * from the database. It exists to check any foreign keys to make sure that + * the objects related to the current object are correct based on foreign key. + * + * You can override this method in the stub class, but you should always invoke + * the base method from the overridden method (i.e. parent::ensureConsistency()), + * in case your model changes. + * + * @throws PropelException + */ + public function ensureConsistency() + { + } // ensureConsistency + + /** + * Reloads this object from datastore based on primary key and (optionally) resets all associated objects. + * + * This will only work if the object has been saved and has a valid primary key set. + * + * @param boolean $deep (optional) Whether to also de-associated any related objects. + * @param ConnectionInterface $con (optional) The ConnectionInterface connection to use. + * @return void + * @throws PropelException - if this object is deleted, unsaved or doesn't have pk match in db + */ + public function reload($deep = false, ConnectionInterface $con = null) + { + if ($this->isDeleted()) { + throw new PropelException("Cannot reload a deleted object."); + } + + if ($this->isNew()) { + throw new PropelException("Cannot reload an unsaved object."); + } + + if ($con === null) { + $con = Propel::getServiceContainer()->getReadConnection(SmsTableMap::DATABASE_NAME); + } + + // We don't need to alter the object instance pool; we're just modifying this instance + // already in the pool. + + $dataFetcher = ChildSmsQuery::create(null, $this->buildPkeyCriteria())->setFormatter(ModelCriteria::FORMAT_STATEMENT)->find($con); + $row = $dataFetcher->fetch(); + $dataFetcher->close(); + if (!$row) { + throw new PropelException('Cannot find matching row in the database to reload object values.'); + } + $this->hydrate($row, 0, true, $dataFetcher->getIndexType()); // rehydrate + + if ($deep) { // also de-associate any related objects? + + } // if (deep) + } + + /** + * Removes this object from datastore and sets delete attribute. + * + * @param ConnectionInterface $con + * @return void + * @throws PropelException + * @see Sms::setDeleted() + * @see Sms::isDeleted() + */ + public function delete(ConnectionInterface $con = null) + { + if ($this->isDeleted()) { + throw new PropelException("This object has already been deleted."); + } + + if ($con === null) { + $con = Propel::getServiceContainer()->getWriteConnection(SmsTableMap::DATABASE_NAME); + } + + $con->transaction(function () use ($con) { + $deleteQuery = ChildSmsQuery::create() + ->filterByPrimaryKey($this->getPrimaryKey()); + $ret = $this->preDelete($con); + if ($ret) { + $deleteQuery->delete($con); + $this->postDelete($con); + $this->setDeleted(true); + } + }); + } + + /** + * Persists this object to the database. + * + * If the object is new, it inserts it; otherwise an update is performed. + * All modified related objects will also be persisted in the doSave() + * method. This method wraps all precipitate database operations in a + * single transaction. + * + * @param ConnectionInterface $con + * @return int The number of rows affected by this insert/update and any referring fk objects' save() operations. + * @throws PropelException + * @see doSave() + */ + public function save(ConnectionInterface $con = null) + { + if ($this->isDeleted()) { + throw new PropelException("You cannot save an object that has been deleted."); + } + + if ($this->alreadyInSave) { + return 0; + } + + if ($con === null) { + $con = Propel::getServiceContainer()->getWriteConnection(SmsTableMap::DATABASE_NAME); + } + + return $con->transaction(function () use ($con) { + $ret = $this->preSave($con); + $isInsert = $this->isNew(); + if ($isInsert) { + $ret = $ret && $this->preInsert($con); + // timestampable behavior + + if (!$this->isColumnModified(SmsTableMap::COL_CREATED_AT)) { + $this->setCreatedAt(\Propel\Runtime\Util\PropelDateTime::createHighPrecision()); + } + if (!$this->isColumnModified(SmsTableMap::COL_UPDATED_AT)) { + $this->setUpdatedAt(\Propel\Runtime\Util\PropelDateTime::createHighPrecision()); + } + } else { + $ret = $ret && $this->preUpdate($con); + // timestampable behavior + if ($this->isModified() && !$this->isColumnModified(SmsTableMap::COL_UPDATED_AT)) { + $this->setUpdatedAt(\Propel\Runtime\Util\PropelDateTime::createHighPrecision()); + } + } + if ($ret) { + $affectedRows = $this->doSave($con); + if ($isInsert) { + $this->postInsert($con); + } else { + $this->postUpdate($con); + } + $this->postSave($con); + SmsTableMap::addInstanceToPool($this); + } else { + $affectedRows = 0; + } + + return $affectedRows; + }); + } + + /** + * Performs the work of inserting or updating the row in the database. + * + * If the object is new, it inserts it; otherwise an update is performed. + * All related objects are also updated in this method. + * + * @param ConnectionInterface $con + * @return int The number of rows affected by this insert/update and any referring fk objects' save() operations. + * @throws PropelException + * @see save() + */ + protected function doSave(ConnectionInterface $con) + { + $affectedRows = 0; // initialize var to track total num of affected rows + if (!$this->alreadyInSave) { + $this->alreadyInSave = true; + + if ($this->isNew() || $this->isModified()) { + // persist changes + if ($this->isNew()) { + $this->doInsert($con); + $affectedRows += 1; + } else { + $affectedRows += $this->doUpdate($con); + } + // Rewind the message LOB column, since PDO does not rewind after inserting value. + if ($this->message !== null && is_resource($this->message)) { + rewind($this->message); + } + + $this->resetModified(); + } + + $this->alreadyInSave = false; + + } + + return $affectedRows; + } // doSave() + + /** + * Insert the row in the database. + * + * @param ConnectionInterface $con + * + * @throws PropelException + * @see doSave() + */ + protected function doInsert(ConnectionInterface $con) + { + $modifiedColumns = array(); + $index = 0; + + $this->modifiedColumns[SmsTableMap::COL_ID] = true; + if (null !== $this->id) { + throw new PropelException('Cannot insert a value for auto-increment primary key (' . SmsTableMap::COL_ID . ')'); + } + + // check the columns in natural order for more readable SQL queries + if ($this->isColumnModified(SmsTableMap::COL_ID)) { + $modifiedColumns[':p' . $index++] = 'id'; + } + if ($this->isColumnModified(SmsTableMap::COL_SENDER)) { + $modifiedColumns[':p' . $index++] = 'sender'; + } + if ($this->isColumnModified(SmsTableMap::COL_MESSAGE)) { + $modifiedColumns[':p' . $index++] = 'message'; + } + if ($this->isColumnModified(SmsTableMap::COL_TIME)) { + $modifiedColumns[':p' . $index++] = 'time'; + } + if ($this->isColumnModified(SmsTableMap::COL_CREATED_AT)) { + $modifiedColumns[':p' . $index++] = 'created_at'; + } + if ($this->isColumnModified(SmsTableMap::COL_UPDATED_AT)) { + $modifiedColumns[':p' . $index++] = 'updated_at'; + } + + $sql = sprintf( + 'INSERT INTO sms (%s) VALUES (%s)', + implode(', ', $modifiedColumns), + implode(', ', array_keys($modifiedColumns)) + ); + + try { + $stmt = $con->prepare($sql); + foreach ($modifiedColumns as $identifier => $columnName) { + switch ($columnName) { + case 'id': + $stmt->bindValue($identifier, $this->id, PDO::PARAM_INT); + break; + case 'sender': + $stmt->bindValue($identifier, $this->sender, PDO::PARAM_STR); + break; + case 'message': + if (is_resource($this->message)) { + rewind($this->message); + } + $stmt->bindValue($identifier, $this->message, PDO::PARAM_LOB); + break; + case 'time': + $stmt->bindValue($identifier, $this->time, PDO::PARAM_INT); + break; + case 'created_at': + $stmt->bindValue($identifier, $this->created_at ? $this->created_at->format("Y-m-d H:i:s.u") : null, PDO::PARAM_STR); + break; + case 'updated_at': + $stmt->bindValue($identifier, $this->updated_at ? $this->updated_at->format("Y-m-d H:i:s.u") : null, PDO::PARAM_STR); + break; + } + } + $stmt->execute(); + } catch (Exception $e) { + Propel::log($e->getMessage(), Propel::LOG_ERR); + throw new PropelException(sprintf('Unable to execute INSERT statement [%s]', $sql), 0, $e); + } + + try { + $pk = $con->lastInsertId(); + } catch (Exception $e) { + throw new PropelException('Unable to get autoincrement id.', 0, $e); + } + $this->setId($pk); + + $this->setNew(false); + } + + /** + * Update the row in the database. + * + * @param ConnectionInterface $con + * + * @return Integer Number of updated rows + * @see doSave() + */ + protected function doUpdate(ConnectionInterface $con) + { + $selectCriteria = $this->buildPkeyCriteria(); + $valuesCriteria = $this->buildCriteria(); + + return $selectCriteria->doUpdate($valuesCriteria, $con); + } + + /** + * Retrieves a field from the object by name passed in as a string. + * + * @param string $name name + * @param string $type The type of fieldname the $name is of: + * one of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_CAMELNAME + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * Defaults to TableMap::TYPE_PHPNAME. + * @return mixed Value of field. + */ + public function getByName($name, $type = TableMap::TYPE_PHPNAME) + { + $pos = SmsTableMap::translateFieldName($name, $type, TableMap::TYPE_NUM); + $field = $this->getByPosition($pos); + + return $field; + } + + /** + * Retrieves a field from the object by Position as specified in the xml schema. + * Zero-based. + * + * @param int $pos position in xml schema + * @return mixed Value of field at $pos + */ + public function getByPosition($pos) + { + switch ($pos) { + case 0: + return $this->getId(); + break; + case 1: + return $this->getSender(); + break; + case 2: + return $this->getMessage(); + break; + case 3: + return $this->getTime(); + break; + case 4: + return $this->getCreatedAt(); + break; + case 5: + return $this->getUpdatedAt(); + break; + default: + return null; + break; + } // switch() + } + + /** + * Exports the object as an array. + * + * You can specify the key type of the array by passing one of the class + * type constants. + * + * @param string $keyType (optional) One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_CAMELNAME, + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * Defaults to TableMap::TYPE_PHPNAME. + * @param boolean $includeLazyLoadColumns (optional) Whether to include lazy loaded columns. Defaults to TRUE. + * @param array $alreadyDumpedObjects List of objects to skip to avoid recursion + * + * @return array an associative array containing the field names (as keys) and field values + */ + public function toArray($keyType = TableMap::TYPE_PHPNAME, $includeLazyLoadColumns = true, $alreadyDumpedObjects = array()) + { + + if (isset($alreadyDumpedObjects['Sms'][$this->hashCode()])) { + return '*RECURSION*'; + } + $alreadyDumpedObjects['Sms'][$this->hashCode()] = true; + $keys = SmsTableMap::getFieldNames($keyType); + $result = array( + $keys[0] => $this->getId(), + $keys[1] => $this->getSender(), + $keys[2] => $this->getMessage(), + $keys[3] => $this->getTime(), + $keys[4] => $this->getCreatedAt(), + $keys[5] => $this->getUpdatedAt(), + ); + if ($result[$keys[4]] instanceof \DateTimeInterface) { + $result[$keys[4]] = $result[$keys[4]]->format('c'); + } + + if ($result[$keys[5]] instanceof \DateTimeInterface) { + $result[$keys[5]] = $result[$keys[5]]->format('c'); + } + + $virtualColumns = $this->virtualColumns; + foreach ($virtualColumns as $key => $virtualColumn) { + $result[$key] = $virtualColumn; + } + + + return $result; + } + + /** + * Sets a field from the object by name passed in as a string. + * + * @param string $name + * @param mixed $value field value + * @param string $type The type of fieldname the $name is of: + * one of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_CAMELNAME + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * Defaults to TableMap::TYPE_PHPNAME. + * @return $this|\App\Model\Sms + */ + public function setByName($name, $value, $type = TableMap::TYPE_PHPNAME) + { + $pos = SmsTableMap::translateFieldName($name, $type, TableMap::TYPE_NUM); + + return $this->setByPosition($pos, $value); + } + + /** + * Sets a field from the object by Position as specified in the xml schema. + * Zero-based. + * + * @param int $pos position in xml schema + * @param mixed $value field value + * @return $this|\App\Model\Sms + */ + public function setByPosition($pos, $value) + { + switch ($pos) { + case 0: + $this->setId($value); + break; + case 1: + $this->setSender($value); + break; + case 2: + $this->setMessage($value); + break; + case 3: + $this->setTime($value); + break; + case 4: + $this->setCreatedAt($value); + break; + case 5: + $this->setUpdatedAt($value); + break; + } // switch() + + return $this; + } + + /** + * Populates the object using an array. + * + * This is particularly useful when populating an object from one of the + * request arrays (e.g. $_POST). This method goes through the column + * names, checking to see whether a matching key exists in populated + * array. If so the setByName() method is called for that column. + * + * You can specify the key type of the array by additionally passing one + * of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_CAMELNAME, + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * The default key type is the column's TableMap::TYPE_PHPNAME. + * + * @param array $arr An array to populate the object from. + * @param string $keyType The type of keys the array uses. + * @return void + */ + public function fromArray($arr, $keyType = TableMap::TYPE_PHPNAME) + { + $keys = SmsTableMap::getFieldNames($keyType); + + if (array_key_exists($keys[0], $arr)) { + $this->setId($arr[$keys[0]]); + } + if (array_key_exists($keys[1], $arr)) { + $this->setSender($arr[$keys[1]]); + } + if (array_key_exists($keys[2], $arr)) { + $this->setMessage($arr[$keys[2]]); + } + if (array_key_exists($keys[3], $arr)) { + $this->setTime($arr[$keys[3]]); + } + if (array_key_exists($keys[4], $arr)) { + $this->setCreatedAt($arr[$keys[4]]); + } + if (array_key_exists($keys[5], $arr)) { + $this->setUpdatedAt($arr[$keys[5]]); + } + } + + /** + * Populate the current object from a string, using a given parser format + * + * $book = new Book(); + * $book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}'); + * + * + * You can specify the key type of the array by additionally passing one + * of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_CAMELNAME, + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * The default key type is the column's TableMap::TYPE_PHPNAME. + * + * @param mixed $parser A AbstractParser instance, + * or a format name ('XML', 'YAML', 'JSON', 'CSV') + * @param string $data The source data to import from + * @param string $keyType The type of keys the array uses. + * + * @return $this|\App\Model\Sms The current object, for fluid interface + */ + public function importFrom($parser, $data, $keyType = TableMap::TYPE_PHPNAME) + { + if (!$parser instanceof AbstractParser) { + $parser = AbstractParser::getParser($parser); + } + + $this->fromArray($parser->toArray($data), $keyType); + + return $this; + } + + /** + * Build a Criteria object containing the values of all modified columns in this object. + * + * @return Criteria The Criteria object containing all modified values. + */ + public function buildCriteria() + { + $criteria = new Criteria(SmsTableMap::DATABASE_NAME); + + if ($this->isColumnModified(SmsTableMap::COL_ID)) { + $criteria->add(SmsTableMap::COL_ID, $this->id); + } + if ($this->isColumnModified(SmsTableMap::COL_SENDER)) { + $criteria->add(SmsTableMap::COL_SENDER, $this->sender); + } + if ($this->isColumnModified(SmsTableMap::COL_MESSAGE)) { + $criteria->add(SmsTableMap::COL_MESSAGE, $this->message); + } + if ($this->isColumnModified(SmsTableMap::COL_TIME)) { + $criteria->add(SmsTableMap::COL_TIME, $this->time); + } + if ($this->isColumnModified(SmsTableMap::COL_CREATED_AT)) { + $criteria->add(SmsTableMap::COL_CREATED_AT, $this->created_at); + } + if ($this->isColumnModified(SmsTableMap::COL_UPDATED_AT)) { + $criteria->add(SmsTableMap::COL_UPDATED_AT, $this->updated_at); + } + + return $criteria; + } + + /** + * Builds a Criteria object containing the primary key for this object. + * + * Unlike buildCriteria() this method includes the primary key values regardless + * of whether or not they have been modified. + * + * @throws LogicException if no primary key is defined + * + * @return Criteria The Criteria object containing value(s) for primary key(s). + */ + public function buildPkeyCriteria() + { + $criteria = ChildSmsQuery::create(); + $criteria->add(SmsTableMap::COL_ID, $this->id); + + return $criteria; + } + + /** + * If the primary key is not null, return the hashcode of the + * primary key. Otherwise, return the hash code of the object. + * + * @return int Hashcode + */ + public function hashCode() + { + $validPk = null !== $this->getId(); + + $validPrimaryKeyFKs = 0; + $primaryKeyFKs = []; + + if ($validPk) { + return crc32(json_encode($this->getPrimaryKey(), JSON_UNESCAPED_UNICODE)); + } elseif ($validPrimaryKeyFKs) { + return crc32(json_encode($primaryKeyFKs, JSON_UNESCAPED_UNICODE)); + } + + return spl_object_hash($this); + } + + /** + * Returns the primary key for this object (row). + * @return int + */ + public function getPrimaryKey() + { + return $this->getId(); + } + + /** + * Generic method to set the primary key (id column). + * + * @param int $key Primary key. + * @return void + */ + public function setPrimaryKey($key) + { + $this->setId($key); + } + + /** + * Returns true if the primary key for this object is null. + * @return boolean + */ + public function isPrimaryKeyNull() + { + return null === $this->getId(); + } + + /** + * Sets contents of passed object to values from current object. + * + * If desired, this method can also make copies of all associated (fkey referrers) + * objects. + * + * @param object $copyObj An object of \App\Model\Sms (or compatible) type. + * @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row. + * @param boolean $makeNew Whether to reset autoincrement PKs and make the object new. + * @throws PropelException + */ + public function copyInto($copyObj, $deepCopy = false, $makeNew = true) + { + $copyObj->setSender($this->getSender()); + $copyObj->setMessage($this->getMessage()); + $copyObj->setTime($this->getTime()); + $copyObj->setCreatedAt($this->getCreatedAt()); + $copyObj->setUpdatedAt($this->getUpdatedAt()); + if ($makeNew) { + $copyObj->setNew(true); + $copyObj->setId(NULL); // this is a auto-increment column, so set to default value + } + } + + /** + * Makes a copy of this object that will be inserted as a new row in table when saved. + * It creates a new object filling in the simple attributes, but skipping any primary + * keys that are defined for the table. + * + * If desired, this method can also make copies of all associated (fkey referrers) + * objects. + * + * @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row. + * @return \App\Model\Sms Clone of current object. + * @throws PropelException + */ + public function copy($deepCopy = false) + { + // we use get_class(), because this might be a subclass + $clazz = get_class($this); + $copyObj = new $clazz(); + $this->copyInto($copyObj, $deepCopy); + + return $copyObj; + } + + /** + * Clears the current object, sets all attributes to their default values and removes + * outgoing references as well as back-references (from other objects to this one. Results probably in a database + * change of those foreign objects when you call `save` there). + */ + public function clear() + { + $this->id = null; + $this->sender = null; + $this->message = null; + $this->time = null; + $this->created_at = null; + $this->updated_at = null; + $this->alreadyInSave = false; + $this->clearAllReferences(); + $this->resetModified(); + $this->setNew(true); + $this->setDeleted(false); + } + + /** + * Resets all references and back-references to other model objects or collections of model objects. + * + * This method is used to reset all php object references (not the actual reference in the database). + * Necessary for object serialisation. + * + * @param boolean $deep Whether to also clear the references on all referrer objects. + */ + public function clearAllReferences($deep = false) + { + if ($deep) { + } // if ($deep) + + } + + /** + * Return the string representation of this object + * + * @return string + */ + public function __toString() + { + return (string) $this->exportTo(SmsTableMap::DEFAULT_STRING_FORMAT); + } + + // timestampable behavior + + /** + * Mark the current object so that the update date doesn't get updated during next save + * + * @return $this|ChildSms The current object (for fluent API support) + */ + public function keepUpdateDateUnchanged() + { + $this->modifiedColumns[SmsTableMap::COL_UPDATED_AT] = true; + + return $this; + } + + /** + * Code to be run before persisting the object + * @param ConnectionInterface $con + * @return boolean + */ + public function preSave(ConnectionInterface $con = null) + { + if (is_callable('parent::preSave')) { + return parent::preSave($con); + } + return true; + } + + /** + * Code to be run after persisting the object + * @param ConnectionInterface $con + */ + public function postSave(ConnectionInterface $con = null) + { + if (is_callable('parent::postSave')) { + parent::postSave($con); + } + } + + /** + * Code to be run before inserting to database + * @param ConnectionInterface $con + * @return boolean + */ + public function preInsert(ConnectionInterface $con = null) + { + if (is_callable('parent::preInsert')) { + return parent::preInsert($con); + } + return true; + } + + /** + * Code to be run after inserting to database + * @param ConnectionInterface $con + */ + public function postInsert(ConnectionInterface $con = null) + { + if (is_callable('parent::postInsert')) { + parent::postInsert($con); + } + } + + /** + * Code to be run before updating the object in database + * @param ConnectionInterface $con + * @return boolean + */ + public function preUpdate(ConnectionInterface $con = null) + { + if (is_callable('parent::preUpdate')) { + return parent::preUpdate($con); + } + return true; + } + + /** + * Code to be run after updating the object in database + * @param ConnectionInterface $con + */ + public function postUpdate(ConnectionInterface $con = null) + { + if (is_callable('parent::postUpdate')) { + parent::postUpdate($con); + } + } + + /** + * Code to be run before deleting the object in database + * @param ConnectionInterface $con + * @return boolean + */ + public function preDelete(ConnectionInterface $con = null) + { + if (is_callable('parent::preDelete')) { + return parent::preDelete($con); + } + return true; + } + + /** + * Code to be run after deleting the object in database + * @param ConnectionInterface $con + */ + public function postDelete(ConnectionInterface $con = null) + { + if (is_callable('parent::postDelete')) { + parent::postDelete($con); + } + } + + + /** + * Derived method to catches calls to undefined methods. + * + * Provides magic import/export method support (fromXML()/toXML(), fromYAML()/toYAML(), etc.). + * Allows to define default __call() behavior if you overwrite __call() + * + * @param string $name + * @param mixed $params + * + * @return array|string + */ + public function __call($name, $params) + { + if (0 === strpos($name, 'get')) { + $virtualColumn = substr($name, 3); + if ($this->hasVirtualColumn($virtualColumn)) { + return $this->getVirtualColumn($virtualColumn); + } + + $virtualColumn = lcfirst($virtualColumn); + if ($this->hasVirtualColumn($virtualColumn)) { + return $this->getVirtualColumn($virtualColumn); + } + } + + if (0 === strpos($name, 'from')) { + $format = substr($name, 4); + + return $this->importFrom($format, reset($params)); + } + + if (0 === strpos($name, 'to')) { + $format = substr($name, 2); + $includeLazyLoadColumns = isset($params[0]) ? $params[0] : true; + + return $this->exportTo($format, $includeLazyLoadColumns); + } + + throw new BadMethodCallException(sprintf('Call to undefined method: %s.', $name)); + } + +} diff --git a/src/App/Model/Base/SmsQuery.php b/src/App/Model/Base/SmsQuery.php new file mode 100644 index 0000000..1f879f3 --- /dev/null +++ b/src/App/Model/Base/SmsQuery.php @@ -0,0 +1,609 @@ +setModelAlias($modelAlias); + } + if ($criteria instanceof Criteria) { + $query->mergeWith($criteria); + } + + return $query; + } + + /** + * Find object by primary key. + * Propel uses the instance pool to skip the database if the object exists. + * Go fast if the query is untouched. + * + * + * $obj = $c->findPk(12, $con); + * + * + * @param mixed $key Primary key to use for the query + * @param ConnectionInterface $con an optional connection object + * + * @return ChildSms|array|mixed the result, formatted by the current formatter + */ + public function findPk($key, ConnectionInterface $con = null) + { + if ($key === null) { + return null; + } + + if ($con === null) { + $con = Propel::getServiceContainer()->getReadConnection(SmsTableMap::DATABASE_NAME); + } + + $this->basePreSelect($con); + + if ( + $this->formatter || $this->modelAlias || $this->with || $this->select + || $this->selectColumns || $this->asColumns || $this->selectModifiers + || $this->map || $this->having || $this->joins + ) { + return $this->findPkComplex($key, $con); + } + + if ((null !== ($obj = SmsTableMap::getInstanceFromPool(null === $key || is_scalar($key) || is_callable([$key, '__toString']) ? (string) $key : $key)))) { + // the object is already in the instance pool + return $obj; + } + + return $this->findPkSimple($key, $con); + } + + /** + * Find object by primary key using raw SQL to go fast. + * Bypass doSelect() and the object formatter by using generated code. + * + * @param mixed $key Primary key to use for the query + * @param ConnectionInterface $con A connection object + * + * @throws \Propel\Runtime\Exception\PropelException + * + * @return ChildSms A model object, or null if the key is not found + */ + protected function findPkSimple($key, ConnectionInterface $con) + { + $sql = 'SELECT id, sender, message, time, created_at, updated_at FROM sms WHERE id = :p0'; + try { + $stmt = $con->prepare($sql); + $stmt->bindValue(':p0', $key, PDO::PARAM_INT); + $stmt->execute(); + } catch (Exception $e) { + Propel::log($e->getMessage(), Propel::LOG_ERR); + throw new PropelException(sprintf('Unable to execute SELECT statement [%s]', $sql), 0, $e); + } + $obj = null; + if ($row = $stmt->fetch(\PDO::FETCH_NUM)) { + /** @var ChildSms $obj */ + $obj = new ChildSms(); + $obj->hydrate($row); + SmsTableMap::addInstanceToPool($obj, null === $key || is_scalar($key) || is_callable([$key, '__toString']) ? (string) $key : $key); + } + $stmt->closeCursor(); + + return $obj; + } + + /** + * Find object by primary key. + * + * @param mixed $key Primary key to use for the query + * @param ConnectionInterface $con A connection object + * + * @return ChildSms|array|mixed the result, formatted by the current formatter + */ + protected function findPkComplex($key, ConnectionInterface $con) + { + // As the query uses a PK condition, no limit(1) is necessary. + $criteria = $this->isKeepQuery() ? clone $this : $this; + $dataFetcher = $criteria + ->filterByPrimaryKey($key) + ->doSelect($con); + + return $criteria->getFormatter()->init($criteria)->formatOne($dataFetcher); + } + + /** + * Find objects by primary key + * + * $objs = $c->findPks(array(12, 56, 832), $con); + * + * @param array $keys Primary keys to use for the query + * @param ConnectionInterface $con an optional connection object + * + * @return ObjectCollection|array|mixed the list of results, formatted by the current formatter + */ + public function findPks($keys, ConnectionInterface $con = null) + { + if (null === $con) { + $con = Propel::getServiceContainer()->getReadConnection($this->getDbName()); + } + $this->basePreSelect($con); + $criteria = $this->isKeepQuery() ? clone $this : $this; + $dataFetcher = $criteria + ->filterByPrimaryKeys($keys) + ->doSelect($con); + + return $criteria->getFormatter()->init($criteria)->format($dataFetcher); + } + + /** + * Filter the query by primary key + * + * @param mixed $key Primary key to use for the query + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function filterByPrimaryKey($key) + { + + return $this->addUsingAlias(SmsTableMap::COL_ID, $key, Criteria::EQUAL); + } + + /** + * Filter the query by a list of primary keys + * + * @param array $keys The list of primary key to use for the query + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function filterByPrimaryKeys($keys) + { + + return $this->addUsingAlias(SmsTableMap::COL_ID, $keys, Criteria::IN); + } + + /** + * Filter the query on the id column + * + * Example usage: + * + * $query->filterById(1234); // WHERE id = 1234 + * $query->filterById(array(12, 34)); // WHERE id IN (12, 34) + * $query->filterById(array('min' => 12)); // WHERE id > 12 + * + * + * @param mixed $id The value to use as filter. + * Use scalar values for equality. + * Use array values for in_array() equivalent. + * Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function filterById($id = null, $comparison = null) + { + if (is_array($id)) { + $useMinMax = false; + if (isset($id['min'])) { + $this->addUsingAlias(SmsTableMap::COL_ID, $id['min'], Criteria::GREATER_EQUAL); + $useMinMax = true; + } + if (isset($id['max'])) { + $this->addUsingAlias(SmsTableMap::COL_ID, $id['max'], Criteria::LESS_EQUAL); + $useMinMax = true; + } + if ($useMinMax) { + return $this; + } + if (null === $comparison) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(SmsTableMap::COL_ID, $id, $comparison); + } + + /** + * Filter the query on the sender column + * + * Example usage: + * + * $query->filterBySender('fooValue'); // WHERE sender = 'fooValue' + * $query->filterBySender('%fooValue%', Criteria::LIKE); // WHERE sender LIKE '%fooValue%' + * + * + * @param string $sender The value to use as filter. + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function filterBySender($sender = null, $comparison = null) + { + if (null === $comparison) { + if (is_array($sender)) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(SmsTableMap::COL_SENDER, $sender, $comparison); + } + + /** + * Filter the query on the message column + * + * @param mixed $message The value to use as filter + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function filterByMessage($message = null, $comparison = null) + { + + return $this->addUsingAlias(SmsTableMap::COL_MESSAGE, $message, $comparison); + } + + /** + * Filter the query on the time column + * + * Example usage: + * + * $query->filterByTime(1234); // WHERE time = 1234 + * $query->filterByTime(array(12, 34)); // WHERE time IN (12, 34) + * $query->filterByTime(array('min' => 12)); // WHERE time > 12 + * + * + * @param mixed $time The value to use as filter. + * Use scalar values for equality. + * Use array values for in_array() equivalent. + * Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function filterByTime($time = null, $comparison = null) + { + if (is_array($time)) { + $useMinMax = false; + if (isset($time['min'])) { + $this->addUsingAlias(SmsTableMap::COL_TIME, $time['min'], Criteria::GREATER_EQUAL); + $useMinMax = true; + } + if (isset($time['max'])) { + $this->addUsingAlias(SmsTableMap::COL_TIME, $time['max'], Criteria::LESS_EQUAL); + $useMinMax = true; + } + if ($useMinMax) { + return $this; + } + if (null === $comparison) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(SmsTableMap::COL_TIME, $time, $comparison); + } + + /** + * Filter the query on the created_at column + * + * Example usage: + * + * $query->filterByCreatedAt('2011-03-14'); // WHERE created_at = '2011-03-14' + * $query->filterByCreatedAt('now'); // WHERE created_at = '2011-03-14' + * $query->filterByCreatedAt(array('max' => 'yesterday')); // WHERE created_at > '2011-03-13' + * + * + * @param mixed $createdAt The value to use as filter. + * Values can be integers (unix timestamps), DateTime objects, or strings. + * Empty strings are treated as NULL. + * Use scalar values for equality. + * Use array values for in_array() equivalent. + * Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function filterByCreatedAt($createdAt = null, $comparison = null) + { + if (is_array($createdAt)) { + $useMinMax = false; + if (isset($createdAt['min'])) { + $this->addUsingAlias(SmsTableMap::COL_CREATED_AT, $createdAt['min'], Criteria::GREATER_EQUAL); + $useMinMax = true; + } + if (isset($createdAt['max'])) { + $this->addUsingAlias(SmsTableMap::COL_CREATED_AT, $createdAt['max'], Criteria::LESS_EQUAL); + $useMinMax = true; + } + if ($useMinMax) { + return $this; + } + if (null === $comparison) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(SmsTableMap::COL_CREATED_AT, $createdAt, $comparison); + } + + /** + * Filter the query on the updated_at column + * + * Example usage: + * + * $query->filterByUpdatedAt('2011-03-14'); // WHERE updated_at = '2011-03-14' + * $query->filterByUpdatedAt('now'); // WHERE updated_at = '2011-03-14' + * $query->filterByUpdatedAt(array('max' => 'yesterday')); // WHERE updated_at > '2011-03-13' + * + * + * @param mixed $updatedAt The value to use as filter. + * Values can be integers (unix timestamps), DateTime objects, or strings. + * Empty strings are treated as NULL. + * Use scalar values for equality. + * Use array values for in_array() equivalent. + * Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function filterByUpdatedAt($updatedAt = null, $comparison = null) + { + if (is_array($updatedAt)) { + $useMinMax = false; + if (isset($updatedAt['min'])) { + $this->addUsingAlias(SmsTableMap::COL_UPDATED_AT, $updatedAt['min'], Criteria::GREATER_EQUAL); + $useMinMax = true; + } + if (isset($updatedAt['max'])) { + $this->addUsingAlias(SmsTableMap::COL_UPDATED_AT, $updatedAt['max'], Criteria::LESS_EQUAL); + $useMinMax = true; + } + if ($useMinMax) { + return $this; + } + if (null === $comparison) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(SmsTableMap::COL_UPDATED_AT, $updatedAt, $comparison); + } + + /** + * Exclude object from result + * + * @param ChildSms $sms Object to remove from the list of results + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function prune($sms = null) + { + if ($sms) { + $this->addUsingAlias(SmsTableMap::COL_ID, $sms->getId(), Criteria::NOT_EQUAL); + } + + return $this; + } + + /** + * Deletes all rows from the sms table. + * + * @param ConnectionInterface $con the connection to use + * @return int The number of affected rows (if supported by underlying database driver). + */ + public function doDeleteAll(ConnectionInterface $con = null) + { + if (null === $con) { + $con = Propel::getServiceContainer()->getWriteConnection(SmsTableMap::DATABASE_NAME); + } + + // use transaction because $criteria could contain info + // for more than one table or we could emulating ON DELETE CASCADE, etc. + return $con->transaction(function () use ($con) { + $affectedRows = 0; // initialize var to track total num of affected rows + $affectedRows += parent::doDeleteAll($con); + // Because this db requires some delete cascade/set null emulation, we have to + // clear the cached instance *after* the emulation has happened (since + // instances get re-added by the select statement contained therein). + SmsTableMap::clearInstancePool(); + SmsTableMap::clearRelatedInstancePool(); + + return $affectedRows; + }); + } + + /** + * Performs a DELETE on the database based on the current ModelCriteria + * + * @param ConnectionInterface $con the connection to use + * @return int The number of affected rows (if supported by underlying database driver). This includes CASCADE-related rows + * if supported by native driver or if emulated using Propel. + * @throws PropelException Any exceptions caught during processing will be + * rethrown wrapped into a PropelException. + */ + public function delete(ConnectionInterface $con = null) + { + if (null === $con) { + $con = Propel::getServiceContainer()->getWriteConnection(SmsTableMap::DATABASE_NAME); + } + + $criteria = $this; + + // Set the correct dbName + $criteria->setDbName(SmsTableMap::DATABASE_NAME); + + // use transaction because $criteria could contain info + // for more than one table or we could emulating ON DELETE CASCADE, etc. + return $con->transaction(function () use ($con, $criteria) { + $affectedRows = 0; // initialize var to track total num of affected rows + + SmsTableMap::removeInstanceFromPool($criteria); + + $affectedRows += ModelCriteria::delete($con); + SmsTableMap::clearRelatedInstancePool(); + + return $affectedRows; + }); + } + + // timestampable behavior + + /** + * Filter by the latest updated + * + * @param int $nbDays Maximum age of the latest update in days + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function recentlyUpdated($nbDays = 7) + { + return $this->addUsingAlias(SmsTableMap::COL_UPDATED_AT, time() - $nbDays * 24 * 60 * 60, Criteria::GREATER_EQUAL); + } + + /** + * Order by update date desc + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function lastUpdatedFirst() + { + return $this->addDescendingOrderByColumn(SmsTableMap::COL_UPDATED_AT); + } + + /** + * Order by update date asc + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function firstUpdatedFirst() + { + return $this->addAscendingOrderByColumn(SmsTableMap::COL_UPDATED_AT); + } + + /** + * Order by create date desc + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function lastCreatedFirst() + { + return $this->addDescendingOrderByColumn(SmsTableMap::COL_CREATED_AT); + } + + /** + * Filter by the latest created + * + * @param int $nbDays Maximum age of in days + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function recentlyCreated($nbDays = 7) + { + return $this->addUsingAlias(SmsTableMap::COL_CREATED_AT, time() - $nbDays * 24 * 60 * 60, Criteria::GREATER_EQUAL); + } + + /** + * Order by create date asc + * + * @return $this|ChildSmsQuery The current query, for fluid interface + */ + public function firstCreatedFirst() + { + return $this->addAscendingOrderByColumn(SmsTableMap::COL_CREATED_AT); + } + +} // SmsQuery diff --git a/src/App/Model/Sms.php b/src/App/Model/Sms.php new file mode 100644 index 0000000..d8d125e --- /dev/null +++ b/src/App/Model/Sms.php @@ -0,0 +1,20 @@ + - + diff --git a/web/index.php b/web/index.php index 5c67da0..fc13b1a 100644 --- a/web/index.php +++ b/web/index.php @@ -9,16 +9,41 @@ $app = new Application(); $app->setRootDir(__DIR__.'/../')->configure(); $app - // ->post('/api/sms/create', function (Request $request) use ($app) { - ->get('/api/sms/create', function (Request $request) use ($app) { - if (!$app['validator.sms']->validateRequest($request)) { + ->post('/api/sms/create', function (Request $request) use ($app) { + if (!$app['sms.validator']->validateRequest($request)) { return $app->abort(422, 'Invalid request.'); } + + $persisted = $app['sms.factory']->createByRequest($request); + + if (!$persisted) { + return $app->abort(500, 'An error occured.'); + } else { + return $app->json([ + 'status' => true, + 'code' => 201, + ], 201); + } }) ->bind('api_sms_create'); $app ->delete('/api/sms/delete/{id}', function (Request $request, $id) use ($app) { + $object = $app['sms.factory']->get($id); + + if (!$object) { + return $app->json([ + 'status' => false, + 'code' => 404, + ], 404); + } + + $app['sms.factory']->remove($object); + + return $app->json([ + 'status' => true, + 'code' => 204, + ], 204); }) ->bind('api_sms_delete') ->assert('id', '\d+') @@ -28,6 +53,20 @@ $app $app ->get('/api/sms/list', function (Request $request) use ($app) { + $objects = $app['sms.factory']->getAll()->getData(); + $data = []; + + foreach ($objects as $object) { + $data[] = [ + 'id' => $object->getId(), + 'sender' => $object->getSender(), + 'message' => $object->getMessage(), + 'received_at' => $object->getTime(), + 'notified_at' => $object->getCreatedAt()->getTimestamp(), + ]; + } + + return $app->json($data); }) ->bind('api_sms_list'); From 1faaff727a236521c8db26833f1e30f56d0edfcd Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Mon, 15 Jan 2018 16:37:01 +0100 Subject: [PATCH 07/12] Makefile tasks --- Makefile | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..0aa3576 --- /dev/null +++ b/Makefile @@ -0,0 +1,37 @@ +COMPOSER ?= composer +GIT ?= git +MKDIR ?= mkdir +PHP ?= php + +all: composer + +composer: + @echo "Installing application's dependencies" + @echo "-------------------------------------" + @echo + + $(COMPOSER) install $(COMPOSER_INSTALL_FLAGS) + +optimize: + @echo "Optimizing Composer's autoloader, can take some time" + @echo "----------------------------------------------------" + @echo + + $(COMPOSER) dump-autoload --optimize + +run: + @echo "Run development server" + @echo "----------------------" + @echo + + $(PHP) -S 0.0.0.0:8080 -t web + +propel: + @echo "Propel migration" + @echo "----------------" + @echo + + ./vendor/propel/propel/bin/propel config:convert + ./vendor/propel/propel/bin/propel model:build --recursive + ./vendor/propel/propel/bin/propel migration:diff --recursive + ./vendor/propel/propel/bin/propel migration:migrate --recursive From 2dc98efbd0c76714f557c024777ad3f8efd44a9b Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Mon, 15 Jan 2018 17:00:06 +0100 Subject: [PATCH 08/12] Api response messages --- web/index.php | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/web/index.php b/web/index.php index fc13b1a..54b35ab 100644 --- a/web/index.php +++ b/web/index.php @@ -22,6 +22,7 @@ $app return $app->json([ 'status' => true, 'code' => 201, + 'message' => 'Resource created.', ], 201); } }) @@ -35,6 +36,7 @@ $app return $app->json([ 'status' => false, 'code' => 404, + 'message' => 'Resource not found.', ], 404); } @@ -43,6 +45,7 @@ $app return $app->json([ 'status' => true, 'code' => 204, + 'message' => 'Resource removed.', ], 204); }) ->bind('api_sms_delete') @@ -61,7 +64,7 @@ $app 'id' => $object->getId(), 'sender' => $object->getSender(), 'message' => $object->getMessage(), - 'received_at' => $object->getTime(), + 'received_at' => (int) $object->getTime(), 'notified_at' => $object->getCreatedAt()->getTimestamp(), ]; } From e30831da4115c22ec9702c2a35763c2d6077cc54 Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Mon, 15 Jan 2018 17:00:15 +0100 Subject: [PATCH 09/12] Documentation of the API --- README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..92c83fb --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +Automate Android API +==================== + +## Installation + +``` +$ git clone https://gitnet.fr/deblan/android-automate-api.git +$ cd android-automate-api +$ make +$ cp propel-dist.yaml propel.yaml # Edit propel.yaml +$ make propel +``` + +## API + +### HTTP Response status + +* `200`: Resource found +* `201`: Resource created +* `204`: Resource removed +* `404`: Resource not found +* `500`: Internal error + +When a resource is created or deleted, the response will be like: + +``` +{ + "status": true|false, + "code": 200|201|204|404|500, + "message": "A message" +} +``` + + +#### Create a SMS + +`POST /api/sms/create` with MIME media type `application/json` + +*Body* +``` +{"sender": "+33611223344", "message": "Hello, World!", "time": "1516031177"} +``` + +#### Delete a SMS + +`DELETE /api/sms/delete/{id}` + +#### Get all SMS + +`GET /api/sms/list` + +The response contains an collection of SMS: + +``` +[ + { + "id": 1234, + "sender": "+33611223344", + "message": "Hello, World!", + "received_at": 1516031177, + "notified_at": 1516031179 + }, + ... +] +``` From a7c56f3c616b24c4f9eca11df528baf1e9a35c4e Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Tue, 16 Jan 2018 09:14:43 +0100 Subject: [PATCH 10/12] Moving routes and functions to controller --- src/App/Application.php | 15 +++- src/App/Controller/Controller.php | 51 +++++++++++ src/App/Controller/SmsController.php | 125 +++++++++++++++++++++++++++ web/index.php | 71 ++------------- 4 files changed, 194 insertions(+), 68 deletions(-) create mode 100644 src/App/Controller/Controller.php create mode 100644 src/App/Controller/SmsController.php diff --git a/src/App/Application.php b/src/App/Application.php index d9e6b02..8d96b7a 100644 --- a/src/App/Application.php +++ b/src/App/Application.php @@ -8,6 +8,7 @@ use Symfony\Component\HttpFoundation\Request; use App\Validator\SmsValidator; use App\Factory\SmsFactory; use Propel\Runtime\Propel; +use App\Controller\Controller; /** * class Application. @@ -22,9 +23,9 @@ class Application extends SilexApplication protected $rootDir; /* - * Configures the application. + * Init the application. */ - public function configure() + public function init() { Propel::init($this->getRootDir().'etc/propel/config.php'); $users = json_decode(file_get_contents($this->getRootDir().'/etc/security/users.json'), true); @@ -49,6 +50,8 @@ class Application extends SilexApplication 'message' => $e->getMessage(), ]); }); + + return $this; } /* @@ -74,4 +77,12 @@ class Application extends SilexApplication { return $this->rootDir; } + + public function addController(Controller $controller) + { + $controller->setApp($this); + $controller->registerRoutes(); + + return $this; + } } diff --git a/src/App/Controller/Controller.php b/src/App/Controller/Controller.php new file mode 100644 index 0000000..ee74e4e --- /dev/null +++ b/src/App/Controller/Controller.php @@ -0,0 +1,51 @@ + + */ +abstract class Controller +{ + /** + * @var Application + */ + protected $app; + + /* + * Set the value of "app". + * + * @param Application $app + * + * @return Controller + */ + public function setApp($app) + { + $this->app = $app; + + return $this; + } + + /* + * Get the value of "app". + * + * @return Application + */ + public function getApp() + { + return $this->app; + } + + /** + * Registers routes. + * + * @param Application $app + * + * @return void + */ + abstract public function registerRoutes(); +} diff --git a/src/App/Controller/SmsController.php b/src/App/Controller/SmsController.php new file mode 100644 index 0000000..5db8b76 --- /dev/null +++ b/src/App/Controller/SmsController.php @@ -0,0 +1,125 @@ + + */ +class SmsController extends Controller +{ + /** + * {@inheritdoc} + */ + public function registerRoutes() + { + $this->app + ->post('/api/sms/create', [$this, 'create']) + ->bind('api_sms_create'); + + $this->app + ->delete('/api/sms/delete/{id}', [$this, 'delete']) + ->bind('api_sms_delete') + ->assert('id', '\d+') + ->convert('id', function ($value) { + return (int) $value; + }); + + $this->app + ->get('/api/sms/list', [$this, 'list']) + ->bind('api_sms_list'); + } + + /** + * Create action. + * + * @param Request $request + * + * @throws \Symfony\Component\HttpKernel\Exception\HttpException + * + * @return \Symfony\Component\HttpFoundation\JsonResponse + */ + public function create(Request $request) + { + $app = $this->app; + + if (!$app['sms.validator']->validateRequest($request)) { + return $app->abort(422, 'Invalid request.'); + } + + $persisted = $app['sms.factory']->createByRequest($request); + + if (!$persisted) { + return $app->abort(500, 'An error occured.'); + } else { + return $app->json([ + 'status' => true, + 'code' => 201, + 'message' => 'Resource created.', + ], 201); + } + } + + /** + * Delete action. + * + * @param Request $request + * @param int $id + * + * @throws \Symfony\Component\HttpKernel\Exception\HttpException + * + * @return \Symfony\Component\HttpFoundation\JsonResponse + */ + public function delete(Request $request, $id) + { + $app = $this->app; + + $object = $app['sms.factory']->get($id); + + if (!$object) { + return $app->json([ + 'status' => false, + 'code' => 404, + 'message' => 'Resource not found.', + ], 404); + } + + $app['sms.factory']->remove($object); + + return $app->json([ + 'status' => true, + 'code' => 204, + 'message' => 'Resource removed.', + ], 204); + } + + /** + * List action. + * + * @param Request $request + * + * @return \Symfony\Component\HttpFoundation\JsonResponse + */ + public function list() + { + $app = $this->app; + + $objects = $app['sms.factory']->getAll()->getData(); + $data = []; + + foreach ($objects as $object) { + $data[] = [ + 'id' => $object->getId(), + 'sender' => $object->getSender(), + 'message' => $object->getMessage(), + 'received_at' => (int) $object->getTime(), + 'notified_at' => $object->getCreatedAt()->getTimestamp(), + ]; + } + + return $app->json($data); + } +} diff --git a/web/index.php b/web/index.php index 54b35ab..0755cd5 100644 --- a/web/index.php +++ b/web/index.php @@ -2,75 +2,14 @@ use App\Application; use Symfony\Component\HttpFoundation\Request; +use App\Controller\SmsController; require_once __DIR__.'/../vendor/autoload.php'; $app = new Application(); -$app->setRootDir(__DIR__.'/../')->configure(); $app - ->post('/api/sms/create', function (Request $request) use ($app) { - if (!$app['sms.validator']->validateRequest($request)) { - return $app->abort(422, 'Invalid request.'); - } - - $persisted = $app['sms.factory']->createByRequest($request); - - if (!$persisted) { - return $app->abort(500, 'An error occured.'); - } else { - return $app->json([ - 'status' => true, - 'code' => 201, - 'message' => 'Resource created.', - ], 201); - } - }) - ->bind('api_sms_create'); - -$app - ->delete('/api/sms/delete/{id}', function (Request $request, $id) use ($app) { - $object = $app['sms.factory']->get($id); - - if (!$object) { - return $app->json([ - 'status' => false, - 'code' => 404, - 'message' => 'Resource not found.', - ], 404); - } - - $app['sms.factory']->remove($object); - - return $app->json([ - 'status' => true, - 'code' => 204, - 'message' => 'Resource removed.', - ], 204); - }) - ->bind('api_sms_delete') - ->assert('id', '\d+') - ->convert('id', function ($value) { - return (int) $value; - }); - -$app - ->get('/api/sms/list', function (Request $request) use ($app) { - $objects = $app['sms.factory']->getAll()->getData(); - $data = []; - - foreach ($objects as $object) { - $data[] = [ - 'id' => $object->getId(), - 'sender' => $object->getSender(), - 'message' => $object->getMessage(), - 'received_at' => (int) $object->getTime(), - 'notified_at' => $object->getCreatedAt()->getTimestamp(), - ]; - } - - return $app->json($data); - }) - ->bind('api_sms_list'); - -$app->run(); + ->setRootDir(__DIR__.'/../') + ->init() + ->addController(new SmsController()) + ->run(); From a64f035accdc92deee4ecf38365557a5d3eff343 Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Tue, 16 Jan 2018 09:16:55 +0100 Subject: [PATCH 11/12] User example --- etc/security/users.json-dist | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/etc/security/users.json-dist b/etc/security/users.json-dist index 0967ef4..ddf97a9 100644 --- a/etc/security/users.json-dist +++ b/etc/security/users.json-dist @@ -1 +1,3 @@ -{} +{ + "foo": ["ROLE_USER", "Use ./bin/generate-password to fill this value"] +} From 3e404d61dfa2224a559bec97341535bf78e1ebbe Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Tue, 16 Jan 2018 11:43:33 +0100 Subject: [PATCH 12/12] Documentation --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 92c83fb..deecc04 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ $ git clone https://gitnet.fr/deblan/android-automate-api.git $ cd android-automate-api $ make $ cp propel-dist.yaml propel.yaml # Edit propel.yaml +$ cp etc/security/users.json-dist etc/security/users.json # Edit users.json $ make propel ```