Skip to content
This repository has been archived by the owner on Mar 15, 2021. It is now read-only.

Latest commit

 

History

History
executable file
·
327 lines (282 loc) · 9.75 KB

README.md

File metadata and controls

executable file
·
327 lines (282 loc) · 9.75 KB

#Address- Helper v1.0.0 for CakePHP 2.3+

Microdata AddressHelper class for easy working with addresses.

Table of Contents

Requirements
Installation
Enable Helper
Usage
AddressHelper API
License
How to Contribute

##Requirements * CakePHP 2.x * PHP 5.3 ## Installation _[Manual]_ * Download this: [http://github.com/amlang/cakephp_addresshelper/zipball/master](http://github.com/amlang/cakephp_addresshelper/zipball/master) * Unzip that download. * Copy the content of resulting folder to `app/` * Done

Test cases could be found in Test/Case/View/Helper/AddressHelper.php
A sample view could be found in View/Pages/sample.php
Top

## Enable Helper Embed __AddressHelper__ in your Controller such as any other helpers, too. 
	//in a Controller
	public $helpers = array('Address');
 ## Usage 
//app/Controller/Samples
 
 public $helpers = array('Address');
//app/View/Samples/index.ctp
//Begin a new Address
print $this->Address->beginn('sample');
print $this->Address->name('New York City Samples', array('link' => 'www.nycsamples.com'));
print $this->Address->end();
<address id="hcard_sample" class="hcard">
	<div itemprop="name" link="www.nycsamples.com">
		<a href="www.nycsamples.com">
			<span itemprop="name">New York City Samples</span>
		</a>
	</div>
</address>

Top

## AddressHelper API

class AddressHelper

constant AddressHelper::SCHEMA_ORG_URL

"http://www.schema.org/"

The $options['format'] key, returns your values in the specified format back.
i.e.

$address = array(
			'streetAddress' => '20 Lincoln Center',
			'addressCountry' => 'USA',
			'addressLocality' => 'New York',
			'addressRegion' => 'NY',
			'postalCode' => '10023'
		);
$options = array('format'=>'%s<br />%s,%s %s');
print $this->Address->address( $address, $options );
	<!-- 	
			20 Lincoln Center
			USA, New York NY
	-->
	<div itemprop="address" itemscope="itemscope" itemtype="http://www.schema.org/PostalAddress">
		<span itemprop="streetAddress">20 Lincoln Center</span> <br>
		<span itemprop="addressCountry">USA</span> ,<span itemprop="addressLocality">New York</span>
		<span itemprop="addressRegion">NY</span>
	</div>

AddressHelper::beginn( string $title, array $options = array() );
Returns

<address id="hcard_title" class="hcard">

AddressHelper::end( void );
Returns

</address>

static final AdressHelper::getSchema ( string $name='' );
Returns

http://www.schema.org/Name

AdressHelper::name ( string $name, array $options = array(), array $itemOptions = array());
Fnc. returns a name-Container.
Keys for name-Array could be:

	//For Persons
	$name = array(
		'givenName' => 'Jane',
		'additionalName' => 'MiddleName',
		'familyName' => 'Doh!',
		'honorificPrefix' =>'Dr.',
		'honorificSuffix' =>'M.D.'
		);
	
	//For Organizations
	$name = array(	
		'legalName' => 'MyOrganization Ltd.'
	);
<div itemprop="name" link="http://example.com">
		<!-- if isset $options['link'] -->
		<!-- <a href="http://example.com">  -->
			<span itemprop="legalName">MyOrganization Ltd.</span>
		<!-- </a> -->
</div>

<!-- or a full name -->

<div itemprop="name">
			<span itemprop="honorificPrefix">Prof. Dr.</span>
			<span itemprop="givenName">Alexander</span>
			<span itemprop="additionalName">M.</span>
			<span itemprop="familyName">Lang</span>
			<span itemprop="honorificSuffix">M.D.</span>
</div>

AdressHelper::founder ( string $founder, array $options = array(), array $itemOptions = array());
Fnc. returns a founder-Container

<div itemprop="founder" itemscope="itemscope" itemtype="http://www.schema.org/Person">
	<span itemprop="givenName">Jane</span>
	<span itemprop="additionalName">Middle</span>
	<span itemprop="familyName">Doh!</span>
</div>

