phpDocumentor ycwp-qr-me
[ class tree: ycwp-qr-me ] [ index: ycwp-qr-me ] [ all elements ]

Class: YCWP_QR_Me

Source Location: /class.ycwp_qrme.php

Class YCWP_QR_Me

Class Overview

This class can handle qr code images through QRCode class (class.qrcode.php).

It uses Google Charts APIs to generate QR Code image used in blog posts.

Located in /class.ycwp_qrme.php [line 58]



		
				Author(s):
		
		
		
Information Tags:
Version:  1.1
Copyright:  Copyright (c) 2012 Nicola Mustone

Properties

Methods

[ Top ]
Constant Summary
VERSION   YCWP QR Me version

[ Top ]
Property Summary
int   $_id   QR Codes id
object   $_qr   QRCode class instance
string   $_the_permalink   Post permalink
string   $_the_title   Post title

[ Top ]
Method Summary
YCWP_QR_Me   __construct()   Initializes properties, sets filters, actions and shortcodes
$string   ycwp_qrme_add_qr_code()   Add a QR Code image to the post content.
void   ycwp_qrme_enqueue_stuff()   Enqueue jQuery scripts
void   ycwp_qrme_localize()   Localizes the plugin
void   ycwp_qrme_option_form()   Prints a options form
void   ycwp_qrme_option_page()   Adds an option page
string   ycwp_qrme_print_image()   Print a QR Code image
void   ycwp_qrme_register_opt_group()   Registers plugin options
void   ycwp_qrme_retrive_post_permalink()   Retrives the permalink of the current post
void   ycwp_qrme_retrive_post_title()   Retrives the title of the current post
void   ycwp_qrme_settings_link()   Adds the Settings link to the plugin activation page
void   ycwp_qrme_set_defaults_on_init()   Defines the defaults values for the plugin.
void   ycwp_qrme_shortcode()   Prints a QR Code using a shortcode.
string   _ycwp_qrme_make_style_js()   Print jQuery code for show/hide effect

[ Top ]
Properties
int   $_id [line 101]

QR Codes id

API Tags:
Access:  private

Information Tags:
Since:  1.0

[ Top ]
object   $_qr [line 74]

QRCode class instance

API Tags:
See:  QRCode
Access:  private

Information Tags:
Since:  1.0

[ Top ]
string   $_the_permalink [line 83]

Post permalink

API Tags:
Access:  private

Information Tags:
Since:  1.0

[ Top ]
string   $_the_title [line 92]

Post title

API Tags:
Access:  private

Information Tags:
Since:  1.0

[ Top ]
Methods
Constructor __construct  [line 108]

  YCWP_QR_Me __construct( )

Initializes properties, sets filters, actions and shortcodes


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
ycwp_qrme_add_qr_code  [line 335]

  $string ycwp_qrme_add_qr_code( string $content  )

Add a QR Code image to the post content.

Parameters:
string   $content: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
ycwp_qrme_enqueue_stuff  [line 146]

  void ycwp_qrme_enqueue_stuff( )

Enqueue jQuery scripts


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
ycwp_qrme_localize  [line 237]

  void ycwp_qrme_localize( )

Localizes the plugin


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
ycwp_qrme_option_form  [line 366]

  void ycwp_qrme_option_form( )

Prints a options form


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
ycwp_qrme_option_page  [line 165]

  void ycwp_qrme_option_page( )

Adds an option page


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
ycwp_qrme_print_image  [line 249]

  string ycwp_qrme_print_image( string $content  )

Print a QR Code image

Parameters:
string   $content: 

API Tags:
Access:  public

Information Tags:
Version:  1.1
Since:  1.0

[ Top ]
ycwp_qrme_register_opt_group  [line 222]

  void ycwp_qrme_register_opt_group( )

Registers plugin options


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
ycwp_qrme_retrive_post_permalink  [line 187]

  void ycwp_qrme_retrive_post_permalink( $the_permalink  )

Retrives the permalink of the current post

Parameters:
   $the_permalink: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
ycwp_qrme_retrive_post_title  [line 197]

  void ycwp_qrme_retrive_post_title( $the_title  )

Retrives the title of the current post

Parameters:
   $the_title: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
ycwp_qrme_settings_link  [line 175]

  void ycwp_qrme_settings_link( $links, $file  )

Adds the Settings link to the plugin activation page

Parameters:
   $links: 
   $file: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
ycwp_qrme_set_defaults_on_init  [line 207]

  void ycwp_qrme_set_defaults_on_init( )

Defines the defaults values for the plugin.


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
ycwp_qrme_shortcode  [line 282]

  void ycwp_qrme_shortcode( $atts, [ $content = null]  )

Prints a QR Code using a shortcode.

Examples:

  • [qrme]http://www.example.com[/qrme]
  • [qrme content="http://www.example.com"]
Examples with all optional attributes:
  • [qrme size="200" error="L" class="my-custom-class" title="My Example website" alt="A QR Code for my link"]http://www.example.com[/qrme]
  • [qrme size="200" error="L" class="my-custom-class" title="My Example website" alt="A QR Code for my link" content="http://www.example.com"]

Parameters:
   $atts: 
   $content: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
_ycwp_qrme_make_style_js  [line 498]

  string _ycwp_qrme_make_style_js( )

Print jQuery code for show/hide effect


API Tags:
Access:  private

Information Tags:
Since:  1.0

[ Top ]
Constants
VERSION = '1.1' [line 64]

YCWP QR Me version


[ Top ]

Documentation generated on Tue, 21 Feb 2012 23:46:12 +0100 by phpDocumentor 1.4.3