AdressHelper::address ( string $address, array $options = array(), array $itemOptions = array());
Fnc. returns a address-Container
Possible keys for AddressHelper::address() are:

	$address = array(
		'streetAddress' => '20 Liconln Center',
		'addressCountry' => 'USA',
		'addressLocality' => 'New York',
		'addressRegion' => 'NY',
	);

Returns

<div itemprop="address" itemscope="itemscope" itemtype="http://www.schema.org/PostalAddress">
	<span itemprop="streetAddress">20 Lincoln Center</span>
	<span itemprop="addressCountry">USA</span>
	<span itemprop="addressLocality">New York</span>
	<span itemprop="addressRegion">NY</span>
</div>

AdressHelper::contact ( string $address, array $options = array(), array $itemOptions = array());
Fnc. returns a contactPoint-Container

<!--$options['format'] = '<span class="label">Telefon: </span>%s <br /><span class="label">Fax: </span>%s <br /><span class="label">Email: </span>%s<br /><span class="label">WWW: </span>%s' -->
<div itemprop="contactPoint" itemscope="itemscope" itemtype="http://www.schema.org/ContactPoint">
	<span class="label">Telefon: </span>
	<span itemprop="telephone" class="prop">0126/123456</span>  <br>
	<span class="label">Fax: </span>
	<span itemprop="faxNumber" class="prop">0126/123457</span>  <br>
	<span class="label">Email: </span>
	<a href="mailto:[email protected]">
		<span itemprop="email" class="prop">[email protected]</span>
	</a><br>
	<span class="label">WWW: </span>
	<a href="http://www.some-example.de">
		<span itemprop="url" class="prop">http://www.some-example.de</span>
	</a>
</div>

AdressHelper::organization ( string $address, array $options = array(), array $itemOptions = array());
Fnc. returns a whole organization-Container

	
		print $this->Address->organization(array(
				'name' => array(
					'content' => array(
						'legalName' => 'An Organization of MyLand Inc.'
					),
					'options' => array(
						'link' => $this->Html->url($this->request->here, true)
					)
				),
				'founder' => array(
					'content' => array(
						'givenName' => 'Jane',
						'familyName' => 'Doh!'
					)
				),
				'address' => array(
					'content' => array(
						'streetAddress' => 'Mainstreet 1',
						'addressCountry' => 'DE',
						'postalCode' => '12345',
						'addressLocality' => 'ExVille',
						'addressRegion' => 'Region of EV'
					),
					'options' => array(
						'format' => '%s<br />%s-%s,%s %s'
					)
				),
				'contact' => array(
					'content' => array(
						'telephone' => '0126/123456',
						'faxNumber' => '0126/123457',
						'email' => '[email protected]'
					),
					'options' => array(
						'format' => 'Telefon: %s <br /> Fax: %s <br /> Email: %s'
					),
					'itemoptions' => array('class' => 'prop')
				)
				), array(
				'class' => 'organization'
		));
		
<address id="hcard_my_orga" class="hcard">
	<div itemprop="" class="organization" itemtype="http://www.schema.org/Organization">
		<div itemprop="name" link="http://example.com/pages/siteinfo">
			<a href="http://example.com/pages/siteinfo">
				<span itemprop="legalName">An Organization of MyLand Inc.</span>
			</a>
		</div>
		<div itemprop="founder" itemscope="itemscope" itemtype="http://www.schema.org/Person">
			<span itemprop="givenName">Jane</span>
			<span itemprop="familyName">Doh!</span> 
		</div>
		<div itemprop="address" itemscope="itemscope" itemtype="http://www.schema.org/PostalAddress">
			<span itemprop="streetAddress">Mainstreet 1</span><br>
			<span itemprop="addressCountry">DE</span> -<span itemprop="postalCode">12345</span> ,
			<span itemprop="addressLocality">ExVille</span>
			<span itemprop="addressRegion">Region of EV</span>
		</div>
		<div itemprop="contactPoint" itemscope="itemscope" itemtype="http://www.schema.org/ContactPoint">
			Telefon: <span itemprop="telephone" class="prop">0126/123456</span>  <br>
			Fax: <span itemprop="faxNumber" class="prop">0126/123457</span>  <br>
			Email: <a href="mailto:[email protected]">
				<span itemprop="email" class="prop">[email protected]</span>
			</a>
		</div>
	</div>
</address>

Top

## License

The MIT License (MIT)

Copyright (c) 2013 Alexander M. Lang

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Top